babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944
  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. get 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. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** 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 */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** 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 */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** 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 */
  693. static readonly GEQUAL: number;
  694. /** 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 */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * 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.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * 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.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. 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>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. 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;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. 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;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * 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".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * 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"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * 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"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * 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)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * 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
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. 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;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. 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;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * 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"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * 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".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * 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"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * 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".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * 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.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. 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);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. 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>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. 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;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. 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;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, 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);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * 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;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * 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).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * 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).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * 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.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * 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.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * 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.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * 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.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * 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.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * 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.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * 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).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * 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).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * 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.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * 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.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * 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.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * 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.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * 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.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * 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.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * 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).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * 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).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * 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.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * 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.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * 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.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * 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.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * 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.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * 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.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * 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).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * 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).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * 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.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * 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.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * 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.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * 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.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * 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.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * 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.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Nullable } from "babylonjs/types";
  9538. import { Scene } from "babylonjs/scene";
  9539. import { ActionManager } from "babylonjs/Actions/actionManager";
  9540. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9541. import { Node } from "babylonjs/node";
  9542. /**
  9543. * Interface used to define Action
  9544. */
  9545. export interface IAction {
  9546. /**
  9547. * Trigger for the action
  9548. */
  9549. trigger: number;
  9550. /** Options of the trigger */
  9551. triggerOptions: any;
  9552. /**
  9553. * Gets the trigger parameters
  9554. * @returns the trigger parameters
  9555. */
  9556. getTriggerParameter(): any;
  9557. /**
  9558. * Internal only - executes current action event
  9559. * @hidden
  9560. */
  9561. _executeCurrent(evt?: ActionEvent): void;
  9562. /**
  9563. * Serialize placeholder for child classes
  9564. * @param parent of child
  9565. * @returns the serialized object
  9566. */
  9567. serialize(parent: any): any;
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Internal only - manager for action
  9575. * @hidden
  9576. */
  9577. _actionManager: Nullable<AbstractActionManager>;
  9578. /**
  9579. * Adds action to chain of actions, may be a DoNothingAction
  9580. * @param action defines the next action to execute
  9581. * @returns The action passed in
  9582. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9583. */
  9584. then(action: IAction): IAction;
  9585. }
  9586. /**
  9587. * The action to be carried out following a trigger
  9588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9589. */
  9590. export class Action implements IAction {
  9591. /** the trigger, with or without parameters, for the action */
  9592. triggerOptions: any;
  9593. /**
  9594. * Trigger for the action
  9595. */
  9596. trigger: number;
  9597. /**
  9598. * Internal only - manager for action
  9599. * @hidden
  9600. */
  9601. _actionManager: ActionManager;
  9602. private _nextActiveAction;
  9603. private _child;
  9604. private _condition?;
  9605. private _triggerParameter;
  9606. /**
  9607. * An event triggered prior to action being executed.
  9608. */
  9609. onBeforeExecuteObservable: Observable<Action>;
  9610. /**
  9611. * Creates a new Action
  9612. * @param triggerOptions the trigger, with or without parameters, for the action
  9613. * @param condition an optional determinant of action
  9614. */
  9615. constructor(
  9616. /** the trigger, with or without parameters, for the action */
  9617. triggerOptions: any, condition?: Condition);
  9618. /**
  9619. * Internal only
  9620. * @hidden
  9621. */
  9622. _prepare(): void;
  9623. /**
  9624. * Gets the trigger parameters
  9625. * @returns the trigger parameters
  9626. */
  9627. getTriggerParameter(): any;
  9628. /**
  9629. * Internal only - executes current action event
  9630. * @hidden
  9631. */
  9632. _executeCurrent(evt?: ActionEvent): void;
  9633. /**
  9634. * Execute placeholder for child classes
  9635. * @param evt optional action event
  9636. */
  9637. execute(evt?: ActionEvent): void;
  9638. /**
  9639. * Skips to next active action
  9640. */
  9641. skipToNextActiveAction(): void;
  9642. /**
  9643. * Adds action to chain of actions, may be a DoNothingAction
  9644. * @param action defines the next action to execute
  9645. * @returns The action passed in
  9646. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9647. */
  9648. then(action: Action): Action;
  9649. /**
  9650. * Internal only
  9651. * @hidden
  9652. */
  9653. _getProperty(propertyPath: string): string;
  9654. /**
  9655. * Internal only
  9656. * @hidden
  9657. */
  9658. _getEffectiveTarget(target: any, propertyPath: string): any;
  9659. /**
  9660. * Serialize placeholder for child classes
  9661. * @param parent of child
  9662. * @returns the serialized object
  9663. */
  9664. serialize(parent: any): any;
  9665. /**
  9666. * Internal only called by serialize
  9667. * @hidden
  9668. */
  9669. protected _serialize(serializedAction: any, parent?: any): any;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. static _SerializeValueAsString: (value: any) => string;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. static _GetTargetProperty: (target: Scene | Node) => {
  9680. name: string;
  9681. targetType: string;
  9682. value: string;
  9683. };
  9684. }
  9685. }
  9686. declare module "babylonjs/Actions/condition" {
  9687. import { ActionManager } from "babylonjs/Actions/actionManager";
  9688. /**
  9689. * A Condition applied to an Action
  9690. */
  9691. export class Condition {
  9692. /**
  9693. * Internal only - manager for action
  9694. * @hidden
  9695. */
  9696. _actionManager: ActionManager;
  9697. /**
  9698. * Internal only
  9699. * @hidden
  9700. */
  9701. _evaluationId: number;
  9702. /**
  9703. * Internal only
  9704. * @hidden
  9705. */
  9706. _currentResult: boolean;
  9707. /**
  9708. * Creates a new Condition
  9709. * @param actionManager the manager of the action the condition is applied to
  9710. */
  9711. constructor(actionManager: ActionManager);
  9712. /**
  9713. * Check if the current condition is valid
  9714. * @returns a boolean
  9715. */
  9716. isValid(): boolean;
  9717. /**
  9718. * Internal only
  9719. * @hidden
  9720. */
  9721. _getProperty(propertyPath: string): string;
  9722. /**
  9723. * Internal only
  9724. * @hidden
  9725. */
  9726. _getEffectiveTarget(target: any, propertyPath: string): any;
  9727. /**
  9728. * Serialize placeholder for child classes
  9729. * @returns the serialized object
  9730. */
  9731. serialize(): any;
  9732. /**
  9733. * Internal only
  9734. * @hidden
  9735. */
  9736. protected _serialize(serializedCondition: any): any;
  9737. }
  9738. /**
  9739. * Defines specific conditional operators as extensions of Condition
  9740. */
  9741. export class ValueCondition extends Condition {
  9742. /** path to specify the property of the target the conditional operator uses */
  9743. propertyPath: string;
  9744. /** the value compared by the conditional operator against the current value of the property */
  9745. value: any;
  9746. /** the conditional operator, default ValueCondition.IsEqual */
  9747. operator: number;
  9748. /**
  9749. * Internal only
  9750. * @hidden
  9751. */
  9752. private static _IsEqual;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. private static _IsDifferent;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. private static _IsGreater;
  9763. /**
  9764. * Internal only
  9765. * @hidden
  9766. */
  9767. private static _IsLesser;
  9768. /**
  9769. * returns the number for IsEqual
  9770. */
  9771. static get IsEqual(): number;
  9772. /**
  9773. * Returns the number for IsDifferent
  9774. */
  9775. static get IsDifferent(): number;
  9776. /**
  9777. * Returns the number for IsGreater
  9778. */
  9779. static get IsGreater(): number;
  9780. /**
  9781. * Returns the number for IsLesser
  9782. */
  9783. static get IsLesser(): number;
  9784. /**
  9785. * Internal only The action manager for the condition
  9786. * @hidden
  9787. */
  9788. _actionManager: ActionManager;
  9789. /**
  9790. * Internal only
  9791. * @hidden
  9792. */
  9793. private _target;
  9794. /**
  9795. * Internal only
  9796. * @hidden
  9797. */
  9798. private _effectiveTarget;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. private _property;
  9804. /**
  9805. * Creates a new ValueCondition
  9806. * @param actionManager manager for the action the condition applies to
  9807. * @param target for the action
  9808. * @param propertyPath path to specify the property of the target the conditional operator uses
  9809. * @param value the value compared by the conditional operator against the current value of the property
  9810. * @param operator the conditional operator, default ValueCondition.IsEqual
  9811. */
  9812. constructor(actionManager: ActionManager, target: any,
  9813. /** path to specify the property of the target the conditional operator uses */
  9814. propertyPath: string,
  9815. /** the value compared by the conditional operator against the current value of the property */
  9816. value: any,
  9817. /** the conditional operator, default ValueCondition.IsEqual */
  9818. operator?: number);
  9819. /**
  9820. * Compares the given value with the property value for the specified conditional operator
  9821. * @returns the result of the comparison
  9822. */
  9823. isValid(): boolean;
  9824. /**
  9825. * Serialize the ValueCondition into a JSON compatible object
  9826. * @returns serialization object
  9827. */
  9828. serialize(): any;
  9829. /**
  9830. * Gets the name of the conditional operator for the ValueCondition
  9831. * @param operator the conditional operator
  9832. * @returns the name
  9833. */
  9834. static GetOperatorName(operator: number): string;
  9835. }
  9836. /**
  9837. * Defines a predicate condition as an extension of Condition
  9838. */
  9839. export class PredicateCondition extends Condition {
  9840. /** defines the predicate function used to validate the condition */
  9841. predicate: () => boolean;
  9842. /**
  9843. * Internal only - manager for action
  9844. * @hidden
  9845. */
  9846. _actionManager: ActionManager;
  9847. /**
  9848. * Creates a new PredicateCondition
  9849. * @param actionManager manager for the action the condition applies to
  9850. * @param predicate defines the predicate function used to validate the condition
  9851. */
  9852. constructor(actionManager: ActionManager,
  9853. /** defines the predicate function used to validate the condition */
  9854. predicate: () => boolean);
  9855. /**
  9856. * @returns the validity of the predicate condition
  9857. */
  9858. isValid(): boolean;
  9859. }
  9860. /**
  9861. * Defines a state condition as an extension of Condition
  9862. */
  9863. export class StateCondition extends Condition {
  9864. /** Value to compare with target state */
  9865. value: string;
  9866. /**
  9867. * Internal only - manager for action
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Creates a new StateCondition
  9878. * @param actionManager manager for the action the condition applies to
  9879. * @param target of the condition
  9880. * @param value to compare with target state
  9881. */
  9882. constructor(actionManager: ActionManager, target: any,
  9883. /** Value to compare with target state */
  9884. value: string);
  9885. /**
  9886. * Gets a boolean indicating if the current condition is met
  9887. * @returns the validity of the state
  9888. */
  9889. isValid(): boolean;
  9890. /**
  9891. * Serialize the StateCondition into a JSON compatible object
  9892. * @returns serialization object
  9893. */
  9894. serialize(): any;
  9895. }
  9896. }
  9897. declare module "babylonjs/Actions/directActions" {
  9898. import { Action } from "babylonjs/Actions/action";
  9899. import { Condition } from "babylonjs/Actions/condition";
  9900. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9901. /**
  9902. * This defines an action responsible to toggle a boolean once triggered.
  9903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9904. */
  9905. export class SwitchBooleanAction extends Action {
  9906. /**
  9907. * The path to the boolean property in the target object
  9908. */
  9909. propertyPath: string;
  9910. private _target;
  9911. private _effectiveTarget;
  9912. private _property;
  9913. /**
  9914. * Instantiate the action
  9915. * @param triggerOptions defines the trigger options
  9916. * @param target defines the object containing the boolean
  9917. * @param propertyPath defines the path to the boolean property in the target object
  9918. * @param condition defines the trigger related conditions
  9919. */
  9920. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9921. /** @hidden */
  9922. _prepare(): void;
  9923. /**
  9924. * Execute the action toggle the boolean value.
  9925. */
  9926. execute(): void;
  9927. /**
  9928. * Serializes the actions and its related information.
  9929. * @param parent defines the object to serialize in
  9930. * @returns the serialized object
  9931. */
  9932. serialize(parent: any): any;
  9933. }
  9934. /**
  9935. * This defines an action responsible to set a the state field of the target
  9936. * to a desired value once triggered.
  9937. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9938. */
  9939. export class SetStateAction extends Action {
  9940. /**
  9941. * The value to store in the state field.
  9942. */
  9943. value: string;
  9944. private _target;
  9945. /**
  9946. * Instantiate the action
  9947. * @param triggerOptions defines the trigger options
  9948. * @param target defines the object containing the state property
  9949. * @param value defines the value to store in the state field
  9950. * @param condition defines the trigger related conditions
  9951. */
  9952. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9953. /**
  9954. * Execute the action and store the value on the target state property.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible to set a property of the target
  9966. * to a desired value once triggered.
  9967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9968. */
  9969. export class SetValueAction extends Action {
  9970. /**
  9971. * The path of the property to set in the target.
  9972. */
  9973. propertyPath: string;
  9974. /**
  9975. * The value to set in the property
  9976. */
  9977. value: any;
  9978. private _target;
  9979. private _effectiveTarget;
  9980. private _property;
  9981. /**
  9982. * Instantiate the action
  9983. * @param triggerOptions defines the trigger options
  9984. * @param target defines the object containing the property
  9985. * @param propertyPath defines the path of the property to set in the target
  9986. * @param value defines the value to set in the property
  9987. * @param condition defines the trigger related conditions
  9988. */
  9989. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9990. /** @hidden */
  9991. _prepare(): void;
  9992. /**
  9993. * Execute the action and set the targetted property to the desired value.
  9994. */
  9995. execute(): void;
  9996. /**
  9997. * Serializes the actions and its related information.
  9998. * @param parent defines the object to serialize in
  9999. * @returns the serialized object
  10000. */
  10001. serialize(parent: any): any;
  10002. }
  10003. /**
  10004. * This defines an action responsible to increment the target value
  10005. * to a desired value once triggered.
  10006. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10007. */
  10008. export class IncrementValueAction extends Action {
  10009. /**
  10010. * The path of the property to increment in the target.
  10011. */
  10012. propertyPath: string;
  10013. /**
  10014. * The value we should increment the property by.
  10015. */
  10016. value: any;
  10017. private _target;
  10018. private _effectiveTarget;
  10019. private _property;
  10020. /**
  10021. * Instantiate the action
  10022. * @param triggerOptions defines the trigger options
  10023. * @param target defines the object containing the property
  10024. * @param propertyPath defines the path of the property to increment in the target
  10025. * @param value defines the value value we should increment the property by
  10026. * @param condition defines the trigger related conditions
  10027. */
  10028. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10029. /** @hidden */
  10030. _prepare(): void;
  10031. /**
  10032. * Execute the action and increment the target of the value amount.
  10033. */
  10034. execute(): void;
  10035. /**
  10036. * Serializes the actions and its related information.
  10037. * @param parent defines the object to serialize in
  10038. * @returns the serialized object
  10039. */
  10040. serialize(parent: any): any;
  10041. }
  10042. /**
  10043. * This defines an action responsible to start an animation once triggered.
  10044. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10045. */
  10046. export class PlayAnimationAction extends Action {
  10047. /**
  10048. * Where the animation should start (animation frame)
  10049. */
  10050. from: number;
  10051. /**
  10052. * Where the animation should stop (animation frame)
  10053. */
  10054. to: number;
  10055. /**
  10056. * Define if the animation should loop or stop after the first play.
  10057. */
  10058. loop?: boolean;
  10059. private _target;
  10060. /**
  10061. * Instantiate the action
  10062. * @param triggerOptions defines the trigger options
  10063. * @param target defines the target animation or animation name
  10064. * @param from defines from where the animation should start (animation frame)
  10065. * @param end defines where the animation should stop (animation frame)
  10066. * @param loop defines if the animation should loop or stop after the first play
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10070. /** @hidden */
  10071. _prepare(): void;
  10072. /**
  10073. * Execute the action and play the animation.
  10074. */
  10075. execute(): void;
  10076. /**
  10077. * Serializes the actions and its related information.
  10078. * @param parent defines the object to serialize in
  10079. * @returns the serialized object
  10080. */
  10081. serialize(parent: any): any;
  10082. }
  10083. /**
  10084. * This defines an action responsible to stop an animation once triggered.
  10085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10086. */
  10087. export class StopAnimationAction extends Action {
  10088. private _target;
  10089. /**
  10090. * Instantiate the action
  10091. * @param triggerOptions defines the trigger options
  10092. * @param target defines the target animation or animation name
  10093. * @param condition defines the trigger related conditions
  10094. */
  10095. constructor(triggerOptions: any, target: any, condition?: Condition);
  10096. /** @hidden */
  10097. _prepare(): void;
  10098. /**
  10099. * Execute the action and stop the animation.
  10100. */
  10101. execute(): void;
  10102. /**
  10103. * Serializes the actions and its related information.
  10104. * @param parent defines the object to serialize in
  10105. * @returns the serialized object
  10106. */
  10107. serialize(parent: any): any;
  10108. }
  10109. /**
  10110. * This defines an action responsible that does nothing once triggered.
  10111. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10112. */
  10113. export class DoNothingAction extends Action {
  10114. /**
  10115. * Instantiate the action
  10116. * @param triggerOptions defines the trigger options
  10117. * @param condition defines the trigger related conditions
  10118. */
  10119. constructor(triggerOptions?: any, condition?: Condition);
  10120. /**
  10121. * Execute the action and do nothing.
  10122. */
  10123. execute(): void;
  10124. /**
  10125. * Serializes the actions and its related information.
  10126. * @param parent defines the object to serialize in
  10127. * @returns the serialized object
  10128. */
  10129. serialize(parent: any): any;
  10130. }
  10131. /**
  10132. * This defines an action responsible to trigger several actions once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class CombineAction extends Action {
  10136. /**
  10137. * The list of aggregated animations to run.
  10138. */
  10139. children: Action[];
  10140. /**
  10141. * Instantiate the action
  10142. * @param triggerOptions defines the trigger options
  10143. * @param children defines the list of aggregated animations to run
  10144. * @param condition defines the trigger related conditions
  10145. */
  10146. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10147. /** @hidden */
  10148. _prepare(): void;
  10149. /**
  10150. * Execute the action and executes all the aggregated actions.
  10151. */
  10152. execute(evt: ActionEvent): void;
  10153. /**
  10154. * Serializes the actions and its related information.
  10155. * @param parent defines the object to serialize in
  10156. * @returns the serialized object
  10157. */
  10158. serialize(parent: any): any;
  10159. }
  10160. /**
  10161. * This defines an action responsible to run code (external event) once triggered.
  10162. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10163. */
  10164. export class ExecuteCodeAction extends Action {
  10165. /**
  10166. * The callback function to run.
  10167. */
  10168. func: (evt: ActionEvent) => void;
  10169. /**
  10170. * Instantiate the action
  10171. * @param triggerOptions defines the trigger options
  10172. * @param func defines the callback function to run
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10176. /**
  10177. * Execute the action and run the attached code.
  10178. */
  10179. execute(evt: ActionEvent): void;
  10180. }
  10181. /**
  10182. * This defines an action responsible to set the parent property of the target once triggered.
  10183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10184. */
  10185. export class SetParentAction extends Action {
  10186. private _parent;
  10187. private _target;
  10188. /**
  10189. * Instantiate the action
  10190. * @param triggerOptions defines the trigger options
  10191. * @param target defines the target containing the parent property
  10192. * @param parent defines from where the animation should start (animation frame)
  10193. * @param condition defines the trigger related conditions
  10194. */
  10195. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10196. /** @hidden */
  10197. _prepare(): void;
  10198. /**
  10199. * Execute the action and set the parent property.
  10200. */
  10201. execute(): void;
  10202. /**
  10203. * Serializes the actions and its related information.
  10204. * @param parent defines the object to serialize in
  10205. * @returns the serialized object
  10206. */
  10207. serialize(parent: any): any;
  10208. }
  10209. }
  10210. declare module "babylonjs/Actions/actionManager" {
  10211. import { Nullable } from "babylonjs/types";
  10212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10213. import { Scene } from "babylonjs/scene";
  10214. import { IAction } from "babylonjs/Actions/action";
  10215. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10216. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10217. /**
  10218. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10219. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10221. */
  10222. export class ActionManager extends AbstractActionManager {
  10223. /**
  10224. * Nothing
  10225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10226. */
  10227. static readonly NothingTrigger: number;
  10228. /**
  10229. * On pick
  10230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10231. */
  10232. static readonly OnPickTrigger: number;
  10233. /**
  10234. * On left pick
  10235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10236. */
  10237. static readonly OnLeftPickTrigger: number;
  10238. /**
  10239. * On right pick
  10240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10241. */
  10242. static readonly OnRightPickTrigger: number;
  10243. /**
  10244. * On center pick
  10245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10246. */
  10247. static readonly OnCenterPickTrigger: number;
  10248. /**
  10249. * On pick down
  10250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10251. */
  10252. static readonly OnPickDownTrigger: number;
  10253. /**
  10254. * On double pick
  10255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10256. */
  10257. static readonly OnDoublePickTrigger: number;
  10258. /**
  10259. * On pick up
  10260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10261. */
  10262. static readonly OnPickUpTrigger: number;
  10263. /**
  10264. * On pick out.
  10265. * This trigger will only be raised if you also declared a OnPickDown
  10266. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10267. */
  10268. static readonly OnPickOutTrigger: number;
  10269. /**
  10270. * On long press
  10271. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10272. */
  10273. static readonly OnLongPressTrigger: number;
  10274. /**
  10275. * On pointer over
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10277. */
  10278. static readonly OnPointerOverTrigger: number;
  10279. /**
  10280. * On pointer out
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly OnPointerOutTrigger: number;
  10284. /**
  10285. * On every frame
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnEveryFrameTrigger: number;
  10289. /**
  10290. * On intersection enter
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnIntersectionEnterTrigger: number;
  10294. /**
  10295. * On intersection exit
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnIntersectionExitTrigger: number;
  10299. /**
  10300. * On key down
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnKeyDownTrigger: number;
  10304. /**
  10305. * On key up
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnKeyUpTrigger: number;
  10309. private _scene;
  10310. /**
  10311. * Creates a new action manager
  10312. * @param scene defines the hosting scene
  10313. */
  10314. constructor(scene: Scene);
  10315. /**
  10316. * Releases all associated resources
  10317. */
  10318. dispose(): void;
  10319. /**
  10320. * Gets hosting scene
  10321. * @returns the hosting scene
  10322. */
  10323. getScene(): Scene;
  10324. /**
  10325. * Does this action manager handles actions of any of the given triggers
  10326. * @param triggers defines the triggers to be tested
  10327. * @return a boolean indicating whether one (or more) of the triggers is handled
  10328. */
  10329. hasSpecificTriggers(triggers: number[]): boolean;
  10330. /**
  10331. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10332. * speed.
  10333. * @param triggerA defines the trigger to be tested
  10334. * @param triggerB defines the trigger to be tested
  10335. * @return a boolean indicating whether one (or more) of the triggers is handled
  10336. */
  10337. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10338. /**
  10339. * Does this action manager handles actions of a given trigger
  10340. * @param trigger defines the trigger to be tested
  10341. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10342. * @return whether the trigger is handled
  10343. */
  10344. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10345. /**
  10346. * Does this action manager has pointer triggers
  10347. */
  10348. get hasPointerTriggers(): boolean;
  10349. /**
  10350. * Does this action manager has pick triggers
  10351. */
  10352. get hasPickTriggers(): boolean;
  10353. /**
  10354. * Registers an action to this action manager
  10355. * @param action defines the action to be registered
  10356. * @return the action amended (prepared) after registration
  10357. */
  10358. registerAction(action: IAction): Nullable<IAction>;
  10359. /**
  10360. * Unregisters an action to this action manager
  10361. * @param action defines the action to be unregistered
  10362. * @return a boolean indicating whether the action has been unregistered
  10363. */
  10364. unregisterAction(action: IAction): Boolean;
  10365. /**
  10366. * Process a specific trigger
  10367. * @param trigger defines the trigger to process
  10368. * @param evt defines the event details to be processed
  10369. */
  10370. processTrigger(trigger: number, evt?: IActionEvent): void;
  10371. /** @hidden */
  10372. _getEffectiveTarget(target: any, propertyPath: string): any;
  10373. /** @hidden */
  10374. _getProperty(propertyPath: string): string;
  10375. /**
  10376. * Serialize this manager to a JSON object
  10377. * @param name defines the property name to store this manager
  10378. * @returns a JSON representation of this manager
  10379. */
  10380. serialize(name: string): any;
  10381. /**
  10382. * Creates a new ActionManager from a JSON data
  10383. * @param parsedActions defines the JSON data to read from
  10384. * @param object defines the hosting mesh
  10385. * @param scene defines the hosting scene
  10386. */
  10387. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10388. /**
  10389. * Get a trigger name by index
  10390. * @param trigger defines the trigger index
  10391. * @returns a trigger name
  10392. */
  10393. static GetTriggerName(trigger: number): string;
  10394. }
  10395. }
  10396. declare module "babylonjs/Sprites/sprite" {
  10397. import { Vector3 } from "babylonjs/Maths/math.vector";
  10398. import { Nullable } from "babylonjs/types";
  10399. import { ActionManager } from "babylonjs/Actions/actionManager";
  10400. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10401. import { Color4 } from "babylonjs/Maths/math.color";
  10402. import { Observable } from "babylonjs/Misc/observable";
  10403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10404. import { Animation } from "babylonjs/Animations/animation";
  10405. /**
  10406. * Class used to represent a sprite
  10407. * @see https://doc.babylonjs.com/babylon101/sprites
  10408. */
  10409. export class Sprite implements IAnimatable {
  10410. /** defines the name */
  10411. name: string;
  10412. /** Gets or sets the current world position */
  10413. position: Vector3;
  10414. /** Gets or sets the main color */
  10415. color: Color4;
  10416. /** Gets or sets the width */
  10417. width: number;
  10418. /** Gets or sets the height */
  10419. height: number;
  10420. /** Gets or sets rotation angle */
  10421. angle: number;
  10422. /** Gets or sets the cell index in the sprite sheet */
  10423. cellIndex: number;
  10424. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10425. cellRef: string;
  10426. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10427. invertU: boolean;
  10428. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10429. invertV: boolean;
  10430. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10431. disposeWhenFinishedAnimating: boolean;
  10432. /** Gets the list of attached animations */
  10433. animations: Nullable<Array<Animation>>;
  10434. /** Gets or sets a boolean indicating if the sprite can be picked */
  10435. isPickable: boolean;
  10436. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10437. useAlphaForPicking: boolean;
  10438. /** @hidden */
  10439. _xOffset: number;
  10440. /** @hidden */
  10441. _yOffset: number;
  10442. /** @hidden */
  10443. _xSize: number;
  10444. /** @hidden */
  10445. _ySize: number;
  10446. /**
  10447. * Gets or sets the associated action manager
  10448. */
  10449. actionManager: Nullable<ActionManager>;
  10450. /**
  10451. * An event triggered when the control has been disposed
  10452. */
  10453. onDisposeObservable: Observable<Sprite>;
  10454. private _animationStarted;
  10455. private _loopAnimation;
  10456. private _fromIndex;
  10457. private _toIndex;
  10458. private _delay;
  10459. private _direction;
  10460. private _manager;
  10461. private _time;
  10462. private _onAnimationEnd;
  10463. /**
  10464. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10465. */
  10466. isVisible: boolean;
  10467. /**
  10468. * Gets or sets the sprite size
  10469. */
  10470. get size(): number;
  10471. set size(value: number);
  10472. /**
  10473. * Returns a boolean indicating if the animation is started
  10474. */
  10475. get animationStarted(): boolean;
  10476. /**
  10477. * Gets or sets the unique id of the sprite
  10478. */
  10479. uniqueId: number;
  10480. /**
  10481. * Gets the manager of this sprite
  10482. */
  10483. get manager(): ISpriteManager;
  10484. /**
  10485. * Creates a new Sprite
  10486. * @param name defines the name
  10487. * @param manager defines the manager
  10488. */
  10489. constructor(
  10490. /** defines the name */
  10491. name: string, manager: ISpriteManager);
  10492. /**
  10493. * Returns the string "Sprite"
  10494. * @returns "Sprite"
  10495. */
  10496. getClassName(): string;
  10497. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10498. get fromIndex(): number;
  10499. set fromIndex(value: number);
  10500. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10501. get toIndex(): number;
  10502. set toIndex(value: number);
  10503. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10504. get loopAnimation(): boolean;
  10505. set loopAnimation(value: boolean);
  10506. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10507. get delay(): number;
  10508. set delay(value: number);
  10509. /**
  10510. * Starts an animation
  10511. * @param from defines the initial key
  10512. * @param to defines the end key
  10513. * @param loop defines if the animation must loop
  10514. * @param delay defines the start delay (in ms)
  10515. * @param onAnimationEnd defines a callback to call when animation ends
  10516. */
  10517. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10518. /** Stops current animation (if any) */
  10519. stopAnimation(): void;
  10520. /** @hidden */
  10521. _animate(deltaTime: number): void;
  10522. /** Release associated resources */
  10523. dispose(): void;
  10524. /**
  10525. * Serializes the sprite to a JSON object
  10526. * @returns the JSON object
  10527. */
  10528. serialize(): any;
  10529. /**
  10530. * Parses a JSON object to create a new sprite
  10531. * @param parsedSprite The JSON object to parse
  10532. * @param manager defines the hosting manager
  10533. * @returns the new sprite
  10534. */
  10535. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10536. }
  10537. }
  10538. declare module "babylonjs/Collisions/pickingInfo" {
  10539. import { Nullable } from "babylonjs/types";
  10540. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10541. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10542. import { Sprite } from "babylonjs/Sprites/sprite";
  10543. import { Ray } from "babylonjs/Culling/ray";
  10544. /**
  10545. * Information about the result of picking within a scene
  10546. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10547. */
  10548. export class PickingInfo {
  10549. /** @hidden */
  10550. _pickingUnavailable: boolean;
  10551. /**
  10552. * If the pick collided with an object
  10553. */
  10554. hit: boolean;
  10555. /**
  10556. * Distance away where the pick collided
  10557. */
  10558. distance: number;
  10559. /**
  10560. * The location of pick collision
  10561. */
  10562. pickedPoint: Nullable<Vector3>;
  10563. /**
  10564. * The mesh corresponding the the pick collision
  10565. */
  10566. pickedMesh: Nullable<AbstractMesh>;
  10567. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10568. bu: number;
  10569. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10570. bv: number;
  10571. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10572. faceId: number;
  10573. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10574. subMeshFaceId: number;
  10575. /** Id of the the submesh that was picked */
  10576. subMeshId: number;
  10577. /** If a sprite was picked, this will be the sprite the pick collided with */
  10578. pickedSprite: Nullable<Sprite>;
  10579. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10580. thinInstanceIndex: number;
  10581. /**
  10582. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10583. */
  10584. originMesh: Nullable<AbstractMesh>;
  10585. /**
  10586. * The ray that was used to perform the picking.
  10587. */
  10588. ray: Nullable<Ray>;
  10589. /**
  10590. * Gets the normal correspodning to the face the pick collided with
  10591. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10592. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10593. * @returns The normal correspodning to the face the pick collided with
  10594. */
  10595. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10596. /**
  10597. * Gets the texture coordinates of where the pick occured
  10598. * @returns the vector containing the coordnates of the texture
  10599. */
  10600. getTextureCoordinates(): Nullable<Vector2>;
  10601. }
  10602. }
  10603. declare module "babylonjs/Culling/ray" {
  10604. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10605. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10607. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10608. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10609. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10610. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10611. import { Plane } from "babylonjs/Maths/math.plane";
  10612. /**
  10613. * Class representing a ray with position and direction
  10614. */
  10615. export class Ray {
  10616. /** origin point */
  10617. origin: Vector3;
  10618. /** direction */
  10619. direction: Vector3;
  10620. /** length of the ray */
  10621. length: number;
  10622. private static readonly _TmpVector3;
  10623. private _tmpRay;
  10624. /**
  10625. * Creates a new ray
  10626. * @param origin origin point
  10627. * @param direction direction
  10628. * @param length length of the ray
  10629. */
  10630. constructor(
  10631. /** origin point */
  10632. origin: Vector3,
  10633. /** direction */
  10634. direction: Vector3,
  10635. /** length of the ray */
  10636. length?: number);
  10637. /**
  10638. * Checks if the ray intersects a box
  10639. * This does not account for the ray lenght by design to improve perfs.
  10640. * @param minimum bound of the box
  10641. * @param maximum bound of the box
  10642. * @param intersectionTreshold extra extend to be added to the box in all direction
  10643. * @returns if the box was hit
  10644. */
  10645. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10646. /**
  10647. * Checks if the ray intersects a box
  10648. * This does not account for the ray lenght by design to improve perfs.
  10649. * @param box the bounding box to check
  10650. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10651. * @returns if the box was hit
  10652. */
  10653. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10654. /**
  10655. * If the ray hits a sphere
  10656. * @param sphere the bounding sphere to check
  10657. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10658. * @returns true if it hits the sphere
  10659. */
  10660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10661. /**
  10662. * If the ray hits a triange
  10663. * @param vertex0 triangle vertex
  10664. * @param vertex1 triangle vertex
  10665. * @param vertex2 triangle vertex
  10666. * @returns intersection information if hit
  10667. */
  10668. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10669. /**
  10670. * Checks if ray intersects a plane
  10671. * @param plane the plane to check
  10672. * @returns the distance away it was hit
  10673. */
  10674. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10675. /**
  10676. * Calculate the intercept of a ray on a given axis
  10677. * @param axis to check 'x' | 'y' | 'z'
  10678. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10679. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10680. */
  10681. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10682. /**
  10683. * Checks if ray intersects a mesh
  10684. * @param mesh the mesh to check
  10685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10686. * @returns picking info of the intersecton
  10687. */
  10688. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10689. /**
  10690. * Checks if ray intersects a mesh
  10691. * @param meshes the meshes to check
  10692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10693. * @param results array to store result in
  10694. * @returns Array of picking infos
  10695. */
  10696. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10697. private _comparePickingInfo;
  10698. private static smallnum;
  10699. private static rayl;
  10700. /**
  10701. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10702. * @param sega the first point of the segment to test the intersection against
  10703. * @param segb the second point of the segment to test the intersection against
  10704. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10705. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10706. */
  10707. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10708. /**
  10709. * Update the ray from viewport position
  10710. * @param x position
  10711. * @param y y position
  10712. * @param viewportWidth viewport width
  10713. * @param viewportHeight viewport height
  10714. * @param world world matrix
  10715. * @param view view matrix
  10716. * @param projection projection matrix
  10717. * @returns this ray updated
  10718. */
  10719. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10720. /**
  10721. * Creates a ray with origin and direction of 0,0,0
  10722. * @returns the new ray
  10723. */
  10724. static Zero(): Ray;
  10725. /**
  10726. * Creates a new ray from screen space and viewport
  10727. * @param x position
  10728. * @param y y position
  10729. * @param viewportWidth viewport width
  10730. * @param viewportHeight viewport height
  10731. * @param world world matrix
  10732. * @param view view matrix
  10733. * @param projection projection matrix
  10734. * @returns new ray
  10735. */
  10736. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10737. /**
  10738. * 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
  10739. * transformed to the given world matrix.
  10740. * @param origin The origin point
  10741. * @param end The end point
  10742. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10743. * @returns the new ray
  10744. */
  10745. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10746. /**
  10747. * Transforms a ray by a matrix
  10748. * @param ray ray to transform
  10749. * @param matrix matrix to apply
  10750. * @returns the resulting new ray
  10751. */
  10752. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10753. /**
  10754. * Transforms a ray by a matrix
  10755. * @param ray ray to transform
  10756. * @param matrix matrix to apply
  10757. * @param result ray to store result in
  10758. */
  10759. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10760. /**
  10761. * Unproject a ray from screen space to object space
  10762. * @param sourceX defines the screen space x coordinate to use
  10763. * @param sourceY defines the screen space y coordinate to use
  10764. * @param viewportWidth defines the current width of the viewport
  10765. * @param viewportHeight defines the current height of the viewport
  10766. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10767. * @param view defines the view matrix to use
  10768. * @param projection defines the projection matrix to use
  10769. */
  10770. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10771. }
  10772. /**
  10773. * Type used to define predicate used to select faces when a mesh intersection is detected
  10774. */
  10775. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10776. module "babylonjs/scene" {
  10777. interface Scene {
  10778. /** @hidden */
  10779. _tempPickingRay: Nullable<Ray>;
  10780. /** @hidden */
  10781. _cachedRayForTransform: Ray;
  10782. /** @hidden */
  10783. _pickWithRayInverseMatrix: Matrix;
  10784. /** @hidden */
  10785. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10786. /** @hidden */
  10787. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10788. /** @hidden */
  10789. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10790. }
  10791. }
  10792. }
  10793. declare module "babylonjs/sceneComponent" {
  10794. import { Scene } from "babylonjs/scene";
  10795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10796. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10797. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10798. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10799. import { Nullable } from "babylonjs/types";
  10800. import { Camera } from "babylonjs/Cameras/camera";
  10801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10802. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10803. import { AbstractScene } from "babylonjs/abstractScene";
  10804. import { Mesh } from "babylonjs/Meshes/mesh";
  10805. /**
  10806. * Groups all the scene component constants in one place to ease maintenance.
  10807. * @hidden
  10808. */
  10809. export class SceneComponentConstants {
  10810. static readonly NAME_EFFECTLAYER: string;
  10811. static readonly NAME_LAYER: string;
  10812. static readonly NAME_LENSFLARESYSTEM: string;
  10813. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10814. static readonly NAME_PARTICLESYSTEM: string;
  10815. static readonly NAME_GAMEPAD: string;
  10816. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10817. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10818. static readonly NAME_PREPASSRENDERER: string;
  10819. static readonly NAME_DEPTHRENDERER: string;
  10820. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10821. static readonly NAME_SPRITE: string;
  10822. static readonly NAME_OUTLINERENDERER: string;
  10823. static readonly NAME_PROCEDURALTEXTURE: string;
  10824. static readonly NAME_SHADOWGENERATOR: string;
  10825. static readonly NAME_OCTREE: string;
  10826. static readonly NAME_PHYSICSENGINE: string;
  10827. static readonly NAME_AUDIO: string;
  10828. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10829. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10832. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10835. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10836. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10837. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10840. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10842. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10843. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10844. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10846. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10847. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10848. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10849. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10850. static readonly STEP_AFTERRENDER_AUDIO: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10854. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10855. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10856. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10857. static readonly STEP_POINTERMOVE_SPRITE: number;
  10858. static readonly STEP_POINTERDOWN_SPRITE: number;
  10859. static readonly STEP_POINTERUP_SPRITE: number;
  10860. }
  10861. /**
  10862. * This represents a scene component.
  10863. *
  10864. * This is used to decouple the dependency the scene is having on the different workloads like
  10865. * layers, post processes...
  10866. */
  10867. export interface ISceneComponent {
  10868. /**
  10869. * The name of the component. Each component must have a unique name.
  10870. */
  10871. name: string;
  10872. /**
  10873. * The scene the component belongs to.
  10874. */
  10875. scene: Scene;
  10876. /**
  10877. * Register the component to one instance of a scene.
  10878. */
  10879. register(): void;
  10880. /**
  10881. * Rebuilds the elements related to this component in case of
  10882. * context lost for instance.
  10883. */
  10884. rebuild(): void;
  10885. /**
  10886. * Disposes the component and the associated ressources.
  10887. */
  10888. dispose(): void;
  10889. }
  10890. /**
  10891. * This represents a SERIALIZABLE scene component.
  10892. *
  10893. * This extends Scene Component to add Serialization methods on top.
  10894. */
  10895. export interface ISceneSerializableComponent extends ISceneComponent {
  10896. /**
  10897. * Adds all the elements from the container to the scene
  10898. * @param container the container holding the elements
  10899. */
  10900. addFromContainer(container: AbstractScene): void;
  10901. /**
  10902. * Removes all the elements in the container from the scene
  10903. * @param container contains the elements to remove
  10904. * @param dispose if the removed element should be disposed (default: false)
  10905. */
  10906. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10907. /**
  10908. * Serializes the component data to the specified json object
  10909. * @param serializationObject The object to serialize to
  10910. */
  10911. serialize(serializationObject: any): void;
  10912. }
  10913. /**
  10914. * Strong typing of a Mesh related stage step action
  10915. */
  10916. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10917. /**
  10918. * Strong typing of a Evaluate Sub Mesh related stage step action
  10919. */
  10920. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10921. /**
  10922. * Strong typing of a Active Mesh related stage step action
  10923. */
  10924. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10925. /**
  10926. * Strong typing of a Camera related stage step action
  10927. */
  10928. export type CameraStageAction = (camera: Camera) => void;
  10929. /**
  10930. * Strong typing of a Camera Frame buffer related stage step action
  10931. */
  10932. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10933. /**
  10934. * Strong typing of a Render Target related stage step action
  10935. */
  10936. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10937. /**
  10938. * Strong typing of a RenderingGroup related stage step action
  10939. */
  10940. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10941. /**
  10942. * Strong typing of a Mesh Render related stage step action
  10943. */
  10944. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10945. /**
  10946. * Strong typing of a simple stage step action
  10947. */
  10948. export type SimpleStageAction = () => void;
  10949. /**
  10950. * Strong typing of a render target action.
  10951. */
  10952. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10953. /**
  10954. * Strong typing of a pointer move action.
  10955. */
  10956. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10957. /**
  10958. * Strong typing of a pointer up/down action.
  10959. */
  10960. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10961. /**
  10962. * Representation of a stage in the scene (Basically a list of ordered steps)
  10963. * @hidden
  10964. */
  10965. export class Stage<T extends Function> extends Array<{
  10966. index: number;
  10967. component: ISceneComponent;
  10968. action: T;
  10969. }> {
  10970. /**
  10971. * Hide ctor from the rest of the world.
  10972. * @param items The items to add.
  10973. */
  10974. private constructor();
  10975. /**
  10976. * Creates a new Stage.
  10977. * @returns A new instance of a Stage
  10978. */
  10979. static Create<T extends Function>(): Stage<T>;
  10980. /**
  10981. * Registers a step in an ordered way in the targeted stage.
  10982. * @param index Defines the position to register the step in
  10983. * @param component Defines the component attached to the step
  10984. * @param action Defines the action to launch during the step
  10985. */
  10986. registerStep(index: number, component: ISceneComponent, action: T): void;
  10987. /**
  10988. * Clears all the steps from the stage.
  10989. */
  10990. clear(): void;
  10991. }
  10992. }
  10993. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10994. import { Nullable } from "babylonjs/types";
  10995. import { Observable } from "babylonjs/Misc/observable";
  10996. import { Scene } from "babylonjs/scene";
  10997. import { Sprite } from "babylonjs/Sprites/sprite";
  10998. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10999. import { Ray } from "babylonjs/Culling/ray";
  11000. import { Camera } from "babylonjs/Cameras/camera";
  11001. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11002. import { ISceneComponent } from "babylonjs/sceneComponent";
  11003. module "babylonjs/scene" {
  11004. interface Scene {
  11005. /** @hidden */
  11006. _pointerOverSprite: Nullable<Sprite>;
  11007. /** @hidden */
  11008. _pickedDownSprite: Nullable<Sprite>;
  11009. /** @hidden */
  11010. _tempSpritePickingRay: Nullable<Ray>;
  11011. /**
  11012. * All of the sprite managers added to this scene
  11013. * @see https://doc.babylonjs.com/babylon101/sprites
  11014. */
  11015. spriteManagers: Array<ISpriteManager>;
  11016. /**
  11017. * An event triggered when sprites rendering is about to start
  11018. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11019. */
  11020. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11021. /**
  11022. * An event triggered when sprites rendering is done
  11023. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11024. */
  11025. onAfterSpritesRenderingObservable: Observable<Scene>;
  11026. /** @hidden */
  11027. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11028. /** Launch a ray to try to pick a sprite in the scene
  11029. * @param x position on screen
  11030. * @param y position on screen
  11031. * @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
  11032. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11033. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11034. * @returns a PickingInfo
  11035. */
  11036. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11037. /** Use the given ray to pick a sprite in the scene
  11038. * @param ray The ray (in world space) to use to pick meshes
  11039. * @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
  11040. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11041. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11042. * @returns a PickingInfo
  11043. */
  11044. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11045. /** @hidden */
  11046. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11047. /** Launch a ray to try to pick sprites in the scene
  11048. * @param x position on screen
  11049. * @param y position on screen
  11050. * @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
  11051. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11052. * @returns a PickingInfo array
  11053. */
  11054. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11055. /** Use the given ray to pick sprites in the scene
  11056. * @param ray The ray (in world space) to use to pick meshes
  11057. * @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
  11058. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11059. * @returns a PickingInfo array
  11060. */
  11061. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11062. /**
  11063. * Force the sprite under the pointer
  11064. * @param sprite defines the sprite to use
  11065. */
  11066. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11067. /**
  11068. * Gets the sprite under the pointer
  11069. * @returns a Sprite or null if no sprite is under the pointer
  11070. */
  11071. getPointerOverSprite(): Nullable<Sprite>;
  11072. }
  11073. }
  11074. /**
  11075. * Defines the sprite scene component responsible to manage sprites
  11076. * in a given scene.
  11077. */
  11078. export class SpriteSceneComponent implements ISceneComponent {
  11079. /**
  11080. * The component name helpfull to identify the component in the list of scene components.
  11081. */
  11082. readonly name: string;
  11083. /**
  11084. * The scene the component belongs to.
  11085. */
  11086. scene: Scene;
  11087. /** @hidden */
  11088. private _spritePredicate;
  11089. /**
  11090. * Creates a new instance of the component for the given scene
  11091. * @param scene Defines the scene to register the component in
  11092. */
  11093. constructor(scene: Scene);
  11094. /**
  11095. * Registers the component in a given scene
  11096. */
  11097. register(): void;
  11098. /**
  11099. * Rebuilds the elements related to this component in case of
  11100. * context lost for instance.
  11101. */
  11102. rebuild(): void;
  11103. /**
  11104. * Disposes the component and the associated ressources.
  11105. */
  11106. dispose(): void;
  11107. private _pickSpriteButKeepRay;
  11108. private _pointerMove;
  11109. private _pointerDown;
  11110. private _pointerUp;
  11111. }
  11112. }
  11113. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11114. /** @hidden */
  11115. export var fogFragmentDeclaration: {
  11116. name: string;
  11117. shader: string;
  11118. };
  11119. }
  11120. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11121. /** @hidden */
  11122. export var fogFragment: {
  11123. name: string;
  11124. shader: string;
  11125. };
  11126. }
  11127. declare module "babylonjs/Shaders/sprites.fragment" {
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11129. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11130. /** @hidden */
  11131. export var spritesPixelShader: {
  11132. name: string;
  11133. shader: string;
  11134. };
  11135. }
  11136. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11137. /** @hidden */
  11138. export var fogVertexDeclaration: {
  11139. name: string;
  11140. shader: string;
  11141. };
  11142. }
  11143. declare module "babylonjs/Shaders/sprites.vertex" {
  11144. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11145. /** @hidden */
  11146. export var spritesVertexShader: {
  11147. name: string;
  11148. shader: string;
  11149. };
  11150. }
  11151. declare module "babylonjs/Sprites/spriteManager" {
  11152. import { IDisposable, Scene } from "babylonjs/scene";
  11153. import { Nullable } from "babylonjs/types";
  11154. import { Observable } from "babylonjs/Misc/observable";
  11155. import { Sprite } from "babylonjs/Sprites/sprite";
  11156. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11157. import { Camera } from "babylonjs/Cameras/camera";
  11158. import { Texture } from "babylonjs/Materials/Textures/texture";
  11159. import "babylonjs/Shaders/sprites.fragment";
  11160. import "babylonjs/Shaders/sprites.vertex";
  11161. import { Ray } from "babylonjs/Culling/ray";
  11162. /**
  11163. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11164. */
  11165. export interface ISpriteManager extends IDisposable {
  11166. /**
  11167. * Gets manager's name
  11168. */
  11169. name: string;
  11170. /**
  11171. * Restricts the camera to viewing objects with the same layerMask.
  11172. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11173. */
  11174. layerMask: number;
  11175. /**
  11176. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11177. */
  11178. isPickable: boolean;
  11179. /**
  11180. * Gets the hosting scene
  11181. */
  11182. scene: Scene;
  11183. /**
  11184. * Specifies the rendering group id for this mesh (0 by default)
  11185. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11186. */
  11187. renderingGroupId: number;
  11188. /**
  11189. * Defines the list of sprites managed by the manager.
  11190. */
  11191. sprites: Array<Sprite>;
  11192. /**
  11193. * Gets or sets the spritesheet texture
  11194. */
  11195. texture: Texture;
  11196. /** Defines the default width of a cell in the spritesheet */
  11197. cellWidth: number;
  11198. /** Defines the default height of a cell in the spritesheet */
  11199. cellHeight: number;
  11200. /**
  11201. * Tests the intersection of a sprite with a specific ray.
  11202. * @param ray The ray we are sending to test the collision
  11203. * @param camera The camera space we are sending rays in
  11204. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11206. * @returns picking info or null.
  11207. */
  11208. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11209. /**
  11210. * Intersects the sprites with a ray
  11211. * @param ray defines the ray to intersect with
  11212. * @param camera defines the current active camera
  11213. * @param predicate defines a predicate used to select candidate sprites
  11214. * @returns null if no hit or a PickingInfo array
  11215. */
  11216. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11217. /**
  11218. * Renders the list of sprites on screen.
  11219. */
  11220. render(): void;
  11221. }
  11222. /**
  11223. * Class used to manage multiple sprites on the same spritesheet
  11224. * @see https://doc.babylonjs.com/babylon101/sprites
  11225. */
  11226. export class SpriteManager implements ISpriteManager {
  11227. /** defines the manager's name */
  11228. name: string;
  11229. /** Define the Url to load snippets */
  11230. static SnippetUrl: string;
  11231. /** Snippet ID if the manager was created from the snippet server */
  11232. snippetId: string;
  11233. /** Gets the list of sprites */
  11234. sprites: Sprite[];
  11235. /** Gets or sets the rendering group id (0 by default) */
  11236. renderingGroupId: number;
  11237. /** Gets or sets camera layer mask */
  11238. layerMask: number;
  11239. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11240. fogEnabled: boolean;
  11241. /** Gets or sets a boolean indicating if the sprites are pickable */
  11242. isPickable: boolean;
  11243. /** Defines the default width of a cell in the spritesheet */
  11244. cellWidth: number;
  11245. /** Defines the default height of a cell in the spritesheet */
  11246. cellHeight: number;
  11247. /** Associative array from JSON sprite data file */
  11248. private _cellData;
  11249. /** Array of sprite names from JSON sprite data file */
  11250. private _spriteMap;
  11251. /** True when packed cell data from JSON file is ready*/
  11252. private _packedAndReady;
  11253. private _textureContent;
  11254. private _useInstancing;
  11255. /**
  11256. * An event triggered when the manager is disposed.
  11257. */
  11258. onDisposeObservable: Observable<SpriteManager>;
  11259. private _onDisposeObserver;
  11260. /**
  11261. * Callback called when the manager is disposed
  11262. */
  11263. set onDispose(callback: () => void);
  11264. private _capacity;
  11265. private _fromPacked;
  11266. private _spriteTexture;
  11267. private _epsilon;
  11268. private _scene;
  11269. private _vertexData;
  11270. private _buffer;
  11271. private _vertexBuffers;
  11272. private _spriteBuffer;
  11273. private _indexBuffer;
  11274. private _effectBase;
  11275. private _effectFog;
  11276. private _vertexBufferSize;
  11277. /**
  11278. * Gets or sets the unique id of the sprite
  11279. */
  11280. uniqueId: number;
  11281. /**
  11282. * Gets the array of sprites
  11283. */
  11284. get children(): Sprite[];
  11285. /**
  11286. * Gets the hosting scene
  11287. */
  11288. get scene(): Scene;
  11289. /**
  11290. * Gets the capacity of the manager
  11291. */
  11292. get capacity(): number;
  11293. /**
  11294. * Gets or sets the spritesheet texture
  11295. */
  11296. get texture(): Texture;
  11297. set texture(value: Texture);
  11298. private _blendMode;
  11299. /**
  11300. * Blend mode use to render the particle, it can be any of
  11301. * the static Constants.ALPHA_x properties provided in this class.
  11302. * Default value is Constants.ALPHA_COMBINE
  11303. */
  11304. get blendMode(): number;
  11305. set blendMode(blendMode: number);
  11306. /** Disables writing to the depth buffer when rendering the sprites.
  11307. * It can be handy to disable depth writing when using textures without alpha channel
  11308. * and setting some specific blend modes.
  11309. */
  11310. disableDepthWrite: boolean;
  11311. /**
  11312. * Creates a new sprite manager
  11313. * @param name defines the manager's name
  11314. * @param imgUrl defines the sprite sheet url
  11315. * @param capacity defines the maximum allowed number of sprites
  11316. * @param cellSize defines the size of a sprite cell
  11317. * @param scene defines the hosting scene
  11318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11319. * @param samplingMode defines the smapling mode to use with spritesheet
  11320. * @param fromPacked set to false; do not alter
  11321. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11322. */
  11323. constructor(
  11324. /** defines the manager's name */
  11325. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11326. /**
  11327. * Returns the string "SpriteManager"
  11328. * @returns "SpriteManager"
  11329. */
  11330. getClassName(): string;
  11331. private _makePacked;
  11332. private _appendSpriteVertex;
  11333. private _checkTextureAlpha;
  11334. /**
  11335. * Intersects the sprites with a ray
  11336. * @param ray defines the ray to intersect with
  11337. * @param camera defines the current active camera
  11338. * @param predicate defines a predicate used to select candidate sprites
  11339. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11340. * @returns null if no hit or a PickingInfo
  11341. */
  11342. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11343. /**
  11344. * Intersects the sprites with a ray
  11345. * @param ray defines the ray to intersect with
  11346. * @param camera defines the current active camera
  11347. * @param predicate defines a predicate used to select candidate sprites
  11348. * @returns null if no hit or a PickingInfo array
  11349. */
  11350. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11351. /**
  11352. * Render all child sprites
  11353. */
  11354. render(): void;
  11355. /**
  11356. * Release associated resources
  11357. */
  11358. dispose(): void;
  11359. /**
  11360. * Serializes the sprite manager to a JSON object
  11361. * @param serializeTexture defines if the texture must be serialized as well
  11362. * @returns the JSON object
  11363. */
  11364. serialize(serializeTexture?: boolean): any;
  11365. /**
  11366. * Parses a JSON object to create a new sprite manager.
  11367. * @param parsedManager The JSON object to parse
  11368. * @param scene The scene to create the sprite managerin
  11369. * @param rootUrl The root url to use to load external dependencies like texture
  11370. * @returns the new sprite manager
  11371. */
  11372. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11373. /**
  11374. * Creates a sprite manager from a snippet saved in a remote file
  11375. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11376. * @param url defines the url to load from
  11377. * @param scene defines the hosting scene
  11378. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11379. * @returns a promise that will resolve to the new sprite manager
  11380. */
  11381. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. /**
  11383. * Creates a sprite manager from a snippet saved by the sprite editor
  11384. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11385. * @param scene defines the hosting scene
  11386. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11387. * @returns a promise that will resolve to the new sprite manager
  11388. */
  11389. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11390. }
  11391. }
  11392. declare module "babylonjs/Misc/gradients" {
  11393. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11394. /** Interface used by value gradients (color, factor, ...) */
  11395. export interface IValueGradient {
  11396. /**
  11397. * Gets or sets the gradient value (between 0 and 1)
  11398. */
  11399. gradient: number;
  11400. }
  11401. /** Class used to store color4 gradient */
  11402. export class ColorGradient implements IValueGradient {
  11403. /**
  11404. * Gets or sets the gradient value (between 0 and 1)
  11405. */
  11406. gradient: number;
  11407. /**
  11408. * Gets or sets first associated color
  11409. */
  11410. color1: Color4;
  11411. /**
  11412. * Gets or sets second associated color
  11413. */
  11414. color2?: Color4 | undefined;
  11415. /**
  11416. * Creates a new color4 gradient
  11417. * @param gradient gets or sets the gradient value (between 0 and 1)
  11418. * @param color1 gets or sets first associated color
  11419. * @param color2 gets or sets first second color
  11420. */
  11421. constructor(
  11422. /**
  11423. * Gets or sets the gradient value (between 0 and 1)
  11424. */
  11425. gradient: number,
  11426. /**
  11427. * Gets or sets first associated color
  11428. */
  11429. color1: Color4,
  11430. /**
  11431. * Gets or sets second associated color
  11432. */
  11433. color2?: Color4 | undefined);
  11434. /**
  11435. * Will get a color picked randomly between color1 and color2.
  11436. * If color2 is undefined then color1 will be used
  11437. * @param result defines the target Color4 to store the result in
  11438. */
  11439. getColorToRef(result: Color4): void;
  11440. }
  11441. /** Class used to store color 3 gradient */
  11442. export class Color3Gradient implements IValueGradient {
  11443. /**
  11444. * Gets or sets the gradient value (between 0 and 1)
  11445. */
  11446. gradient: number;
  11447. /**
  11448. * Gets or sets the associated color
  11449. */
  11450. color: Color3;
  11451. /**
  11452. * Creates a new color3 gradient
  11453. * @param gradient gets or sets the gradient value (between 0 and 1)
  11454. * @param color gets or sets associated color
  11455. */
  11456. constructor(
  11457. /**
  11458. * Gets or sets the gradient value (between 0 and 1)
  11459. */
  11460. gradient: number,
  11461. /**
  11462. * Gets or sets the associated color
  11463. */
  11464. color: Color3);
  11465. }
  11466. /** Class used to store factor gradient */
  11467. export class FactorGradient implements IValueGradient {
  11468. /**
  11469. * Gets or sets the gradient value (between 0 and 1)
  11470. */
  11471. gradient: number;
  11472. /**
  11473. * Gets or sets first associated factor
  11474. */
  11475. factor1: number;
  11476. /**
  11477. * Gets or sets second associated factor
  11478. */
  11479. factor2?: number | undefined;
  11480. /**
  11481. * Creates a new factor gradient
  11482. * @param gradient gets or sets the gradient value (between 0 and 1)
  11483. * @param factor1 gets or sets first associated factor
  11484. * @param factor2 gets or sets second associated factor
  11485. */
  11486. constructor(
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number,
  11491. /**
  11492. * Gets or sets first associated factor
  11493. */
  11494. factor1: number,
  11495. /**
  11496. * Gets or sets second associated factor
  11497. */
  11498. factor2?: number | undefined);
  11499. /**
  11500. * Will get a number picked randomly between factor1 and factor2.
  11501. * If factor2 is undefined then factor1 will be used
  11502. * @returns the picked number
  11503. */
  11504. getFactor(): number;
  11505. }
  11506. /**
  11507. * Helper used to simplify some generic gradient tasks
  11508. */
  11509. export class GradientHelper {
  11510. /**
  11511. * Gets the current gradient from an array of IValueGradient
  11512. * @param ratio defines the current ratio to get
  11513. * @param gradients defines the array of IValueGradient
  11514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11515. */
  11516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11517. }
  11518. }
  11519. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11520. import { Nullable } from "babylonjs/types";
  11521. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11522. import { Scene } from "babylonjs/scene";
  11523. module "babylonjs/Engines/thinEngine" {
  11524. interface ThinEngine {
  11525. /**
  11526. * Creates a raw texture
  11527. * @param data defines the data to store in the texture
  11528. * @param width defines the width of the texture
  11529. * @param height defines the height of the texture
  11530. * @param format defines the format of the data
  11531. * @param generateMipMaps defines if the engine should generate the mip levels
  11532. * @param invertY defines if data must be stored with Y axis inverted
  11533. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11534. * @param compression defines the compression used (null by default)
  11535. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11536. * @returns the raw texture inside an InternalTexture
  11537. */
  11538. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11539. /**
  11540. * Update a raw texture
  11541. * @param texture defines the texture to update
  11542. * @param data defines the data to store in the texture
  11543. * @param format defines the format of the data
  11544. * @param invertY defines if data must be stored with Y axis inverted
  11545. */
  11546. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11547. /**
  11548. * Update a raw texture
  11549. * @param texture defines the texture to update
  11550. * @param data defines the data to store in the texture
  11551. * @param format defines the format of the data
  11552. * @param invertY defines if data must be stored with Y axis inverted
  11553. * @param compression defines the compression used (null by default)
  11554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11555. */
  11556. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11557. /**
  11558. * Creates a new raw cube texture
  11559. * @param data defines the array of data to use to create each face
  11560. * @param size defines the size of the textures
  11561. * @param format defines the format of the data
  11562. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11563. * @param generateMipMaps defines if the engine should generate the mip levels
  11564. * @param invertY defines if data must be stored with Y axis inverted
  11565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11566. * @param compression defines the compression used (null by default)
  11567. * @returns the cube texture as an InternalTexture
  11568. */
  11569. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11570. /**
  11571. * Update a raw cube texture
  11572. * @param texture defines the texture to udpdate
  11573. * @param data defines the data to store
  11574. * @param format defines the data format
  11575. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11576. * @param invertY defines if data must be stored with Y axis inverted
  11577. */
  11578. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11579. /**
  11580. * Update a raw cube texture
  11581. * @param texture defines the texture to udpdate
  11582. * @param data defines the data to store
  11583. * @param format defines the data format
  11584. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11585. * @param invertY defines if data must be stored with Y axis inverted
  11586. * @param compression defines the compression used (null by default)
  11587. */
  11588. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11589. /**
  11590. * Update a raw cube texture
  11591. * @param texture defines the texture to udpdate
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. * @param compression defines the compression used (null by default)
  11597. * @param level defines which level of the texture to update
  11598. */
  11599. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11600. /**
  11601. * Creates a new raw cube texture from a specified url
  11602. * @param url defines the url where the data is located
  11603. * @param scene defines the current scene
  11604. * @param size defines the size of the textures
  11605. * @param format defines the format of the data
  11606. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11607. * @param noMipmap defines if the engine should avoid generating the mip levels
  11608. * @param callback defines a callback used to extract texture data from loaded data
  11609. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11610. * @param onLoad defines a callback called when texture is loaded
  11611. * @param onError defines a callback called if there is an error
  11612. * @returns the cube texture as an InternalTexture
  11613. */
  11614. createRawCubeTextureFromUrl(url: string, scene: Nullable<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;
  11615. /**
  11616. * Creates a new raw cube texture from a specified url
  11617. * @param url defines the url where the data is located
  11618. * @param scene defines the current scene
  11619. * @param size defines the size of the textures
  11620. * @param format defines the format of the data
  11621. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11622. * @param noMipmap defines if the engine should avoid generating the mip levels
  11623. * @param callback defines a callback used to extract texture data from loaded data
  11624. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11625. * @param onLoad defines a callback called when texture is loaded
  11626. * @param onError defines a callback called if there is an error
  11627. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. * @returns the cube texture as an InternalTexture
  11630. */
  11631. createRawCubeTextureFromUrl(url: string, scene: Nullable<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;
  11632. /**
  11633. * Creates a new raw 3D texture
  11634. * @param data defines the data used to create the texture
  11635. * @param width defines the width of the texture
  11636. * @param height defines the height of the texture
  11637. * @param depth defines the depth of the texture
  11638. * @param format defines the format of the texture
  11639. * @param generateMipMaps defines if the engine must generate mip levels
  11640. * @param invertY defines if data must be stored with Y axis inverted
  11641. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11642. * @param compression defines the compressed used (can be null)
  11643. * @param textureType defines the compressed used (can be null)
  11644. * @returns a new raw 3D texture (stored in an InternalTexture)
  11645. */
  11646. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11647. /**
  11648. * Update a raw 3D texture
  11649. * @param texture defines the texture to update
  11650. * @param data defines the data to store
  11651. * @param format defines the data format
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. */
  11654. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11655. /**
  11656. * Update a raw 3D texture
  11657. * @param texture defines the texture to update
  11658. * @param data defines the data to store
  11659. * @param format defines the data format
  11660. * @param invertY defines if data must be stored with Y axis inverted
  11661. * @param compression defines the used compression (can be null)
  11662. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11663. */
  11664. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11665. /**
  11666. * Creates a new raw 2D array texture
  11667. * @param data defines the data used to create the texture
  11668. * @param width defines the width of the texture
  11669. * @param height defines the height of the texture
  11670. * @param depth defines the number of layers of the texture
  11671. * @param format defines the format of the texture
  11672. * @param generateMipMaps defines if the engine must generate mip levels
  11673. * @param invertY defines if data must be stored with Y axis inverted
  11674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11675. * @param compression defines the compressed used (can be null)
  11676. * @param textureType defines the compressed used (can be null)
  11677. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11678. */
  11679. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11680. /**
  11681. * Update a raw 2D array texture
  11682. * @param texture defines the texture to update
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. */
  11687. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11688. /**
  11689. * Update a raw 2D array texture
  11690. * @param texture defines the texture to update
  11691. * @param data defines the data to store
  11692. * @param format defines the data format
  11693. * @param invertY defines if data must be stored with Y axis inverted
  11694. * @param compression defines the used compression (can be null)
  11695. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11696. */
  11697. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11698. }
  11699. }
  11700. }
  11701. declare module "babylonjs/Materials/Textures/rawTexture" {
  11702. import { Texture } from "babylonjs/Materials/Textures/texture";
  11703. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11704. import { Nullable } from "babylonjs/types";
  11705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11706. import { Scene } from "babylonjs/scene";
  11707. /**
  11708. * Raw texture can help creating a texture directly from an array of data.
  11709. * This can be super useful if you either get the data from an uncompressed source or
  11710. * if you wish to create your texture pixel by pixel.
  11711. */
  11712. export class RawTexture extends Texture {
  11713. /**
  11714. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11715. */
  11716. format: number;
  11717. /**
  11718. * Instantiates a new RawTexture.
  11719. * Raw texture can help creating a texture directly from an array of data.
  11720. * This can be super useful if you either get the data from an uncompressed source or
  11721. * if you wish to create your texture pixel by pixel.
  11722. * @param data define the array of data to use to create the texture
  11723. * @param width define the width of the texture
  11724. * @param height define the height of the texture
  11725. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11726. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11727. * @param generateMipMaps define whether mip maps should be generated or not
  11728. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11729. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11730. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11731. */
  11732. constructor(data: ArrayBufferView, width: number, height: number,
  11733. /**
  11734. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11735. */
  11736. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11737. /**
  11738. * Updates the texture underlying data.
  11739. * @param data Define the new data of the texture
  11740. */
  11741. update(data: ArrayBufferView): void;
  11742. /**
  11743. * Creates a luminance texture from some data.
  11744. * @param data Define the texture data
  11745. * @param width Define the width of the texture
  11746. * @param height Define the height of the texture
  11747. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11748. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11749. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11750. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11751. * @returns the luminance texture
  11752. */
  11753. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11754. /**
  11755. * Creates a luminance alpha texture from some data.
  11756. * @param data Define the texture data
  11757. * @param width Define the width of the texture
  11758. * @param height Define the height of the texture
  11759. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11760. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11761. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11762. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11763. * @returns the luminance alpha texture
  11764. */
  11765. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11766. /**
  11767. * Creates an alpha texture from some data.
  11768. * @param data Define the texture data
  11769. * @param width Define the width of the texture
  11770. * @param height Define the height of the texture
  11771. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11772. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11773. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11774. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11775. * @returns the alpha texture
  11776. */
  11777. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11778. /**
  11779. * Creates a RGB texture from some data.
  11780. * @param data Define the texture data
  11781. * @param width Define the width of the texture
  11782. * @param height Define the height of the texture
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. * @returns the RGB alpha texture
  11789. */
  11790. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11791. /**
  11792. * Creates a RGBA texture from some data.
  11793. * @param data Define the texture data
  11794. * @param width Define the width of the texture
  11795. * @param height Define the height of the texture
  11796. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11797. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11798. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11799. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11800. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11801. * @returns the RGBA texture
  11802. */
  11803. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11804. /**
  11805. * Creates a R texture from some data.
  11806. * @param data Define the texture data
  11807. * @param width Define the width of the texture
  11808. * @param height Define the height of the texture
  11809. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11810. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11811. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11812. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11813. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11814. * @returns the R texture
  11815. */
  11816. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11817. }
  11818. }
  11819. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11820. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11821. import { IndicesArray, DataArray } from "babylonjs/types";
  11822. module "babylonjs/Engines/thinEngine" {
  11823. interface ThinEngine {
  11824. /**
  11825. * Update a dynamic index buffer
  11826. * @param indexBuffer defines the target index buffer
  11827. * @param indices defines the data to update
  11828. * @param offset defines the offset in the target index buffer where update should start
  11829. */
  11830. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11831. /**
  11832. * Updates a dynamic vertex buffer.
  11833. * @param vertexBuffer the vertex buffer to update
  11834. * @param data the data used to update the vertex buffer
  11835. * @param byteOffset the byte offset of the data
  11836. * @param byteLength the byte length of the data
  11837. */
  11838. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11839. }
  11840. }
  11841. }
  11842. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11843. import { Scene } from "babylonjs/scene";
  11844. import { ISceneComponent } from "babylonjs/sceneComponent";
  11845. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11846. module "babylonjs/abstractScene" {
  11847. interface AbstractScene {
  11848. /**
  11849. * The list of procedural textures added to the scene
  11850. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11851. */
  11852. proceduralTextures: Array<ProceduralTexture>;
  11853. }
  11854. }
  11855. /**
  11856. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11857. * in a given scene.
  11858. */
  11859. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11860. /**
  11861. * The component name helpfull to identify the component in the list of scene components.
  11862. */
  11863. readonly name: string;
  11864. /**
  11865. * The scene the component belongs to.
  11866. */
  11867. scene: Scene;
  11868. /**
  11869. * Creates a new instance of the component for the given scene
  11870. * @param scene Defines the scene to register the component in
  11871. */
  11872. constructor(scene: Scene);
  11873. /**
  11874. * Registers the component in a given scene
  11875. */
  11876. register(): void;
  11877. /**
  11878. * Rebuilds the elements related to this component in case of
  11879. * context lost for instance.
  11880. */
  11881. rebuild(): void;
  11882. /**
  11883. * Disposes the component and the associated ressources.
  11884. */
  11885. dispose(): void;
  11886. private _beforeClear;
  11887. }
  11888. }
  11889. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11890. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11891. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11892. module "babylonjs/Engines/thinEngine" {
  11893. interface ThinEngine {
  11894. /**
  11895. * Creates a new render target cube texture
  11896. * @param size defines the size of the texture
  11897. * @param options defines the options used to create the texture
  11898. * @returns a new render target cube texture stored in an InternalTexture
  11899. */
  11900. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11901. }
  11902. }
  11903. }
  11904. declare module "babylonjs/Shaders/procedural.vertex" {
  11905. /** @hidden */
  11906. export var proceduralVertexShader: {
  11907. name: string;
  11908. shader: string;
  11909. };
  11910. }
  11911. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11912. import { Observable } from "babylonjs/Misc/observable";
  11913. import { Nullable } from "babylonjs/types";
  11914. import { Scene } from "babylonjs/scene";
  11915. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11916. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11917. import { Effect } from "babylonjs/Materials/effect";
  11918. import { Texture } from "babylonjs/Materials/Textures/texture";
  11919. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11920. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11921. import "babylonjs/Shaders/procedural.vertex";
  11922. /**
  11923. * 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.
  11924. * This is the base class of any Procedural texture and contains most of the shareable code.
  11925. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11926. */
  11927. export class ProceduralTexture extends Texture {
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * 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.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * 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.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** 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 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * 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)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * 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.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * 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.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * 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.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * 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)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * 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.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * 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.
  12937. * 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: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * 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.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @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.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * 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.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * 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.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * 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
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * 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)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * 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.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * 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
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * 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
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. /** @hidden */
  15088. _postMultiplyPivotMatrix: boolean;
  15089. protected _isWorldMatrixFrozen: boolean;
  15090. /** @hidden */
  15091. _indexInSceneTransformNodesArray: number;
  15092. /**
  15093. * An event triggered after the world matrix is updated
  15094. */
  15095. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15096. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15097. /**
  15098. * Gets a string identifying the name of the class
  15099. * @returns "TransformNode" string
  15100. */
  15101. getClassName(): string;
  15102. /**
  15103. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15104. */
  15105. get position(): Vector3;
  15106. set position(newPosition: Vector3);
  15107. /**
  15108. * 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)).
  15109. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15110. */
  15111. get rotation(): Vector3;
  15112. set rotation(newRotation: Vector3);
  15113. /**
  15114. * 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)).
  15115. */
  15116. get scaling(): Vector3;
  15117. set scaling(newScaling: Vector3);
  15118. /**
  15119. * 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).
  15120. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15121. */
  15122. get rotationQuaternion(): Nullable<Quaternion>;
  15123. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15124. /**
  15125. * The forward direction of that transform in world space.
  15126. */
  15127. get forward(): Vector3;
  15128. /**
  15129. * The up direction of that transform in world space.
  15130. */
  15131. get up(): Vector3;
  15132. /**
  15133. * The right direction of that transform in world space.
  15134. */
  15135. get right(): Vector3;
  15136. /**
  15137. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15138. * @param matrix the matrix to copy the pose from
  15139. * @returns this TransformNode.
  15140. */
  15141. updatePoseMatrix(matrix: Matrix): TransformNode;
  15142. /**
  15143. * Returns the mesh Pose matrix.
  15144. * @returns the pose matrix
  15145. */
  15146. getPoseMatrix(): Matrix;
  15147. /** @hidden */
  15148. _isSynchronized(): boolean;
  15149. /** @hidden */
  15150. _initCache(): void;
  15151. /**
  15152. * Flag the transform node as dirty (Forcing it to update everything)
  15153. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15154. * @returns this transform node
  15155. */
  15156. markAsDirty(property: string): TransformNode;
  15157. /**
  15158. * Returns the current mesh absolute position.
  15159. * Returns a Vector3.
  15160. */
  15161. get absolutePosition(): Vector3;
  15162. /**
  15163. * Returns the current mesh absolute scaling.
  15164. * Returns a Vector3.
  15165. */
  15166. get absoluteScaling(): Vector3;
  15167. /**
  15168. * Returns the current mesh absolute rotation.
  15169. * Returns a Quaternion.
  15170. */
  15171. get absoluteRotationQuaternion(): Quaternion;
  15172. /**
  15173. * Sets a new matrix to apply before all other transformation
  15174. * @param matrix defines the transform matrix
  15175. * @returns the current TransformNode
  15176. */
  15177. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15178. /**
  15179. * Sets a new pivot matrix to the current node
  15180. * @param matrix defines the new pivot matrix to use
  15181. * @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
  15182. * @returns the current TransformNode
  15183. */
  15184. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15185. /**
  15186. * Returns the mesh pivot matrix.
  15187. * Default : Identity.
  15188. * @returns the matrix
  15189. */
  15190. getPivotMatrix(): Matrix;
  15191. /**
  15192. * Instantiate (when possible) or clone that node with its hierarchy
  15193. * @param newParent defines the new parent to use for the instance (or clone)
  15194. * @param options defines options to configure how copy is done
  15195. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15196. * @returns an instance (or a clone) of the current node with its hiearchy
  15197. */
  15198. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15199. doNotInstantiate: boolean;
  15200. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15201. /**
  15202. * Prevents the World matrix to be computed any longer
  15203. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15204. * @returns the TransformNode.
  15205. */
  15206. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15207. /**
  15208. * Allows back the World matrix computation.
  15209. * @returns the TransformNode.
  15210. */
  15211. unfreezeWorldMatrix(): this;
  15212. /**
  15213. * True if the World matrix has been frozen.
  15214. */
  15215. get isWorldMatrixFrozen(): boolean;
  15216. /**
  15217. * Retuns the mesh absolute position in the World.
  15218. * @returns a Vector3.
  15219. */
  15220. getAbsolutePosition(): Vector3;
  15221. /**
  15222. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15223. * @param absolutePosition the absolute position to set
  15224. * @returns the TransformNode.
  15225. */
  15226. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15227. /**
  15228. * Sets the mesh position in its local space.
  15229. * @param vector3 the position to set in localspace
  15230. * @returns the TransformNode.
  15231. */
  15232. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15233. /**
  15234. * Returns the mesh position in the local space from the current World matrix values.
  15235. * @returns a new Vector3.
  15236. */
  15237. getPositionExpressedInLocalSpace(): Vector3;
  15238. /**
  15239. * Translates the mesh along the passed Vector3 in its local space.
  15240. * @param vector3 the distance to translate in localspace
  15241. * @returns the TransformNode.
  15242. */
  15243. locallyTranslate(vector3: Vector3): TransformNode;
  15244. private static _lookAtVectorCache;
  15245. /**
  15246. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15247. * @param targetPoint the position (must be in same space as current mesh) to look at
  15248. * @param yawCor optional yaw (y-axis) correction in radians
  15249. * @param pitchCor optional pitch (x-axis) correction in radians
  15250. * @param rollCor optional roll (z-axis) correction in radians
  15251. * @param space the choosen space of the target
  15252. * @returns the TransformNode.
  15253. */
  15254. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15255. /**
  15256. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15257. * This Vector3 is expressed in the World space.
  15258. * @param localAxis axis to rotate
  15259. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15260. */
  15261. getDirection(localAxis: Vector3): Vector3;
  15262. /**
  15263. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15264. * localAxis is expressed in the mesh local space.
  15265. * result is computed in the Wordl space from the mesh World matrix.
  15266. * @param localAxis axis to rotate
  15267. * @param result the resulting transformnode
  15268. * @returns this TransformNode.
  15269. */
  15270. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15271. /**
  15272. * Sets this transform node rotation to the given local axis.
  15273. * @param localAxis the axis in local space
  15274. * @param yawCor optional yaw (y-axis) correction in radians
  15275. * @param pitchCor optional pitch (x-axis) correction in radians
  15276. * @param rollCor optional roll (z-axis) correction in radians
  15277. * @returns this TransformNode
  15278. */
  15279. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15280. /**
  15281. * Sets a new pivot point to the current node
  15282. * @param point defines the new pivot point to use
  15283. * @param space defines if the point is in world or local space (local by default)
  15284. * @returns the current TransformNode
  15285. */
  15286. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15287. /**
  15288. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15289. * @returns the pivot point
  15290. */
  15291. getPivotPoint(): Vector3;
  15292. /**
  15293. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15294. * @param result the vector3 to store the result
  15295. * @returns this TransformNode.
  15296. */
  15297. getPivotPointToRef(result: Vector3): TransformNode;
  15298. /**
  15299. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15301. */
  15302. getAbsolutePivotPoint(): Vector3;
  15303. /**
  15304. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15305. * @param result vector3 to store the result
  15306. * @returns this TransformNode.
  15307. */
  15308. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15309. /**
  15310. * Defines the passed node as the parent of the current node.
  15311. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15312. * @see https://doc.babylonjs.com/how_to/parenting
  15313. * @param node the node ot set as the parent
  15314. * @returns this TransformNode.
  15315. */
  15316. setParent(node: Nullable<Node>): TransformNode;
  15317. private _nonUniformScaling;
  15318. /**
  15319. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15320. */
  15321. get nonUniformScaling(): boolean;
  15322. /** @hidden */
  15323. _updateNonUniformScalingState(value: boolean): boolean;
  15324. /**
  15325. * Attach the current TransformNode to another TransformNode associated with a bone
  15326. * @param bone Bone affecting the TransformNode
  15327. * @param affectedTransformNode TransformNode associated with the bone
  15328. * @returns this object
  15329. */
  15330. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15331. /**
  15332. * Detach the transform node if its associated with a bone
  15333. * @returns this object
  15334. */
  15335. detachFromBone(): TransformNode;
  15336. private static _rotationAxisCache;
  15337. /**
  15338. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15339. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15340. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15341. * The passed axis is also normalized.
  15342. * @param axis the axis to rotate around
  15343. * @param amount the amount to rotate in radians
  15344. * @param space Space to rotate in (Default: local)
  15345. * @returns the TransformNode.
  15346. */
  15347. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15348. /**
  15349. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15350. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15351. * The passed axis is also normalized. .
  15352. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15353. * @param point the point to rotate around
  15354. * @param axis the axis to rotate around
  15355. * @param amount the amount to rotate in radians
  15356. * @returns the TransformNode
  15357. */
  15358. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15359. /**
  15360. * Translates the mesh along the axis vector for the passed distance in the given space.
  15361. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15362. * @param axis the axis to translate in
  15363. * @param distance the distance to translate
  15364. * @param space Space to rotate in (Default: local)
  15365. * @returns the TransformNode.
  15366. */
  15367. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15368. /**
  15369. * Adds a rotation step to the mesh current rotation.
  15370. * x, y, z are Euler angles expressed in radians.
  15371. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15372. * This means this rotation is made in the mesh local space only.
  15373. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15374. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15375. * ```javascript
  15376. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15377. * ```
  15378. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15379. * 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.
  15380. * @param x Rotation to add
  15381. * @param y Rotation to add
  15382. * @param z Rotation to add
  15383. * @returns the TransformNode.
  15384. */
  15385. addRotation(x: number, y: number, z: number): TransformNode;
  15386. /**
  15387. * @hidden
  15388. */
  15389. protected _getEffectiveParent(): Nullable<Node>;
  15390. /**
  15391. * Computes the world matrix of the node
  15392. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15393. * @returns the world matrix
  15394. */
  15395. computeWorldMatrix(force?: boolean): Matrix;
  15396. /**
  15397. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15398. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15399. */
  15400. resetLocalMatrix(independentOfChildren?: boolean): void;
  15401. protected _afterComputeWorldMatrix(): void;
  15402. /**
  15403. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15404. * @param func callback function to add
  15405. *
  15406. * @returns the TransformNode.
  15407. */
  15408. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15409. /**
  15410. * Removes a registered callback function.
  15411. * @param func callback function to remove
  15412. * @returns the TransformNode.
  15413. */
  15414. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15415. /**
  15416. * Gets the position of the current mesh in camera space
  15417. * @param camera defines the camera to use
  15418. * @returns a position
  15419. */
  15420. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15421. /**
  15422. * Returns the distance from the mesh to the active camera
  15423. * @param camera defines the camera to use
  15424. * @returns the distance
  15425. */
  15426. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15427. /**
  15428. * Clone the current transform node
  15429. * @param name Name of the new clone
  15430. * @param newParent New parent for the clone
  15431. * @param doNotCloneChildren Do not clone children hierarchy
  15432. * @returns the new transform node
  15433. */
  15434. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15435. /**
  15436. * Serializes the objects information.
  15437. * @param currentSerializationObject defines the object to serialize in
  15438. * @returns the serialized object
  15439. */
  15440. serialize(currentSerializationObject?: any): any;
  15441. /**
  15442. * Returns a new TransformNode object parsed from the source provided.
  15443. * @param parsedTransformNode is the source.
  15444. * @param scene the scne the object belongs to
  15445. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15446. * @returns a new TransformNode object parsed from the source provided.
  15447. */
  15448. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15449. /**
  15450. * Get all child-transformNodes of this node
  15451. * @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
  15452. * @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
  15453. * @returns an array of TransformNode
  15454. */
  15455. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15456. /**
  15457. * Releases resources associated with this transform node.
  15458. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15459. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15460. */
  15461. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15462. /**
  15463. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15464. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15465. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15466. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15467. * @returns the current mesh
  15468. */
  15469. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15470. private _syncAbsoluteScalingAndRotation;
  15471. }
  15472. }
  15473. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15474. /**
  15475. * Class used to override all child animations of a given target
  15476. */
  15477. export class AnimationPropertiesOverride {
  15478. /**
  15479. * Gets or sets a value indicating if animation blending must be used
  15480. */
  15481. enableBlending: boolean;
  15482. /**
  15483. * Gets or sets the blending speed to use when enableBlending is true
  15484. */
  15485. blendingSpeed: number;
  15486. /**
  15487. * Gets or sets the default loop mode to use
  15488. */
  15489. loopMode: number;
  15490. }
  15491. }
  15492. declare module "babylonjs/Bones/bone" {
  15493. import { Skeleton } from "babylonjs/Bones/skeleton";
  15494. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15495. import { Nullable } from "babylonjs/types";
  15496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15497. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15498. import { Node } from "babylonjs/node";
  15499. import { Space } from "babylonjs/Maths/math.axis";
  15500. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15501. /**
  15502. * Class used to store bone information
  15503. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15504. */
  15505. export class Bone extends Node {
  15506. /**
  15507. * defines the bone name
  15508. */
  15509. name: string;
  15510. private static _tmpVecs;
  15511. private static _tmpQuat;
  15512. private static _tmpMats;
  15513. /**
  15514. * Gets the list of child bones
  15515. */
  15516. children: Bone[];
  15517. /** Gets the animations associated with this bone */
  15518. animations: import("babylonjs/Animations/animation").Animation[];
  15519. /**
  15520. * Gets or sets bone length
  15521. */
  15522. length: number;
  15523. /**
  15524. * @hidden Internal only
  15525. * Set this value to map this bone to a different index in the transform matrices
  15526. * Set this value to -1 to exclude the bone from the transform matrices
  15527. */
  15528. _index: Nullable<number>;
  15529. private _skeleton;
  15530. private _localMatrix;
  15531. private _restPose;
  15532. private _bindPose;
  15533. private _baseMatrix;
  15534. private _absoluteTransform;
  15535. private _invertedAbsoluteTransform;
  15536. private _parent;
  15537. private _scalingDeterminant;
  15538. private _worldTransform;
  15539. private _localScaling;
  15540. private _localRotation;
  15541. private _localPosition;
  15542. private _needToDecompose;
  15543. private _needToCompose;
  15544. /** @hidden */
  15545. _linkedTransformNode: Nullable<TransformNode>;
  15546. /** @hidden */
  15547. _waitingTransformNodeId: Nullable<string>;
  15548. /** @hidden */
  15549. get _matrix(): Matrix;
  15550. /** @hidden */
  15551. set _matrix(value: Matrix);
  15552. /**
  15553. * Create a new bone
  15554. * @param name defines the bone name
  15555. * @param skeleton defines the parent skeleton
  15556. * @param parentBone defines the parent (can be null if the bone is the root)
  15557. * @param localMatrix defines the local matrix
  15558. * @param restPose defines the rest pose matrix
  15559. * @param baseMatrix defines the base matrix
  15560. * @param index defines index of the bone in the hiearchy
  15561. */
  15562. constructor(
  15563. /**
  15564. * defines the bone name
  15565. */
  15566. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15567. /**
  15568. * Gets the current object class name.
  15569. * @return the class name
  15570. */
  15571. getClassName(): string;
  15572. /**
  15573. * Gets the parent skeleton
  15574. * @returns a skeleton
  15575. */
  15576. getSkeleton(): Skeleton;
  15577. /**
  15578. * Gets parent bone
  15579. * @returns a bone or null if the bone is the root of the bone hierarchy
  15580. */
  15581. getParent(): Nullable<Bone>;
  15582. /**
  15583. * Returns an array containing the root bones
  15584. * @returns an array containing the root bones
  15585. */
  15586. getChildren(): Array<Bone>;
  15587. /**
  15588. * Gets the node index in matrix array generated for rendering
  15589. * @returns the node index
  15590. */
  15591. getIndex(): number;
  15592. /**
  15593. * Sets the parent bone
  15594. * @param parent defines the parent (can be null if the bone is the root)
  15595. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15596. */
  15597. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15598. /**
  15599. * Gets the local matrix
  15600. * @returns a matrix
  15601. */
  15602. getLocalMatrix(): Matrix;
  15603. /**
  15604. * Gets the base matrix (initial matrix which remains unchanged)
  15605. * @returns a matrix
  15606. */
  15607. getBaseMatrix(): Matrix;
  15608. /**
  15609. * Gets the rest pose matrix
  15610. * @returns a matrix
  15611. */
  15612. getRestPose(): Matrix;
  15613. /**
  15614. * Sets the rest pose matrix
  15615. * @param matrix the local-space rest pose to set for this bone
  15616. */
  15617. setRestPose(matrix: Matrix): void;
  15618. /**
  15619. * Gets the bind pose matrix
  15620. * @returns the bind pose matrix
  15621. */
  15622. getBindPose(): Matrix;
  15623. /**
  15624. * Sets the bind pose matrix
  15625. * @param matrix the local-space bind pose to set for this bone
  15626. */
  15627. setBindPose(matrix: Matrix): void;
  15628. /**
  15629. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15630. */
  15631. getWorldMatrix(): Matrix;
  15632. /**
  15633. * Sets the local matrix to rest pose matrix
  15634. */
  15635. returnToRest(): void;
  15636. /**
  15637. * Gets the inverse of the absolute transform matrix.
  15638. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15639. * @returns a matrix
  15640. */
  15641. getInvertedAbsoluteTransform(): Matrix;
  15642. /**
  15643. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15644. * @returns a matrix
  15645. */
  15646. getAbsoluteTransform(): Matrix;
  15647. /**
  15648. * Links with the given transform node.
  15649. * The local matrix of this bone is copied from the transform node every frame.
  15650. * @param transformNode defines the transform node to link to
  15651. */
  15652. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15653. /**
  15654. * Gets the node used to drive the bone's transformation
  15655. * @returns a transform node or null
  15656. */
  15657. getTransformNode(): Nullable<TransformNode>;
  15658. /** Gets or sets current position (in local space) */
  15659. get position(): Vector3;
  15660. set position(newPosition: Vector3);
  15661. /** Gets or sets current rotation (in local space) */
  15662. get rotation(): Vector3;
  15663. set rotation(newRotation: Vector3);
  15664. /** Gets or sets current rotation quaternion (in local space) */
  15665. get rotationQuaternion(): Quaternion;
  15666. set rotationQuaternion(newRotation: Quaternion);
  15667. /** Gets or sets current scaling (in local space) */
  15668. get scaling(): Vector3;
  15669. set scaling(newScaling: Vector3);
  15670. /**
  15671. * Gets the animation properties override
  15672. */
  15673. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15674. private _decompose;
  15675. private _compose;
  15676. /**
  15677. * Update the base and local matrices
  15678. * @param matrix defines the new base or local matrix
  15679. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15680. * @param updateLocalMatrix defines if the local matrix should be updated
  15681. */
  15682. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15683. /** @hidden */
  15684. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15685. /**
  15686. * Flag the bone as dirty (Forcing it to update everything)
  15687. */
  15688. markAsDirty(): void;
  15689. /** @hidden */
  15690. _markAsDirtyAndCompose(): void;
  15691. private _markAsDirtyAndDecompose;
  15692. /**
  15693. * Translate the bone in local or world space
  15694. * @param vec The amount to translate the bone
  15695. * @param space The space that the translation is in
  15696. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15697. */
  15698. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15699. /**
  15700. * Set the postion of the bone in local or world space
  15701. * @param position The position to set the bone
  15702. * @param space The space that the position is in
  15703. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15704. */
  15705. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15706. /**
  15707. * Set the absolute position of the bone (world space)
  15708. * @param position The position to set the bone
  15709. * @param mesh The mesh that this bone is attached to
  15710. */
  15711. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15712. /**
  15713. * Scale the bone on the x, y and z axes (in local space)
  15714. * @param x The amount to scale the bone on the x axis
  15715. * @param y The amount to scale the bone on the y axis
  15716. * @param z The amount to scale the bone on the z axis
  15717. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15718. */
  15719. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15720. /**
  15721. * Set the bone scaling in local space
  15722. * @param scale defines the scaling vector
  15723. */
  15724. setScale(scale: Vector3): void;
  15725. /**
  15726. * Gets the current scaling in local space
  15727. * @returns the current scaling vector
  15728. */
  15729. getScale(): Vector3;
  15730. /**
  15731. * Gets the current scaling in local space and stores it in a target vector
  15732. * @param result defines the target vector
  15733. */
  15734. getScaleToRef(result: Vector3): void;
  15735. /**
  15736. * Set the yaw, pitch, and roll of the bone in local or world space
  15737. * @param yaw The rotation of the bone on the y axis
  15738. * @param pitch The rotation of the bone on the x axis
  15739. * @param roll The rotation of the bone on the z axis
  15740. * @param space The space that the axes of rotation are in
  15741. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15742. */
  15743. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15744. /**
  15745. * Add a rotation to the bone on an axis in local or world space
  15746. * @param axis The axis to rotate the bone on
  15747. * @param amount The amount to rotate the bone
  15748. * @param space The space that the axis is in
  15749. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15750. */
  15751. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15752. /**
  15753. * Set the rotation of the bone to a particular axis angle in local or world space
  15754. * @param axis The axis to rotate the bone on
  15755. * @param angle The angle that the bone should be rotated to
  15756. * @param space The space that the axis is in
  15757. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15758. */
  15759. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15760. /**
  15761. * Set the euler rotation of the bone in local of world space
  15762. * @param rotation The euler rotation that the bone should be set to
  15763. * @param space The space that the rotation is in
  15764. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15765. */
  15766. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15767. /**
  15768. * Set the quaternion rotation of the bone in local of world space
  15769. * @param quat The quaternion rotation that the bone should be set to
  15770. * @param space The space that the rotation is in
  15771. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15772. */
  15773. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15774. /**
  15775. * Set the rotation matrix of the bone in local of world space
  15776. * @param rotMat The rotation matrix that the bone should be set to
  15777. * @param space The space that the rotation is in
  15778. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15779. */
  15780. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15781. private _rotateWithMatrix;
  15782. private _getNegativeRotationToRef;
  15783. /**
  15784. * Get the position of the bone in local or world space
  15785. * @param space The space that the returned position is in
  15786. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15787. * @returns The position of the bone
  15788. */
  15789. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15790. /**
  15791. * Copy the position of the bone to a vector3 in local or world space
  15792. * @param space The space that the returned position is in
  15793. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15794. * @param result The vector3 to copy the position to
  15795. */
  15796. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15797. /**
  15798. * Get the absolute position of the bone (world space)
  15799. * @param mesh The mesh that this bone is attached to
  15800. * @returns The absolute position of the bone
  15801. */
  15802. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15803. /**
  15804. * Copy the absolute position of the bone (world space) to the result param
  15805. * @param mesh The mesh that this bone is attached to
  15806. * @param result The vector3 to copy the absolute position to
  15807. */
  15808. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15809. /**
  15810. * Compute the absolute transforms of this bone and its children
  15811. */
  15812. computeAbsoluteTransforms(): void;
  15813. /**
  15814. * Get the world direction from an axis that is in the local space of the bone
  15815. * @param localAxis The local direction that is used to compute the world direction
  15816. * @param mesh The mesh that this bone is attached to
  15817. * @returns The world direction
  15818. */
  15819. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15820. /**
  15821. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15822. * @param localAxis The local direction that is used to compute the world direction
  15823. * @param mesh The mesh that this bone is attached to
  15824. * @param result The vector3 that the world direction will be copied to
  15825. */
  15826. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15827. /**
  15828. * Get the euler rotation of the bone in local or world space
  15829. * @param space The space that the rotation should be in
  15830. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15831. * @returns The euler rotation
  15832. */
  15833. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15834. /**
  15835. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15836. * @param space The space that the rotation should be in
  15837. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15838. * @param result The vector3 that the rotation should be copied to
  15839. */
  15840. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15841. /**
  15842. * Get the quaternion rotation of the bone in either local or world space
  15843. * @param space The space that the rotation should be in
  15844. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15845. * @returns The quaternion rotation
  15846. */
  15847. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15848. /**
  15849. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15850. * @param space The space that the rotation should be in
  15851. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15852. * @param result The quaternion that the rotation should be copied to
  15853. */
  15854. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15855. /**
  15856. * Get the rotation matrix of the bone in local or world space
  15857. * @param space The space that the rotation should be in
  15858. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15859. * @returns The rotation matrix
  15860. */
  15861. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15862. /**
  15863. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15864. * @param space The space that the rotation should be in
  15865. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15866. * @param result The quaternion that the rotation should be copied to
  15867. */
  15868. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15869. /**
  15870. * Get the world position of a point that is in the local space of the bone
  15871. * @param position The local position
  15872. * @param mesh The mesh that this bone is attached to
  15873. * @returns The world position
  15874. */
  15875. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15876. /**
  15877. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15878. * @param position The local position
  15879. * @param mesh The mesh that this bone is attached to
  15880. * @param result The vector3 that the world position should be copied to
  15881. */
  15882. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15883. /**
  15884. * Get the local position of a point that is in world space
  15885. * @param position The world position
  15886. * @param mesh The mesh that this bone is attached to
  15887. * @returns The local position
  15888. */
  15889. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15890. /**
  15891. * Get the local position of a point that is in world space and copy it to the result param
  15892. * @param position The world position
  15893. * @param mesh The mesh that this bone is attached to
  15894. * @param result The vector3 that the local position should be copied to
  15895. */
  15896. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15897. }
  15898. }
  15899. declare module "babylonjs/Animations/runtimeAnimation" {
  15900. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15901. import { Animatable } from "babylonjs/Animations/animatable";
  15902. import { Scene } from "babylonjs/scene";
  15903. /**
  15904. * Defines a runtime animation
  15905. */
  15906. export class RuntimeAnimation {
  15907. private _events;
  15908. /**
  15909. * The current frame of the runtime animation
  15910. */
  15911. private _currentFrame;
  15912. /**
  15913. * The animation used by the runtime animation
  15914. */
  15915. private _animation;
  15916. /**
  15917. * The target of the runtime animation
  15918. */
  15919. private _target;
  15920. /**
  15921. * The initiating animatable
  15922. */
  15923. private _host;
  15924. /**
  15925. * The original value of the runtime animation
  15926. */
  15927. private _originalValue;
  15928. /**
  15929. * The original blend value of the runtime animation
  15930. */
  15931. private _originalBlendValue;
  15932. /**
  15933. * The offsets cache of the runtime animation
  15934. */
  15935. private _offsetsCache;
  15936. /**
  15937. * The high limits cache of the runtime animation
  15938. */
  15939. private _highLimitsCache;
  15940. /**
  15941. * Specifies if the runtime animation has been stopped
  15942. */
  15943. private _stopped;
  15944. /**
  15945. * The blending factor of the runtime animation
  15946. */
  15947. private _blendingFactor;
  15948. /**
  15949. * The BabylonJS scene
  15950. */
  15951. private _scene;
  15952. /**
  15953. * The current value of the runtime animation
  15954. */
  15955. private _currentValue;
  15956. /** @hidden */
  15957. _animationState: _IAnimationState;
  15958. /**
  15959. * The active target of the runtime animation
  15960. */
  15961. private _activeTargets;
  15962. private _currentActiveTarget;
  15963. private _directTarget;
  15964. /**
  15965. * The target path of the runtime animation
  15966. */
  15967. private _targetPath;
  15968. /**
  15969. * The weight of the runtime animation
  15970. */
  15971. private _weight;
  15972. /**
  15973. * The ratio offset of the runtime animation
  15974. */
  15975. private _ratioOffset;
  15976. /**
  15977. * The previous delay of the runtime animation
  15978. */
  15979. private _previousDelay;
  15980. /**
  15981. * The previous ratio of the runtime animation
  15982. */
  15983. private _previousRatio;
  15984. private _enableBlending;
  15985. private _keys;
  15986. private _minFrame;
  15987. private _maxFrame;
  15988. private _minValue;
  15989. private _maxValue;
  15990. private _targetIsArray;
  15991. /**
  15992. * Gets the current frame of the runtime animation
  15993. */
  15994. get currentFrame(): number;
  15995. /**
  15996. * Gets the weight of the runtime animation
  15997. */
  15998. get weight(): number;
  15999. /**
  16000. * Gets the current value of the runtime animation
  16001. */
  16002. get currentValue(): any;
  16003. /**
  16004. * Gets the target path of the runtime animation
  16005. */
  16006. get targetPath(): string;
  16007. /**
  16008. * Gets the actual target of the runtime animation
  16009. */
  16010. get target(): any;
  16011. /**
  16012. * Gets the additive state of the runtime animation
  16013. */
  16014. get isAdditive(): boolean;
  16015. /** @hidden */
  16016. _onLoop: () => void;
  16017. /**
  16018. * Create a new RuntimeAnimation object
  16019. * @param target defines the target of the animation
  16020. * @param animation defines the source animation object
  16021. * @param scene defines the hosting scene
  16022. * @param host defines the initiating Animatable
  16023. */
  16024. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16025. private _preparePath;
  16026. /**
  16027. * Gets the animation from the runtime animation
  16028. */
  16029. get animation(): Animation;
  16030. /**
  16031. * Resets the runtime animation to the beginning
  16032. * @param restoreOriginal defines whether to restore the target property to the original value
  16033. */
  16034. reset(restoreOriginal?: boolean): void;
  16035. /**
  16036. * Specifies if the runtime animation is stopped
  16037. * @returns Boolean specifying if the runtime animation is stopped
  16038. */
  16039. isStopped(): boolean;
  16040. /**
  16041. * Disposes of the runtime animation
  16042. */
  16043. dispose(): void;
  16044. /**
  16045. * Apply the interpolated value to the target
  16046. * @param currentValue defines the value computed by the animation
  16047. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16048. */
  16049. setValue(currentValue: any, weight: number): void;
  16050. private _getOriginalValues;
  16051. private _setValue;
  16052. /**
  16053. * Gets the loop pmode of the runtime animation
  16054. * @returns Loop Mode
  16055. */
  16056. private _getCorrectLoopMode;
  16057. /**
  16058. * Move the current animation to a given frame
  16059. * @param frame defines the frame to move to
  16060. */
  16061. goToFrame(frame: number): void;
  16062. /**
  16063. * @hidden Internal use only
  16064. */
  16065. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16066. /**
  16067. * Execute the current animation
  16068. * @param delay defines the delay to add to the current frame
  16069. * @param from defines the lower bound of the animation range
  16070. * @param to defines the upper bound of the animation range
  16071. * @param loop defines if the current animation must loop
  16072. * @param speedRatio defines the current speed ratio
  16073. * @param weight defines the weight of the animation (default is -1 so no weight)
  16074. * @param onLoop optional callback called when animation loops
  16075. * @returns a boolean indicating if the animation is running
  16076. */
  16077. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16078. }
  16079. }
  16080. declare module "babylonjs/Animations/animatable" {
  16081. import { Animation } from "babylonjs/Animations/animation";
  16082. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16083. import { Nullable } from "babylonjs/types";
  16084. import { Observable } from "babylonjs/Misc/observable";
  16085. import { Scene } from "babylonjs/scene";
  16086. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16087. import { Node } from "babylonjs/node";
  16088. /**
  16089. * Class used to store an actual running animation
  16090. */
  16091. export class Animatable {
  16092. /** defines the target object */
  16093. target: any;
  16094. /** defines the starting frame number (default is 0) */
  16095. fromFrame: number;
  16096. /** defines the ending frame number (default is 100) */
  16097. toFrame: number;
  16098. /** defines if the animation must loop (default is false) */
  16099. loopAnimation: boolean;
  16100. /** defines a callback to call when animation ends if it is not looping */
  16101. onAnimationEnd?: (() => void) | null | undefined;
  16102. /** defines a callback to call when animation loops */
  16103. onAnimationLoop?: (() => void) | null | undefined;
  16104. /** defines whether the animation should be evaluated additively */
  16105. isAdditive: boolean;
  16106. private _localDelayOffset;
  16107. private _pausedDelay;
  16108. private _runtimeAnimations;
  16109. private _paused;
  16110. private _scene;
  16111. private _speedRatio;
  16112. private _weight;
  16113. private _syncRoot;
  16114. /**
  16115. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16116. * This will only apply for non looping animation (default is true)
  16117. */
  16118. disposeOnEnd: boolean;
  16119. /**
  16120. * Gets a boolean indicating if the animation has started
  16121. */
  16122. animationStarted: boolean;
  16123. /**
  16124. * Observer raised when the animation ends
  16125. */
  16126. onAnimationEndObservable: Observable<Animatable>;
  16127. /**
  16128. * Observer raised when the animation loops
  16129. */
  16130. onAnimationLoopObservable: Observable<Animatable>;
  16131. /**
  16132. * Gets the root Animatable used to synchronize and normalize animations
  16133. */
  16134. get syncRoot(): Nullable<Animatable>;
  16135. /**
  16136. * Gets the current frame of the first RuntimeAnimation
  16137. * Used to synchronize Animatables
  16138. */
  16139. get masterFrame(): number;
  16140. /**
  16141. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16142. */
  16143. get weight(): number;
  16144. set weight(value: number);
  16145. /**
  16146. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16147. */
  16148. get speedRatio(): number;
  16149. set speedRatio(value: number);
  16150. /**
  16151. * Creates a new Animatable
  16152. * @param scene defines the hosting scene
  16153. * @param target defines the target object
  16154. * @param fromFrame defines the starting frame number (default is 0)
  16155. * @param toFrame defines the ending frame number (default is 100)
  16156. * @param loopAnimation defines if the animation must loop (default is false)
  16157. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16158. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16159. * @param animations defines a group of animation to add to the new Animatable
  16160. * @param onAnimationLoop defines a callback to call when animation loops
  16161. * @param isAdditive defines whether the animation should be evaluated additively
  16162. */
  16163. constructor(scene: Scene,
  16164. /** defines the target object */
  16165. target: any,
  16166. /** defines the starting frame number (default is 0) */
  16167. fromFrame?: number,
  16168. /** defines the ending frame number (default is 100) */
  16169. toFrame?: number,
  16170. /** defines if the animation must loop (default is false) */
  16171. loopAnimation?: boolean, speedRatio?: number,
  16172. /** defines a callback to call when animation ends if it is not looping */
  16173. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16174. /** defines a callback to call when animation loops */
  16175. onAnimationLoop?: (() => void) | null | undefined,
  16176. /** defines whether the animation should be evaluated additively */
  16177. isAdditive?: boolean);
  16178. /**
  16179. * Synchronize and normalize current Animatable with a source Animatable
  16180. * This is useful when using animation weights and when animations are not of the same length
  16181. * @param root defines the root Animatable to synchronize with
  16182. * @returns the current Animatable
  16183. */
  16184. syncWith(root: Animatable): Animatable;
  16185. /**
  16186. * Gets the list of runtime animations
  16187. * @returns an array of RuntimeAnimation
  16188. */
  16189. getAnimations(): RuntimeAnimation[];
  16190. /**
  16191. * Adds more animations to the current animatable
  16192. * @param target defines the target of the animations
  16193. * @param animations defines the new animations to add
  16194. */
  16195. appendAnimations(target: any, animations: Animation[]): void;
  16196. /**
  16197. * Gets the source animation for a specific property
  16198. * @param property defines the propertyu to look for
  16199. * @returns null or the source animation for the given property
  16200. */
  16201. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16202. /**
  16203. * Gets the runtime animation for a specific property
  16204. * @param property defines the propertyu to look for
  16205. * @returns null or the runtime animation for the given property
  16206. */
  16207. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16208. /**
  16209. * Resets the animatable to its original state
  16210. */
  16211. reset(): void;
  16212. /**
  16213. * Allows the animatable to blend with current running animations
  16214. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16215. * @param blendingSpeed defines the blending speed to use
  16216. */
  16217. enableBlending(blendingSpeed: number): void;
  16218. /**
  16219. * Disable animation blending
  16220. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16221. */
  16222. disableBlending(): void;
  16223. /**
  16224. * Jump directly to a given frame
  16225. * @param frame defines the frame to jump to
  16226. */
  16227. goToFrame(frame: number): void;
  16228. /**
  16229. * Pause the animation
  16230. */
  16231. pause(): void;
  16232. /**
  16233. * Restart the animation
  16234. */
  16235. restart(): void;
  16236. private _raiseOnAnimationEnd;
  16237. /**
  16238. * Stop and delete the current animation
  16239. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16240. * @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)
  16241. */
  16242. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16243. /**
  16244. * Wait asynchronously for the animation to end
  16245. * @returns a promise which will be fullfilled when the animation ends
  16246. */
  16247. waitAsync(): Promise<Animatable>;
  16248. /** @hidden */
  16249. _animate(delay: number): boolean;
  16250. }
  16251. module "babylonjs/scene" {
  16252. interface Scene {
  16253. /** @hidden */
  16254. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16255. /** @hidden */
  16256. _processLateAnimationBindingsForMatrices(holder: {
  16257. totalWeight: number;
  16258. totalAdditiveWeight: number;
  16259. animations: RuntimeAnimation[];
  16260. additiveAnimations: RuntimeAnimation[];
  16261. originalValue: Matrix;
  16262. }): any;
  16263. /** @hidden */
  16264. _processLateAnimationBindingsForQuaternions(holder: {
  16265. totalWeight: number;
  16266. totalAdditiveWeight: number;
  16267. animations: RuntimeAnimation[];
  16268. additiveAnimations: RuntimeAnimation[];
  16269. originalValue: Quaternion;
  16270. }, refQuaternion: Quaternion): Quaternion;
  16271. /** @hidden */
  16272. _processLateAnimationBindings(): void;
  16273. /**
  16274. * Will start the animation sequence of a given target
  16275. * @param target defines the target
  16276. * @param from defines from which frame should animation start
  16277. * @param to defines until which frame should animation run.
  16278. * @param weight defines the weight to apply to the animation (1.0 by default)
  16279. * @param loop defines if the animation loops
  16280. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16281. * @param onAnimationEnd defines the function to be executed when the animation ends
  16282. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16283. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16284. * @param onAnimationLoop defines the callback to call when an animation loops
  16285. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16286. * @returns the animatable object created for this animation
  16287. */
  16288. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16289. /**
  16290. * Will start the animation sequence of a given target
  16291. * @param target defines the target
  16292. * @param from defines from which frame should animation start
  16293. * @param to defines until which frame should animation run.
  16294. * @param loop defines if the animation loops
  16295. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16296. * @param onAnimationEnd defines the function to be executed when the animation ends
  16297. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16298. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16299. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16300. * @param onAnimationLoop defines the callback to call when an animation loops
  16301. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16302. * @returns the animatable object created for this animation
  16303. */
  16304. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16305. /**
  16306. * Will start the animation sequence of a given target and its hierarchy
  16307. * @param target defines the target
  16308. * @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.
  16309. * @param from defines from which frame should animation start
  16310. * @param to defines until which frame should animation run.
  16311. * @param loop defines if the animation loops
  16312. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16313. * @param onAnimationEnd defines the function to be executed when the animation ends
  16314. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16315. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16316. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16317. * @param onAnimationLoop defines the callback to call when an animation loops
  16318. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16319. * @returns the list of created animatables
  16320. */
  16321. 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, isAdditive?: boolean): Animatable[];
  16322. /**
  16323. * Begin a new animation on a given node
  16324. * @param target defines the target where the animation will take place
  16325. * @param animations defines the list of animations to start
  16326. * @param from defines the initial value
  16327. * @param to defines the final value
  16328. * @param loop defines if you want animation to loop (off by default)
  16329. * @param speedRatio defines the speed ratio to apply to all animations
  16330. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16331. * @param onAnimationLoop defines the callback to call when an animation loops
  16332. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16333. * @returns the list of created animatables
  16334. */
  16335. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16336. /**
  16337. * Begin a new animation on a given node and its hierarchy
  16338. * @param target defines the root node where the animation will take place
  16339. * @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.
  16340. * @param animations defines the list of animations to start
  16341. * @param from defines the initial value
  16342. * @param to defines the final value
  16343. * @param loop defines if you want animation to loop (off by default)
  16344. * @param speedRatio defines the speed ratio to apply to all animations
  16345. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16346. * @param onAnimationLoop defines the callback to call when an animation loops
  16347. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16348. * @returns the list of animatables created for all nodes
  16349. */
  16350. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16351. /**
  16352. * Gets the animatable associated with a specific target
  16353. * @param target defines the target of the animatable
  16354. * @returns the required animatable if found
  16355. */
  16356. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16357. /**
  16358. * Gets all animatables associated with a given target
  16359. * @param target defines the target to look animatables for
  16360. * @returns an array of Animatables
  16361. */
  16362. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16363. /**
  16364. * Stops and removes all animations that have been applied to the scene
  16365. */
  16366. stopAllAnimations(): void;
  16367. /**
  16368. * Gets the current delta time used by animation engine
  16369. */
  16370. deltaTime: number;
  16371. }
  16372. }
  16373. module "babylonjs/Bones/bone" {
  16374. interface Bone {
  16375. /**
  16376. * Copy an animation range from another bone
  16377. * @param source defines the source bone
  16378. * @param rangeName defines the range name to copy
  16379. * @param frameOffset defines the frame offset
  16380. * @param rescaleAsRequired defines if rescaling must be applied if required
  16381. * @param skelDimensionsRatio defines the scaling ratio
  16382. * @returns true if operation was successful
  16383. */
  16384. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16385. }
  16386. }
  16387. }
  16388. declare module "babylonjs/Bones/skeleton" {
  16389. import { Bone } from "babylonjs/Bones/bone";
  16390. import { Observable } from "babylonjs/Misc/observable";
  16391. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16392. import { Scene } from "babylonjs/scene";
  16393. import { Nullable } from "babylonjs/types";
  16394. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16395. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16396. import { Animatable } from "babylonjs/Animations/animatable";
  16397. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16398. import { Animation } from "babylonjs/Animations/animation";
  16399. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16400. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16401. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16402. /**
  16403. * Class used to handle skinning animations
  16404. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16405. */
  16406. export class Skeleton implements IAnimatable {
  16407. /** defines the skeleton name */
  16408. name: string;
  16409. /** defines the skeleton Id */
  16410. id: string;
  16411. /**
  16412. * Defines the list of child bones
  16413. */
  16414. bones: Bone[];
  16415. /**
  16416. * Defines an estimate of the dimension of the skeleton at rest
  16417. */
  16418. dimensionsAtRest: Vector3;
  16419. /**
  16420. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16421. */
  16422. needInitialSkinMatrix: boolean;
  16423. /**
  16424. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16425. */
  16426. overrideMesh: Nullable<AbstractMesh>;
  16427. /**
  16428. * Gets the list of animations attached to this skeleton
  16429. */
  16430. animations: Array<Animation>;
  16431. private _scene;
  16432. private _isDirty;
  16433. private _transformMatrices;
  16434. private _transformMatrixTexture;
  16435. private _meshesWithPoseMatrix;
  16436. private _animatables;
  16437. private _identity;
  16438. private _synchronizedWithMesh;
  16439. private _ranges;
  16440. private _lastAbsoluteTransformsUpdateId;
  16441. private _canUseTextureForBones;
  16442. private _uniqueId;
  16443. /** @hidden */
  16444. _numBonesWithLinkedTransformNode: number;
  16445. /** @hidden */
  16446. _hasWaitingData: Nullable<boolean>;
  16447. /** @hidden */
  16448. _waitingOverrideMeshId: Nullable<string>;
  16449. /**
  16450. * Specifies if the skeleton should be serialized
  16451. */
  16452. doNotSerialize: boolean;
  16453. private _useTextureToStoreBoneMatrices;
  16454. /**
  16455. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16456. * Please note that this option is not available if the hardware does not support it
  16457. */
  16458. get useTextureToStoreBoneMatrices(): boolean;
  16459. set useTextureToStoreBoneMatrices(value: boolean);
  16460. private _animationPropertiesOverride;
  16461. /**
  16462. * Gets or sets the animation properties override
  16463. */
  16464. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16465. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16466. /**
  16467. * List of inspectable custom properties (used by the Inspector)
  16468. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16469. */
  16470. inspectableCustomProperties: IInspectable[];
  16471. /**
  16472. * An observable triggered before computing the skeleton's matrices
  16473. */
  16474. onBeforeComputeObservable: Observable<Skeleton>;
  16475. /**
  16476. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16477. */
  16478. get isUsingTextureForMatrices(): boolean;
  16479. /**
  16480. * Gets the unique ID of this skeleton
  16481. */
  16482. get uniqueId(): number;
  16483. /**
  16484. * Creates a new skeleton
  16485. * @param name defines the skeleton name
  16486. * @param id defines the skeleton Id
  16487. * @param scene defines the hosting scene
  16488. */
  16489. constructor(
  16490. /** defines the skeleton name */
  16491. name: string,
  16492. /** defines the skeleton Id */
  16493. id: string, scene: Scene);
  16494. /**
  16495. * Gets the current object class name.
  16496. * @return the class name
  16497. */
  16498. getClassName(): string;
  16499. /**
  16500. * Returns an array containing the root bones
  16501. * @returns an array containing the root bones
  16502. */
  16503. getChildren(): Array<Bone>;
  16504. /**
  16505. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16506. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16507. * @returns a Float32Array containing matrices data
  16508. */
  16509. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16510. /**
  16511. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16512. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16513. * @returns a raw texture containing the data
  16514. */
  16515. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16516. /**
  16517. * Gets the current hosting scene
  16518. * @returns a scene object
  16519. */
  16520. getScene(): Scene;
  16521. /**
  16522. * Gets a string representing the current skeleton data
  16523. * @param fullDetails defines a boolean indicating if we want a verbose version
  16524. * @returns a string representing the current skeleton data
  16525. */
  16526. toString(fullDetails?: boolean): string;
  16527. /**
  16528. * Get bone's index searching by name
  16529. * @param name defines bone's name to search for
  16530. * @return the indice of the bone. Returns -1 if not found
  16531. */
  16532. getBoneIndexByName(name: string): number;
  16533. /**
  16534. * Creater a new animation range
  16535. * @param name defines the name of the range
  16536. * @param from defines the start key
  16537. * @param to defines the end key
  16538. */
  16539. createAnimationRange(name: string, from: number, to: number): void;
  16540. /**
  16541. * Delete a specific animation range
  16542. * @param name defines the name of the range
  16543. * @param deleteFrames defines if frames must be removed as well
  16544. */
  16545. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16546. /**
  16547. * Gets a specific animation range
  16548. * @param name defines the name of the range to look for
  16549. * @returns the requested animation range or null if not found
  16550. */
  16551. getAnimationRange(name: string): Nullable<AnimationRange>;
  16552. /**
  16553. * Gets the list of all animation ranges defined on this skeleton
  16554. * @returns an array
  16555. */
  16556. getAnimationRanges(): Nullable<AnimationRange>[];
  16557. /**
  16558. * Copy animation range from a source skeleton.
  16559. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16560. * @param source defines the source skeleton
  16561. * @param name defines the name of the range to copy
  16562. * @param rescaleAsRequired defines if rescaling must be applied if required
  16563. * @returns true if operation was successful
  16564. */
  16565. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16566. /**
  16567. * Forces the skeleton to go to rest pose
  16568. */
  16569. returnToRest(): void;
  16570. private _getHighestAnimationFrame;
  16571. /**
  16572. * Begin a specific animation range
  16573. * @param name defines the name of the range to start
  16574. * @param loop defines if looping must be turned on (false by default)
  16575. * @param speedRatio defines the speed ratio to apply (1 by default)
  16576. * @param onAnimationEnd defines a callback which will be called when animation will end
  16577. * @returns a new animatable
  16578. */
  16579. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16580. /**
  16581. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16582. * @param skeleton defines the Skeleton containing the animation range to convert
  16583. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16584. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16585. * @returns the original skeleton
  16586. */
  16587. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16588. /** @hidden */
  16589. _markAsDirty(): void;
  16590. /** @hidden */
  16591. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16592. /** @hidden */
  16593. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16594. private _computeTransformMatrices;
  16595. /**
  16596. * Build all resources required to render a skeleton
  16597. */
  16598. prepare(): void;
  16599. /**
  16600. * Gets the list of animatables currently running for this skeleton
  16601. * @returns an array of animatables
  16602. */
  16603. getAnimatables(): IAnimatable[];
  16604. /**
  16605. * Clone the current skeleton
  16606. * @param name defines the name of the new skeleton
  16607. * @param id defines the id of the new skeleton
  16608. * @returns the new skeleton
  16609. */
  16610. clone(name: string, id?: string): Skeleton;
  16611. /**
  16612. * Enable animation blending for this skeleton
  16613. * @param blendingSpeed defines the blending speed to apply
  16614. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16615. */
  16616. enableBlending(blendingSpeed?: number): void;
  16617. /**
  16618. * Releases all resources associated with the current skeleton
  16619. */
  16620. dispose(): void;
  16621. /**
  16622. * Serialize the skeleton in a JSON object
  16623. * @returns a JSON object
  16624. */
  16625. serialize(): any;
  16626. /**
  16627. * Creates a new skeleton from serialized data
  16628. * @param parsedSkeleton defines the serialized data
  16629. * @param scene defines the hosting scene
  16630. * @returns a new skeleton
  16631. */
  16632. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16633. /**
  16634. * Compute all node absolute transforms
  16635. * @param forceUpdate defines if computation must be done even if cache is up to date
  16636. */
  16637. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16638. /**
  16639. * Gets the root pose matrix
  16640. * @returns a matrix
  16641. */
  16642. getPoseMatrix(): Nullable<Matrix>;
  16643. /**
  16644. * Sorts bones per internal index
  16645. */
  16646. sortBones(): void;
  16647. private _sortBones;
  16648. }
  16649. }
  16650. declare module "babylonjs/Meshes/instancedMesh" {
  16651. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16652. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16653. import { Camera } from "babylonjs/Cameras/camera";
  16654. import { Node } from "babylonjs/node";
  16655. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16656. import { Mesh } from "babylonjs/Meshes/mesh";
  16657. import { Material } from "babylonjs/Materials/material";
  16658. import { Skeleton } from "babylonjs/Bones/skeleton";
  16659. import { Light } from "babylonjs/Lights/light";
  16660. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16661. /**
  16662. * Creates an instance based on a source mesh.
  16663. */
  16664. export class InstancedMesh extends AbstractMesh {
  16665. private _sourceMesh;
  16666. private _currentLOD;
  16667. /** @hidden */
  16668. _indexInSourceMeshInstanceArray: number;
  16669. constructor(name: string, source: Mesh);
  16670. /**
  16671. * Returns the string "InstancedMesh".
  16672. */
  16673. getClassName(): string;
  16674. /** Gets the list of lights affecting that mesh */
  16675. get lightSources(): Light[];
  16676. _resyncLightSources(): void;
  16677. _resyncLightSource(light: Light): void;
  16678. _removeLightSource(light: Light, dispose: boolean): void;
  16679. /**
  16680. * If the source mesh receives shadows
  16681. */
  16682. get receiveShadows(): boolean;
  16683. /**
  16684. * The material of the source mesh
  16685. */
  16686. get material(): Nullable<Material>;
  16687. /**
  16688. * Visibility of the source mesh
  16689. */
  16690. get visibility(): number;
  16691. /**
  16692. * Skeleton of the source mesh
  16693. */
  16694. get skeleton(): Nullable<Skeleton>;
  16695. /**
  16696. * Rendering ground id of the source mesh
  16697. */
  16698. get renderingGroupId(): number;
  16699. set renderingGroupId(value: number);
  16700. /**
  16701. * Returns the total number of vertices (integer).
  16702. */
  16703. getTotalVertices(): number;
  16704. /**
  16705. * Returns a positive integer : the total number of indices in this mesh geometry.
  16706. * @returns the numner of indices or zero if the mesh has no geometry.
  16707. */
  16708. getTotalIndices(): number;
  16709. /**
  16710. * The source mesh of the instance
  16711. */
  16712. get sourceMesh(): Mesh;
  16713. /**
  16714. * Creates a new InstancedMesh object from the mesh model.
  16715. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16716. * @param name defines the name of the new instance
  16717. * @returns a new InstancedMesh
  16718. */
  16719. createInstance(name: string): InstancedMesh;
  16720. /**
  16721. * Is this node ready to be used/rendered
  16722. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16723. * @return {boolean} is it ready
  16724. */
  16725. isReady(completeCheck?: boolean): boolean;
  16726. /**
  16727. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16728. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16729. * @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.
  16730. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16731. */
  16732. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16733. /**
  16734. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16735. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16736. * The `data` are either a numeric array either a Float32Array.
  16737. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16738. * 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).
  16739. * Note that a new underlying VertexBuffer object is created each call.
  16740. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16741. *
  16742. * Possible `kind` values :
  16743. * - VertexBuffer.PositionKind
  16744. * - VertexBuffer.UVKind
  16745. * - VertexBuffer.UV2Kind
  16746. * - VertexBuffer.UV3Kind
  16747. * - VertexBuffer.UV4Kind
  16748. * - VertexBuffer.UV5Kind
  16749. * - VertexBuffer.UV6Kind
  16750. * - VertexBuffer.ColorKind
  16751. * - VertexBuffer.MatricesIndicesKind
  16752. * - VertexBuffer.MatricesIndicesExtraKind
  16753. * - VertexBuffer.MatricesWeightsKind
  16754. * - VertexBuffer.MatricesWeightsExtraKind
  16755. *
  16756. * Returns the Mesh.
  16757. */
  16758. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16759. /**
  16760. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16761. * If the mesh has no geometry, it is simply returned as it is.
  16762. * The `data` are either a numeric array either a Float32Array.
  16763. * No new underlying VertexBuffer object is created.
  16764. * 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.
  16765. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16766. *
  16767. * Possible `kind` values :
  16768. * - VertexBuffer.PositionKind
  16769. * - VertexBuffer.UVKind
  16770. * - VertexBuffer.UV2Kind
  16771. * - VertexBuffer.UV3Kind
  16772. * - VertexBuffer.UV4Kind
  16773. * - VertexBuffer.UV5Kind
  16774. * - VertexBuffer.UV6Kind
  16775. * - VertexBuffer.ColorKind
  16776. * - VertexBuffer.MatricesIndicesKind
  16777. * - VertexBuffer.MatricesIndicesExtraKind
  16778. * - VertexBuffer.MatricesWeightsKind
  16779. * - VertexBuffer.MatricesWeightsExtraKind
  16780. *
  16781. * Returns the Mesh.
  16782. */
  16783. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16784. /**
  16785. * Sets the mesh indices.
  16786. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16787. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16788. * This method creates a new index buffer each call.
  16789. * Returns the Mesh.
  16790. */
  16791. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16792. /**
  16793. * Boolean : True if the mesh owns the requested kind of data.
  16794. */
  16795. isVerticesDataPresent(kind: string): boolean;
  16796. /**
  16797. * Returns an array of indices (IndicesArray).
  16798. */
  16799. getIndices(): Nullable<IndicesArray>;
  16800. get _positions(): Nullable<Vector3[]>;
  16801. /**
  16802. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16803. * This means the mesh underlying bounding box and sphere are recomputed.
  16804. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16805. * @returns the current mesh
  16806. */
  16807. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16808. /** @hidden */
  16809. _preActivate(): InstancedMesh;
  16810. /** @hidden */
  16811. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16812. /** @hidden */
  16813. _postActivate(): void;
  16814. getWorldMatrix(): Matrix;
  16815. get isAnInstance(): boolean;
  16816. /**
  16817. * Returns the current associated LOD AbstractMesh.
  16818. */
  16819. getLOD(camera: Camera): AbstractMesh;
  16820. /** @hidden */
  16821. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16822. /** @hidden */
  16823. _syncSubMeshes(): InstancedMesh;
  16824. /** @hidden */
  16825. _generatePointsArray(): boolean;
  16826. /** @hidden */
  16827. _updateBoundingInfo(): AbstractMesh;
  16828. /**
  16829. * Creates a new InstancedMesh from the current mesh.
  16830. * - name (string) : the cloned mesh name
  16831. * - newParent (optional Node) : the optional Node to parent the clone to.
  16832. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16833. *
  16834. * Returns the clone.
  16835. */
  16836. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16837. /**
  16838. * Disposes the InstancedMesh.
  16839. * Returns nothing.
  16840. */
  16841. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16842. }
  16843. module "babylonjs/Meshes/mesh" {
  16844. interface Mesh {
  16845. /**
  16846. * Register a custom buffer that will be instanced
  16847. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16848. * @param kind defines the buffer kind
  16849. * @param stride defines the stride in floats
  16850. */
  16851. registerInstancedBuffer(kind: string, stride: number): void;
  16852. /**
  16853. * true to use the edge renderer for all instances of this mesh
  16854. */
  16855. edgesShareWithInstances: boolean;
  16856. /** @hidden */
  16857. _userInstancedBuffersStorage: {
  16858. data: {
  16859. [key: string]: Float32Array;
  16860. };
  16861. sizes: {
  16862. [key: string]: number;
  16863. };
  16864. vertexBuffers: {
  16865. [key: string]: Nullable<VertexBuffer>;
  16866. };
  16867. strides: {
  16868. [key: string]: number;
  16869. };
  16870. };
  16871. }
  16872. }
  16873. module "babylonjs/Meshes/abstractMesh" {
  16874. interface AbstractMesh {
  16875. /**
  16876. * Object used to store instanced buffers defined by user
  16877. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16878. */
  16879. instancedBuffers: {
  16880. [key: string]: any;
  16881. };
  16882. }
  16883. }
  16884. }
  16885. declare module "babylonjs/Materials/shaderMaterial" {
  16886. import { Nullable } from "babylonjs/types";
  16887. import { Scene } from "babylonjs/scene";
  16888. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16889. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16890. import { Mesh } from "babylonjs/Meshes/mesh";
  16891. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16892. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16893. import { Effect } from "babylonjs/Materials/effect";
  16894. import { Material } from "babylonjs/Materials/material";
  16895. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16896. /**
  16897. * Defines the options associated with the creation of a shader material.
  16898. */
  16899. export interface IShaderMaterialOptions {
  16900. /**
  16901. * Does the material work in alpha blend mode
  16902. */
  16903. needAlphaBlending: boolean;
  16904. /**
  16905. * Does the material work in alpha test mode
  16906. */
  16907. needAlphaTesting: boolean;
  16908. /**
  16909. * The list of attribute names used in the shader
  16910. */
  16911. attributes: string[];
  16912. /**
  16913. * The list of unifrom names used in the shader
  16914. */
  16915. uniforms: string[];
  16916. /**
  16917. * The list of UBO names used in the shader
  16918. */
  16919. uniformBuffers: string[];
  16920. /**
  16921. * The list of sampler names used in the shader
  16922. */
  16923. samplers: string[];
  16924. /**
  16925. * The list of defines used in the shader
  16926. */
  16927. defines: string[];
  16928. }
  16929. /**
  16930. * 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.
  16931. *
  16932. * This returned material effects how the mesh will look based on the code in the shaders.
  16933. *
  16934. * @see https://doc.babylonjs.com/how_to/shader_material
  16935. */
  16936. export class ShaderMaterial extends Material {
  16937. private _shaderPath;
  16938. private _options;
  16939. private _textures;
  16940. private _textureArrays;
  16941. private _floats;
  16942. private _ints;
  16943. private _floatsArrays;
  16944. private _colors3;
  16945. private _colors3Arrays;
  16946. private _colors4;
  16947. private _colors4Arrays;
  16948. private _vectors2;
  16949. private _vectors3;
  16950. private _vectors4;
  16951. private _matrices;
  16952. private _matrixArrays;
  16953. private _matrices3x3;
  16954. private _matrices2x2;
  16955. private _vectors2Arrays;
  16956. private _vectors3Arrays;
  16957. private _vectors4Arrays;
  16958. private _cachedWorldViewMatrix;
  16959. private _cachedWorldViewProjectionMatrix;
  16960. private _renderId;
  16961. private _multiview;
  16962. private _cachedDefines;
  16963. /** Define the Url to load snippets */
  16964. static SnippetUrl: string;
  16965. /** Snippet ID if the material was created from the snippet server */
  16966. snippetId: string;
  16967. /**
  16968. * Instantiate a new shader material.
  16969. * 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.
  16970. * This returned material effects how the mesh will look based on the code in the shaders.
  16971. * @see https://doc.babylonjs.com/how_to/shader_material
  16972. * @param name Define the name of the material in the scene
  16973. * @param scene Define the scene the material belongs to
  16974. * @param shaderPath Defines the route to the shader code in one of three ways:
  16975. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16976. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16977. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16978. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16979. * @param options Define the options used to create the shader
  16980. */
  16981. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16982. /**
  16983. * Gets the shader path used to define the shader code
  16984. * It can be modified to trigger a new compilation
  16985. */
  16986. get shaderPath(): any;
  16987. /**
  16988. * Sets the shader path used to define the shader code
  16989. * It can be modified to trigger a new compilation
  16990. */
  16991. set shaderPath(shaderPath: any);
  16992. /**
  16993. * Gets the options used to compile the shader.
  16994. * They can be modified to trigger a new compilation
  16995. */
  16996. get options(): IShaderMaterialOptions;
  16997. /**
  16998. * Gets the current class name of the material e.g. "ShaderMaterial"
  16999. * Mainly use in serialization.
  17000. * @returns the class name
  17001. */
  17002. getClassName(): string;
  17003. /**
  17004. * Specifies if the material will require alpha blending
  17005. * @returns a boolean specifying if alpha blending is needed
  17006. */
  17007. needAlphaBlending(): boolean;
  17008. /**
  17009. * Specifies if this material should be rendered in alpha test mode
  17010. * @returns a boolean specifying if an alpha test is needed.
  17011. */
  17012. needAlphaTesting(): boolean;
  17013. private _checkUniform;
  17014. /**
  17015. * Set a texture in the shader.
  17016. * @param name Define the name of the uniform samplers as defined in the shader
  17017. * @param texture Define the texture to bind to this sampler
  17018. * @return the material itself allowing "fluent" like uniform updates
  17019. */
  17020. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17021. /**
  17022. * Set a texture array in the shader.
  17023. * @param name Define the name of the uniform sampler array as defined in the shader
  17024. * @param textures Define the list of textures to bind to this sampler
  17025. * @return the material itself allowing "fluent" like uniform updates
  17026. */
  17027. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17028. /**
  17029. * Set a float in the shader.
  17030. * @param name Define the name of the uniform as defined in the shader
  17031. * @param value Define the value to give to the uniform
  17032. * @return the material itself allowing "fluent" like uniform updates
  17033. */
  17034. setFloat(name: string, value: number): ShaderMaterial;
  17035. /**
  17036. * Set a int in the shader.
  17037. * @param name Define the name of the uniform as defined in the shader
  17038. * @param value Define the value to give to the uniform
  17039. * @return the material itself allowing "fluent" like uniform updates
  17040. */
  17041. setInt(name: string, value: number): ShaderMaterial;
  17042. /**
  17043. * Set an array of floats in the shader.
  17044. * @param name Define the name of the uniform as defined in the shader
  17045. * @param value Define the value to give to the uniform
  17046. * @return the material itself allowing "fluent" like uniform updates
  17047. */
  17048. setFloats(name: string, value: number[]): ShaderMaterial;
  17049. /**
  17050. * Set a vec3 in the shader from a Color3.
  17051. * @param name Define the name of the uniform as defined in the shader
  17052. * @param value Define the value to give to the uniform
  17053. * @return the material itself allowing "fluent" like uniform updates
  17054. */
  17055. setColor3(name: string, value: Color3): ShaderMaterial;
  17056. /**
  17057. * Set a vec3 array in the shader from a Color3 array.
  17058. * @param name Define the name of the uniform as defined in the shader
  17059. * @param value Define the value to give to the uniform
  17060. * @return the material itself allowing "fluent" like uniform updates
  17061. */
  17062. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17063. /**
  17064. * Set a vec4 in the shader from a Color4.
  17065. * @param name Define the name of the uniform as defined in the shader
  17066. * @param value Define the value to give to the uniform
  17067. * @return the material itself allowing "fluent" like uniform updates
  17068. */
  17069. setColor4(name: string, value: Color4): ShaderMaterial;
  17070. /**
  17071. * Set a vec4 array in the shader from a Color4 array.
  17072. * @param name Define the name of the uniform as defined in the shader
  17073. * @param value Define the value to give to the uniform
  17074. * @return the material itself allowing "fluent" like uniform updates
  17075. */
  17076. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17077. /**
  17078. * Set a vec2 in the shader from a Vector2.
  17079. * @param name Define the name of the uniform as defined in the shader
  17080. * @param value Define the value to give to the uniform
  17081. * @return the material itself allowing "fluent" like uniform updates
  17082. */
  17083. setVector2(name: string, value: Vector2): ShaderMaterial;
  17084. /**
  17085. * Set a vec3 in the shader from a Vector3.
  17086. * @param name Define the name of the uniform as defined in the shader
  17087. * @param value Define the value to give to the uniform
  17088. * @return the material itself allowing "fluent" like uniform updates
  17089. */
  17090. setVector3(name: string, value: Vector3): ShaderMaterial;
  17091. /**
  17092. * Set a vec4 in the shader from a Vector4.
  17093. * @param name Define the name of the uniform as defined in the shader
  17094. * @param value Define the value to give to the uniform
  17095. * @return the material itself allowing "fluent" like uniform updates
  17096. */
  17097. setVector4(name: string, value: Vector4): ShaderMaterial;
  17098. /**
  17099. * Set a mat4 in the shader from a Matrix.
  17100. * @param name Define the name of the uniform as defined in the shader
  17101. * @param value Define the value to give to the uniform
  17102. * @return the material itself allowing "fluent" like uniform updates
  17103. */
  17104. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17105. /**
  17106. * Set a float32Array in the shader from a matrix array.
  17107. * @param name Define the name of the uniform as defined in the shader
  17108. * @param value Define the value to give to the uniform
  17109. * @return the material itself allowing "fluent" like uniform updates
  17110. */
  17111. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17112. /**
  17113. * Set a mat3 in the shader from a Float32Array.
  17114. * @param name Define the name of the uniform as defined in the shader
  17115. * @param value Define the value to give to the uniform
  17116. * @return the material itself allowing "fluent" like uniform updates
  17117. */
  17118. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17119. /**
  17120. * Set a mat2 in the shader from a Float32Array.
  17121. * @param name Define the name of the uniform as defined in the shader
  17122. * @param value Define the value to give to the uniform
  17123. * @return the material itself allowing "fluent" like uniform updates
  17124. */
  17125. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17126. /**
  17127. * Set a vec2 array in the shader from a number array.
  17128. * @param name Define the name of the uniform as defined in the shader
  17129. * @param value Define the value to give to the uniform
  17130. * @return the material itself allowing "fluent" like uniform updates
  17131. */
  17132. setArray2(name: string, value: number[]): ShaderMaterial;
  17133. /**
  17134. * Set a vec3 array in the shader from a number array.
  17135. * @param name Define the name of the uniform as defined in the shader
  17136. * @param value Define the value to give to the uniform
  17137. * @return the material itself allowing "fluent" like uniform updates
  17138. */
  17139. setArray3(name: string, value: number[]): ShaderMaterial;
  17140. /**
  17141. * Set a vec4 array in the shader from a number array.
  17142. * @param name Define the name of the uniform as defined in the shader
  17143. * @param value Define the value to give to the uniform
  17144. * @return the material itself allowing "fluent" like uniform updates
  17145. */
  17146. setArray4(name: string, value: number[]): ShaderMaterial;
  17147. private _checkCache;
  17148. /**
  17149. * Specifies that the submesh is ready to be used
  17150. * @param mesh defines the mesh to check
  17151. * @param subMesh defines which submesh to check
  17152. * @param useInstances specifies that instances should be used
  17153. * @returns a boolean indicating that the submesh is ready or not
  17154. */
  17155. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17156. /**
  17157. * Checks if the material is ready to render the requested mesh
  17158. * @param mesh Define the mesh to render
  17159. * @param useInstances Define whether or not the material is used with instances
  17160. * @returns true if ready, otherwise false
  17161. */
  17162. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17163. /**
  17164. * Binds the world matrix to the material
  17165. * @param world defines the world transformation matrix
  17166. * @param effectOverride - If provided, use this effect instead of internal effect
  17167. */
  17168. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17169. /**
  17170. * Binds the submesh to this material by preparing the effect and shader to draw
  17171. * @param world defines the world transformation matrix
  17172. * @param mesh defines the mesh containing the submesh
  17173. * @param subMesh defines the submesh to bind the material to
  17174. */
  17175. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17176. /**
  17177. * Binds the material to the mesh
  17178. * @param world defines the world transformation matrix
  17179. * @param mesh defines the mesh to bind the material to
  17180. * @param effectOverride - If provided, use this effect instead of internal effect
  17181. */
  17182. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17183. protected _afterBind(mesh?: Mesh): void;
  17184. /**
  17185. * Gets the active textures from the material
  17186. * @returns an array of textures
  17187. */
  17188. getActiveTextures(): BaseTexture[];
  17189. /**
  17190. * Specifies if the material uses a texture
  17191. * @param texture defines the texture to check against the material
  17192. * @returns a boolean specifying if the material uses the texture
  17193. */
  17194. hasTexture(texture: BaseTexture): boolean;
  17195. /**
  17196. * Makes a duplicate of the material, and gives it a new name
  17197. * @param name defines the new name for the duplicated material
  17198. * @returns the cloned material
  17199. */
  17200. clone(name: string): ShaderMaterial;
  17201. /**
  17202. * Disposes the material
  17203. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17204. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17205. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17206. */
  17207. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17208. /**
  17209. * Serializes this material in a JSON representation
  17210. * @returns the serialized material object
  17211. */
  17212. serialize(): any;
  17213. /**
  17214. * Creates a shader material from parsed shader material data
  17215. * @param source defines the JSON represnetation of the material
  17216. * @param scene defines the hosting scene
  17217. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17218. * @returns a new material
  17219. */
  17220. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17221. /**
  17222. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17223. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17224. * @param url defines the url to load from
  17225. * @param scene defines the hosting scene
  17226. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17227. * @returns a promise that will resolve to the new ShaderMaterial
  17228. */
  17229. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17230. /**
  17231. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17232. * @param snippetId defines the snippet to load
  17233. * @param scene defines the hosting scene
  17234. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17235. * @returns a promise that will resolve to the new ShaderMaterial
  17236. */
  17237. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17238. }
  17239. }
  17240. declare module "babylonjs/Shaders/color.fragment" {
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17242. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17243. /** @hidden */
  17244. export var colorPixelShader: {
  17245. name: string;
  17246. shader: string;
  17247. };
  17248. }
  17249. declare module "babylonjs/Shaders/color.vertex" {
  17250. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17253. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17255. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17256. /** @hidden */
  17257. export var colorVertexShader: {
  17258. name: string;
  17259. shader: string;
  17260. };
  17261. }
  17262. declare module "babylonjs/Meshes/linesMesh" {
  17263. import { Nullable } from "babylonjs/types";
  17264. import { Scene } from "babylonjs/scene";
  17265. import { Color3 } from "babylonjs/Maths/math.color";
  17266. import { Node } from "babylonjs/node";
  17267. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17268. import { Mesh } from "babylonjs/Meshes/mesh";
  17269. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17270. import { Effect } from "babylonjs/Materials/effect";
  17271. import { Material } from "babylonjs/Materials/material";
  17272. import "babylonjs/Shaders/color.fragment";
  17273. import "babylonjs/Shaders/color.vertex";
  17274. /**
  17275. * Line mesh
  17276. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17277. */
  17278. export class LinesMesh extends Mesh {
  17279. /**
  17280. * If vertex color should be applied to the mesh
  17281. */
  17282. readonly useVertexColor?: boolean | undefined;
  17283. /**
  17284. * If vertex alpha should be applied to the mesh
  17285. */
  17286. readonly useVertexAlpha?: boolean | undefined;
  17287. /**
  17288. * Color of the line (Default: White)
  17289. */
  17290. color: Color3;
  17291. /**
  17292. * Alpha of the line (Default: 1)
  17293. */
  17294. alpha: number;
  17295. /**
  17296. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17297. * This margin is expressed in world space coordinates, so its value may vary.
  17298. * Default value is 0.1
  17299. */
  17300. intersectionThreshold: number;
  17301. private _colorShader;
  17302. private color4;
  17303. /**
  17304. * Creates a new LinesMesh
  17305. * @param name defines the name
  17306. * @param scene defines the hosting scene
  17307. * @param parent defines the parent mesh if any
  17308. * @param source defines the optional source LinesMesh used to clone data from
  17309. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17310. * When false, achieved by calling a clone(), also passing False.
  17311. * This will make creation of children, recursive.
  17312. * @param useVertexColor defines if this LinesMesh supports vertex color
  17313. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17314. */
  17315. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17316. /**
  17317. * If vertex color should be applied to the mesh
  17318. */
  17319. useVertexColor?: boolean | undefined,
  17320. /**
  17321. * If vertex alpha should be applied to the mesh
  17322. */
  17323. useVertexAlpha?: boolean | undefined);
  17324. private _addClipPlaneDefine;
  17325. private _removeClipPlaneDefine;
  17326. isReady(): boolean;
  17327. /**
  17328. * Returns the string "LineMesh"
  17329. */
  17330. getClassName(): string;
  17331. /**
  17332. * @hidden
  17333. */
  17334. get material(): Material;
  17335. /**
  17336. * @hidden
  17337. */
  17338. set material(value: Material);
  17339. /**
  17340. * @hidden
  17341. */
  17342. get checkCollisions(): boolean;
  17343. /** @hidden */
  17344. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17345. /** @hidden */
  17346. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17347. /**
  17348. * Disposes of the line mesh
  17349. * @param doNotRecurse If children should be disposed
  17350. */
  17351. dispose(doNotRecurse?: boolean): void;
  17352. /**
  17353. * Returns a new LineMesh object cloned from the current one.
  17354. */
  17355. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17356. /**
  17357. * Creates a new InstancedLinesMesh object from the mesh model.
  17358. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17359. * @param name defines the name of the new instance
  17360. * @returns a new InstancedLinesMesh
  17361. */
  17362. createInstance(name: string): InstancedLinesMesh;
  17363. }
  17364. /**
  17365. * Creates an instance based on a source LinesMesh
  17366. */
  17367. export class InstancedLinesMesh extends InstancedMesh {
  17368. /**
  17369. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17370. * This margin is expressed in world space coordinates, so its value may vary.
  17371. * Initilized with the intersectionThreshold value of the source LinesMesh
  17372. */
  17373. intersectionThreshold: number;
  17374. constructor(name: string, source: LinesMesh);
  17375. /**
  17376. * Returns the string "InstancedLinesMesh".
  17377. */
  17378. getClassName(): string;
  17379. }
  17380. }
  17381. declare module "babylonjs/Shaders/line.fragment" {
  17382. /** @hidden */
  17383. export var linePixelShader: {
  17384. name: string;
  17385. shader: string;
  17386. };
  17387. }
  17388. declare module "babylonjs/Shaders/line.vertex" {
  17389. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17390. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17391. /** @hidden */
  17392. export var lineVertexShader: {
  17393. name: string;
  17394. shader: string;
  17395. };
  17396. }
  17397. declare module "babylonjs/Rendering/edgesRenderer" {
  17398. import { Nullable } from "babylonjs/types";
  17399. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17400. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17401. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17402. import { IDisposable } from "babylonjs/scene";
  17403. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17404. import "babylonjs/Shaders/line.fragment";
  17405. import "babylonjs/Shaders/line.vertex";
  17406. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17407. import { SmartArray } from "babylonjs/Misc/smartArray";
  17408. module "babylonjs/scene" {
  17409. interface Scene {
  17410. /** @hidden */
  17411. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17412. }
  17413. }
  17414. module "babylonjs/Meshes/abstractMesh" {
  17415. interface AbstractMesh {
  17416. /**
  17417. * Gets the edgesRenderer associated with the mesh
  17418. */
  17419. edgesRenderer: Nullable<EdgesRenderer>;
  17420. }
  17421. }
  17422. module "babylonjs/Meshes/linesMesh" {
  17423. interface LinesMesh {
  17424. /**
  17425. * Enables the edge rendering mode on the mesh.
  17426. * This mode makes the mesh edges visible
  17427. * @param epsilon defines the maximal distance between two angles to detect a face
  17428. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17429. * @returns the currentAbstractMesh
  17430. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17431. */
  17432. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17433. }
  17434. }
  17435. module "babylonjs/Meshes/linesMesh" {
  17436. interface InstancedLinesMesh {
  17437. /**
  17438. * Enables the edge rendering mode on the mesh.
  17439. * This mode makes the mesh edges visible
  17440. * @param epsilon defines the maximal distance between two angles to detect a face
  17441. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17442. * @returns the current InstancedLinesMesh
  17443. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17444. */
  17445. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17446. }
  17447. }
  17448. /**
  17449. * Defines the minimum contract an Edges renderer should follow.
  17450. */
  17451. export interface IEdgesRenderer extends IDisposable {
  17452. /**
  17453. * Gets or sets a boolean indicating if the edgesRenderer is active
  17454. */
  17455. isEnabled: boolean;
  17456. /**
  17457. * Renders the edges of the attached mesh,
  17458. */
  17459. render(): void;
  17460. /**
  17461. * Checks wether or not the edges renderer is ready to render.
  17462. * @return true if ready, otherwise false.
  17463. */
  17464. isReady(): boolean;
  17465. /**
  17466. * List of instances to render in case the source mesh has instances
  17467. */
  17468. customInstances: SmartArray<Matrix>;
  17469. }
  17470. /**
  17471. * Defines the additional options of the edges renderer
  17472. */
  17473. export interface IEdgesRendererOptions {
  17474. /**
  17475. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17476. * If not defined, the default value is true
  17477. */
  17478. useAlternateEdgeFinder?: boolean;
  17479. /**
  17480. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17481. * If not defined, the default value is true.
  17482. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17483. * This option is used only if useAlternateEdgeFinder = true
  17484. */
  17485. useFastVertexMerger?: boolean;
  17486. /**
  17487. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17488. * The default value is 1e-6
  17489. * This option is used only if useAlternateEdgeFinder = true
  17490. */
  17491. epsilonVertexMerge?: number;
  17492. /**
  17493. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17494. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17495. * This option is used only if useAlternateEdgeFinder = true
  17496. */
  17497. applyTessellation?: boolean;
  17498. /**
  17499. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17500. * The default value is 1e-6
  17501. * This option is used only if useAlternateEdgeFinder = true
  17502. */
  17503. epsilonVertexAligned?: number;
  17504. }
  17505. /**
  17506. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17507. */
  17508. export class EdgesRenderer implements IEdgesRenderer {
  17509. /**
  17510. * Define the size of the edges with an orthographic camera
  17511. */
  17512. edgesWidthScalerForOrthographic: number;
  17513. /**
  17514. * Define the size of the edges with a perspective camera
  17515. */
  17516. edgesWidthScalerForPerspective: number;
  17517. protected _source: AbstractMesh;
  17518. protected _linesPositions: number[];
  17519. protected _linesNormals: number[];
  17520. protected _linesIndices: number[];
  17521. protected _epsilon: number;
  17522. protected _indicesCount: number;
  17523. protected _lineShader: ShaderMaterial;
  17524. protected _ib: DataBuffer;
  17525. protected _buffers: {
  17526. [key: string]: Nullable<VertexBuffer>;
  17527. };
  17528. protected _buffersForInstances: {
  17529. [key: string]: Nullable<VertexBuffer>;
  17530. };
  17531. protected _checkVerticesInsteadOfIndices: boolean;
  17532. protected _options: Nullable<IEdgesRendererOptions>;
  17533. private _meshRebuildObserver;
  17534. private _meshDisposeObserver;
  17535. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17536. isEnabled: boolean;
  17537. /**
  17538. * List of instances to render in case the source mesh has instances
  17539. */
  17540. customInstances: SmartArray<Matrix>;
  17541. private static GetShader;
  17542. /**
  17543. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17544. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17545. * @param source Mesh used to create edges
  17546. * @param epsilon sum of angles in adjacency to check for edge
  17547. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17548. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17549. * @param options The options to apply when generating the edges
  17550. */
  17551. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17552. protected _prepareRessources(): void;
  17553. /** @hidden */
  17554. _rebuild(): void;
  17555. /**
  17556. * Releases the required resources for the edges renderer
  17557. */
  17558. dispose(): void;
  17559. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17560. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17561. /**
  17562. * Checks if the pair of p0 and p1 is en edge
  17563. * @param faceIndex
  17564. * @param edge
  17565. * @param faceNormals
  17566. * @param p0
  17567. * @param p1
  17568. * @private
  17569. */
  17570. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17571. /**
  17572. * push line into the position, normal and index buffer
  17573. * @protected
  17574. */
  17575. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17576. /**
  17577. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17578. */
  17579. private _tessellateTriangle;
  17580. private _generateEdgesLinesAlternate;
  17581. /**
  17582. * Generates lines edges from adjacencjes
  17583. * @private
  17584. */
  17585. _generateEdgesLines(): void;
  17586. /**
  17587. * Checks wether or not the edges renderer is ready to render.
  17588. * @return true if ready, otherwise false.
  17589. */
  17590. isReady(): boolean;
  17591. /**
  17592. * Renders the edges of the attached mesh,
  17593. */
  17594. render(): void;
  17595. }
  17596. /**
  17597. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17598. */
  17599. export class LineEdgesRenderer extends EdgesRenderer {
  17600. /**
  17601. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17602. * @param source LineMesh used to generate edges
  17603. * @param epsilon not important (specified angle for edge detection)
  17604. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17605. */
  17606. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17607. /**
  17608. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17609. */
  17610. _generateEdgesLines(): void;
  17611. }
  17612. }
  17613. declare module "babylonjs/Rendering/renderingGroup" {
  17614. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17615. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17617. import { Nullable } from "babylonjs/types";
  17618. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17619. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17620. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17621. import { Material } from "babylonjs/Materials/material";
  17622. import { Scene } from "babylonjs/scene";
  17623. /**
  17624. * This represents the object necessary to create a rendering group.
  17625. * This is exclusively used and created by the rendering manager.
  17626. * To modify the behavior, you use the available helpers in your scene or meshes.
  17627. * @hidden
  17628. */
  17629. export class RenderingGroup {
  17630. index: number;
  17631. private static _zeroVector;
  17632. private _scene;
  17633. private _opaqueSubMeshes;
  17634. private _transparentSubMeshes;
  17635. private _alphaTestSubMeshes;
  17636. private _depthOnlySubMeshes;
  17637. private _particleSystems;
  17638. private _spriteManagers;
  17639. private _opaqueSortCompareFn;
  17640. private _alphaTestSortCompareFn;
  17641. private _transparentSortCompareFn;
  17642. private _renderOpaque;
  17643. private _renderAlphaTest;
  17644. private _renderTransparent;
  17645. /** @hidden */
  17646. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17647. onBeforeTransparentRendering: () => void;
  17648. /**
  17649. * Set the opaque sort comparison function.
  17650. * If null the sub meshes will be render in the order they were created
  17651. */
  17652. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17653. /**
  17654. * Set the alpha test sort comparison function.
  17655. * If null the sub meshes will be render in the order they were created
  17656. */
  17657. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17658. /**
  17659. * Set the transparent sort comparison function.
  17660. * If null the sub meshes will be render in the order they were created
  17661. */
  17662. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17663. /**
  17664. * Creates a new rendering group.
  17665. * @param index The rendering group index
  17666. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17667. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17668. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17669. */
  17670. 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>);
  17671. /**
  17672. * Render all the sub meshes contained in the group.
  17673. * @param customRenderFunction Used to override the default render behaviour of the group.
  17674. * @returns true if rendered some submeshes.
  17675. */
  17676. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17677. /**
  17678. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17679. * @param subMeshes The submeshes to render
  17680. */
  17681. private renderOpaqueSorted;
  17682. /**
  17683. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17684. * @param subMeshes The submeshes to render
  17685. */
  17686. private renderAlphaTestSorted;
  17687. /**
  17688. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17689. * @param subMeshes The submeshes to render
  17690. */
  17691. private renderTransparentSorted;
  17692. /**
  17693. * Renders the submeshes in a specified order.
  17694. * @param subMeshes The submeshes to sort before render
  17695. * @param sortCompareFn The comparison function use to sort
  17696. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17697. * @param transparent Specifies to activate blending if true
  17698. */
  17699. private static renderSorted;
  17700. /**
  17701. * Renders the submeshes in the order they were dispatched (no sort applied).
  17702. * @param subMeshes The submeshes to render
  17703. */
  17704. private static renderUnsorted;
  17705. /**
  17706. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17707. * are rendered back to front if in the same alpha index.
  17708. *
  17709. * @param a The first submesh
  17710. * @param b The second submesh
  17711. * @returns The result of the comparison
  17712. */
  17713. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17714. /**
  17715. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17716. * are rendered back to front.
  17717. *
  17718. * @param a The first submesh
  17719. * @param b The second submesh
  17720. * @returns The result of the comparison
  17721. */
  17722. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17723. /**
  17724. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17725. * are rendered front to back (prevent overdraw).
  17726. *
  17727. * @param a The first submesh
  17728. * @param b The second submesh
  17729. * @returns The result of the comparison
  17730. */
  17731. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17732. /**
  17733. * Resets the different lists of submeshes to prepare a new frame.
  17734. */
  17735. prepare(): void;
  17736. dispose(): void;
  17737. /**
  17738. * Inserts the submesh in its correct queue depending on its material.
  17739. * @param subMesh The submesh to dispatch
  17740. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17741. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17742. */
  17743. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17744. dispatchSprites(spriteManager: ISpriteManager): void;
  17745. dispatchParticles(particleSystem: IParticleSystem): void;
  17746. private _renderParticles;
  17747. private _renderSprites;
  17748. }
  17749. }
  17750. declare module "babylonjs/Rendering/renderingManager" {
  17751. import { Nullable } from "babylonjs/types";
  17752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17753. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17754. import { SmartArray } from "babylonjs/Misc/smartArray";
  17755. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17756. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17757. import { Material } from "babylonjs/Materials/material";
  17758. import { Scene } from "babylonjs/scene";
  17759. import { Camera } from "babylonjs/Cameras/camera";
  17760. /**
  17761. * Interface describing the different options available in the rendering manager
  17762. * regarding Auto Clear between groups.
  17763. */
  17764. export interface IRenderingManagerAutoClearSetup {
  17765. /**
  17766. * Defines whether or not autoclear is enable.
  17767. */
  17768. autoClear: boolean;
  17769. /**
  17770. * Defines whether or not to autoclear the depth buffer.
  17771. */
  17772. depth: boolean;
  17773. /**
  17774. * Defines whether or not to autoclear the stencil buffer.
  17775. */
  17776. stencil: boolean;
  17777. }
  17778. /**
  17779. * This class is used by the onRenderingGroupObservable
  17780. */
  17781. export class RenderingGroupInfo {
  17782. /**
  17783. * The Scene that being rendered
  17784. */
  17785. scene: Scene;
  17786. /**
  17787. * The camera currently used for the rendering pass
  17788. */
  17789. camera: Nullable<Camera>;
  17790. /**
  17791. * The ID of the renderingGroup being processed
  17792. */
  17793. renderingGroupId: number;
  17794. }
  17795. /**
  17796. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17797. * It is enable to manage the different groups as well as the different necessary sort functions.
  17798. * This should not be used directly aside of the few static configurations
  17799. */
  17800. export class RenderingManager {
  17801. /**
  17802. * The max id used for rendering groups (not included)
  17803. */
  17804. static MAX_RENDERINGGROUPS: number;
  17805. /**
  17806. * The min id used for rendering groups (included)
  17807. */
  17808. static MIN_RENDERINGGROUPS: number;
  17809. /**
  17810. * Used to globally prevent autoclearing scenes.
  17811. */
  17812. static AUTOCLEAR: boolean;
  17813. /**
  17814. * @hidden
  17815. */
  17816. _useSceneAutoClearSetup: boolean;
  17817. private _scene;
  17818. private _renderingGroups;
  17819. private _depthStencilBufferAlreadyCleaned;
  17820. private _autoClearDepthStencil;
  17821. private _customOpaqueSortCompareFn;
  17822. private _customAlphaTestSortCompareFn;
  17823. private _customTransparentSortCompareFn;
  17824. private _renderingGroupInfo;
  17825. /**
  17826. * Instantiates a new rendering group for a particular scene
  17827. * @param scene Defines the scene the groups belongs to
  17828. */
  17829. constructor(scene: Scene);
  17830. private _clearDepthStencilBuffer;
  17831. /**
  17832. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17833. * @hidden
  17834. */
  17835. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17836. /**
  17837. * Resets the different information of the group to prepare a new frame
  17838. * @hidden
  17839. */
  17840. reset(): void;
  17841. /**
  17842. * Dispose and release the group and its associated resources.
  17843. * @hidden
  17844. */
  17845. dispose(): void;
  17846. /**
  17847. * Clear the info related to rendering groups preventing retention points during dispose.
  17848. */
  17849. freeRenderingGroups(): void;
  17850. private _prepareRenderingGroup;
  17851. /**
  17852. * Add a sprite manager to the rendering manager in order to render it this frame.
  17853. * @param spriteManager Define the sprite manager to render
  17854. */
  17855. dispatchSprites(spriteManager: ISpriteManager): void;
  17856. /**
  17857. * Add a particle system to the rendering manager in order to render it this frame.
  17858. * @param particleSystem Define the particle system to render
  17859. */
  17860. dispatchParticles(particleSystem: IParticleSystem): void;
  17861. /**
  17862. * Add a submesh to the manager in order to render it this frame
  17863. * @param subMesh The submesh to dispatch
  17864. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17865. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17866. */
  17867. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17868. /**
  17869. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17870. * This allowed control for front to back rendering or reversly depending of the special needs.
  17871. *
  17872. * @param renderingGroupId The rendering group id corresponding to its index
  17873. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17874. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17875. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17876. */
  17877. 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;
  17878. /**
  17879. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17880. *
  17881. * @param renderingGroupId The rendering group id corresponding to its index
  17882. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17883. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17884. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17885. */
  17886. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17887. /**
  17888. * Gets the current auto clear configuration for one rendering group of the rendering
  17889. * manager.
  17890. * @param index the rendering group index to get the information for
  17891. * @returns The auto clear setup for the requested rendering group
  17892. */
  17893. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17894. }
  17895. }
  17896. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17897. import { SmartArray } from "babylonjs/Misc/smartArray";
  17898. import { Nullable } from "babylonjs/types";
  17899. import { Scene } from "babylonjs/scene";
  17900. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17901. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17902. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17903. import { Mesh } from "babylonjs/Meshes/mesh";
  17904. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17905. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17906. import { Effect } from "babylonjs/Materials/effect";
  17907. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17908. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17909. import "babylonjs/Shaders/shadowMap.fragment";
  17910. import "babylonjs/Shaders/shadowMap.vertex";
  17911. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17912. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17913. import { Observable } from "babylonjs/Misc/observable";
  17914. /**
  17915. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17916. */
  17917. export interface ICustomShaderOptions {
  17918. /**
  17919. * Gets or sets the custom shader name to use
  17920. */
  17921. shaderName: string;
  17922. /**
  17923. * The list of attribute names used in the shader
  17924. */
  17925. attributes?: string[];
  17926. /**
  17927. * The list of unifrom names used in the shader
  17928. */
  17929. uniforms?: string[];
  17930. /**
  17931. * The list of sampler names used in the shader
  17932. */
  17933. samplers?: string[];
  17934. /**
  17935. * The list of defines used in the shader
  17936. */
  17937. defines?: string[];
  17938. }
  17939. /**
  17940. * Interface to implement to create a shadow generator compatible with BJS.
  17941. */
  17942. export interface IShadowGenerator {
  17943. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17944. id: string;
  17945. /**
  17946. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17947. * @returns The render target texture if present otherwise, null
  17948. */
  17949. getShadowMap(): Nullable<RenderTargetTexture>;
  17950. /**
  17951. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17952. * @param subMesh The submesh we want to render in the shadow map
  17953. * @param useInstances Defines wether will draw in the map using instances
  17954. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17955. * @returns true if ready otherwise, false
  17956. */
  17957. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17958. /**
  17959. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17960. * @param defines Defines of the material we want to update
  17961. * @param lightIndex Index of the light in the enabled light list of the material
  17962. */
  17963. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17964. /**
  17965. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17966. * defined in the generator but impacting the effect).
  17967. * It implies the unifroms available on the materials are the standard BJS ones.
  17968. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17969. * @param effect The effect we are binfing the information for
  17970. */
  17971. bindShadowLight(lightIndex: string, effect: Effect): void;
  17972. /**
  17973. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17974. * (eq to shadow prjection matrix * light transform matrix)
  17975. * @returns The transform matrix used to create the shadow map
  17976. */
  17977. getTransformMatrix(): Matrix;
  17978. /**
  17979. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17980. * Cube and 2D textures for instance.
  17981. */
  17982. recreateShadowMap(): void;
  17983. /**
  17984. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17985. * @param onCompiled Callback triggered at the and of the effects compilation
  17986. * @param options Sets of optional options forcing the compilation with different modes
  17987. */
  17988. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17989. useInstances: boolean;
  17990. }>): void;
  17991. /**
  17992. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17993. * @param options Sets of optional options forcing the compilation with different modes
  17994. * @returns A promise that resolves when the compilation completes
  17995. */
  17996. forceCompilationAsync(options?: Partial<{
  17997. useInstances: boolean;
  17998. }>): Promise<void>;
  17999. /**
  18000. * Serializes the shadow generator setup to a json object.
  18001. * @returns The serialized JSON object
  18002. */
  18003. serialize(): any;
  18004. /**
  18005. * Disposes the Shadow map and related Textures and effects.
  18006. */
  18007. dispose(): void;
  18008. }
  18009. /**
  18010. * Default implementation IShadowGenerator.
  18011. * This is the main object responsible of generating shadows in the framework.
  18012. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18013. */
  18014. export class ShadowGenerator implements IShadowGenerator {
  18015. /**
  18016. * Name of the shadow generator class
  18017. */
  18018. static CLASSNAME: string;
  18019. /**
  18020. * Shadow generator mode None: no filtering applied.
  18021. */
  18022. static readonly FILTER_NONE: number;
  18023. /**
  18024. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18025. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18026. */
  18027. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18028. /**
  18029. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18030. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18031. */
  18032. static readonly FILTER_POISSONSAMPLING: number;
  18033. /**
  18034. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18035. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18036. */
  18037. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18038. /**
  18039. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18040. * edge artifacts on steep falloff.
  18041. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18042. */
  18043. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18044. /**
  18045. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18046. * edge artifacts on steep falloff.
  18047. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18048. */
  18049. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18050. /**
  18051. * Shadow generator mode PCF: Percentage Closer Filtering
  18052. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18053. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18054. */
  18055. static readonly FILTER_PCF: number;
  18056. /**
  18057. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18058. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18059. * Contact Hardening
  18060. */
  18061. static readonly FILTER_PCSS: number;
  18062. /**
  18063. * Reserved for PCF and PCSS
  18064. * Highest Quality.
  18065. *
  18066. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18067. *
  18068. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18069. */
  18070. static readonly QUALITY_HIGH: number;
  18071. /**
  18072. * Reserved for PCF and PCSS
  18073. * Good tradeoff for quality/perf cross devices
  18074. *
  18075. * Execute PCF on a 3*3 kernel.
  18076. *
  18077. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18078. */
  18079. static readonly QUALITY_MEDIUM: number;
  18080. /**
  18081. * Reserved for PCF and PCSS
  18082. * The lowest quality but the fastest.
  18083. *
  18084. * Execute PCF on a 1*1 kernel.
  18085. *
  18086. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18087. */
  18088. static readonly QUALITY_LOW: number;
  18089. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18090. id: string;
  18091. /** Gets or sets the custom shader name to use */
  18092. customShaderOptions: ICustomShaderOptions;
  18093. /**
  18094. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18095. */
  18096. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18097. /**
  18098. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18099. */
  18100. onAfterShadowMapRenderObservable: Observable<Effect>;
  18101. /**
  18102. * Observable triggered before a mesh is rendered in the shadow map.
  18103. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18104. */
  18105. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18106. /**
  18107. * Observable triggered after a mesh is rendered in the shadow map.
  18108. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18109. */
  18110. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18111. protected _bias: number;
  18112. /**
  18113. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18114. */
  18115. get bias(): number;
  18116. /**
  18117. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18118. */
  18119. set bias(bias: number);
  18120. protected _normalBias: number;
  18121. /**
  18122. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18123. */
  18124. get normalBias(): number;
  18125. /**
  18126. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18127. */
  18128. set normalBias(normalBias: number);
  18129. protected _blurBoxOffset: number;
  18130. /**
  18131. * Gets the blur box offset: offset applied during the blur pass.
  18132. * Only useful if useKernelBlur = false
  18133. */
  18134. get blurBoxOffset(): number;
  18135. /**
  18136. * Sets the blur box offset: offset applied during the blur pass.
  18137. * Only useful if useKernelBlur = false
  18138. */
  18139. set blurBoxOffset(value: number);
  18140. protected _blurScale: number;
  18141. /**
  18142. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18143. * 2 means half of the size.
  18144. */
  18145. get blurScale(): number;
  18146. /**
  18147. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18148. * 2 means half of the size.
  18149. */
  18150. set blurScale(value: number);
  18151. protected _blurKernel: number;
  18152. /**
  18153. * Gets the blur kernel: kernel size of the blur pass.
  18154. * Only useful if useKernelBlur = true
  18155. */
  18156. get blurKernel(): number;
  18157. /**
  18158. * Sets the blur kernel: kernel size of the blur pass.
  18159. * Only useful if useKernelBlur = true
  18160. */
  18161. set blurKernel(value: number);
  18162. protected _useKernelBlur: boolean;
  18163. /**
  18164. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18165. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18166. */
  18167. get useKernelBlur(): boolean;
  18168. /**
  18169. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18170. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18171. */
  18172. set useKernelBlur(value: boolean);
  18173. protected _depthScale: number;
  18174. /**
  18175. * Gets the depth scale used in ESM mode.
  18176. */
  18177. get depthScale(): number;
  18178. /**
  18179. * Sets the depth scale used in ESM mode.
  18180. * This can override the scale stored on the light.
  18181. */
  18182. set depthScale(value: number);
  18183. protected _validateFilter(filter: number): number;
  18184. protected _filter: number;
  18185. /**
  18186. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18187. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18188. */
  18189. get filter(): number;
  18190. /**
  18191. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18192. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18193. */
  18194. set filter(value: number);
  18195. /**
  18196. * Gets if the current filter is set to Poisson Sampling.
  18197. */
  18198. get usePoissonSampling(): boolean;
  18199. /**
  18200. * Sets the current filter to Poisson Sampling.
  18201. */
  18202. set usePoissonSampling(value: boolean);
  18203. /**
  18204. * Gets if the current filter is set to ESM.
  18205. */
  18206. get useExponentialShadowMap(): boolean;
  18207. /**
  18208. * Sets the current filter is to ESM.
  18209. */
  18210. set useExponentialShadowMap(value: boolean);
  18211. /**
  18212. * Gets if the current filter is set to filtered ESM.
  18213. */
  18214. get useBlurExponentialShadowMap(): boolean;
  18215. /**
  18216. * Gets if the current filter is set to filtered ESM.
  18217. */
  18218. set useBlurExponentialShadowMap(value: boolean);
  18219. /**
  18220. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18221. * exponential to prevent steep falloff artifacts).
  18222. */
  18223. get useCloseExponentialShadowMap(): boolean;
  18224. /**
  18225. * Sets the current filter to "close ESM" (using the inverse of the
  18226. * exponential to prevent steep falloff artifacts).
  18227. */
  18228. set useCloseExponentialShadowMap(value: boolean);
  18229. /**
  18230. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18231. * exponential to prevent steep falloff artifacts).
  18232. */
  18233. get useBlurCloseExponentialShadowMap(): boolean;
  18234. /**
  18235. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18236. * exponential to prevent steep falloff artifacts).
  18237. */
  18238. set useBlurCloseExponentialShadowMap(value: boolean);
  18239. /**
  18240. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18241. */
  18242. get usePercentageCloserFiltering(): boolean;
  18243. /**
  18244. * Sets the current filter to "PCF" (percentage closer filtering).
  18245. */
  18246. set usePercentageCloserFiltering(value: boolean);
  18247. protected _filteringQuality: number;
  18248. /**
  18249. * Gets the PCF or PCSS Quality.
  18250. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18251. */
  18252. get filteringQuality(): number;
  18253. /**
  18254. * Sets the PCF or PCSS Quality.
  18255. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18256. */
  18257. set filteringQuality(filteringQuality: number);
  18258. /**
  18259. * Gets if the current filter is set to "PCSS" (contact hardening).
  18260. */
  18261. get useContactHardeningShadow(): boolean;
  18262. /**
  18263. * Sets the current filter to "PCSS" (contact hardening).
  18264. */
  18265. set useContactHardeningShadow(value: boolean);
  18266. protected _contactHardeningLightSizeUVRatio: number;
  18267. /**
  18268. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18269. * Using a ratio helps keeping shape stability independently of the map size.
  18270. *
  18271. * It does not account for the light projection as it was having too much
  18272. * instability during the light setup or during light position changes.
  18273. *
  18274. * Only valid if useContactHardeningShadow is true.
  18275. */
  18276. get contactHardeningLightSizeUVRatio(): number;
  18277. /**
  18278. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18279. * Using a ratio helps keeping shape stability independently of the map size.
  18280. *
  18281. * It does not account for the light projection as it was having too much
  18282. * instability during the light setup or during light position changes.
  18283. *
  18284. * Only valid if useContactHardeningShadow is true.
  18285. */
  18286. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18287. protected _darkness: number;
  18288. /** Gets or sets the actual darkness of a shadow */
  18289. get darkness(): number;
  18290. set darkness(value: number);
  18291. /**
  18292. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18293. * 0 means strongest and 1 would means no shadow.
  18294. * @returns the darkness.
  18295. */
  18296. getDarkness(): number;
  18297. /**
  18298. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18299. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18300. * @returns the shadow generator allowing fluent coding.
  18301. */
  18302. setDarkness(darkness: number): ShadowGenerator;
  18303. protected _transparencyShadow: boolean;
  18304. /** Gets or sets the ability to have transparent shadow */
  18305. get transparencyShadow(): boolean;
  18306. set transparencyShadow(value: boolean);
  18307. /**
  18308. * Sets the ability to have transparent shadow (boolean).
  18309. * @param transparent True if transparent else False
  18310. * @returns the shadow generator allowing fluent coding
  18311. */
  18312. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18313. /**
  18314. * Enables or disables shadows with varying strength based on the transparency
  18315. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18316. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18317. * mesh.visibility * alphaTexture.a
  18318. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18319. */
  18320. enableSoftTransparentShadow: boolean;
  18321. protected _shadowMap: Nullable<RenderTargetTexture>;
  18322. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18323. /**
  18324. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18325. * @returns The render target texture if present otherwise, null
  18326. */
  18327. getShadowMap(): Nullable<RenderTargetTexture>;
  18328. /**
  18329. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18330. * @returns The render target texture if the shadow map is present otherwise, null
  18331. */
  18332. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18333. /**
  18334. * Gets the class name of that object
  18335. * @returns "ShadowGenerator"
  18336. */
  18337. getClassName(): string;
  18338. /**
  18339. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18340. * @param mesh Mesh to add
  18341. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18342. * @returns the Shadow Generator itself
  18343. */
  18344. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18345. /**
  18346. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18347. * @param mesh Mesh to remove
  18348. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18349. * @returns the Shadow Generator itself
  18350. */
  18351. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18352. /**
  18353. * Controls the extent to which the shadows fade out at the edge of the frustum
  18354. */
  18355. frustumEdgeFalloff: number;
  18356. protected _light: IShadowLight;
  18357. /**
  18358. * Returns the associated light object.
  18359. * @returns the light generating the shadow
  18360. */
  18361. getLight(): IShadowLight;
  18362. /**
  18363. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18364. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18365. * It might on the other hand introduce peter panning.
  18366. */
  18367. forceBackFacesOnly: boolean;
  18368. protected _scene: Scene;
  18369. protected _lightDirection: Vector3;
  18370. protected _effect: Effect;
  18371. protected _viewMatrix: Matrix;
  18372. protected _projectionMatrix: Matrix;
  18373. protected _transformMatrix: Matrix;
  18374. protected _cachedPosition: Vector3;
  18375. protected _cachedDirection: Vector3;
  18376. protected _cachedDefines: string;
  18377. protected _currentRenderID: number;
  18378. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18380. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18381. protected _blurPostProcesses: PostProcess[];
  18382. protected _mapSize: number;
  18383. protected _currentFaceIndex: number;
  18384. protected _currentFaceIndexCache: number;
  18385. protected _textureType: number;
  18386. protected _defaultTextureMatrix: Matrix;
  18387. protected _storedUniqueId: Nullable<number>;
  18388. /** @hidden */
  18389. static _SceneComponentInitialization: (scene: Scene) => void;
  18390. /**
  18391. * Creates a ShadowGenerator object.
  18392. * A ShadowGenerator is the required tool to use the shadows.
  18393. * Each light casting shadows needs to use its own ShadowGenerator.
  18394. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18395. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18396. * @param light The light object generating the shadows.
  18397. * @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.
  18398. */
  18399. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18400. protected _initializeGenerator(): void;
  18401. protected _createTargetRenderTexture(): void;
  18402. protected _initializeShadowMap(): void;
  18403. protected _initializeBlurRTTAndPostProcesses(): void;
  18404. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18405. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18406. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18407. protected _applyFilterValues(): void;
  18408. /**
  18409. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18410. * @param onCompiled Callback triggered at the and of the effects compilation
  18411. * @param options Sets of optional options forcing the compilation with different modes
  18412. */
  18413. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18414. useInstances: boolean;
  18415. }>): void;
  18416. /**
  18417. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18418. * @param options Sets of optional options forcing the compilation with different modes
  18419. * @returns A promise that resolves when the compilation completes
  18420. */
  18421. forceCompilationAsync(options?: Partial<{
  18422. useInstances: boolean;
  18423. }>): Promise<void>;
  18424. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18425. private _prepareShadowDefines;
  18426. /**
  18427. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18428. * @param subMesh The submesh we want to render in the shadow map
  18429. * @param useInstances Defines wether will draw in the map using instances
  18430. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18431. * @returns true if ready otherwise, false
  18432. */
  18433. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18434. /**
  18435. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18436. * @param defines Defines of the material we want to update
  18437. * @param lightIndex Index of the light in the enabled light list of the material
  18438. */
  18439. prepareDefines(defines: any, lightIndex: number): void;
  18440. /**
  18441. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18442. * defined in the generator but impacting the effect).
  18443. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18444. * @param effect The effect we are binfing the information for
  18445. */
  18446. bindShadowLight(lightIndex: string, effect: Effect): void;
  18447. /**
  18448. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18449. * (eq to shadow prjection matrix * light transform matrix)
  18450. * @returns The transform matrix used to create the shadow map
  18451. */
  18452. getTransformMatrix(): Matrix;
  18453. /**
  18454. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18455. * Cube and 2D textures for instance.
  18456. */
  18457. recreateShadowMap(): void;
  18458. protected _disposeBlurPostProcesses(): void;
  18459. protected _disposeRTTandPostProcesses(): void;
  18460. /**
  18461. * Disposes the ShadowGenerator.
  18462. * Returns nothing.
  18463. */
  18464. dispose(): void;
  18465. /**
  18466. * Serializes the shadow generator setup to a json object.
  18467. * @returns The serialized JSON object
  18468. */
  18469. serialize(): any;
  18470. /**
  18471. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18472. * @param parsedShadowGenerator The JSON object to parse
  18473. * @param scene The scene to create the shadow map for
  18474. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18475. * @returns The parsed shadow generator
  18476. */
  18477. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18478. }
  18479. }
  18480. declare module "babylonjs/Lights/light" {
  18481. import { Nullable } from "babylonjs/types";
  18482. import { Scene } from "babylonjs/scene";
  18483. import { Vector3 } from "babylonjs/Maths/math.vector";
  18484. import { Color3 } from "babylonjs/Maths/math.color";
  18485. import { Node } from "babylonjs/node";
  18486. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18487. import { Effect } from "babylonjs/Materials/effect";
  18488. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18489. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18490. /**
  18491. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18492. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18493. * 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.
  18494. */
  18495. export abstract class Light extends Node {
  18496. /**
  18497. * Falloff Default: light is falling off following the material specification:
  18498. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18499. */
  18500. static readonly FALLOFF_DEFAULT: number;
  18501. /**
  18502. * Falloff Physical: light is falling off following the inverse squared distance law.
  18503. */
  18504. static readonly FALLOFF_PHYSICAL: number;
  18505. /**
  18506. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18507. * to enhance interoperability with other engines.
  18508. */
  18509. static readonly FALLOFF_GLTF: number;
  18510. /**
  18511. * Falloff Standard: light is falling off like in the standard material
  18512. * to enhance interoperability with other materials.
  18513. */
  18514. static readonly FALLOFF_STANDARD: number;
  18515. /**
  18516. * If every light affecting the material is in this lightmapMode,
  18517. * material.lightmapTexture adds or multiplies
  18518. * (depends on material.useLightmapAsShadowmap)
  18519. * after every other light calculations.
  18520. */
  18521. static readonly LIGHTMAP_DEFAULT: number;
  18522. /**
  18523. * material.lightmapTexture as only diffuse lighting from this light
  18524. * adds only specular lighting from this light
  18525. * adds dynamic shadows
  18526. */
  18527. static readonly LIGHTMAP_SPECULAR: number;
  18528. /**
  18529. * material.lightmapTexture as only lighting
  18530. * no light calculation from this light
  18531. * only adds dynamic shadows from this light
  18532. */
  18533. static readonly LIGHTMAP_SHADOWSONLY: number;
  18534. /**
  18535. * Each light type uses the default quantity according to its type:
  18536. * point/spot lights use luminous intensity
  18537. * directional lights use illuminance
  18538. */
  18539. static readonly INTENSITYMODE_AUTOMATIC: number;
  18540. /**
  18541. * lumen (lm)
  18542. */
  18543. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18544. /**
  18545. * candela (lm/sr)
  18546. */
  18547. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18548. /**
  18549. * lux (lm/m^2)
  18550. */
  18551. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18552. /**
  18553. * nit (cd/m^2)
  18554. */
  18555. static readonly INTENSITYMODE_LUMINANCE: number;
  18556. /**
  18557. * Light type const id of the point light.
  18558. */
  18559. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18560. /**
  18561. * Light type const id of the directional light.
  18562. */
  18563. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18564. /**
  18565. * Light type const id of the spot light.
  18566. */
  18567. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18568. /**
  18569. * Light type const id of the hemispheric light.
  18570. */
  18571. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18572. /**
  18573. * Diffuse gives the basic color to an object.
  18574. */
  18575. diffuse: Color3;
  18576. /**
  18577. * Specular produces a highlight color on an object.
  18578. * Note: This is note affecting PBR materials.
  18579. */
  18580. specular: Color3;
  18581. /**
  18582. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18583. * falling off base on range or angle.
  18584. * This can be set to any values in Light.FALLOFF_x.
  18585. *
  18586. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18587. * other types of materials.
  18588. */
  18589. falloffType: number;
  18590. /**
  18591. * Strength of the light.
  18592. * Note: By default it is define in the framework own unit.
  18593. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18594. */
  18595. intensity: number;
  18596. private _range;
  18597. protected _inverseSquaredRange: number;
  18598. /**
  18599. * Defines how far from the source the light is impacting in scene units.
  18600. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18601. */
  18602. get range(): number;
  18603. /**
  18604. * Defines how far from the source the light is impacting in scene units.
  18605. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18606. */
  18607. set range(value: number);
  18608. /**
  18609. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18610. * of light.
  18611. */
  18612. private _photometricScale;
  18613. private _intensityMode;
  18614. /**
  18615. * Gets the photometric scale used to interpret the intensity.
  18616. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18617. */
  18618. get intensityMode(): number;
  18619. /**
  18620. * Sets the photometric scale used to interpret the intensity.
  18621. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18622. */
  18623. set intensityMode(value: number);
  18624. private _radius;
  18625. /**
  18626. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18627. */
  18628. get radius(): number;
  18629. /**
  18630. * sets the light radius used by PBR Materials to simulate soft area lights.
  18631. */
  18632. set radius(value: number);
  18633. private _renderPriority;
  18634. /**
  18635. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18636. * exceeding the number allowed of the materials.
  18637. */
  18638. renderPriority: number;
  18639. private _shadowEnabled;
  18640. /**
  18641. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18642. * the current shadow generator.
  18643. */
  18644. get shadowEnabled(): boolean;
  18645. /**
  18646. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18647. * the current shadow generator.
  18648. */
  18649. set shadowEnabled(value: boolean);
  18650. private _includedOnlyMeshes;
  18651. /**
  18652. * Gets the only meshes impacted by this light.
  18653. */
  18654. get includedOnlyMeshes(): AbstractMesh[];
  18655. /**
  18656. * Sets the only meshes impacted by this light.
  18657. */
  18658. set includedOnlyMeshes(value: AbstractMesh[]);
  18659. private _excludedMeshes;
  18660. /**
  18661. * Gets the meshes not impacted by this light.
  18662. */
  18663. get excludedMeshes(): AbstractMesh[];
  18664. /**
  18665. * Sets the meshes not impacted by this light.
  18666. */
  18667. set excludedMeshes(value: AbstractMesh[]);
  18668. private _excludeWithLayerMask;
  18669. /**
  18670. * Gets the layer id use to find what meshes are not impacted by the light.
  18671. * Inactive if 0
  18672. */
  18673. get excludeWithLayerMask(): number;
  18674. /**
  18675. * Sets the layer id use to find what meshes are not impacted by the light.
  18676. * Inactive if 0
  18677. */
  18678. set excludeWithLayerMask(value: number);
  18679. private _includeOnlyWithLayerMask;
  18680. /**
  18681. * Gets the layer id use to find what meshes are impacted by the light.
  18682. * Inactive if 0
  18683. */
  18684. get includeOnlyWithLayerMask(): number;
  18685. /**
  18686. * Sets the layer id use to find what meshes are impacted by the light.
  18687. * Inactive if 0
  18688. */
  18689. set includeOnlyWithLayerMask(value: number);
  18690. private _lightmapMode;
  18691. /**
  18692. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18693. */
  18694. get lightmapMode(): number;
  18695. /**
  18696. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18697. */
  18698. set lightmapMode(value: number);
  18699. /**
  18700. * Shadow generator associted to the light.
  18701. * @hidden Internal use only.
  18702. */
  18703. _shadowGenerator: Nullable<IShadowGenerator>;
  18704. /**
  18705. * @hidden Internal use only.
  18706. */
  18707. _excludedMeshesIds: string[];
  18708. /**
  18709. * @hidden Internal use only.
  18710. */
  18711. _includedOnlyMeshesIds: string[];
  18712. /**
  18713. * The current light unifom buffer.
  18714. * @hidden Internal use only.
  18715. */
  18716. _uniformBuffer: UniformBuffer;
  18717. /** @hidden */
  18718. _renderId: number;
  18719. /**
  18720. * Creates a Light object in the scene.
  18721. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18722. * @param name The firendly name of the light
  18723. * @param scene The scene the light belongs too
  18724. */
  18725. constructor(name: string, scene: Scene);
  18726. protected abstract _buildUniformLayout(): void;
  18727. /**
  18728. * Sets the passed Effect "effect" with the Light information.
  18729. * @param effect The effect to update
  18730. * @param lightIndex The index of the light in the effect to update
  18731. * @returns The light
  18732. */
  18733. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18734. /**
  18735. * Sets the passed Effect "effect" with the Light textures.
  18736. * @param effect The effect to update
  18737. * @param lightIndex The index of the light in the effect to update
  18738. * @returns The light
  18739. */
  18740. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18741. /**
  18742. * Binds the lights information from the scene to the effect for the given mesh.
  18743. * @param lightIndex Light index
  18744. * @param scene The scene where the light belongs to
  18745. * @param effect The effect we are binding the data to
  18746. * @param useSpecular Defines if specular is supported
  18747. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18748. */
  18749. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18750. /**
  18751. * Sets the passed Effect "effect" with the Light information.
  18752. * @param effect The effect to update
  18753. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18754. * @returns The light
  18755. */
  18756. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18757. /**
  18758. * Returns the string "Light".
  18759. * @returns the class name
  18760. */
  18761. getClassName(): string;
  18762. /** @hidden */
  18763. readonly _isLight: boolean;
  18764. /**
  18765. * Converts the light information to a readable string for debug purpose.
  18766. * @param fullDetails Supports for multiple levels of logging within scene loading
  18767. * @returns the human readable light info
  18768. */
  18769. toString(fullDetails?: boolean): string;
  18770. /** @hidden */
  18771. protected _syncParentEnabledState(): void;
  18772. /**
  18773. * Set the enabled state of this node.
  18774. * @param value - the new enabled state
  18775. */
  18776. setEnabled(value: boolean): void;
  18777. /**
  18778. * Returns the Light associated shadow generator if any.
  18779. * @return the associated shadow generator.
  18780. */
  18781. getShadowGenerator(): Nullable<IShadowGenerator>;
  18782. /**
  18783. * Returns a Vector3, the absolute light position in the World.
  18784. * @returns the world space position of the light
  18785. */
  18786. getAbsolutePosition(): Vector3;
  18787. /**
  18788. * Specifies if the light will affect the passed mesh.
  18789. * @param mesh The mesh to test against the light
  18790. * @return true the mesh is affected otherwise, false.
  18791. */
  18792. canAffectMesh(mesh: AbstractMesh): boolean;
  18793. /**
  18794. * Sort function to order lights for rendering.
  18795. * @param a First Light object to compare to second.
  18796. * @param b Second Light object to compare first.
  18797. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18798. */
  18799. static CompareLightsPriority(a: Light, b: Light): number;
  18800. /**
  18801. * Releases resources associated with this node.
  18802. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18803. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18804. */
  18805. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18806. /**
  18807. * Returns the light type ID (integer).
  18808. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18809. */
  18810. getTypeID(): number;
  18811. /**
  18812. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18813. * @returns the scaled intensity in intensity mode unit
  18814. */
  18815. getScaledIntensity(): number;
  18816. /**
  18817. * Returns a new Light object, named "name", from the current one.
  18818. * @param name The name of the cloned light
  18819. * @param newParent The parent of this light, if it has one
  18820. * @returns the new created light
  18821. */
  18822. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18823. /**
  18824. * Serializes the current light into a Serialization object.
  18825. * @returns the serialized object.
  18826. */
  18827. serialize(): any;
  18828. /**
  18829. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18830. * This new light is named "name" and added to the passed scene.
  18831. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18832. * @param name The friendly name of the light
  18833. * @param scene The scene the new light will belong to
  18834. * @returns the constructor function
  18835. */
  18836. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18837. /**
  18838. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18839. * @param parsedLight The JSON representation of the light
  18840. * @param scene The scene to create the parsed light in
  18841. * @returns the created light after parsing
  18842. */
  18843. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18844. private _hookArrayForExcluded;
  18845. private _hookArrayForIncludedOnly;
  18846. private _resyncMeshes;
  18847. /**
  18848. * Forces the meshes to update their light related information in their rendering used effects
  18849. * @hidden Internal Use Only
  18850. */
  18851. _markMeshesAsLightDirty(): void;
  18852. /**
  18853. * Recomputes the cached photometric scale if needed.
  18854. */
  18855. private _computePhotometricScale;
  18856. /**
  18857. * Returns the Photometric Scale according to the light type and intensity mode.
  18858. */
  18859. private _getPhotometricScale;
  18860. /**
  18861. * Reorder the light in the scene according to their defined priority.
  18862. * @hidden Internal Use Only
  18863. */
  18864. _reorderLightsInScene(): void;
  18865. /**
  18866. * Prepares the list of defines specific to the light type.
  18867. * @param defines the list of defines
  18868. * @param lightIndex defines the index of the light for the effect
  18869. */
  18870. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18871. }
  18872. }
  18873. declare module "babylonjs/Cameras/targetCamera" {
  18874. import { Nullable } from "babylonjs/types";
  18875. import { Camera } from "babylonjs/Cameras/camera";
  18876. import { Scene } from "babylonjs/scene";
  18877. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18878. /**
  18879. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18880. * This is the base of the follow, arc rotate cameras and Free camera
  18881. * @see https://doc.babylonjs.com/features/cameras
  18882. */
  18883. export class TargetCamera extends Camera {
  18884. private static _RigCamTransformMatrix;
  18885. private static _TargetTransformMatrix;
  18886. private static _TargetFocalPoint;
  18887. private _tmpUpVector;
  18888. private _tmpTargetVector;
  18889. /**
  18890. * Define the current direction the camera is moving to
  18891. */
  18892. cameraDirection: Vector3;
  18893. /**
  18894. * Define the current rotation the camera is rotating to
  18895. */
  18896. cameraRotation: Vector2;
  18897. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18898. ignoreParentScaling: boolean;
  18899. /**
  18900. * When set, the up vector of the camera will be updated by the rotation of the camera
  18901. */
  18902. updateUpVectorFromRotation: boolean;
  18903. private _tmpQuaternion;
  18904. /**
  18905. * Define the current rotation of the camera
  18906. */
  18907. rotation: Vector3;
  18908. /**
  18909. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18910. */
  18911. rotationQuaternion: Quaternion;
  18912. /**
  18913. * Define the current speed of the camera
  18914. */
  18915. speed: number;
  18916. /**
  18917. * Add constraint to the camera to prevent it to move freely in all directions and
  18918. * around all axis.
  18919. */
  18920. noRotationConstraint: boolean;
  18921. /**
  18922. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18923. * panning
  18924. */
  18925. invertRotation: boolean;
  18926. /**
  18927. * Speed multiplier for inverse camera panning
  18928. */
  18929. inverseRotationSpeed: number;
  18930. /**
  18931. * Define the current target of the camera as an object or a position.
  18932. */
  18933. lockedTarget: any;
  18934. /** @hidden */
  18935. _currentTarget: Vector3;
  18936. /** @hidden */
  18937. _initialFocalDistance: number;
  18938. /** @hidden */
  18939. _viewMatrix: Matrix;
  18940. /** @hidden */
  18941. _camMatrix: Matrix;
  18942. /** @hidden */
  18943. _cameraTransformMatrix: Matrix;
  18944. /** @hidden */
  18945. _cameraRotationMatrix: Matrix;
  18946. /** @hidden */
  18947. _referencePoint: Vector3;
  18948. /** @hidden */
  18949. _transformedReferencePoint: Vector3;
  18950. /** @hidden */
  18951. _reset: () => void;
  18952. private _defaultUp;
  18953. /**
  18954. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18955. * This is the base of the follow, arc rotate cameras and Free camera
  18956. * @see https://doc.babylonjs.com/features/cameras
  18957. * @param name Defines the name of the camera in the scene
  18958. * @param position Defines the start position of the camera in the scene
  18959. * @param scene Defines the scene the camera belongs to
  18960. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18961. */
  18962. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18963. /**
  18964. * Gets the position in front of the camera at a given distance.
  18965. * @param distance The distance from the camera we want the position to be
  18966. * @returns the position
  18967. */
  18968. getFrontPosition(distance: number): Vector3;
  18969. /** @hidden */
  18970. _getLockedTargetPosition(): Nullable<Vector3>;
  18971. private _storedPosition;
  18972. private _storedRotation;
  18973. private _storedRotationQuaternion;
  18974. /**
  18975. * Store current camera state of the camera (fov, position, rotation, etc..)
  18976. * @returns the camera
  18977. */
  18978. storeState(): Camera;
  18979. /**
  18980. * Restored camera state. You must call storeState() first
  18981. * @returns whether it was successful or not
  18982. * @hidden
  18983. */
  18984. _restoreStateValues(): boolean;
  18985. /** @hidden */
  18986. _initCache(): void;
  18987. /** @hidden */
  18988. _updateCache(ignoreParentClass?: boolean): void;
  18989. /** @hidden */
  18990. _isSynchronizedViewMatrix(): boolean;
  18991. /** @hidden */
  18992. _computeLocalCameraSpeed(): number;
  18993. /**
  18994. * Defines the target the camera should look at.
  18995. * @param target Defines the new target as a Vector or a mesh
  18996. */
  18997. setTarget(target: Vector3): void;
  18998. /**
  18999. * Defines the target point of the camera.
  19000. * The camera looks towards it form the radius distance.
  19001. */
  19002. get target(): Vector3;
  19003. set target(value: Vector3);
  19004. /**
  19005. * Return the current target position of the camera. This value is expressed in local space.
  19006. * @returns the target position
  19007. */
  19008. getTarget(): Vector3;
  19009. /** @hidden */
  19010. _decideIfNeedsToMove(): boolean;
  19011. /** @hidden */
  19012. _updatePosition(): void;
  19013. /** @hidden */
  19014. _checkInputs(): void;
  19015. protected _updateCameraRotationMatrix(): void;
  19016. /**
  19017. * 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)
  19018. * @returns the current camera
  19019. */
  19020. private _rotateUpVectorWithCameraRotationMatrix;
  19021. private _cachedRotationZ;
  19022. private _cachedQuaternionRotationZ;
  19023. /** @hidden */
  19024. _getViewMatrix(): Matrix;
  19025. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19026. /**
  19027. * @hidden
  19028. */
  19029. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19030. /**
  19031. * @hidden
  19032. */
  19033. _updateRigCameras(): void;
  19034. private _getRigCamPositionAndTarget;
  19035. /**
  19036. * Gets the current object class name.
  19037. * @return the class name
  19038. */
  19039. getClassName(): string;
  19040. }
  19041. }
  19042. declare module "babylonjs/Events/keyboardEvents" {
  19043. /**
  19044. * Gather the list of keyboard event types as constants.
  19045. */
  19046. export class KeyboardEventTypes {
  19047. /**
  19048. * The keydown event is fired when a key becomes active (pressed).
  19049. */
  19050. static readonly KEYDOWN: number;
  19051. /**
  19052. * The keyup event is fired when a key has been released.
  19053. */
  19054. static readonly KEYUP: number;
  19055. }
  19056. /**
  19057. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19058. */
  19059. export class KeyboardInfo {
  19060. /**
  19061. * Defines the type of event (KeyboardEventTypes)
  19062. */
  19063. type: number;
  19064. /**
  19065. * Defines the related dom event
  19066. */
  19067. event: KeyboardEvent;
  19068. /**
  19069. * Instantiates a new keyboard info.
  19070. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19071. * @param type Defines the type of event (KeyboardEventTypes)
  19072. * @param event Defines the related dom event
  19073. */
  19074. constructor(
  19075. /**
  19076. * Defines the type of event (KeyboardEventTypes)
  19077. */
  19078. type: number,
  19079. /**
  19080. * Defines the related dom event
  19081. */
  19082. event: KeyboardEvent);
  19083. }
  19084. /**
  19085. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19086. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19087. */
  19088. export class KeyboardInfoPre extends KeyboardInfo {
  19089. /**
  19090. * Defines the type of event (KeyboardEventTypes)
  19091. */
  19092. type: number;
  19093. /**
  19094. * Defines the related dom event
  19095. */
  19096. event: KeyboardEvent;
  19097. /**
  19098. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19099. */
  19100. skipOnPointerObservable: boolean;
  19101. /**
  19102. * Instantiates a new keyboard pre info.
  19103. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19104. * @param type Defines the type of event (KeyboardEventTypes)
  19105. * @param event Defines the related dom event
  19106. */
  19107. constructor(
  19108. /**
  19109. * Defines the type of event (KeyboardEventTypes)
  19110. */
  19111. type: number,
  19112. /**
  19113. * Defines the related dom event
  19114. */
  19115. event: KeyboardEvent);
  19116. }
  19117. }
  19118. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19119. import { Nullable } from "babylonjs/types";
  19120. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19121. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19122. /**
  19123. * Manage the keyboard inputs to control the movement of a free camera.
  19124. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19125. */
  19126. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19127. /**
  19128. * Defines the camera the input is attached to.
  19129. */
  19130. camera: FreeCamera;
  19131. /**
  19132. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19133. */
  19134. keysUp: number[];
  19135. /**
  19136. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19137. */
  19138. keysUpward: number[];
  19139. /**
  19140. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19141. */
  19142. keysDown: number[];
  19143. /**
  19144. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19145. */
  19146. keysDownward: number[];
  19147. /**
  19148. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19149. */
  19150. keysLeft: number[];
  19151. /**
  19152. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19153. */
  19154. keysRight: number[];
  19155. private _keys;
  19156. private _onCanvasBlurObserver;
  19157. private _onKeyboardObserver;
  19158. private _engine;
  19159. private _scene;
  19160. /**
  19161. * Attach the input controls to a specific dom element to get the input from.
  19162. * @param element Defines the element the controls should be listened from
  19163. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19164. */
  19165. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19166. /**
  19167. * Detach the current controls from the specified dom element.
  19168. * @param element Defines the element to stop listening the inputs from
  19169. */
  19170. detachControl(element: Nullable<HTMLElement>): void;
  19171. /**
  19172. * Update the current camera state depending on the inputs that have been used this frame.
  19173. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19174. */
  19175. checkInputs(): void;
  19176. /**
  19177. * Gets the class name of the current intput.
  19178. * @returns the class name
  19179. */
  19180. getClassName(): string;
  19181. /** @hidden */
  19182. _onLostFocus(): void;
  19183. /**
  19184. * Get the friendly name associated with the input class.
  19185. * @returns the input friendly name
  19186. */
  19187. getSimpleName(): string;
  19188. }
  19189. }
  19190. declare module "babylonjs/Events/pointerEvents" {
  19191. import { Nullable } from "babylonjs/types";
  19192. import { Vector2 } from "babylonjs/Maths/math.vector";
  19193. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19194. import { Ray } from "babylonjs/Culling/ray";
  19195. /**
  19196. * Gather the list of pointer event types as constants.
  19197. */
  19198. export class PointerEventTypes {
  19199. /**
  19200. * 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.
  19201. */
  19202. static readonly POINTERDOWN: number;
  19203. /**
  19204. * The pointerup event is fired when a pointer is no longer active.
  19205. */
  19206. static readonly POINTERUP: number;
  19207. /**
  19208. * The pointermove event is fired when a pointer changes coordinates.
  19209. */
  19210. static readonly POINTERMOVE: number;
  19211. /**
  19212. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19213. */
  19214. static readonly POINTERWHEEL: number;
  19215. /**
  19216. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19217. */
  19218. static readonly POINTERPICK: number;
  19219. /**
  19220. * The pointertap event is fired when a the object has been touched and released without drag.
  19221. */
  19222. static readonly POINTERTAP: number;
  19223. /**
  19224. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19225. */
  19226. static readonly POINTERDOUBLETAP: number;
  19227. }
  19228. /**
  19229. * Base class of pointer info types.
  19230. */
  19231. export class PointerInfoBase {
  19232. /**
  19233. * Defines the type of event (PointerEventTypes)
  19234. */
  19235. type: number;
  19236. /**
  19237. * Defines the related dom event
  19238. */
  19239. event: PointerEvent | MouseWheelEvent;
  19240. /**
  19241. * Instantiates the base class of pointers info.
  19242. * @param type Defines the type of event (PointerEventTypes)
  19243. * @param event Defines the related dom event
  19244. */
  19245. constructor(
  19246. /**
  19247. * Defines the type of event (PointerEventTypes)
  19248. */
  19249. type: number,
  19250. /**
  19251. * Defines the related dom event
  19252. */
  19253. event: PointerEvent | MouseWheelEvent);
  19254. }
  19255. /**
  19256. * This class is used to store pointer related info for the onPrePointerObservable event.
  19257. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19258. */
  19259. export class PointerInfoPre extends PointerInfoBase {
  19260. /**
  19261. * Ray from a pointer if availible (eg. 6dof controller)
  19262. */
  19263. ray: Nullable<Ray>;
  19264. /**
  19265. * Defines the local position of the pointer on the canvas.
  19266. */
  19267. localPosition: Vector2;
  19268. /**
  19269. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19270. */
  19271. skipOnPointerObservable: boolean;
  19272. /**
  19273. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19274. * @param type Defines the type of event (PointerEventTypes)
  19275. * @param event Defines the related dom event
  19276. * @param localX Defines the local x coordinates of the pointer when the event occured
  19277. * @param localY Defines the local y coordinates of the pointer when the event occured
  19278. */
  19279. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19280. }
  19281. /**
  19282. * This type contains all the data related to a pointer event in Babylon.js.
  19283. * 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.
  19284. */
  19285. export class PointerInfo extends PointerInfoBase {
  19286. /**
  19287. * Defines the picking info associated to the info (if any)\
  19288. */
  19289. pickInfo: Nullable<PickingInfo>;
  19290. /**
  19291. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19292. * @param type Defines the type of event (PointerEventTypes)
  19293. * @param event Defines the related dom event
  19294. * @param pickInfo Defines the picking info associated to the info (if any)\
  19295. */
  19296. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19297. /**
  19298. * Defines the picking info associated to the info (if any)\
  19299. */
  19300. pickInfo: Nullable<PickingInfo>);
  19301. }
  19302. /**
  19303. * Data relating to a touch event on the screen.
  19304. */
  19305. export interface PointerTouch {
  19306. /**
  19307. * X coordinate of touch.
  19308. */
  19309. x: number;
  19310. /**
  19311. * Y coordinate of touch.
  19312. */
  19313. y: number;
  19314. /**
  19315. * Id of touch. Unique for each finger.
  19316. */
  19317. pointerId: number;
  19318. /**
  19319. * Event type passed from DOM.
  19320. */
  19321. type: any;
  19322. }
  19323. }
  19324. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19325. import { Observable } from "babylonjs/Misc/observable";
  19326. import { Nullable } from "babylonjs/types";
  19327. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19328. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19329. /**
  19330. * Manage the mouse inputs to control the movement of a free camera.
  19331. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19332. */
  19333. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19334. /**
  19335. * Define if touch is enabled in the mouse input
  19336. */
  19337. touchEnabled: boolean;
  19338. /**
  19339. * Defines the camera the input is attached to.
  19340. */
  19341. camera: FreeCamera;
  19342. /**
  19343. * Defines the buttons associated with the input to handle camera move.
  19344. */
  19345. buttons: number[];
  19346. /**
  19347. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19348. */
  19349. angularSensibility: number;
  19350. private _pointerInput;
  19351. private _onMouseMove;
  19352. private _observer;
  19353. private previousPosition;
  19354. /**
  19355. * Observable for when a pointer move event occurs containing the move offset
  19356. */
  19357. onPointerMovedObservable: Observable<{
  19358. offsetX: number;
  19359. offsetY: number;
  19360. }>;
  19361. /**
  19362. * @hidden
  19363. * If the camera should be rotated automatically based on pointer movement
  19364. */
  19365. _allowCameraRotation: boolean;
  19366. /**
  19367. * Manage the mouse inputs to control the movement of a free camera.
  19368. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19369. * @param touchEnabled Defines if touch is enabled or not
  19370. */
  19371. constructor(
  19372. /**
  19373. * Define if touch is enabled in the mouse input
  19374. */
  19375. touchEnabled?: boolean);
  19376. /**
  19377. * Attach the input controls to a specific dom element to get the input from.
  19378. * @param element Defines the element the controls should be listened from
  19379. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19380. */
  19381. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19382. /**
  19383. * Called on JS contextmenu event.
  19384. * Override this method to provide functionality.
  19385. */
  19386. protected onContextMenu(evt: PointerEvent): void;
  19387. /**
  19388. * Detach the current controls from the specified dom element.
  19389. * @param element Defines the element to stop listening the inputs from
  19390. */
  19391. detachControl(element: Nullable<HTMLElement>): void;
  19392. /**
  19393. * Gets the class name of the current intput.
  19394. * @returns the class name
  19395. */
  19396. getClassName(): string;
  19397. /**
  19398. * Get the friendly name associated with the input class.
  19399. * @returns the input friendly name
  19400. */
  19401. getSimpleName(): string;
  19402. }
  19403. }
  19404. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19405. import { Nullable } from "babylonjs/types";
  19406. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19407. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19408. /**
  19409. * Manage the touch inputs to control the movement of a free camera.
  19410. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19411. */
  19412. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19413. /**
  19414. * Define if mouse events can be treated as touch events
  19415. */
  19416. allowMouse: boolean;
  19417. /**
  19418. * Defines the camera the input is attached to.
  19419. */
  19420. camera: FreeCamera;
  19421. /**
  19422. * Defines the touch sensibility for rotation.
  19423. * The higher the faster.
  19424. */
  19425. touchAngularSensibility: number;
  19426. /**
  19427. * Defines the touch sensibility for move.
  19428. * The higher the faster.
  19429. */
  19430. touchMoveSensibility: number;
  19431. private _offsetX;
  19432. private _offsetY;
  19433. private _pointerPressed;
  19434. private _pointerInput;
  19435. private _observer;
  19436. private _onLostFocus;
  19437. /**
  19438. * Manage the touch inputs to control the movement of a free camera.
  19439. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19440. * @param allowMouse Defines if mouse events can be treated as touch events
  19441. */
  19442. constructor(
  19443. /**
  19444. * Define if mouse events can be treated as touch events
  19445. */
  19446. allowMouse?: boolean);
  19447. /**
  19448. * Attach the input controls to a specific dom element to get the input from.
  19449. * @param element Defines the element the controls should be listened from
  19450. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19451. */
  19452. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19453. /**
  19454. * Detach the current controls from the specified dom element.
  19455. * @param element Defines the element to stop listening the inputs from
  19456. */
  19457. detachControl(element: Nullable<HTMLElement>): void;
  19458. /**
  19459. * Update the current camera state depending on the inputs that have been used this frame.
  19460. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19461. */
  19462. checkInputs(): void;
  19463. /**
  19464. * Gets the class name of the current intput.
  19465. * @returns the class name
  19466. */
  19467. getClassName(): string;
  19468. /**
  19469. * Get the friendly name associated with the input class.
  19470. * @returns the input friendly name
  19471. */
  19472. getSimpleName(): string;
  19473. }
  19474. }
  19475. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19477. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19478. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19479. import { Nullable } from "babylonjs/types";
  19480. /**
  19481. * Default Inputs manager for the FreeCamera.
  19482. * It groups all the default supported inputs for ease of use.
  19483. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19484. */
  19485. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19486. /**
  19487. * @hidden
  19488. */
  19489. _mouseInput: Nullable<FreeCameraMouseInput>;
  19490. /**
  19491. * Instantiates a new FreeCameraInputsManager.
  19492. * @param camera Defines the camera the inputs belong to
  19493. */
  19494. constructor(camera: FreeCamera);
  19495. /**
  19496. * Add keyboard input support to the input manager.
  19497. * @returns the current input manager
  19498. */
  19499. addKeyboard(): FreeCameraInputsManager;
  19500. /**
  19501. * Add mouse input support to the input manager.
  19502. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19503. * @returns the current input manager
  19504. */
  19505. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19506. /**
  19507. * Removes the mouse input support from the manager
  19508. * @returns the current input manager
  19509. */
  19510. removeMouse(): FreeCameraInputsManager;
  19511. /**
  19512. * Add touch input support to the input manager.
  19513. * @returns the current input manager
  19514. */
  19515. addTouch(): FreeCameraInputsManager;
  19516. /**
  19517. * Remove all attached input methods from a camera
  19518. */
  19519. clear(): void;
  19520. }
  19521. }
  19522. declare module "babylonjs/Cameras/freeCamera" {
  19523. import { Vector3 } from "babylonjs/Maths/math.vector";
  19524. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19525. import { Scene } from "babylonjs/scene";
  19526. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19527. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19528. /**
  19529. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19530. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19531. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19532. */
  19533. export class FreeCamera extends TargetCamera {
  19534. /**
  19535. * Define the collision ellipsoid of the camera.
  19536. * This is helpful to simulate a camera body like the player body around the camera
  19537. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19538. */
  19539. ellipsoid: Vector3;
  19540. /**
  19541. * Define an offset for the position of the ellipsoid around the camera.
  19542. * This can be helpful to determine the center of the body near the gravity center of the body
  19543. * instead of its head.
  19544. */
  19545. ellipsoidOffset: Vector3;
  19546. /**
  19547. * Enable or disable collisions of the camera with the rest of the scene objects.
  19548. */
  19549. checkCollisions: boolean;
  19550. /**
  19551. * Enable or disable gravity on the camera.
  19552. */
  19553. applyGravity: boolean;
  19554. /**
  19555. * Define the input manager associated to the camera.
  19556. */
  19557. inputs: FreeCameraInputsManager;
  19558. /**
  19559. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19560. * Higher values reduce sensitivity.
  19561. */
  19562. get angularSensibility(): number;
  19563. /**
  19564. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19565. * Higher values reduce sensitivity.
  19566. */
  19567. set angularSensibility(value: number);
  19568. /**
  19569. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19570. */
  19571. get keysUp(): number[];
  19572. set keysUp(value: number[]);
  19573. /**
  19574. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19575. */
  19576. get keysUpward(): number[];
  19577. set keysUpward(value: number[]);
  19578. /**
  19579. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19580. */
  19581. get keysDown(): number[];
  19582. set keysDown(value: number[]);
  19583. /**
  19584. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19585. */
  19586. get keysDownward(): number[];
  19587. set keysDownward(value: number[]);
  19588. /**
  19589. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19590. */
  19591. get keysLeft(): number[];
  19592. set keysLeft(value: number[]);
  19593. /**
  19594. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19595. */
  19596. get keysRight(): number[];
  19597. set keysRight(value: number[]);
  19598. /**
  19599. * Event raised when the camera collide with a mesh in the scene.
  19600. */
  19601. onCollide: (collidedMesh: AbstractMesh) => void;
  19602. private _collider;
  19603. private _needMoveForGravity;
  19604. private _oldPosition;
  19605. private _diffPosition;
  19606. private _newPosition;
  19607. /** @hidden */
  19608. _localDirection: Vector3;
  19609. /** @hidden */
  19610. _transformedDirection: Vector3;
  19611. /**
  19612. * Instantiates a Free Camera.
  19613. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19614. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19615. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19616. * @param name Define the name of the camera in the scene
  19617. * @param position Define the start position of the camera in the scene
  19618. * @param scene Define the scene the camera belongs to
  19619. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19620. */
  19621. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19622. /**
  19623. * Attached controls to the current camera.
  19624. * @param element Defines the element the controls should be listened from
  19625. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19626. */
  19627. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19628. /**
  19629. * Detach the current controls from the camera.
  19630. * The camera will stop reacting to inputs.
  19631. * @param element Defines the element to stop listening the inputs from
  19632. */
  19633. detachControl(element: HTMLElement): void;
  19634. private _collisionMask;
  19635. /**
  19636. * Define a collision mask to limit the list of object the camera can collide with
  19637. */
  19638. get collisionMask(): number;
  19639. set collisionMask(mask: number);
  19640. /** @hidden */
  19641. _collideWithWorld(displacement: Vector3): void;
  19642. private _onCollisionPositionChange;
  19643. /** @hidden */
  19644. _checkInputs(): void;
  19645. /** @hidden */
  19646. _decideIfNeedsToMove(): boolean;
  19647. /** @hidden */
  19648. _updatePosition(): void;
  19649. /**
  19650. * Destroy the camera and release the current resources hold by it.
  19651. */
  19652. dispose(): void;
  19653. /**
  19654. * Gets the current object class name.
  19655. * @return the class name
  19656. */
  19657. getClassName(): string;
  19658. }
  19659. }
  19660. declare module "babylonjs/Gamepads/gamepad" {
  19661. import { Observable } from "babylonjs/Misc/observable";
  19662. /**
  19663. * Represents a gamepad control stick position
  19664. */
  19665. export class StickValues {
  19666. /**
  19667. * The x component of the control stick
  19668. */
  19669. x: number;
  19670. /**
  19671. * The y component of the control stick
  19672. */
  19673. y: number;
  19674. /**
  19675. * Initializes the gamepad x and y control stick values
  19676. * @param x The x component of the gamepad control stick value
  19677. * @param y The y component of the gamepad control stick value
  19678. */
  19679. constructor(
  19680. /**
  19681. * The x component of the control stick
  19682. */
  19683. x: number,
  19684. /**
  19685. * The y component of the control stick
  19686. */
  19687. y: number);
  19688. }
  19689. /**
  19690. * An interface which manages callbacks for gamepad button changes
  19691. */
  19692. export interface GamepadButtonChanges {
  19693. /**
  19694. * Called when a gamepad has been changed
  19695. */
  19696. changed: boolean;
  19697. /**
  19698. * Called when a gamepad press event has been triggered
  19699. */
  19700. pressChanged: boolean;
  19701. /**
  19702. * Called when a touch event has been triggered
  19703. */
  19704. touchChanged: boolean;
  19705. /**
  19706. * Called when a value has changed
  19707. */
  19708. valueChanged: boolean;
  19709. }
  19710. /**
  19711. * Represents a gamepad
  19712. */
  19713. export class Gamepad {
  19714. /**
  19715. * The id of the gamepad
  19716. */
  19717. id: string;
  19718. /**
  19719. * The index of the gamepad
  19720. */
  19721. index: number;
  19722. /**
  19723. * The browser gamepad
  19724. */
  19725. browserGamepad: any;
  19726. /**
  19727. * Specifies what type of gamepad this represents
  19728. */
  19729. type: number;
  19730. private _leftStick;
  19731. private _rightStick;
  19732. /** @hidden */
  19733. _isConnected: boolean;
  19734. private _leftStickAxisX;
  19735. private _leftStickAxisY;
  19736. private _rightStickAxisX;
  19737. private _rightStickAxisY;
  19738. /**
  19739. * Triggered when the left control stick has been changed
  19740. */
  19741. private _onleftstickchanged;
  19742. /**
  19743. * Triggered when the right control stick has been changed
  19744. */
  19745. private _onrightstickchanged;
  19746. /**
  19747. * Represents a gamepad controller
  19748. */
  19749. static GAMEPAD: number;
  19750. /**
  19751. * Represents a generic controller
  19752. */
  19753. static GENERIC: number;
  19754. /**
  19755. * Represents an XBox controller
  19756. */
  19757. static XBOX: number;
  19758. /**
  19759. * Represents a pose-enabled controller
  19760. */
  19761. static POSE_ENABLED: number;
  19762. /**
  19763. * Represents an Dual Shock controller
  19764. */
  19765. static DUALSHOCK: number;
  19766. /**
  19767. * Specifies whether the left control stick should be Y-inverted
  19768. */
  19769. protected _invertLeftStickY: boolean;
  19770. /**
  19771. * Specifies if the gamepad has been connected
  19772. */
  19773. get isConnected(): boolean;
  19774. /**
  19775. * Initializes the gamepad
  19776. * @param id The id of the gamepad
  19777. * @param index The index of the gamepad
  19778. * @param browserGamepad The browser gamepad
  19779. * @param leftStickX The x component of the left joystick
  19780. * @param leftStickY The y component of the left joystick
  19781. * @param rightStickX The x component of the right joystick
  19782. * @param rightStickY The y component of the right joystick
  19783. */
  19784. constructor(
  19785. /**
  19786. * The id of the gamepad
  19787. */
  19788. id: string,
  19789. /**
  19790. * The index of the gamepad
  19791. */
  19792. index: number,
  19793. /**
  19794. * The browser gamepad
  19795. */
  19796. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19797. /**
  19798. * Callback triggered when the left joystick has changed
  19799. * @param callback
  19800. */
  19801. onleftstickchanged(callback: (values: StickValues) => void): void;
  19802. /**
  19803. * Callback triggered when the right joystick has changed
  19804. * @param callback
  19805. */
  19806. onrightstickchanged(callback: (values: StickValues) => void): void;
  19807. /**
  19808. * Gets the left joystick
  19809. */
  19810. get leftStick(): StickValues;
  19811. /**
  19812. * Sets the left joystick values
  19813. */
  19814. set leftStick(newValues: StickValues);
  19815. /**
  19816. * Gets the right joystick
  19817. */
  19818. get rightStick(): StickValues;
  19819. /**
  19820. * Sets the right joystick value
  19821. */
  19822. set rightStick(newValues: StickValues);
  19823. /**
  19824. * Updates the gamepad joystick positions
  19825. */
  19826. update(): void;
  19827. /**
  19828. * Disposes the gamepad
  19829. */
  19830. dispose(): void;
  19831. }
  19832. /**
  19833. * Represents a generic gamepad
  19834. */
  19835. export class GenericPad extends Gamepad {
  19836. private _buttons;
  19837. private _onbuttondown;
  19838. private _onbuttonup;
  19839. /**
  19840. * Observable triggered when a button has been pressed
  19841. */
  19842. onButtonDownObservable: Observable<number>;
  19843. /**
  19844. * Observable triggered when a button has been released
  19845. */
  19846. onButtonUpObservable: Observable<number>;
  19847. /**
  19848. * Callback triggered when a button has been pressed
  19849. * @param callback Called when a button has been pressed
  19850. */
  19851. onbuttondown(callback: (buttonPressed: number) => void): void;
  19852. /**
  19853. * Callback triggered when a button has been released
  19854. * @param callback Called when a button has been released
  19855. */
  19856. onbuttonup(callback: (buttonReleased: number) => void): void;
  19857. /**
  19858. * Initializes the generic gamepad
  19859. * @param id The id of the generic gamepad
  19860. * @param index The index of the generic gamepad
  19861. * @param browserGamepad The browser gamepad
  19862. */
  19863. constructor(id: string, index: number, browserGamepad: any);
  19864. private _setButtonValue;
  19865. /**
  19866. * Updates the generic gamepad
  19867. */
  19868. update(): void;
  19869. /**
  19870. * Disposes the generic gamepad
  19871. */
  19872. dispose(): void;
  19873. }
  19874. }
  19875. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19876. import { Observable } from "babylonjs/Misc/observable";
  19877. import { Nullable } from "babylonjs/types";
  19878. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19879. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19880. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19881. import { Ray } from "babylonjs/Culling/ray";
  19882. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19883. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19884. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19885. /**
  19886. * Defines the types of pose enabled controllers that are supported
  19887. */
  19888. export enum PoseEnabledControllerType {
  19889. /**
  19890. * HTC Vive
  19891. */
  19892. VIVE = 0,
  19893. /**
  19894. * Oculus Rift
  19895. */
  19896. OCULUS = 1,
  19897. /**
  19898. * Windows mixed reality
  19899. */
  19900. WINDOWS = 2,
  19901. /**
  19902. * Samsung gear VR
  19903. */
  19904. GEAR_VR = 3,
  19905. /**
  19906. * Google Daydream
  19907. */
  19908. DAYDREAM = 4,
  19909. /**
  19910. * Generic
  19911. */
  19912. GENERIC = 5
  19913. }
  19914. /**
  19915. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19916. */
  19917. export interface MutableGamepadButton {
  19918. /**
  19919. * Value of the button/trigger
  19920. */
  19921. value: number;
  19922. /**
  19923. * If the button/trigger is currently touched
  19924. */
  19925. touched: boolean;
  19926. /**
  19927. * If the button/trigger is currently pressed
  19928. */
  19929. pressed: boolean;
  19930. }
  19931. /**
  19932. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19933. * @hidden
  19934. */
  19935. export interface ExtendedGamepadButton extends GamepadButton {
  19936. /**
  19937. * If the button/trigger is currently pressed
  19938. */
  19939. readonly pressed: boolean;
  19940. /**
  19941. * If the button/trigger is currently touched
  19942. */
  19943. readonly touched: boolean;
  19944. /**
  19945. * Value of the button/trigger
  19946. */
  19947. readonly value: number;
  19948. }
  19949. /** @hidden */
  19950. export interface _GamePadFactory {
  19951. /**
  19952. * Returns whether or not the current gamepad can be created for this type of controller.
  19953. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19954. * @returns true if it can be created, otherwise false
  19955. */
  19956. canCreate(gamepadInfo: any): boolean;
  19957. /**
  19958. * Creates a new instance of the Gamepad.
  19959. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19960. * @returns the new gamepad instance
  19961. */
  19962. create(gamepadInfo: any): Gamepad;
  19963. }
  19964. /**
  19965. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19966. */
  19967. export class PoseEnabledControllerHelper {
  19968. /** @hidden */
  19969. static _ControllerFactories: _GamePadFactory[];
  19970. /** @hidden */
  19971. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19972. /**
  19973. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19974. * @param vrGamepad the gamepad to initialized
  19975. * @returns a vr controller of the type the gamepad identified as
  19976. */
  19977. static InitiateController(vrGamepad: any): Gamepad;
  19978. }
  19979. /**
  19980. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19981. */
  19982. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19983. /**
  19984. * If the controller is used in a webXR session
  19985. */
  19986. isXR: boolean;
  19987. private _deviceRoomPosition;
  19988. private _deviceRoomRotationQuaternion;
  19989. /**
  19990. * The device position in babylon space
  19991. */
  19992. devicePosition: Vector3;
  19993. /**
  19994. * The device rotation in babylon space
  19995. */
  19996. deviceRotationQuaternion: Quaternion;
  19997. /**
  19998. * The scale factor of the device in babylon space
  19999. */
  20000. deviceScaleFactor: number;
  20001. /**
  20002. * (Likely devicePosition should be used instead) The device position in its room space
  20003. */
  20004. position: Vector3;
  20005. /**
  20006. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20007. */
  20008. rotationQuaternion: Quaternion;
  20009. /**
  20010. * The type of controller (Eg. Windows mixed reality)
  20011. */
  20012. controllerType: PoseEnabledControllerType;
  20013. protected _calculatedPosition: Vector3;
  20014. private _calculatedRotation;
  20015. /**
  20016. * The raw pose from the device
  20017. */
  20018. rawPose: DevicePose;
  20019. private _trackPosition;
  20020. private _maxRotationDistFromHeadset;
  20021. private _draggedRoomRotation;
  20022. /**
  20023. * @hidden
  20024. */
  20025. _disableTrackPosition(fixedPosition: Vector3): void;
  20026. /**
  20027. * Internal, the mesh attached to the controller
  20028. * @hidden
  20029. */
  20030. _mesh: Nullable<AbstractMesh>;
  20031. private _poseControlledCamera;
  20032. private _leftHandSystemQuaternion;
  20033. /**
  20034. * Internal, matrix used to convert room space to babylon space
  20035. * @hidden
  20036. */
  20037. _deviceToWorld: Matrix;
  20038. /**
  20039. * Node to be used when casting a ray from the controller
  20040. * @hidden
  20041. */
  20042. _pointingPoseNode: Nullable<TransformNode>;
  20043. /**
  20044. * Name of the child mesh that can be used to cast a ray from the controller
  20045. */
  20046. static readonly POINTING_POSE: string;
  20047. /**
  20048. * Creates a new PoseEnabledController from a gamepad
  20049. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20050. */
  20051. constructor(browserGamepad: any);
  20052. private _workingMatrix;
  20053. /**
  20054. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20055. */
  20056. update(): void;
  20057. /**
  20058. * Updates only the pose device and mesh without doing any button event checking
  20059. */
  20060. protected _updatePoseAndMesh(): void;
  20061. /**
  20062. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20063. * @param poseData raw pose fromthe device
  20064. */
  20065. updateFromDevice(poseData: DevicePose): void;
  20066. /**
  20067. * @hidden
  20068. */
  20069. _meshAttachedObservable: Observable<AbstractMesh>;
  20070. /**
  20071. * Attaches a mesh to the controller
  20072. * @param mesh the mesh to be attached
  20073. */
  20074. attachToMesh(mesh: AbstractMesh): void;
  20075. /**
  20076. * Attaches the controllers mesh to a camera
  20077. * @param camera the camera the mesh should be attached to
  20078. */
  20079. attachToPoseControlledCamera(camera: TargetCamera): void;
  20080. /**
  20081. * Disposes of the controller
  20082. */
  20083. dispose(): void;
  20084. /**
  20085. * The mesh that is attached to the controller
  20086. */
  20087. get mesh(): Nullable<AbstractMesh>;
  20088. /**
  20089. * Gets the ray of the controller in the direction the controller is pointing
  20090. * @param length the length the resulting ray should be
  20091. * @returns a ray in the direction the controller is pointing
  20092. */
  20093. getForwardRay(length?: number): Ray;
  20094. }
  20095. }
  20096. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20097. import { Observable } from "babylonjs/Misc/observable";
  20098. import { Scene } from "babylonjs/scene";
  20099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20100. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20101. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20102. import { Nullable } from "babylonjs/types";
  20103. /**
  20104. * Defines the WebVRController object that represents controllers tracked in 3D space
  20105. */
  20106. export abstract class WebVRController extends PoseEnabledController {
  20107. /**
  20108. * Internal, the default controller model for the controller
  20109. */
  20110. protected _defaultModel: Nullable<AbstractMesh>;
  20111. /**
  20112. * Fired when the trigger state has changed
  20113. */
  20114. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20115. /**
  20116. * Fired when the main button state has changed
  20117. */
  20118. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20119. /**
  20120. * Fired when the secondary button state has changed
  20121. */
  20122. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20123. /**
  20124. * Fired when the pad state has changed
  20125. */
  20126. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20127. /**
  20128. * Fired when controllers stick values have changed
  20129. */
  20130. onPadValuesChangedObservable: Observable<StickValues>;
  20131. /**
  20132. * Array of button availible on the controller
  20133. */
  20134. protected _buttons: Array<MutableGamepadButton>;
  20135. private _onButtonStateChange;
  20136. /**
  20137. * Fired when a controller button's state has changed
  20138. * @param callback the callback containing the button that was modified
  20139. */
  20140. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20141. /**
  20142. * X and Y axis corresponding to the controllers joystick
  20143. */
  20144. pad: StickValues;
  20145. /**
  20146. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20147. */
  20148. hand: string;
  20149. /**
  20150. * The default controller model for the controller
  20151. */
  20152. get defaultModel(): Nullable<AbstractMesh>;
  20153. /**
  20154. * Creates a new WebVRController from a gamepad
  20155. * @param vrGamepad the gamepad that the WebVRController should be created from
  20156. */
  20157. constructor(vrGamepad: any);
  20158. /**
  20159. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20160. */
  20161. update(): void;
  20162. /**
  20163. * Function to be called when a button is modified
  20164. */
  20165. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20166. /**
  20167. * Loads a mesh and attaches it to the controller
  20168. * @param scene the scene the mesh should be added to
  20169. * @param meshLoaded callback for when the mesh has been loaded
  20170. */
  20171. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20172. private _setButtonValue;
  20173. private _changes;
  20174. private _checkChanges;
  20175. /**
  20176. * Disposes of th webVRCOntroller
  20177. */
  20178. dispose(): void;
  20179. }
  20180. }
  20181. declare module "babylonjs/Lights/hemisphericLight" {
  20182. import { Nullable } from "babylonjs/types";
  20183. import { Scene } from "babylonjs/scene";
  20184. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20185. import { Color3 } from "babylonjs/Maths/math.color";
  20186. import { Effect } from "babylonjs/Materials/effect";
  20187. import { Light } from "babylonjs/Lights/light";
  20188. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20189. /**
  20190. * The HemisphericLight simulates the ambient environment light,
  20191. * so the passed direction is the light reflection direction, not the incoming direction.
  20192. */
  20193. export class HemisphericLight extends Light {
  20194. /**
  20195. * The groundColor is the light in the opposite direction to the one specified during creation.
  20196. * 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.
  20197. */
  20198. groundColor: Color3;
  20199. /**
  20200. * The light reflection direction, not the incoming direction.
  20201. */
  20202. direction: Vector3;
  20203. /**
  20204. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20205. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20206. * The HemisphericLight can't cast shadows.
  20207. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20208. * @param name The friendly name of the light
  20209. * @param direction The direction of the light reflection
  20210. * @param scene The scene the light belongs to
  20211. */
  20212. constructor(name: string, direction: Vector3, scene: Scene);
  20213. protected _buildUniformLayout(): void;
  20214. /**
  20215. * Returns the string "HemisphericLight".
  20216. * @return The class name
  20217. */
  20218. getClassName(): string;
  20219. /**
  20220. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20221. * Returns the updated direction.
  20222. * @param target The target the direction should point to
  20223. * @return The computed direction
  20224. */
  20225. setDirectionToTarget(target: Vector3): Vector3;
  20226. /**
  20227. * Returns the shadow generator associated to the light.
  20228. * @returns Always null for hemispheric lights because it does not support shadows.
  20229. */
  20230. getShadowGenerator(): Nullable<IShadowGenerator>;
  20231. /**
  20232. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20233. * @param effect The effect to update
  20234. * @param lightIndex The index of the light in the effect to update
  20235. * @returns The hemispheric light
  20236. */
  20237. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20238. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20239. /**
  20240. * Computes the world matrix of the node
  20241. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20242. * @param useWasUpdatedFlag defines a reserved property
  20243. * @returns the world matrix
  20244. */
  20245. computeWorldMatrix(): Matrix;
  20246. /**
  20247. * Returns the integer 3.
  20248. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20249. */
  20250. getTypeID(): number;
  20251. /**
  20252. * Prepares the list of defines specific to the light type.
  20253. * @param defines the list of defines
  20254. * @param lightIndex defines the index of the light for the effect
  20255. */
  20256. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20257. }
  20258. }
  20259. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20260. /** @hidden */
  20261. export var vrMultiviewToSingleviewPixelShader: {
  20262. name: string;
  20263. shader: string;
  20264. };
  20265. }
  20266. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20267. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20268. import { Scene } from "babylonjs/scene";
  20269. /**
  20270. * Renders to multiple views with a single draw call
  20271. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20272. */
  20273. export class MultiviewRenderTarget extends RenderTargetTexture {
  20274. /**
  20275. * Creates a multiview render target
  20276. * @param scene scene used with the render target
  20277. * @param size the size of the render target (used for each view)
  20278. */
  20279. constructor(scene: Scene, size?: number | {
  20280. width: number;
  20281. height: number;
  20282. } | {
  20283. ratio: number;
  20284. });
  20285. /**
  20286. * @hidden
  20287. * @param faceIndex the face index, if its a cube texture
  20288. */
  20289. _bindFrameBuffer(faceIndex?: number): void;
  20290. /**
  20291. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20292. * @returns the view count
  20293. */
  20294. getViewCount(): number;
  20295. }
  20296. }
  20297. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20298. import { Camera } from "babylonjs/Cameras/camera";
  20299. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20300. import { Nullable } from "babylonjs/types";
  20301. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20302. import { Matrix } from "babylonjs/Maths/math.vector";
  20303. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20304. module "babylonjs/Engines/engine" {
  20305. interface Engine {
  20306. /**
  20307. * Creates a new multiview render target
  20308. * @param width defines the width of the texture
  20309. * @param height defines the height of the texture
  20310. * @returns the created multiview texture
  20311. */
  20312. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20313. /**
  20314. * Binds a multiview framebuffer to be drawn to
  20315. * @param multiviewTexture texture to bind
  20316. */
  20317. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20318. }
  20319. }
  20320. module "babylonjs/Cameras/camera" {
  20321. interface Camera {
  20322. /**
  20323. * @hidden
  20324. * 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)
  20325. */
  20326. _useMultiviewToSingleView: boolean;
  20327. /**
  20328. * @hidden
  20329. * 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)
  20330. */
  20331. _multiviewTexture: Nullable<RenderTargetTexture>;
  20332. /**
  20333. * @hidden
  20334. * ensures the multiview texture of the camera exists and has the specified width/height
  20335. * @param width height to set on the multiview texture
  20336. * @param height width to set on the multiview texture
  20337. */
  20338. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20339. }
  20340. }
  20341. module "babylonjs/scene" {
  20342. interface Scene {
  20343. /** @hidden */
  20344. _transformMatrixR: Matrix;
  20345. /** @hidden */
  20346. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20347. /** @hidden */
  20348. _createMultiviewUbo(): void;
  20349. /** @hidden */
  20350. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20351. /** @hidden */
  20352. _renderMultiviewToSingleView(camera: Camera): void;
  20353. }
  20354. }
  20355. }
  20356. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20357. import { Camera } from "babylonjs/Cameras/camera";
  20358. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20359. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20360. import "babylonjs/Engines/Extensions/engine.multiview";
  20361. /**
  20362. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20363. * This will not be used for webXR as it supports displaying texture arrays directly
  20364. */
  20365. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20366. /**
  20367. * Gets a string identifying the name of the class
  20368. * @returns "VRMultiviewToSingleviewPostProcess" string
  20369. */
  20370. getClassName(): string;
  20371. /**
  20372. * Initializes a VRMultiviewToSingleview
  20373. * @param name name of the post process
  20374. * @param camera camera to be applied to
  20375. * @param scaleFactor scaling factor to the size of the output texture
  20376. */
  20377. constructor(name: string, camera: Camera, scaleFactor: number);
  20378. }
  20379. }
  20380. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20381. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20382. import { Nullable } from "babylonjs/types";
  20383. import { Size } from "babylonjs/Maths/math.size";
  20384. import { Observable } from "babylonjs/Misc/observable";
  20385. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20386. /**
  20387. * Interface used to define additional presentation attributes
  20388. */
  20389. export interface IVRPresentationAttributes {
  20390. /**
  20391. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20392. */
  20393. highRefreshRate: boolean;
  20394. /**
  20395. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20396. */
  20397. foveationLevel: number;
  20398. }
  20399. module "babylonjs/Engines/engine" {
  20400. interface Engine {
  20401. /** @hidden */
  20402. _vrDisplay: any;
  20403. /** @hidden */
  20404. _vrSupported: boolean;
  20405. /** @hidden */
  20406. _oldSize: Size;
  20407. /** @hidden */
  20408. _oldHardwareScaleFactor: number;
  20409. /** @hidden */
  20410. _vrExclusivePointerMode: boolean;
  20411. /** @hidden */
  20412. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20413. /** @hidden */
  20414. _onVRDisplayPointerRestricted: () => void;
  20415. /** @hidden */
  20416. _onVRDisplayPointerUnrestricted: () => void;
  20417. /** @hidden */
  20418. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20419. /** @hidden */
  20420. _onVrDisplayDisconnect: Nullable<() => void>;
  20421. /** @hidden */
  20422. _onVrDisplayPresentChange: Nullable<() => void>;
  20423. /**
  20424. * Observable signaled when VR display mode changes
  20425. */
  20426. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20427. /**
  20428. * Observable signaled when VR request present is complete
  20429. */
  20430. onVRRequestPresentComplete: Observable<boolean>;
  20431. /**
  20432. * Observable signaled when VR request present starts
  20433. */
  20434. onVRRequestPresentStart: Observable<Engine>;
  20435. /**
  20436. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20437. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20438. */
  20439. isInVRExclusivePointerMode: boolean;
  20440. /**
  20441. * Gets a boolean indicating if a webVR device was detected
  20442. * @returns true if a webVR device was detected
  20443. */
  20444. isVRDevicePresent(): boolean;
  20445. /**
  20446. * Gets the current webVR device
  20447. * @returns the current webVR device (or null)
  20448. */
  20449. getVRDevice(): any;
  20450. /**
  20451. * Initializes a webVR display and starts listening to display change events
  20452. * The onVRDisplayChangedObservable will be notified upon these changes
  20453. * @returns A promise containing a VRDisplay and if vr is supported
  20454. */
  20455. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20456. /** @hidden */
  20457. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20458. /**
  20459. * Gets or sets the presentation attributes used to configure VR rendering
  20460. */
  20461. vrPresentationAttributes?: IVRPresentationAttributes;
  20462. /**
  20463. * Call this function to switch to webVR mode
  20464. * Will do nothing if webVR is not supported or if there is no webVR device
  20465. * @param options the webvr options provided to the camera. mainly used for multiview
  20466. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20467. */
  20468. enableVR(options: WebVROptions): void;
  20469. /** @hidden */
  20470. _onVRFullScreenTriggered(): void;
  20471. }
  20472. }
  20473. }
  20474. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20475. import { Nullable } from "babylonjs/types";
  20476. import { Observable } from "babylonjs/Misc/observable";
  20477. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20478. import { Scene } from "babylonjs/scene";
  20479. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20480. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20481. import { Node } from "babylonjs/node";
  20482. import { Ray } from "babylonjs/Culling/ray";
  20483. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20484. import "babylonjs/Engines/Extensions/engine.webVR";
  20485. /**
  20486. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20487. * IMPORTANT!! The data is right-hand data.
  20488. * @export
  20489. * @interface DevicePose
  20490. */
  20491. export interface DevicePose {
  20492. /**
  20493. * The position of the device, values in array are [x,y,z].
  20494. */
  20495. readonly position: Nullable<Float32Array>;
  20496. /**
  20497. * The linearVelocity of the device, values in array are [x,y,z].
  20498. */
  20499. readonly linearVelocity: Nullable<Float32Array>;
  20500. /**
  20501. * The linearAcceleration of the device, values in array are [x,y,z].
  20502. */
  20503. readonly linearAcceleration: Nullable<Float32Array>;
  20504. /**
  20505. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20506. */
  20507. readonly orientation: Nullable<Float32Array>;
  20508. /**
  20509. * The angularVelocity of the device, values in array are [x,y,z].
  20510. */
  20511. readonly angularVelocity: Nullable<Float32Array>;
  20512. /**
  20513. * The angularAcceleration of the device, values in array are [x,y,z].
  20514. */
  20515. readonly angularAcceleration: Nullable<Float32Array>;
  20516. }
  20517. /**
  20518. * Interface representing a pose controlled object in Babylon.
  20519. * A pose controlled object has both regular pose values as well as pose values
  20520. * from an external device such as a VR head mounted display
  20521. */
  20522. export interface PoseControlled {
  20523. /**
  20524. * The position of the object in babylon space.
  20525. */
  20526. position: Vector3;
  20527. /**
  20528. * The rotation quaternion of the object in babylon space.
  20529. */
  20530. rotationQuaternion: Quaternion;
  20531. /**
  20532. * The position of the device in babylon space.
  20533. */
  20534. devicePosition?: Vector3;
  20535. /**
  20536. * The rotation quaternion of the device in babylon space.
  20537. */
  20538. deviceRotationQuaternion: Quaternion;
  20539. /**
  20540. * The raw pose coming from the device.
  20541. */
  20542. rawPose: Nullable<DevicePose>;
  20543. /**
  20544. * The scale of the device to be used when translating from device space to babylon space.
  20545. */
  20546. deviceScaleFactor: number;
  20547. /**
  20548. * Updates the poseControlled values based on the input device pose.
  20549. * @param poseData the pose data to update the object with
  20550. */
  20551. updateFromDevice(poseData: DevicePose): void;
  20552. }
  20553. /**
  20554. * Set of options to customize the webVRCamera
  20555. */
  20556. export interface WebVROptions {
  20557. /**
  20558. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20559. */
  20560. trackPosition?: boolean;
  20561. /**
  20562. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20563. */
  20564. positionScale?: number;
  20565. /**
  20566. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20567. */
  20568. displayName?: string;
  20569. /**
  20570. * Should the native controller meshes be initialized. (default: true)
  20571. */
  20572. controllerMeshes?: boolean;
  20573. /**
  20574. * Creating a default HemiLight only on controllers. (default: true)
  20575. */
  20576. defaultLightingOnControllers?: boolean;
  20577. /**
  20578. * If you don't want to use the default VR button of the helper. (default: false)
  20579. */
  20580. useCustomVRButton?: boolean;
  20581. /**
  20582. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20583. */
  20584. customVRButton?: HTMLButtonElement;
  20585. /**
  20586. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20587. */
  20588. rayLength?: number;
  20589. /**
  20590. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20591. */
  20592. defaultHeight?: number;
  20593. /**
  20594. * If multiview should be used if availible (default: false)
  20595. */
  20596. useMultiview?: boolean;
  20597. }
  20598. /**
  20599. * This represents a WebVR camera.
  20600. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20601. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20602. */
  20603. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20604. private webVROptions;
  20605. /**
  20606. * @hidden
  20607. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20608. */
  20609. _vrDevice: any;
  20610. /**
  20611. * The rawPose of the vrDevice.
  20612. */
  20613. rawPose: Nullable<DevicePose>;
  20614. private _onVREnabled;
  20615. private _specsVersion;
  20616. private _attached;
  20617. private _frameData;
  20618. protected _descendants: Array<Node>;
  20619. private _deviceRoomPosition;
  20620. /** @hidden */
  20621. _deviceRoomRotationQuaternion: Quaternion;
  20622. private _standingMatrix;
  20623. /**
  20624. * Represents device position in babylon space.
  20625. */
  20626. devicePosition: Vector3;
  20627. /**
  20628. * Represents device rotation in babylon space.
  20629. */
  20630. deviceRotationQuaternion: Quaternion;
  20631. /**
  20632. * The scale of the device to be used when translating from device space to babylon space.
  20633. */
  20634. deviceScaleFactor: number;
  20635. private _deviceToWorld;
  20636. private _worldToDevice;
  20637. /**
  20638. * References to the webVR controllers for the vrDevice.
  20639. */
  20640. controllers: Array<WebVRController>;
  20641. /**
  20642. * Emits an event when a controller is attached.
  20643. */
  20644. onControllersAttachedObservable: Observable<WebVRController[]>;
  20645. /**
  20646. * Emits an event when a controller's mesh has been loaded;
  20647. */
  20648. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20649. /**
  20650. * Emits an event when the HMD's pose has been updated.
  20651. */
  20652. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20653. private _poseSet;
  20654. /**
  20655. * If the rig cameras be used as parent instead of this camera.
  20656. */
  20657. rigParenting: boolean;
  20658. private _lightOnControllers;
  20659. private _defaultHeight?;
  20660. /**
  20661. * Instantiates a WebVRFreeCamera.
  20662. * @param name The name of the WebVRFreeCamera
  20663. * @param position The starting anchor position for the camera
  20664. * @param scene The scene the camera belongs to
  20665. * @param webVROptions a set of customizable options for the webVRCamera
  20666. */
  20667. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20668. /**
  20669. * Gets the device distance from the ground in meters.
  20670. * @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.
  20671. */
  20672. deviceDistanceToRoomGround(): number;
  20673. /**
  20674. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20675. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20676. */
  20677. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20678. /**
  20679. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20680. * @returns A promise with a boolean set to if the standing matrix is supported.
  20681. */
  20682. useStandingMatrixAsync(): Promise<boolean>;
  20683. /**
  20684. * Disposes the camera
  20685. */
  20686. dispose(): void;
  20687. /**
  20688. * Gets a vrController by name.
  20689. * @param name The name of the controller to retreive
  20690. * @returns the controller matching the name specified or null if not found
  20691. */
  20692. getControllerByName(name: string): Nullable<WebVRController>;
  20693. private _leftController;
  20694. /**
  20695. * The controller corresponding to the users left hand.
  20696. */
  20697. get leftController(): Nullable<WebVRController>;
  20698. private _rightController;
  20699. /**
  20700. * The controller corresponding to the users right hand.
  20701. */
  20702. get rightController(): Nullable<WebVRController>;
  20703. /**
  20704. * Casts a ray forward from the vrCamera's gaze.
  20705. * @param length Length of the ray (default: 100)
  20706. * @returns the ray corresponding to the gaze
  20707. */
  20708. getForwardRay(length?: number): Ray;
  20709. /**
  20710. * @hidden
  20711. * Updates the camera based on device's frame data
  20712. */
  20713. _checkInputs(): void;
  20714. /**
  20715. * Updates the poseControlled values based on the input device pose.
  20716. * @param poseData Pose coming from the device
  20717. */
  20718. updateFromDevice(poseData: DevicePose): void;
  20719. private _htmlElementAttached;
  20720. private _detachIfAttached;
  20721. /**
  20722. * WebVR's attach control will start broadcasting frames to the device.
  20723. * Note that in certain browsers (chrome for example) this function must be called
  20724. * within a user-interaction callback. Example:
  20725. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20726. *
  20727. * @param element html element to attach the vrDevice to
  20728. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20729. */
  20730. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20731. /**
  20732. * Detaches the camera from the html element and disables VR
  20733. *
  20734. * @param element html element to detach from
  20735. */
  20736. detachControl(element: HTMLElement): void;
  20737. /**
  20738. * @returns the name of this class
  20739. */
  20740. getClassName(): string;
  20741. /**
  20742. * Calls resetPose on the vrDisplay
  20743. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20744. */
  20745. resetToCurrentRotation(): void;
  20746. /**
  20747. * @hidden
  20748. * Updates the rig cameras (left and right eye)
  20749. */
  20750. _updateRigCameras(): void;
  20751. private _workingVector;
  20752. private _oneVector;
  20753. private _workingMatrix;
  20754. private updateCacheCalled;
  20755. private _correctPositionIfNotTrackPosition;
  20756. /**
  20757. * @hidden
  20758. * Updates the cached values of the camera
  20759. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20760. */
  20761. _updateCache(ignoreParentClass?: boolean): void;
  20762. /**
  20763. * @hidden
  20764. * Get current device position in babylon world
  20765. */
  20766. _computeDevicePosition(): void;
  20767. /**
  20768. * Updates the current device position and rotation in the babylon world
  20769. */
  20770. update(): void;
  20771. /**
  20772. * @hidden
  20773. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20774. * @returns an identity matrix
  20775. */
  20776. _getViewMatrix(): Matrix;
  20777. private _tmpMatrix;
  20778. /**
  20779. * This function is called by the two RIG cameras.
  20780. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20781. * @hidden
  20782. */
  20783. _getWebVRViewMatrix(): Matrix;
  20784. /** @hidden */
  20785. _getWebVRProjectionMatrix(): Matrix;
  20786. private _onGamepadConnectedObserver;
  20787. private _onGamepadDisconnectedObserver;
  20788. private _updateCacheWhenTrackingDisabledObserver;
  20789. /**
  20790. * Initializes the controllers and their meshes
  20791. */
  20792. initControllers(): void;
  20793. }
  20794. }
  20795. declare module "babylonjs/Materials/materialHelper" {
  20796. import { Nullable } from "babylonjs/types";
  20797. import { Scene } from "babylonjs/scene";
  20798. import { Engine } from "babylonjs/Engines/engine";
  20799. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20800. import { Light } from "babylonjs/Lights/light";
  20801. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20802. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20803. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20804. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20805. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20806. /**
  20807. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20808. *
  20809. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20810. *
  20811. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20812. */
  20813. export class MaterialHelper {
  20814. /**
  20815. * Bind the current view position to an effect.
  20816. * @param effect The effect to be bound
  20817. * @param scene The scene the eyes position is used from
  20818. * @param variableName name of the shader variable that will hold the eye position
  20819. */
  20820. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20821. /**
  20822. * Helps preparing the defines values about the UVs in used in the effect.
  20823. * UVs are shared as much as we can accross channels in the shaders.
  20824. * @param texture The texture we are preparing the UVs for
  20825. * @param defines The defines to update
  20826. * @param key The channel key "diffuse", "specular"... used in the shader
  20827. */
  20828. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20829. /**
  20830. * Binds a texture matrix value to its corrsponding uniform
  20831. * @param texture The texture to bind the matrix for
  20832. * @param uniformBuffer The uniform buffer receivin the data
  20833. * @param key The channel key "diffuse", "specular"... used in the shader
  20834. */
  20835. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20836. /**
  20837. * Gets the current status of the fog (should it be enabled?)
  20838. * @param mesh defines the mesh to evaluate for fog support
  20839. * @param scene defines the hosting scene
  20840. * @returns true if fog must be enabled
  20841. */
  20842. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20843. /**
  20844. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20845. * @param mesh defines the current mesh
  20846. * @param scene defines the current scene
  20847. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20848. * @param pointsCloud defines if point cloud rendering has to be turned on
  20849. * @param fogEnabled defines if fog has to be turned on
  20850. * @param alphaTest defines if alpha testing has to be turned on
  20851. * @param defines defines the current list of defines
  20852. */
  20853. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20854. /**
  20855. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20856. * @param scene defines the current scene
  20857. * @param engine defines the current engine
  20858. * @param defines specifies the list of active defines
  20859. * @param useInstances defines if instances have to be turned on
  20860. * @param useClipPlane defines if clip plane have to be turned on
  20861. * @param useInstances defines if instances have to be turned on
  20862. * @param useThinInstances defines if thin instances have to be turned on
  20863. */
  20864. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20865. /**
  20866. * Prepares the defines for bones
  20867. * @param mesh The mesh containing the geometry data we will draw
  20868. * @param defines The defines to update
  20869. */
  20870. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20871. /**
  20872. * Prepares the defines for morph targets
  20873. * @param mesh The mesh containing the geometry data we will draw
  20874. * @param defines The defines to update
  20875. */
  20876. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20877. /**
  20878. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20879. * @param mesh The mesh containing the geometry data we will draw
  20880. * @param defines The defines to update
  20881. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20882. * @param useBones Precise whether bones should be used or not (override mesh info)
  20883. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20884. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20885. * @returns false if defines are considered not dirty and have not been checked
  20886. */
  20887. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20888. /**
  20889. * Prepares the defines related to multiview
  20890. * @param scene The scene we are intending to draw
  20891. * @param defines The defines to update
  20892. */
  20893. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20894. /**
  20895. * Prepares the defines related to the prepass
  20896. * @param scene The scene we are intending to draw
  20897. * @param defines The defines to update
  20898. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20899. */
  20900. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20901. /**
  20902. * Prepares the defines related to the light information passed in parameter
  20903. * @param scene The scene we are intending to draw
  20904. * @param mesh The mesh the effect is compiling for
  20905. * @param light The light the effect is compiling for
  20906. * @param lightIndex The index of the light
  20907. * @param defines The defines to update
  20908. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20909. * @param state Defines the current state regarding what is needed (normals, etc...)
  20910. */
  20911. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20912. needNormals: boolean;
  20913. needRebuild: boolean;
  20914. shadowEnabled: boolean;
  20915. specularEnabled: boolean;
  20916. lightmapMode: boolean;
  20917. }): void;
  20918. /**
  20919. * Prepares the defines related to the light information passed in parameter
  20920. * @param scene The scene we are intending to draw
  20921. * @param mesh The mesh the effect is compiling for
  20922. * @param defines The defines to update
  20923. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20924. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20925. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20926. * @returns true if normals will be required for the rest of the effect
  20927. */
  20928. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20929. /**
  20930. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20931. * @param lightIndex defines the light index
  20932. * @param uniformsList The uniform list
  20933. * @param samplersList The sampler list
  20934. * @param projectedLightTexture defines if projected texture must be used
  20935. * @param uniformBuffersList defines an optional list of uniform buffers
  20936. */
  20937. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20938. /**
  20939. * Prepares the uniforms and samplers list to be used in the effect
  20940. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20941. * @param samplersList The sampler list
  20942. * @param defines The defines helping in the list generation
  20943. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20944. */
  20945. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20946. /**
  20947. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20948. * @param defines The defines to update while falling back
  20949. * @param fallbacks The authorized effect fallbacks
  20950. * @param maxSimultaneousLights The maximum number of lights allowed
  20951. * @param rank the current rank of the Effect
  20952. * @returns The newly affected rank
  20953. */
  20954. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20955. private static _TmpMorphInfluencers;
  20956. /**
  20957. * Prepares the list of attributes required for morph targets according to the effect defines.
  20958. * @param attribs The current list of supported attribs
  20959. * @param mesh The mesh to prepare the morph targets attributes for
  20960. * @param influencers The number of influencers
  20961. */
  20962. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20963. /**
  20964. * Prepares the list of attributes required for morph targets according to the effect defines.
  20965. * @param attribs The current list of supported attribs
  20966. * @param mesh The mesh to prepare the morph targets attributes for
  20967. * @param defines The current Defines of the effect
  20968. */
  20969. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20970. /**
  20971. * Prepares the list of attributes required for bones according to the effect defines.
  20972. * @param attribs The current list of supported attribs
  20973. * @param mesh The mesh to prepare the bones attributes for
  20974. * @param defines The current Defines of the effect
  20975. * @param fallbacks The current efffect fallback strategy
  20976. */
  20977. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20978. /**
  20979. * Check and prepare the list of attributes required for instances according to the effect defines.
  20980. * @param attribs The current list of supported attribs
  20981. * @param defines The current MaterialDefines of the effect
  20982. */
  20983. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20984. /**
  20985. * Add the list of attributes required for instances to the attribs array.
  20986. * @param attribs The current list of supported attribs
  20987. */
  20988. static PushAttributesForInstances(attribs: string[]): void;
  20989. /**
  20990. * Binds the light information to the effect.
  20991. * @param light The light containing the generator
  20992. * @param effect The effect we are binding the data to
  20993. * @param lightIndex The light index in the effect used to render
  20994. */
  20995. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20996. /**
  20997. * Binds the lights information from the scene to the effect for the given mesh.
  20998. * @param light Light to bind
  20999. * @param lightIndex Light index
  21000. * @param scene The scene where the light belongs to
  21001. * @param effect The effect we are binding the data to
  21002. * @param useSpecular Defines if specular is supported
  21003. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21004. */
  21005. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21006. /**
  21007. * Binds the lights information from the scene to the effect for the given mesh.
  21008. * @param scene The scene the lights belongs to
  21009. * @param mesh The mesh we are binding the information to render
  21010. * @param effect The effect we are binding the data to
  21011. * @param defines The generated defines for the effect
  21012. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21013. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21014. */
  21015. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21016. private static _tempFogColor;
  21017. /**
  21018. * Binds the fog information from the scene to the effect for the given mesh.
  21019. * @param scene The scene the lights belongs to
  21020. * @param mesh The mesh we are binding the information to render
  21021. * @param effect The effect we are binding the data to
  21022. * @param linearSpace Defines if the fog effect is applied in linear space
  21023. */
  21024. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21025. /**
  21026. * Binds the bones information from the mesh to the effect.
  21027. * @param mesh The mesh we are binding the information to render
  21028. * @param effect The effect we are binding the data to
  21029. */
  21030. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21031. /**
  21032. * Binds the morph targets information from the mesh to the effect.
  21033. * @param abstractMesh The mesh we are binding the information to render
  21034. * @param effect The effect we are binding the data to
  21035. */
  21036. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21037. /**
  21038. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21039. * @param defines The generated defines used in the effect
  21040. * @param effect The effect we are binding the data to
  21041. * @param scene The scene we are willing to render with logarithmic scale for
  21042. */
  21043. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21044. /**
  21045. * Binds the clip plane information from the scene to the effect.
  21046. * @param scene The scene the clip plane information are extracted from
  21047. * @param effect The effect we are binding the data to
  21048. */
  21049. static BindClipPlane(effect: Effect, scene: Scene): void;
  21050. }
  21051. }
  21052. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21053. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21054. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21055. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21056. import { Nullable } from "babylonjs/types";
  21057. import { Effect } from "babylonjs/Materials/effect";
  21058. import { Matrix } from "babylonjs/Maths/math.vector";
  21059. import { Scene } from "babylonjs/scene";
  21060. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21061. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21062. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21063. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21064. import { Observable } from "babylonjs/Misc/observable";
  21065. /**
  21066. * Block used to expose an input value
  21067. */
  21068. export class InputBlock extends NodeMaterialBlock {
  21069. private _mode;
  21070. private _associatedVariableName;
  21071. private _storedValue;
  21072. private _valueCallback;
  21073. private _type;
  21074. private _animationType;
  21075. /** Gets or set a value used to limit the range of float values */
  21076. min: number;
  21077. /** Gets or set a value used to limit the range of float values */
  21078. max: number;
  21079. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21080. isBoolean: boolean;
  21081. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21082. matrixMode: number;
  21083. /** @hidden */
  21084. _systemValue: Nullable<NodeMaterialSystemValues>;
  21085. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21086. visibleInInspector: boolean;
  21087. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21088. isConstant: boolean;
  21089. /** Gets or sets the group to use to display this block in the Inspector */
  21090. groupInInspector: string;
  21091. /** Gets an observable raised when the value is changed */
  21092. onValueChangedObservable: Observable<InputBlock>;
  21093. /**
  21094. * Gets or sets the connection point type (default is float)
  21095. */
  21096. get type(): NodeMaterialBlockConnectionPointTypes;
  21097. /**
  21098. * Creates a new InputBlock
  21099. * @param name defines the block name
  21100. * @param target defines the target of that block (Vertex by default)
  21101. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21102. */
  21103. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21104. /**
  21105. * Validates if a name is a reserve word.
  21106. * @param newName the new name to be given to the node.
  21107. * @returns false if the name is a reserve word, else true.
  21108. */
  21109. validateBlockName(newName: string): boolean;
  21110. /**
  21111. * Gets the output component
  21112. */
  21113. get output(): NodeMaterialConnectionPoint;
  21114. /**
  21115. * Set the source of this connection point to a vertex attribute
  21116. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21117. * @returns the current connection point
  21118. */
  21119. setAsAttribute(attributeName?: string): InputBlock;
  21120. /**
  21121. * Set the source of this connection point to a system value
  21122. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21123. * @returns the current connection point
  21124. */
  21125. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21126. /**
  21127. * Gets or sets the value of that point.
  21128. * Please note that this value will be ignored if valueCallback is defined
  21129. */
  21130. get value(): any;
  21131. set value(value: any);
  21132. /**
  21133. * Gets or sets a callback used to get the value of that point.
  21134. * Please note that setting this value will force the connection point to ignore the value property
  21135. */
  21136. get valueCallback(): () => any;
  21137. set valueCallback(value: () => any);
  21138. /**
  21139. * Gets or sets the associated variable name in the shader
  21140. */
  21141. get associatedVariableName(): string;
  21142. set associatedVariableName(value: string);
  21143. /** Gets or sets the type of animation applied to the input */
  21144. get animationType(): AnimatedInputBlockTypes;
  21145. set animationType(value: AnimatedInputBlockTypes);
  21146. /**
  21147. * Gets a boolean indicating that this connection point not defined yet
  21148. */
  21149. get isUndefined(): boolean;
  21150. /**
  21151. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21152. * In this case the connection point name must be the name of the uniform to use.
  21153. * Can only be set on inputs
  21154. */
  21155. get isUniform(): boolean;
  21156. set isUniform(value: boolean);
  21157. /**
  21158. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21159. * In this case the connection point name must be the name of the attribute to use
  21160. * Can only be set on inputs
  21161. */
  21162. get isAttribute(): boolean;
  21163. set isAttribute(value: boolean);
  21164. /**
  21165. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21166. * Can only be set on exit points
  21167. */
  21168. get isVarying(): boolean;
  21169. set isVarying(value: boolean);
  21170. /**
  21171. * Gets a boolean indicating that the current connection point is a system value
  21172. */
  21173. get isSystemValue(): boolean;
  21174. /**
  21175. * Gets or sets the current well known value or null if not defined as a system value
  21176. */
  21177. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21178. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21179. /**
  21180. * Gets the current class name
  21181. * @returns the class name
  21182. */
  21183. getClassName(): string;
  21184. /**
  21185. * Animate the input if animationType !== None
  21186. * @param scene defines the rendering scene
  21187. */
  21188. animate(scene: Scene): void;
  21189. private _emitDefine;
  21190. initialize(state: NodeMaterialBuildState): void;
  21191. /**
  21192. * Set the input block to its default value (based on its type)
  21193. */
  21194. setDefaultValue(): void;
  21195. private _emitConstant;
  21196. /** @hidden */
  21197. get _noContextSwitch(): boolean;
  21198. private _emit;
  21199. /** @hidden */
  21200. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21201. /** @hidden */
  21202. _transmit(effect: Effect, scene: Scene): void;
  21203. protected _buildBlock(state: NodeMaterialBuildState): void;
  21204. protected _dumpPropertiesCode(): string;
  21205. dispose(): void;
  21206. serialize(): any;
  21207. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21208. }
  21209. }
  21210. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21211. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21212. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21213. import { Nullable } from "babylonjs/types";
  21214. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21215. import { Observable } from "babylonjs/Misc/observable";
  21216. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21217. /**
  21218. * Enum used to define the compatibility state between two connection points
  21219. */
  21220. export enum NodeMaterialConnectionPointCompatibilityStates {
  21221. /** Points are compatibles */
  21222. Compatible = 0,
  21223. /** Points are incompatible because of their types */
  21224. TypeIncompatible = 1,
  21225. /** Points are incompatible because of their targets (vertex vs fragment) */
  21226. TargetIncompatible = 2
  21227. }
  21228. /**
  21229. * Defines the direction of a connection point
  21230. */
  21231. export enum NodeMaterialConnectionPointDirection {
  21232. /** Input */
  21233. Input = 0,
  21234. /** Output */
  21235. Output = 1
  21236. }
  21237. /**
  21238. * Defines a connection point for a block
  21239. */
  21240. export class NodeMaterialConnectionPoint {
  21241. /** @hidden */
  21242. _ownerBlock: NodeMaterialBlock;
  21243. /** @hidden */
  21244. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21245. private _endpoints;
  21246. private _associatedVariableName;
  21247. private _direction;
  21248. /** @hidden */
  21249. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21250. /** @hidden */
  21251. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21252. private _type;
  21253. /** @hidden */
  21254. _enforceAssociatedVariableName: boolean;
  21255. /** Gets the direction of the point */
  21256. get direction(): NodeMaterialConnectionPointDirection;
  21257. /** Indicates that this connection point needs dual validation before being connected to another point */
  21258. needDualDirectionValidation: boolean;
  21259. /**
  21260. * Gets or sets the additional types supported by this connection point
  21261. */
  21262. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21263. /**
  21264. * Gets or sets the additional types excluded by this connection point
  21265. */
  21266. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21267. /**
  21268. * Observable triggered when this point is connected
  21269. */
  21270. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21271. /**
  21272. * Gets or sets the associated variable name in the shader
  21273. */
  21274. get associatedVariableName(): string;
  21275. set associatedVariableName(value: string);
  21276. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21277. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21278. /**
  21279. * Gets or sets the connection point type (default is float)
  21280. */
  21281. get type(): NodeMaterialBlockConnectionPointTypes;
  21282. set type(value: NodeMaterialBlockConnectionPointTypes);
  21283. /**
  21284. * Gets or sets the connection point name
  21285. */
  21286. name: string;
  21287. /**
  21288. * Gets or sets the connection point name
  21289. */
  21290. displayName: string;
  21291. /**
  21292. * Gets or sets a boolean indicating that this connection point can be omitted
  21293. */
  21294. isOptional: boolean;
  21295. /**
  21296. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21297. */
  21298. isExposedOnFrame: boolean;
  21299. /**
  21300. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21301. */
  21302. define: string;
  21303. /** @hidden */
  21304. _prioritizeVertex: boolean;
  21305. private _target;
  21306. /** Gets or sets the target of that connection point */
  21307. get target(): NodeMaterialBlockTargets;
  21308. set target(value: NodeMaterialBlockTargets);
  21309. /**
  21310. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21311. */
  21312. get isConnected(): boolean;
  21313. /**
  21314. * Gets a boolean indicating that the current point is connected to an input block
  21315. */
  21316. get isConnectedToInputBlock(): boolean;
  21317. /**
  21318. * Gets a the connected input block (if any)
  21319. */
  21320. get connectInputBlock(): Nullable<InputBlock>;
  21321. /** Get the other side of the connection (if any) */
  21322. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21323. /** Get the block that owns this connection point */
  21324. get ownerBlock(): NodeMaterialBlock;
  21325. /** Get the block connected on the other side of this connection (if any) */
  21326. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21327. /** Get the block connected on the endpoints of this connection (if any) */
  21328. get connectedBlocks(): Array<NodeMaterialBlock>;
  21329. /** Gets the list of connected endpoints */
  21330. get endpoints(): NodeMaterialConnectionPoint[];
  21331. /** Gets a boolean indicating if that output point is connected to at least one input */
  21332. get hasEndpoints(): boolean;
  21333. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21334. get isConnectedInVertexShader(): boolean;
  21335. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21336. get isConnectedInFragmentShader(): boolean;
  21337. /**
  21338. * Creates a block suitable to be used as an input for this input point.
  21339. * If null is returned, a block based on the point type will be created.
  21340. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21341. */
  21342. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21343. /**
  21344. * Creates a new connection point
  21345. * @param name defines the connection point name
  21346. * @param ownerBlock defines the block hosting this connection point
  21347. * @param direction defines the direction of the connection point
  21348. */
  21349. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21350. /**
  21351. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21352. * @returns the class name
  21353. */
  21354. getClassName(): string;
  21355. /**
  21356. * Gets a boolean indicating if the current point can be connected to another point
  21357. * @param connectionPoint defines the other connection point
  21358. * @returns a boolean
  21359. */
  21360. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21361. /**
  21362. * Gets a number indicating if the current point can be connected to another point
  21363. * @param connectionPoint defines the other connection point
  21364. * @returns a number defining the compatibility state
  21365. */
  21366. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21367. /**
  21368. * Connect this point to another connection point
  21369. * @param connectionPoint defines the other connection point
  21370. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21371. * @returns the current connection point
  21372. */
  21373. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21374. /**
  21375. * Disconnect this point from one of his endpoint
  21376. * @param endpoint defines the other connection point
  21377. * @returns the current connection point
  21378. */
  21379. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21380. /**
  21381. * Serializes this point in a JSON representation
  21382. * @param isInput defines if the connection point is an input (default is true)
  21383. * @returns the serialized point object
  21384. */
  21385. serialize(isInput?: boolean): any;
  21386. /**
  21387. * Release resources
  21388. */
  21389. dispose(): void;
  21390. }
  21391. }
  21392. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21393. /**
  21394. * Enum used to define the material modes
  21395. */
  21396. export enum NodeMaterialModes {
  21397. /** Regular material */
  21398. Material = 0,
  21399. /** For post process */
  21400. PostProcess = 1,
  21401. /** For particle system */
  21402. Particle = 2
  21403. }
  21404. }
  21405. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21406. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21407. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21408. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21409. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21411. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21412. import { Effect } from "babylonjs/Materials/effect";
  21413. import { Mesh } from "babylonjs/Meshes/mesh";
  21414. import { Nullable } from "babylonjs/types";
  21415. import { Texture } from "babylonjs/Materials/Textures/texture";
  21416. import { Scene } from "babylonjs/scene";
  21417. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21418. /**
  21419. * Block used to read a texture from a sampler
  21420. */
  21421. export class TextureBlock extends NodeMaterialBlock {
  21422. private _defineName;
  21423. private _linearDefineName;
  21424. private _gammaDefineName;
  21425. private _tempTextureRead;
  21426. private _samplerName;
  21427. private _transformedUVName;
  21428. private _textureTransformName;
  21429. private _textureInfoName;
  21430. private _mainUVName;
  21431. private _mainUVDefineName;
  21432. private _fragmentOnly;
  21433. /**
  21434. * Gets or sets the texture associated with the node
  21435. */
  21436. texture: Nullable<Texture>;
  21437. /**
  21438. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21439. */
  21440. convertToGammaSpace: boolean;
  21441. /**
  21442. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21443. */
  21444. convertToLinearSpace: boolean;
  21445. /**
  21446. * Create a new TextureBlock
  21447. * @param name defines the block name
  21448. */
  21449. constructor(name: string, fragmentOnly?: boolean);
  21450. /**
  21451. * Gets the current class name
  21452. * @returns the class name
  21453. */
  21454. getClassName(): string;
  21455. /**
  21456. * Gets the uv input component
  21457. */
  21458. get uv(): NodeMaterialConnectionPoint;
  21459. /**
  21460. * Gets the rgba output component
  21461. */
  21462. get rgba(): NodeMaterialConnectionPoint;
  21463. /**
  21464. * Gets the rgb output component
  21465. */
  21466. get rgb(): NodeMaterialConnectionPoint;
  21467. /**
  21468. * Gets the r output component
  21469. */
  21470. get r(): NodeMaterialConnectionPoint;
  21471. /**
  21472. * Gets the g output component
  21473. */
  21474. get g(): NodeMaterialConnectionPoint;
  21475. /**
  21476. * Gets the b output component
  21477. */
  21478. get b(): NodeMaterialConnectionPoint;
  21479. /**
  21480. * Gets the a output component
  21481. */
  21482. get a(): NodeMaterialConnectionPoint;
  21483. get target(): NodeMaterialBlockTargets;
  21484. autoConfigure(material: NodeMaterial): void;
  21485. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21486. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21487. isReady(): boolean;
  21488. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21489. private get _isMixed();
  21490. private _injectVertexCode;
  21491. private _writeTextureRead;
  21492. private _writeOutput;
  21493. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21494. protected _dumpPropertiesCode(): string;
  21495. serialize(): any;
  21496. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21497. }
  21498. }
  21499. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21500. /** @hidden */
  21501. export var reflectionFunction: {
  21502. name: string;
  21503. shader: string;
  21504. };
  21505. }
  21506. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21507. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21508. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21509. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21510. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21511. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21512. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21513. import { Effect } from "babylonjs/Materials/effect";
  21514. import { Mesh } from "babylonjs/Meshes/mesh";
  21515. import { Nullable } from "babylonjs/types";
  21516. import { Scene } from "babylonjs/scene";
  21517. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21518. /**
  21519. * Base block used to read a reflection texture from a sampler
  21520. */
  21521. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21522. /** @hidden */
  21523. _define3DName: string;
  21524. /** @hidden */
  21525. _defineCubicName: string;
  21526. /** @hidden */
  21527. _defineExplicitName: string;
  21528. /** @hidden */
  21529. _defineProjectionName: string;
  21530. /** @hidden */
  21531. _defineLocalCubicName: string;
  21532. /** @hidden */
  21533. _defineSphericalName: string;
  21534. /** @hidden */
  21535. _definePlanarName: string;
  21536. /** @hidden */
  21537. _defineEquirectangularName: string;
  21538. /** @hidden */
  21539. _defineMirroredEquirectangularFixedName: string;
  21540. /** @hidden */
  21541. _defineEquirectangularFixedName: string;
  21542. /** @hidden */
  21543. _defineSkyboxName: string;
  21544. /** @hidden */
  21545. _defineOppositeZ: string;
  21546. /** @hidden */
  21547. _cubeSamplerName: string;
  21548. /** @hidden */
  21549. _2DSamplerName: string;
  21550. protected _positionUVWName: string;
  21551. protected _directionWName: string;
  21552. protected _reflectionVectorName: string;
  21553. /** @hidden */
  21554. _reflectionCoordsName: string;
  21555. /** @hidden */
  21556. _reflectionMatrixName: string;
  21557. protected _reflectionColorName: string;
  21558. /**
  21559. * Gets or sets the texture associated with the node
  21560. */
  21561. texture: Nullable<BaseTexture>;
  21562. /**
  21563. * Create a new ReflectionTextureBaseBlock
  21564. * @param name defines the block name
  21565. */
  21566. constructor(name: string);
  21567. /**
  21568. * Gets the current class name
  21569. * @returns the class name
  21570. */
  21571. getClassName(): string;
  21572. /**
  21573. * Gets the world position input component
  21574. */
  21575. abstract get position(): NodeMaterialConnectionPoint;
  21576. /**
  21577. * Gets the world position input component
  21578. */
  21579. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21580. /**
  21581. * Gets the world normal input component
  21582. */
  21583. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21584. /**
  21585. * Gets the world input component
  21586. */
  21587. abstract get world(): NodeMaterialConnectionPoint;
  21588. /**
  21589. * Gets the camera (or eye) position component
  21590. */
  21591. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21592. /**
  21593. * Gets the view input component
  21594. */
  21595. abstract get view(): NodeMaterialConnectionPoint;
  21596. protected _getTexture(): Nullable<BaseTexture>;
  21597. autoConfigure(material: NodeMaterial): void;
  21598. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21599. isReady(): boolean;
  21600. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21601. /**
  21602. * Gets the code to inject in the vertex shader
  21603. * @param state current state of the node material building
  21604. * @returns the shader code
  21605. */
  21606. handleVertexSide(state: NodeMaterialBuildState): string;
  21607. /**
  21608. * Handles the inits for the fragment code path
  21609. * @param state node material build state
  21610. */
  21611. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21612. /**
  21613. * Generates the reflection coords code for the fragment code path
  21614. * @param worldNormalVarName name of the world normal variable
  21615. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21616. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21617. * @returns the shader code
  21618. */
  21619. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21620. /**
  21621. * Generates the reflection color code for the fragment code path
  21622. * @param lodVarName name of the lod variable
  21623. * @param swizzleLookupTexture swizzle to use for the final color variable
  21624. * @returns the shader code
  21625. */
  21626. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21627. /**
  21628. * Generates the code corresponding to the connected output points
  21629. * @param state node material build state
  21630. * @param varName name of the variable to output
  21631. * @returns the shader code
  21632. */
  21633. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21634. protected _buildBlock(state: NodeMaterialBuildState): this;
  21635. protected _dumpPropertiesCode(): string;
  21636. serialize(): any;
  21637. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21638. }
  21639. }
  21640. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21642. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21643. import { Nullable } from "babylonjs/types";
  21644. /**
  21645. * Defines a connection point to be used for points with a custom object type
  21646. */
  21647. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21648. private _blockType;
  21649. private _blockName;
  21650. private _nameForCheking?;
  21651. /**
  21652. * Creates a new connection point
  21653. * @param name defines the connection point name
  21654. * @param ownerBlock defines the block hosting this connection point
  21655. * @param direction defines the direction of the connection point
  21656. */
  21657. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21658. /**
  21659. * Gets a number indicating if the current point can be connected to another point
  21660. * @param connectionPoint defines the other connection point
  21661. * @returns a number defining the compatibility state
  21662. */
  21663. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21664. /**
  21665. * Creates a block suitable to be used as an input for this input point.
  21666. * If null is returned, a block based on the point type will be created.
  21667. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21668. */
  21669. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21670. }
  21671. }
  21672. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21673. /**
  21674. * Enum defining the type of properties that can be edited in the property pages in the NME
  21675. */
  21676. export enum PropertyTypeForEdition {
  21677. /** property is a boolean */
  21678. Boolean = 0,
  21679. /** property is a float */
  21680. Float = 1,
  21681. /** property is a Vector2 */
  21682. Vector2 = 2,
  21683. /** property is a list of values */
  21684. List = 3
  21685. }
  21686. /**
  21687. * Interface that defines an option in a variable of type list
  21688. */
  21689. export interface IEditablePropertyListOption {
  21690. /** label of the option */
  21691. "label": string;
  21692. /** value of the option */
  21693. "value": number;
  21694. }
  21695. /**
  21696. * Interface that defines the options available for an editable property
  21697. */
  21698. export interface IEditablePropertyOption {
  21699. /** min value */
  21700. "min"?: number;
  21701. /** max value */
  21702. "max"?: number;
  21703. /** notifiers: indicates which actions to take when the property is changed */
  21704. "notifiers"?: {
  21705. /** the material should be rebuilt */
  21706. "rebuild"?: boolean;
  21707. /** the preview should be updated */
  21708. "update"?: boolean;
  21709. };
  21710. /** list of the options for a variable of type list */
  21711. "options"?: IEditablePropertyListOption[];
  21712. }
  21713. /**
  21714. * Interface that describes an editable property
  21715. */
  21716. export interface IPropertyDescriptionForEdition {
  21717. /** name of the property */
  21718. "propertyName": string;
  21719. /** display name of the property */
  21720. "displayName": string;
  21721. /** type of the property */
  21722. "type": PropertyTypeForEdition;
  21723. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21724. "groupName": string;
  21725. /** options for the property */
  21726. "options": IEditablePropertyOption;
  21727. }
  21728. /**
  21729. * Decorator that flags a property in a node material block as being editable
  21730. */
  21731. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21732. }
  21733. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21734. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21735. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21736. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21737. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21738. import { Nullable } from "babylonjs/types";
  21739. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21740. import { Mesh } from "babylonjs/Meshes/mesh";
  21741. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21742. import { Effect } from "babylonjs/Materials/effect";
  21743. import { Scene } from "babylonjs/scene";
  21744. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21745. /**
  21746. * Block used to implement the refraction part of the sub surface module of the PBR material
  21747. */
  21748. export class RefractionBlock extends NodeMaterialBlock {
  21749. /** @hidden */
  21750. _define3DName: string;
  21751. /** @hidden */
  21752. _refractionMatrixName: string;
  21753. /** @hidden */
  21754. _defineLODRefractionAlpha: string;
  21755. /** @hidden */
  21756. _defineLinearSpecularRefraction: string;
  21757. /** @hidden */
  21758. _defineOppositeZ: string;
  21759. /** @hidden */
  21760. _cubeSamplerName: string;
  21761. /** @hidden */
  21762. _2DSamplerName: string;
  21763. /** @hidden */
  21764. _vRefractionMicrosurfaceInfosName: string;
  21765. /** @hidden */
  21766. _vRefractionInfosName: string;
  21767. private _scene;
  21768. /**
  21769. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21770. * Materials half opaque for instance using refraction could benefit from this control.
  21771. */
  21772. linkRefractionWithTransparency: boolean;
  21773. /**
  21774. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21775. */
  21776. invertRefractionY: boolean;
  21777. /**
  21778. * Gets or sets the texture associated with the node
  21779. */
  21780. texture: Nullable<BaseTexture>;
  21781. /**
  21782. * Create a new RefractionBlock
  21783. * @param name defines the block name
  21784. */
  21785. constructor(name: string);
  21786. /**
  21787. * Gets the current class name
  21788. * @returns the class name
  21789. */
  21790. getClassName(): string;
  21791. /**
  21792. * Gets the intensity input component
  21793. */
  21794. get intensity(): NodeMaterialConnectionPoint;
  21795. /**
  21796. * Gets the index of refraction input component
  21797. */
  21798. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21799. /**
  21800. * Gets the tint at distance input component
  21801. */
  21802. get tintAtDistance(): NodeMaterialConnectionPoint;
  21803. /**
  21804. * Gets the view input component
  21805. */
  21806. get view(): NodeMaterialConnectionPoint;
  21807. /**
  21808. * Gets the refraction object output component
  21809. */
  21810. get refraction(): NodeMaterialConnectionPoint;
  21811. /**
  21812. * Returns true if the block has a texture
  21813. */
  21814. get hasTexture(): boolean;
  21815. protected _getTexture(): Nullable<BaseTexture>;
  21816. autoConfigure(material: NodeMaterial): void;
  21817. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21818. isReady(): boolean;
  21819. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21820. /**
  21821. * Gets the main code of the block (fragment side)
  21822. * @param state current state of the node material building
  21823. * @returns the shader code
  21824. */
  21825. getCode(state: NodeMaterialBuildState): string;
  21826. protected _buildBlock(state: NodeMaterialBuildState): this;
  21827. protected _dumpPropertiesCode(): string;
  21828. serialize(): any;
  21829. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21830. }
  21831. }
  21832. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21833. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21834. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21835. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21836. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21838. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21839. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21840. import { Nullable } from "babylonjs/types";
  21841. import { Scene } from "babylonjs/scene";
  21842. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21843. /**
  21844. * Base block used as input for post process
  21845. */
  21846. export class CurrentScreenBlock extends NodeMaterialBlock {
  21847. private _samplerName;
  21848. private _linearDefineName;
  21849. private _gammaDefineName;
  21850. private _mainUVName;
  21851. private _tempTextureRead;
  21852. /**
  21853. * Gets or sets the texture associated with the node
  21854. */
  21855. texture: Nullable<BaseTexture>;
  21856. /**
  21857. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21858. */
  21859. convertToGammaSpace: boolean;
  21860. /**
  21861. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21862. */
  21863. convertToLinearSpace: boolean;
  21864. /**
  21865. * Create a new CurrentScreenBlock
  21866. * @param name defines the block name
  21867. */
  21868. constructor(name: string);
  21869. /**
  21870. * Gets the current class name
  21871. * @returns the class name
  21872. */
  21873. getClassName(): string;
  21874. /**
  21875. * Gets the uv input component
  21876. */
  21877. get uv(): NodeMaterialConnectionPoint;
  21878. /**
  21879. * Gets the rgba output component
  21880. */
  21881. get rgba(): NodeMaterialConnectionPoint;
  21882. /**
  21883. * Gets the rgb output component
  21884. */
  21885. get rgb(): NodeMaterialConnectionPoint;
  21886. /**
  21887. * Gets the r output component
  21888. */
  21889. get r(): NodeMaterialConnectionPoint;
  21890. /**
  21891. * Gets the g output component
  21892. */
  21893. get g(): NodeMaterialConnectionPoint;
  21894. /**
  21895. * Gets the b output component
  21896. */
  21897. get b(): NodeMaterialConnectionPoint;
  21898. /**
  21899. * Gets the a output component
  21900. */
  21901. get a(): NodeMaterialConnectionPoint;
  21902. /**
  21903. * Initialize the block and prepare the context for build
  21904. * @param state defines the state that will be used for the build
  21905. */
  21906. initialize(state: NodeMaterialBuildState): void;
  21907. get target(): NodeMaterialBlockTargets;
  21908. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21909. isReady(): boolean;
  21910. private _injectVertexCode;
  21911. private _writeTextureRead;
  21912. private _writeOutput;
  21913. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21914. serialize(): any;
  21915. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21916. }
  21917. }
  21918. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21923. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21924. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21925. import { Nullable } from "babylonjs/types";
  21926. import { Scene } from "babylonjs/scene";
  21927. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21928. /**
  21929. * Base block used for the particle texture
  21930. */
  21931. export class ParticleTextureBlock extends NodeMaterialBlock {
  21932. private _samplerName;
  21933. private _linearDefineName;
  21934. private _gammaDefineName;
  21935. private _tempTextureRead;
  21936. /**
  21937. * Gets or sets the texture associated with the node
  21938. */
  21939. texture: Nullable<BaseTexture>;
  21940. /**
  21941. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21942. */
  21943. convertToGammaSpace: boolean;
  21944. /**
  21945. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21946. */
  21947. convertToLinearSpace: boolean;
  21948. /**
  21949. * Create a new ParticleTextureBlock
  21950. * @param name defines the block name
  21951. */
  21952. constructor(name: string);
  21953. /**
  21954. * Gets the current class name
  21955. * @returns the class name
  21956. */
  21957. getClassName(): string;
  21958. /**
  21959. * Gets the uv input component
  21960. */
  21961. get uv(): NodeMaterialConnectionPoint;
  21962. /**
  21963. * Gets the rgba output component
  21964. */
  21965. get rgba(): NodeMaterialConnectionPoint;
  21966. /**
  21967. * Gets the rgb output component
  21968. */
  21969. get rgb(): NodeMaterialConnectionPoint;
  21970. /**
  21971. * Gets the r output component
  21972. */
  21973. get r(): NodeMaterialConnectionPoint;
  21974. /**
  21975. * Gets the g output component
  21976. */
  21977. get g(): NodeMaterialConnectionPoint;
  21978. /**
  21979. * Gets the b output component
  21980. */
  21981. get b(): NodeMaterialConnectionPoint;
  21982. /**
  21983. * Gets the a output component
  21984. */
  21985. get a(): NodeMaterialConnectionPoint;
  21986. /**
  21987. * Initialize the block and prepare the context for build
  21988. * @param state defines the state that will be used for the build
  21989. */
  21990. initialize(state: NodeMaterialBuildState): void;
  21991. autoConfigure(material: NodeMaterial): void;
  21992. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21993. isReady(): boolean;
  21994. private _writeOutput;
  21995. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21996. serialize(): any;
  21997. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21998. }
  21999. }
  22000. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22001. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22002. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22003. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22004. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22005. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22006. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22007. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22008. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22009. import { Scene } from "babylonjs/scene";
  22010. /**
  22011. * Class used to store shared data between 2 NodeMaterialBuildState
  22012. */
  22013. export class NodeMaterialBuildStateSharedData {
  22014. /**
  22015. * Gets the list of emitted varyings
  22016. */
  22017. temps: string[];
  22018. /**
  22019. * Gets the list of emitted varyings
  22020. */
  22021. varyings: string[];
  22022. /**
  22023. * Gets the varying declaration string
  22024. */
  22025. varyingDeclaration: string;
  22026. /**
  22027. * Input blocks
  22028. */
  22029. inputBlocks: InputBlock[];
  22030. /**
  22031. * Input blocks
  22032. */
  22033. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22034. /**
  22035. * Bindable blocks (Blocks that need to set data to the effect)
  22036. */
  22037. bindableBlocks: NodeMaterialBlock[];
  22038. /**
  22039. * List of blocks that can provide a compilation fallback
  22040. */
  22041. blocksWithFallbacks: NodeMaterialBlock[];
  22042. /**
  22043. * List of blocks that can provide a define update
  22044. */
  22045. blocksWithDefines: NodeMaterialBlock[];
  22046. /**
  22047. * List of blocks that can provide a repeatable content
  22048. */
  22049. repeatableContentBlocks: NodeMaterialBlock[];
  22050. /**
  22051. * List of blocks that can provide a dynamic list of uniforms
  22052. */
  22053. dynamicUniformBlocks: NodeMaterialBlock[];
  22054. /**
  22055. * List of blocks that can block the isReady function for the material
  22056. */
  22057. blockingBlocks: NodeMaterialBlock[];
  22058. /**
  22059. * Gets the list of animated inputs
  22060. */
  22061. animatedInputs: InputBlock[];
  22062. /**
  22063. * Build Id used to avoid multiple recompilations
  22064. */
  22065. buildId: number;
  22066. /** List of emitted variables */
  22067. variableNames: {
  22068. [key: string]: number;
  22069. };
  22070. /** List of emitted defines */
  22071. defineNames: {
  22072. [key: string]: number;
  22073. };
  22074. /** Should emit comments? */
  22075. emitComments: boolean;
  22076. /** Emit build activity */
  22077. verbose: boolean;
  22078. /** Gets or sets the hosting scene */
  22079. scene: Scene;
  22080. /**
  22081. * Gets the compilation hints emitted at compilation time
  22082. */
  22083. hints: {
  22084. needWorldViewMatrix: boolean;
  22085. needWorldViewProjectionMatrix: boolean;
  22086. needAlphaBlending: boolean;
  22087. needAlphaTesting: boolean;
  22088. };
  22089. /**
  22090. * List of compilation checks
  22091. */
  22092. checks: {
  22093. emitVertex: boolean;
  22094. emitFragment: boolean;
  22095. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22096. };
  22097. /**
  22098. * Is vertex program allowed to be empty?
  22099. */
  22100. allowEmptyVertexProgram: boolean;
  22101. /** Creates a new shared data */
  22102. constructor();
  22103. /**
  22104. * Emits console errors and exceptions if there is a failing check
  22105. */
  22106. emitErrors(): void;
  22107. }
  22108. }
  22109. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22110. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22111. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22112. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22113. /**
  22114. * Class used to store node based material build state
  22115. */
  22116. export class NodeMaterialBuildState {
  22117. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22118. supportUniformBuffers: boolean;
  22119. /**
  22120. * Gets the list of emitted attributes
  22121. */
  22122. attributes: string[];
  22123. /**
  22124. * Gets the list of emitted uniforms
  22125. */
  22126. uniforms: string[];
  22127. /**
  22128. * Gets the list of emitted constants
  22129. */
  22130. constants: string[];
  22131. /**
  22132. * Gets the list of emitted samplers
  22133. */
  22134. samplers: string[];
  22135. /**
  22136. * Gets the list of emitted functions
  22137. */
  22138. functions: {
  22139. [key: string]: string;
  22140. };
  22141. /**
  22142. * Gets the list of emitted extensions
  22143. */
  22144. extensions: {
  22145. [key: string]: string;
  22146. };
  22147. /**
  22148. * Gets the target of the compilation state
  22149. */
  22150. target: NodeMaterialBlockTargets;
  22151. /**
  22152. * Gets the list of emitted counters
  22153. */
  22154. counters: {
  22155. [key: string]: number;
  22156. };
  22157. /**
  22158. * Shared data between multiple NodeMaterialBuildState instances
  22159. */
  22160. sharedData: NodeMaterialBuildStateSharedData;
  22161. /** @hidden */
  22162. _vertexState: NodeMaterialBuildState;
  22163. /** @hidden */
  22164. _attributeDeclaration: string;
  22165. /** @hidden */
  22166. _uniformDeclaration: string;
  22167. /** @hidden */
  22168. _constantDeclaration: string;
  22169. /** @hidden */
  22170. _samplerDeclaration: string;
  22171. /** @hidden */
  22172. _varyingTransfer: string;
  22173. /** @hidden */
  22174. _injectAtEnd: string;
  22175. private _repeatableContentAnchorIndex;
  22176. /** @hidden */
  22177. _builtCompilationString: string;
  22178. /**
  22179. * Gets the emitted compilation strings
  22180. */
  22181. compilationString: string;
  22182. /**
  22183. * Finalize the compilation strings
  22184. * @param state defines the current compilation state
  22185. */
  22186. finalize(state: NodeMaterialBuildState): void;
  22187. /** @hidden */
  22188. get _repeatableContentAnchor(): string;
  22189. /** @hidden */
  22190. _getFreeVariableName(prefix: string): string;
  22191. /** @hidden */
  22192. _getFreeDefineName(prefix: string): string;
  22193. /** @hidden */
  22194. _excludeVariableName(name: string): void;
  22195. /** @hidden */
  22196. _emit2DSampler(name: string): void;
  22197. /** @hidden */
  22198. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22199. /** @hidden */
  22200. _emitExtension(name: string, extension: string, define?: string): void;
  22201. /** @hidden */
  22202. _emitFunction(name: string, code: string, comments: string): void;
  22203. /** @hidden */
  22204. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22205. replaceStrings?: {
  22206. search: RegExp;
  22207. replace: string;
  22208. }[];
  22209. repeatKey?: string;
  22210. }): string;
  22211. /** @hidden */
  22212. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22213. repeatKey?: string;
  22214. removeAttributes?: boolean;
  22215. removeUniforms?: boolean;
  22216. removeVaryings?: boolean;
  22217. removeIfDef?: boolean;
  22218. replaceStrings?: {
  22219. search: RegExp;
  22220. replace: string;
  22221. }[];
  22222. }, storeKey?: string): void;
  22223. /** @hidden */
  22224. _registerTempVariable(name: string): boolean;
  22225. /** @hidden */
  22226. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22227. /** @hidden */
  22228. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22229. /** @hidden */
  22230. _emitFloat(value: number): string;
  22231. }
  22232. }
  22233. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22234. /**
  22235. * Helper class used to generate session unique ID
  22236. */
  22237. export class UniqueIdGenerator {
  22238. private static _UniqueIdCounter;
  22239. /**
  22240. * Gets an unique (relatively to the current scene) Id
  22241. */
  22242. static get UniqueId(): number;
  22243. }
  22244. }
  22245. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22246. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22247. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22248. import { Nullable } from "babylonjs/types";
  22249. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22250. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22251. import { Effect } from "babylonjs/Materials/effect";
  22252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22253. import { Mesh } from "babylonjs/Meshes/mesh";
  22254. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22255. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22256. import { Scene } from "babylonjs/scene";
  22257. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22258. /**
  22259. * Defines a block that can be used inside a node based material
  22260. */
  22261. export class NodeMaterialBlock {
  22262. private _buildId;
  22263. private _buildTarget;
  22264. private _target;
  22265. private _isFinalMerger;
  22266. private _isInput;
  22267. private _name;
  22268. protected _isUnique: boolean;
  22269. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22270. inputsAreExclusive: boolean;
  22271. /** @hidden */
  22272. _codeVariableName: string;
  22273. /** @hidden */
  22274. _inputs: NodeMaterialConnectionPoint[];
  22275. /** @hidden */
  22276. _outputs: NodeMaterialConnectionPoint[];
  22277. /** @hidden */
  22278. _preparationId: number;
  22279. /**
  22280. * Gets the name of the block
  22281. */
  22282. get name(): string;
  22283. /**
  22284. * Sets the name of the block. Will check if the name is valid.
  22285. */
  22286. set name(newName: string);
  22287. /**
  22288. * Gets or sets the unique id of the node
  22289. */
  22290. uniqueId: number;
  22291. /**
  22292. * Gets or sets the comments associated with this block
  22293. */
  22294. comments: string;
  22295. /**
  22296. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22297. */
  22298. get isUnique(): boolean;
  22299. /**
  22300. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22301. */
  22302. get isFinalMerger(): boolean;
  22303. /**
  22304. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22305. */
  22306. get isInput(): boolean;
  22307. /**
  22308. * Gets or sets the build Id
  22309. */
  22310. get buildId(): number;
  22311. set buildId(value: number);
  22312. /**
  22313. * Gets or sets the target of the block
  22314. */
  22315. get target(): NodeMaterialBlockTargets;
  22316. set target(value: NodeMaterialBlockTargets);
  22317. /**
  22318. * Gets the list of input points
  22319. */
  22320. get inputs(): NodeMaterialConnectionPoint[];
  22321. /** Gets the list of output points */
  22322. get outputs(): NodeMaterialConnectionPoint[];
  22323. /**
  22324. * Find an input by its name
  22325. * @param name defines the name of the input to look for
  22326. * @returns the input or null if not found
  22327. */
  22328. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22329. /**
  22330. * Find an output by its name
  22331. * @param name defines the name of the outputto look for
  22332. * @returns the output or null if not found
  22333. */
  22334. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22335. /**
  22336. * Creates a new NodeMaterialBlock
  22337. * @param name defines the block name
  22338. * @param target defines the target of that block (Vertex by default)
  22339. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22340. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22341. */
  22342. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22343. /**
  22344. * Initialize the block and prepare the context for build
  22345. * @param state defines the state that will be used for the build
  22346. */
  22347. initialize(state: NodeMaterialBuildState): void;
  22348. /**
  22349. * Bind data to effect. Will only be called for blocks with isBindable === true
  22350. * @param effect defines the effect to bind data to
  22351. * @param nodeMaterial defines the hosting NodeMaterial
  22352. * @param mesh defines the mesh that will be rendered
  22353. * @param subMesh defines the submesh that will be rendered
  22354. */
  22355. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22356. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22357. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22358. protected _writeFloat(value: number): string;
  22359. /**
  22360. * Gets the current class name e.g. "NodeMaterialBlock"
  22361. * @returns the class name
  22362. */
  22363. getClassName(): string;
  22364. /**
  22365. * Register a new input. Must be called inside a block constructor
  22366. * @param name defines the connection point name
  22367. * @param type defines the connection point type
  22368. * @param isOptional defines a boolean indicating that this input can be omitted
  22369. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22370. * @param point an already created connection point. If not provided, create a new one
  22371. * @returns the current block
  22372. */
  22373. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22374. /**
  22375. * Register a new output. Must be called inside a block constructor
  22376. * @param name defines the connection point name
  22377. * @param type defines the connection point type
  22378. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22379. * @param point an already created connection point. If not provided, create a new one
  22380. * @returns the current block
  22381. */
  22382. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22383. /**
  22384. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22385. * @param forOutput defines an optional connection point to check compatibility with
  22386. * @returns the first available input or null
  22387. */
  22388. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22389. /**
  22390. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22391. * @param forBlock defines an optional block to check compatibility with
  22392. * @returns the first available input or null
  22393. */
  22394. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22395. /**
  22396. * Gets the sibling of the given output
  22397. * @param current defines the current output
  22398. * @returns the next output in the list or null
  22399. */
  22400. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22401. /**
  22402. * Connect current block with another block
  22403. * @param other defines the block to connect with
  22404. * @param options define the various options to help pick the right connections
  22405. * @returns the current block
  22406. */
  22407. connectTo(other: NodeMaterialBlock, options?: {
  22408. input?: string;
  22409. output?: string;
  22410. outputSwizzle?: string;
  22411. }): this | undefined;
  22412. protected _buildBlock(state: NodeMaterialBuildState): void;
  22413. /**
  22414. * Add uniforms, samplers and uniform buffers at compilation time
  22415. * @param state defines the state to update
  22416. * @param nodeMaterial defines the node material requesting the update
  22417. * @param defines defines the material defines to update
  22418. * @param uniformBuffers defines the list of uniform buffer names
  22419. */
  22420. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22421. /**
  22422. * Add potential fallbacks if shader compilation fails
  22423. * @param mesh defines the mesh to be rendered
  22424. * @param fallbacks defines the current prioritized list of fallbacks
  22425. */
  22426. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22427. /**
  22428. * Initialize defines for shader compilation
  22429. * @param mesh defines the mesh to be rendered
  22430. * @param nodeMaterial defines the node material requesting the update
  22431. * @param defines defines the material defines to update
  22432. * @param useInstances specifies that instances should be used
  22433. */
  22434. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22435. /**
  22436. * Update defines for shader compilation
  22437. * @param mesh defines the mesh to be rendered
  22438. * @param nodeMaterial defines the node material requesting the update
  22439. * @param defines defines the material defines to update
  22440. * @param useInstances specifies that instances should be used
  22441. * @param subMesh defines which submesh to render
  22442. */
  22443. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22444. /**
  22445. * Lets the block try to connect some inputs automatically
  22446. * @param material defines the hosting NodeMaterial
  22447. */
  22448. autoConfigure(material: NodeMaterial): void;
  22449. /**
  22450. * Function called when a block is declared as repeatable content generator
  22451. * @param vertexShaderState defines the current compilation state for the vertex shader
  22452. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22453. * @param mesh defines the mesh to be rendered
  22454. * @param defines defines the material defines to update
  22455. */
  22456. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22457. /**
  22458. * Checks if the block is ready
  22459. * @param mesh defines the mesh to be rendered
  22460. * @param nodeMaterial defines the node material requesting the update
  22461. * @param defines defines the material defines to update
  22462. * @param useInstances specifies that instances should be used
  22463. * @returns true if the block is ready
  22464. */
  22465. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22466. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22467. private _processBuild;
  22468. /**
  22469. * Validates the new name for the block node.
  22470. * @param newName the new name to be given to the node.
  22471. * @returns false if the name is a reserve word, else true.
  22472. */
  22473. validateBlockName(newName: string): boolean;
  22474. /**
  22475. * Compile the current node and generate the shader code
  22476. * @param state defines the current compilation state (uniforms, samplers, current string)
  22477. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22478. * @returns true if already built
  22479. */
  22480. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22481. protected _inputRename(name: string): string;
  22482. protected _outputRename(name: string): string;
  22483. protected _dumpPropertiesCode(): string;
  22484. /** @hidden */
  22485. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22486. /** @hidden */
  22487. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22488. /**
  22489. * Clone the current block to a new identical block
  22490. * @param scene defines the hosting scene
  22491. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22492. * @returns a copy of the current block
  22493. */
  22494. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22495. /**
  22496. * Serializes this block in a JSON representation
  22497. * @returns the serialized block object
  22498. */
  22499. serialize(): any;
  22500. /** @hidden */
  22501. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22502. private _deserializePortDisplayNamesAndExposedOnFrame;
  22503. /**
  22504. * Release resources
  22505. */
  22506. dispose(): void;
  22507. }
  22508. }
  22509. declare module "babylonjs/Materials/pushMaterial" {
  22510. import { Nullable } from "babylonjs/types";
  22511. import { Scene } from "babylonjs/scene";
  22512. import { Matrix } from "babylonjs/Maths/math.vector";
  22513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22514. import { Mesh } from "babylonjs/Meshes/mesh";
  22515. import { Material } from "babylonjs/Materials/material";
  22516. import { Effect } from "babylonjs/Materials/effect";
  22517. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22518. /**
  22519. * Base class of materials working in push mode in babylon JS
  22520. * @hidden
  22521. */
  22522. export class PushMaterial extends Material {
  22523. protected _activeEffect: Effect;
  22524. protected _normalMatrix: Matrix;
  22525. constructor(name: string, scene: Scene);
  22526. getEffect(): Effect;
  22527. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22528. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22529. /**
  22530. * Binds the given world matrix to the active effect
  22531. *
  22532. * @param world the matrix to bind
  22533. */
  22534. bindOnlyWorldMatrix(world: Matrix): void;
  22535. /**
  22536. * Binds the given normal matrix to the active effect
  22537. *
  22538. * @param normalMatrix the matrix to bind
  22539. */
  22540. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22541. bind(world: Matrix, mesh?: Mesh): void;
  22542. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22543. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22544. }
  22545. }
  22546. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22547. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22548. /**
  22549. * Root class for all node material optimizers
  22550. */
  22551. export class NodeMaterialOptimizer {
  22552. /**
  22553. * Function used to optimize a NodeMaterial graph
  22554. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22555. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22556. */
  22557. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22558. }
  22559. }
  22560. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22561. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22562. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22563. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22564. import { Scene } from "babylonjs/scene";
  22565. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22566. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22567. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22568. /**
  22569. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22570. */
  22571. export class TransformBlock extends NodeMaterialBlock {
  22572. /**
  22573. * Defines the value to use to complement W value to transform it to a Vector4
  22574. */
  22575. complementW: number;
  22576. /**
  22577. * Defines the value to use to complement z value to transform it to a Vector4
  22578. */
  22579. complementZ: number;
  22580. /**
  22581. * Creates a new TransformBlock
  22582. * @param name defines the block name
  22583. */
  22584. constructor(name: string);
  22585. /**
  22586. * Gets the current class name
  22587. * @returns the class name
  22588. */
  22589. getClassName(): string;
  22590. /**
  22591. * Gets the vector input
  22592. */
  22593. get vector(): NodeMaterialConnectionPoint;
  22594. /**
  22595. * Gets the output component
  22596. */
  22597. get output(): NodeMaterialConnectionPoint;
  22598. /**
  22599. * Gets the xyz output component
  22600. */
  22601. get xyz(): NodeMaterialConnectionPoint;
  22602. /**
  22603. * Gets the matrix transform input
  22604. */
  22605. get transform(): NodeMaterialConnectionPoint;
  22606. protected _buildBlock(state: NodeMaterialBuildState): this;
  22607. /**
  22608. * Update defines for shader compilation
  22609. * @param mesh defines the mesh to be rendered
  22610. * @param nodeMaterial defines the node material requesting the update
  22611. * @param defines defines the material defines to update
  22612. * @param useInstances specifies that instances should be used
  22613. * @param subMesh defines which submesh to render
  22614. */
  22615. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22616. serialize(): any;
  22617. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22618. protected _dumpPropertiesCode(): string;
  22619. }
  22620. }
  22621. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22622. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22623. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22624. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22625. /**
  22626. * Block used to output the vertex position
  22627. */
  22628. export class VertexOutputBlock extends NodeMaterialBlock {
  22629. /**
  22630. * Creates a new VertexOutputBlock
  22631. * @param name defines the block name
  22632. */
  22633. constructor(name: string);
  22634. /**
  22635. * Gets the current class name
  22636. * @returns the class name
  22637. */
  22638. getClassName(): string;
  22639. /**
  22640. * Gets the vector input component
  22641. */
  22642. get vector(): NodeMaterialConnectionPoint;
  22643. protected _buildBlock(state: NodeMaterialBuildState): this;
  22644. }
  22645. }
  22646. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22647. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22648. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22649. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22650. /**
  22651. * Block used to output the final color
  22652. */
  22653. export class FragmentOutputBlock extends NodeMaterialBlock {
  22654. /**
  22655. * Create a new FragmentOutputBlock
  22656. * @param name defines the block name
  22657. */
  22658. constructor(name: string);
  22659. /**
  22660. * Gets the current class name
  22661. * @returns the class name
  22662. */
  22663. getClassName(): string;
  22664. /**
  22665. * Gets the rgba input component
  22666. */
  22667. get rgba(): NodeMaterialConnectionPoint;
  22668. /**
  22669. * Gets the rgb input component
  22670. */
  22671. get rgb(): NodeMaterialConnectionPoint;
  22672. /**
  22673. * Gets the a input component
  22674. */
  22675. get a(): NodeMaterialConnectionPoint;
  22676. protected _buildBlock(state: NodeMaterialBuildState): this;
  22677. }
  22678. }
  22679. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22682. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22683. /**
  22684. * Block used for the particle ramp gradient section
  22685. */
  22686. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22687. /**
  22688. * Create a new ParticleRampGradientBlock
  22689. * @param name defines the block name
  22690. */
  22691. constructor(name: string);
  22692. /**
  22693. * Gets the current class name
  22694. * @returns the class name
  22695. */
  22696. getClassName(): string;
  22697. /**
  22698. * Gets the color input component
  22699. */
  22700. get color(): NodeMaterialConnectionPoint;
  22701. /**
  22702. * Gets the rampColor output component
  22703. */
  22704. get rampColor(): NodeMaterialConnectionPoint;
  22705. /**
  22706. * Initialize the block and prepare the context for build
  22707. * @param state defines the state that will be used for the build
  22708. */
  22709. initialize(state: NodeMaterialBuildState): void;
  22710. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22711. }
  22712. }
  22713. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22714. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22715. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22716. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22717. /**
  22718. * Block used for the particle blend multiply section
  22719. */
  22720. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22721. /**
  22722. * Create a new ParticleBlendMultiplyBlock
  22723. * @param name defines the block name
  22724. */
  22725. constructor(name: string);
  22726. /**
  22727. * Gets the current class name
  22728. * @returns the class name
  22729. */
  22730. getClassName(): string;
  22731. /**
  22732. * Gets the color input component
  22733. */
  22734. get color(): NodeMaterialConnectionPoint;
  22735. /**
  22736. * Gets the alphaTexture input component
  22737. */
  22738. get alphaTexture(): NodeMaterialConnectionPoint;
  22739. /**
  22740. * Gets the alphaColor input component
  22741. */
  22742. get alphaColor(): NodeMaterialConnectionPoint;
  22743. /**
  22744. * Gets the blendColor output component
  22745. */
  22746. get blendColor(): NodeMaterialConnectionPoint;
  22747. /**
  22748. * Initialize the block and prepare the context for build
  22749. * @param state defines the state that will be used for the build
  22750. */
  22751. initialize(state: NodeMaterialBuildState): void;
  22752. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22753. }
  22754. }
  22755. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22756. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22757. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22758. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22759. /**
  22760. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22761. */
  22762. export class VectorMergerBlock extends NodeMaterialBlock {
  22763. /**
  22764. * Create a new VectorMergerBlock
  22765. * @param name defines the block name
  22766. */
  22767. constructor(name: string);
  22768. /**
  22769. * Gets the current class name
  22770. * @returns the class name
  22771. */
  22772. getClassName(): string;
  22773. /**
  22774. * Gets the xyz component (input)
  22775. */
  22776. get xyzIn(): NodeMaterialConnectionPoint;
  22777. /**
  22778. * Gets the xy component (input)
  22779. */
  22780. get xyIn(): NodeMaterialConnectionPoint;
  22781. /**
  22782. * Gets the x component (input)
  22783. */
  22784. get x(): NodeMaterialConnectionPoint;
  22785. /**
  22786. * Gets the y component (input)
  22787. */
  22788. get y(): NodeMaterialConnectionPoint;
  22789. /**
  22790. * Gets the z component (input)
  22791. */
  22792. get z(): NodeMaterialConnectionPoint;
  22793. /**
  22794. * Gets the w component (input)
  22795. */
  22796. get w(): NodeMaterialConnectionPoint;
  22797. /**
  22798. * Gets the xyzw component (output)
  22799. */
  22800. get xyzw(): NodeMaterialConnectionPoint;
  22801. /**
  22802. * Gets the xyz component (output)
  22803. */
  22804. get xyzOut(): NodeMaterialConnectionPoint;
  22805. /**
  22806. * Gets the xy component (output)
  22807. */
  22808. get xyOut(): NodeMaterialConnectionPoint;
  22809. /**
  22810. * Gets the xy component (output)
  22811. * @deprecated Please use xyOut instead.
  22812. */
  22813. get xy(): NodeMaterialConnectionPoint;
  22814. /**
  22815. * Gets the xyz component (output)
  22816. * @deprecated Please use xyzOut instead.
  22817. */
  22818. get xyz(): NodeMaterialConnectionPoint;
  22819. protected _buildBlock(state: NodeMaterialBuildState): this;
  22820. }
  22821. }
  22822. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22823. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22824. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22825. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22826. import { Vector2 } from "babylonjs/Maths/math.vector";
  22827. import { Scene } from "babylonjs/scene";
  22828. /**
  22829. * Block used to remap a float from a range to a new one
  22830. */
  22831. export class RemapBlock extends NodeMaterialBlock {
  22832. /**
  22833. * Gets or sets the source range
  22834. */
  22835. sourceRange: Vector2;
  22836. /**
  22837. * Gets or sets the target range
  22838. */
  22839. targetRange: Vector2;
  22840. /**
  22841. * Creates a new RemapBlock
  22842. * @param name defines the block name
  22843. */
  22844. constructor(name: string);
  22845. /**
  22846. * Gets the current class name
  22847. * @returns the class name
  22848. */
  22849. getClassName(): string;
  22850. /**
  22851. * Gets the input component
  22852. */
  22853. get input(): NodeMaterialConnectionPoint;
  22854. /**
  22855. * Gets the source min input component
  22856. */
  22857. get sourceMin(): NodeMaterialConnectionPoint;
  22858. /**
  22859. * Gets the source max input component
  22860. */
  22861. get sourceMax(): NodeMaterialConnectionPoint;
  22862. /**
  22863. * Gets the target min input component
  22864. */
  22865. get targetMin(): NodeMaterialConnectionPoint;
  22866. /**
  22867. * Gets the target max input component
  22868. */
  22869. get targetMax(): NodeMaterialConnectionPoint;
  22870. /**
  22871. * Gets the output component
  22872. */
  22873. get output(): NodeMaterialConnectionPoint;
  22874. protected _buildBlock(state: NodeMaterialBuildState): this;
  22875. protected _dumpPropertiesCode(): string;
  22876. serialize(): any;
  22877. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22878. }
  22879. }
  22880. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22881. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22882. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22883. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22884. /**
  22885. * Block used to multiply 2 values
  22886. */
  22887. export class MultiplyBlock extends NodeMaterialBlock {
  22888. /**
  22889. * Creates a new MultiplyBlock
  22890. * @param name defines the block name
  22891. */
  22892. constructor(name: string);
  22893. /**
  22894. * Gets the current class name
  22895. * @returns the class name
  22896. */
  22897. getClassName(): string;
  22898. /**
  22899. * Gets the left operand input component
  22900. */
  22901. get left(): NodeMaterialConnectionPoint;
  22902. /**
  22903. * Gets the right operand input component
  22904. */
  22905. get right(): NodeMaterialConnectionPoint;
  22906. /**
  22907. * Gets the output component
  22908. */
  22909. get output(): NodeMaterialConnectionPoint;
  22910. protected _buildBlock(state: NodeMaterialBuildState): this;
  22911. }
  22912. }
  22913. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22914. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22915. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22916. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22917. /**
  22918. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22919. */
  22920. export class ColorSplitterBlock extends NodeMaterialBlock {
  22921. /**
  22922. * Create a new ColorSplitterBlock
  22923. * @param name defines the block name
  22924. */
  22925. constructor(name: string);
  22926. /**
  22927. * Gets the current class name
  22928. * @returns the class name
  22929. */
  22930. getClassName(): string;
  22931. /**
  22932. * Gets the rgba component (input)
  22933. */
  22934. get rgba(): NodeMaterialConnectionPoint;
  22935. /**
  22936. * Gets the rgb component (input)
  22937. */
  22938. get rgbIn(): NodeMaterialConnectionPoint;
  22939. /**
  22940. * Gets the rgb component (output)
  22941. */
  22942. get rgbOut(): NodeMaterialConnectionPoint;
  22943. /**
  22944. * Gets the r component (output)
  22945. */
  22946. get r(): NodeMaterialConnectionPoint;
  22947. /**
  22948. * Gets the g component (output)
  22949. */
  22950. get g(): NodeMaterialConnectionPoint;
  22951. /**
  22952. * Gets the b component (output)
  22953. */
  22954. get b(): NodeMaterialConnectionPoint;
  22955. /**
  22956. * Gets the a component (output)
  22957. */
  22958. get a(): NodeMaterialConnectionPoint;
  22959. protected _inputRename(name: string): string;
  22960. protected _outputRename(name: string): string;
  22961. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22962. }
  22963. }
  22964. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22965. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22966. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22967. import { Scene } from "babylonjs/scene";
  22968. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22969. import { Matrix } from "babylonjs/Maths/math.vector";
  22970. import { Mesh } from "babylonjs/Meshes/mesh";
  22971. import { Engine } from "babylonjs/Engines/engine";
  22972. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22973. import { Observable } from "babylonjs/Misc/observable";
  22974. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22975. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22976. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22977. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22978. import { Nullable } from "babylonjs/types";
  22979. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22980. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22981. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22982. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22983. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22984. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22985. import { Effect } from "babylonjs/Materials/effect";
  22986. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22987. import { Camera } from "babylonjs/Cameras/camera";
  22988. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22989. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22990. /**
  22991. * Interface used to configure the node material editor
  22992. */
  22993. export interface INodeMaterialEditorOptions {
  22994. /** Define the URl to load node editor script */
  22995. editorURL?: string;
  22996. }
  22997. /** @hidden */
  22998. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22999. NORMAL: boolean;
  23000. TANGENT: boolean;
  23001. UV1: boolean;
  23002. /** BONES */
  23003. NUM_BONE_INFLUENCERS: number;
  23004. BonesPerMesh: number;
  23005. BONETEXTURE: boolean;
  23006. /** MORPH TARGETS */
  23007. MORPHTARGETS: boolean;
  23008. MORPHTARGETS_NORMAL: boolean;
  23009. MORPHTARGETS_TANGENT: boolean;
  23010. MORPHTARGETS_UV: boolean;
  23011. NUM_MORPH_INFLUENCERS: number;
  23012. /** IMAGE PROCESSING */
  23013. IMAGEPROCESSING: boolean;
  23014. VIGNETTE: boolean;
  23015. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23016. VIGNETTEBLENDMODEOPAQUE: boolean;
  23017. TONEMAPPING: boolean;
  23018. TONEMAPPING_ACES: boolean;
  23019. CONTRAST: boolean;
  23020. EXPOSURE: boolean;
  23021. COLORCURVES: boolean;
  23022. COLORGRADING: boolean;
  23023. COLORGRADING3D: boolean;
  23024. SAMPLER3DGREENDEPTH: boolean;
  23025. SAMPLER3DBGRMAP: boolean;
  23026. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23027. /** MISC. */
  23028. BUMPDIRECTUV: number;
  23029. constructor();
  23030. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23031. }
  23032. /**
  23033. * Class used to configure NodeMaterial
  23034. */
  23035. export interface INodeMaterialOptions {
  23036. /**
  23037. * Defines if blocks should emit comments
  23038. */
  23039. emitComments: boolean;
  23040. }
  23041. /**
  23042. * Class used to create a node based material built by assembling shader blocks
  23043. */
  23044. export class NodeMaterial extends PushMaterial {
  23045. private static _BuildIdGenerator;
  23046. private _options;
  23047. private _vertexCompilationState;
  23048. private _fragmentCompilationState;
  23049. private _sharedData;
  23050. private _buildId;
  23051. private _buildWasSuccessful;
  23052. private _cachedWorldViewMatrix;
  23053. private _cachedWorldViewProjectionMatrix;
  23054. private _optimizers;
  23055. private _animationFrame;
  23056. /** Define the Url to load node editor script */
  23057. static EditorURL: string;
  23058. /** Define the Url to load snippets */
  23059. static SnippetUrl: string;
  23060. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23061. static IgnoreTexturesAtLoadTime: boolean;
  23062. private BJSNODEMATERIALEDITOR;
  23063. /** Get the inspector from bundle or global */
  23064. private _getGlobalNodeMaterialEditor;
  23065. /**
  23066. * Snippet ID if the material was created from the snippet server
  23067. */
  23068. snippetId: string;
  23069. /**
  23070. * Gets or sets data used by visual editor
  23071. * @see https://nme.babylonjs.com
  23072. */
  23073. editorData: any;
  23074. /**
  23075. * 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)
  23076. */
  23077. ignoreAlpha: boolean;
  23078. /**
  23079. * Defines the maximum number of lights that can be used in the material
  23080. */
  23081. maxSimultaneousLights: number;
  23082. /**
  23083. * Observable raised when the material is built
  23084. */
  23085. onBuildObservable: Observable<NodeMaterial>;
  23086. /**
  23087. * Gets or sets the root nodes of the material vertex shader
  23088. */
  23089. _vertexOutputNodes: NodeMaterialBlock[];
  23090. /**
  23091. * Gets or sets the root nodes of the material fragment (pixel) shader
  23092. */
  23093. _fragmentOutputNodes: NodeMaterialBlock[];
  23094. /** Gets or sets options to control the node material overall behavior */
  23095. get options(): INodeMaterialOptions;
  23096. set options(options: INodeMaterialOptions);
  23097. /**
  23098. * Default configuration related to image processing available in the standard Material.
  23099. */
  23100. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23101. /**
  23102. * Gets the image processing configuration used either in this material.
  23103. */
  23104. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23105. /**
  23106. * Sets the Default image processing configuration used either in the this material.
  23107. *
  23108. * If sets to null, the scene one is in use.
  23109. */
  23110. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23111. /**
  23112. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23113. */
  23114. attachedBlocks: NodeMaterialBlock[];
  23115. /**
  23116. * Specifies the mode of the node material
  23117. * @hidden
  23118. */
  23119. _mode: NodeMaterialModes;
  23120. /**
  23121. * Gets the mode property
  23122. */
  23123. get mode(): NodeMaterialModes;
  23124. /**
  23125. * Create a new node based material
  23126. * @param name defines the material name
  23127. * @param scene defines the hosting scene
  23128. * @param options defines creation option
  23129. */
  23130. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23131. /**
  23132. * Gets the current class name of the material e.g. "NodeMaterial"
  23133. * @returns the class name
  23134. */
  23135. getClassName(): string;
  23136. /**
  23137. * Keep track of the image processing observer to allow dispose and replace.
  23138. */
  23139. private _imageProcessingObserver;
  23140. /**
  23141. * Attaches a new image processing configuration to the Standard Material.
  23142. * @param configuration
  23143. */
  23144. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23145. /**
  23146. * Get a block by its name
  23147. * @param name defines the name of the block to retrieve
  23148. * @returns the required block or null if not found
  23149. */
  23150. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23151. /**
  23152. * Get a block by its name
  23153. * @param predicate defines the predicate used to find the good candidate
  23154. * @returns the required block or null if not found
  23155. */
  23156. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23157. /**
  23158. * Get an input block by its name
  23159. * @param predicate defines the predicate used to find the good candidate
  23160. * @returns the required input block or null if not found
  23161. */
  23162. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23163. /**
  23164. * Gets the list of input blocks attached to this material
  23165. * @returns an array of InputBlocks
  23166. */
  23167. getInputBlocks(): InputBlock[];
  23168. /**
  23169. * Adds a new optimizer to the list of optimizers
  23170. * @param optimizer defines the optimizers to add
  23171. * @returns the current material
  23172. */
  23173. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23174. /**
  23175. * Remove an optimizer from the list of optimizers
  23176. * @param optimizer defines the optimizers to remove
  23177. * @returns the current material
  23178. */
  23179. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23180. /**
  23181. * Add a new block to the list of output nodes
  23182. * @param node defines the node to add
  23183. * @returns the current material
  23184. */
  23185. addOutputNode(node: NodeMaterialBlock): this;
  23186. /**
  23187. * Remove a block from the list of root nodes
  23188. * @param node defines the node to remove
  23189. * @returns the current material
  23190. */
  23191. removeOutputNode(node: NodeMaterialBlock): this;
  23192. private _addVertexOutputNode;
  23193. private _removeVertexOutputNode;
  23194. private _addFragmentOutputNode;
  23195. private _removeFragmentOutputNode;
  23196. /**
  23197. * Specifies if the material will require alpha blending
  23198. * @returns a boolean specifying if alpha blending is needed
  23199. */
  23200. needAlphaBlending(): boolean;
  23201. /**
  23202. * Specifies if this material should be rendered in alpha test mode
  23203. * @returns a boolean specifying if an alpha test is needed.
  23204. */
  23205. needAlphaTesting(): boolean;
  23206. private _initializeBlock;
  23207. private _resetDualBlocks;
  23208. /**
  23209. * Remove a block from the current node material
  23210. * @param block defines the block to remove
  23211. */
  23212. removeBlock(block: NodeMaterialBlock): void;
  23213. /**
  23214. * Build the material and generates the inner effect
  23215. * @param verbose defines if the build should log activity
  23216. */
  23217. build(verbose?: boolean): void;
  23218. /**
  23219. * Runs an otpimization phase to try to improve the shader code
  23220. */
  23221. optimize(): void;
  23222. private _prepareDefinesForAttributes;
  23223. /**
  23224. * Create a post process from the material
  23225. * @param camera The camera to apply the render pass to.
  23226. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23227. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23228. * @param engine The engine which the post process will be applied. (default: current engine)
  23229. * @param reusable If the post process can be reused on the same frame. (default: false)
  23230. * @param textureType Type of textures used when performing the post process. (default: 0)
  23231. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23232. * @returns the post process created
  23233. */
  23234. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23235. /**
  23236. * Create the post process effect from the material
  23237. * @param postProcess The post process to create the effect for
  23238. */
  23239. createEffectForPostProcess(postProcess: PostProcess): void;
  23240. private _createEffectOrPostProcess;
  23241. private _createEffectForParticles;
  23242. /**
  23243. * Create the effect to be used as the custom effect for a particle system
  23244. * @param particleSystem Particle system to create the effect for
  23245. * @param onCompiled defines a function to call when the effect creation is successful
  23246. * @param onError defines a function to call when the effect creation has failed
  23247. */
  23248. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23249. private _processDefines;
  23250. /**
  23251. * Get if the submesh is ready to be used and all its information available.
  23252. * Child classes can use it to update shaders
  23253. * @param mesh defines the mesh to check
  23254. * @param subMesh defines which submesh to check
  23255. * @param useInstances specifies that instances should be used
  23256. * @returns a boolean indicating that the submesh is ready or not
  23257. */
  23258. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23259. /**
  23260. * Get a string representing the shaders built by the current node graph
  23261. */
  23262. get compiledShaders(): string;
  23263. /**
  23264. * Binds the world matrix to the material
  23265. * @param world defines the world transformation matrix
  23266. */
  23267. bindOnlyWorldMatrix(world: Matrix): void;
  23268. /**
  23269. * Binds the submesh to this material by preparing the effect and shader to draw
  23270. * @param world defines the world transformation matrix
  23271. * @param mesh defines the mesh containing the submesh
  23272. * @param subMesh defines the submesh to bind the material to
  23273. */
  23274. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23275. /**
  23276. * Gets the active textures from the material
  23277. * @returns an array of textures
  23278. */
  23279. getActiveTextures(): BaseTexture[];
  23280. /**
  23281. * Gets the list of texture blocks
  23282. * @returns an array of texture blocks
  23283. */
  23284. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23285. /**
  23286. * Specifies if the material uses a texture
  23287. * @param texture defines the texture to check against the material
  23288. * @returns a boolean specifying if the material uses the texture
  23289. */
  23290. hasTexture(texture: BaseTexture): boolean;
  23291. /**
  23292. * Disposes the material
  23293. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23294. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23295. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23296. */
  23297. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23298. /** Creates the node editor window. */
  23299. private _createNodeEditor;
  23300. /**
  23301. * Launch the node material editor
  23302. * @param config Define the configuration of the editor
  23303. * @return a promise fulfilled when the node editor is visible
  23304. */
  23305. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23306. /**
  23307. * Clear the current material
  23308. */
  23309. clear(): void;
  23310. /**
  23311. * Clear the current material and set it to a default state
  23312. */
  23313. setToDefault(): void;
  23314. /**
  23315. * Clear the current material and set it to a default state for post process
  23316. */
  23317. setToDefaultPostProcess(): void;
  23318. /**
  23319. * Clear the current material and set it to a default state for particle
  23320. */
  23321. setToDefaultParticle(): void;
  23322. /**
  23323. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23324. * @param url defines the url to load from
  23325. * @returns a promise that will fullfil when the material is fully loaded
  23326. */
  23327. loadAsync(url: string): Promise<void>;
  23328. private _gatherBlocks;
  23329. /**
  23330. * Generate a string containing the code declaration required to create an equivalent of this material
  23331. * @returns a string
  23332. */
  23333. generateCode(): string;
  23334. /**
  23335. * Serializes this material in a JSON representation
  23336. * @returns the serialized material object
  23337. */
  23338. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23339. private _restoreConnections;
  23340. /**
  23341. * Clear the current graph and load a new one from a serialization object
  23342. * @param source defines the JSON representation of the material
  23343. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23344. * @param merge defines whether or not the source must be merged or replace the current content
  23345. */
  23346. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23347. /**
  23348. * Makes a duplicate of the current material.
  23349. * @param name - name to use for the new material.
  23350. */
  23351. clone(name: string): NodeMaterial;
  23352. /**
  23353. * Creates a node material from parsed material data
  23354. * @param source defines the JSON representation of the material
  23355. * @param scene defines the hosting scene
  23356. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23357. * @returns a new node material
  23358. */
  23359. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23360. /**
  23361. * Creates a node material from a snippet saved in a remote file
  23362. * @param name defines the name of the material to create
  23363. * @param url defines the url to load from
  23364. * @param scene defines the hosting scene
  23365. * @returns a promise that will resolve to the new node material
  23366. */
  23367. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23368. /**
  23369. * Creates a node material from a snippet saved by the node material editor
  23370. * @param snippetId defines the snippet to load
  23371. * @param scene defines the hosting scene
  23372. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23373. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23374. * @returns a promise that will resolve to the new node material
  23375. */
  23376. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23377. /**
  23378. * Creates a new node material set to default basic configuration
  23379. * @param name defines the name of the material
  23380. * @param scene defines the hosting scene
  23381. * @returns a new NodeMaterial
  23382. */
  23383. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23384. }
  23385. }
  23386. declare module "babylonjs/PostProcesses/postProcess" {
  23387. import { Nullable } from "babylonjs/types";
  23388. import { SmartArray } from "babylonjs/Misc/smartArray";
  23389. import { Observable } from "babylonjs/Misc/observable";
  23390. import { Vector2 } from "babylonjs/Maths/math.vector";
  23391. import { Camera } from "babylonjs/Cameras/camera";
  23392. import { Effect } from "babylonjs/Materials/effect";
  23393. import "babylonjs/Shaders/postprocess.vertex";
  23394. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23395. import { Engine } from "babylonjs/Engines/engine";
  23396. import { Color4 } from "babylonjs/Maths/math.color";
  23397. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23398. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23399. import { Scene } from "babylonjs/scene";
  23400. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23401. /**
  23402. * Size options for a post process
  23403. */
  23404. export type PostProcessOptions = {
  23405. width: number;
  23406. height: number;
  23407. };
  23408. /**
  23409. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23410. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23411. */
  23412. export class PostProcess {
  23413. /**
  23414. * Gets or sets the unique id of the post process
  23415. */
  23416. uniqueId: number;
  23417. /** Name of the PostProcess. */
  23418. name: string;
  23419. /**
  23420. * Width of the texture to apply the post process on
  23421. */
  23422. width: number;
  23423. /**
  23424. * Height of the texture to apply the post process on
  23425. */
  23426. height: number;
  23427. /**
  23428. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23429. */
  23430. nodeMaterialSource: Nullable<NodeMaterial>;
  23431. /**
  23432. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23433. * @hidden
  23434. */
  23435. _outputTexture: Nullable<InternalTexture>;
  23436. /**
  23437. * Sampling mode used by the shader
  23438. * See https://doc.babylonjs.com/classes/3.1/texture
  23439. */
  23440. renderTargetSamplingMode: number;
  23441. /**
  23442. * Clear color to use when screen clearing
  23443. */
  23444. clearColor: Color4;
  23445. /**
  23446. * If the buffer needs to be cleared before applying the post process. (default: true)
  23447. * Should be set to false if shader will overwrite all previous pixels.
  23448. */
  23449. autoClear: boolean;
  23450. /**
  23451. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23452. */
  23453. alphaMode: number;
  23454. /**
  23455. * Sets the setAlphaBlendConstants of the babylon engine
  23456. */
  23457. alphaConstants: Color4;
  23458. /**
  23459. * Animations to be used for the post processing
  23460. */
  23461. animations: import("babylonjs/Animations/animation").Animation[];
  23462. /**
  23463. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23464. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23465. */
  23466. enablePixelPerfectMode: boolean;
  23467. /**
  23468. * Force the postprocess to be applied without taking in account viewport
  23469. */
  23470. forceFullscreenViewport: boolean;
  23471. /**
  23472. * List of inspectable custom properties (used by the Inspector)
  23473. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23474. */
  23475. inspectableCustomProperties: IInspectable[];
  23476. /**
  23477. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23478. *
  23479. * | Value | Type | Description |
  23480. * | ----- | ----------------------------------- | ----------- |
  23481. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23482. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23483. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23484. *
  23485. */
  23486. scaleMode: number;
  23487. /**
  23488. * Force textures to be a power of two (default: false)
  23489. */
  23490. alwaysForcePOT: boolean;
  23491. private _samples;
  23492. /**
  23493. * Number of sample textures (default: 1)
  23494. */
  23495. get samples(): number;
  23496. set samples(n: number);
  23497. /**
  23498. * Modify the scale of the post process to be the same as the viewport (default: false)
  23499. */
  23500. adaptScaleToCurrentViewport: boolean;
  23501. private _camera;
  23502. protected _scene: Scene;
  23503. private _engine;
  23504. private _options;
  23505. private _reusable;
  23506. private _textureType;
  23507. private _textureFormat;
  23508. /**
  23509. * Smart array of input and output textures for the post process.
  23510. * @hidden
  23511. */
  23512. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23513. /**
  23514. * The index in _textures that corresponds to the output texture.
  23515. * @hidden
  23516. */
  23517. _currentRenderTextureInd: number;
  23518. private _effect;
  23519. private _samplers;
  23520. private _fragmentUrl;
  23521. private _vertexUrl;
  23522. private _parameters;
  23523. private _scaleRatio;
  23524. protected _indexParameters: any;
  23525. private _shareOutputWithPostProcess;
  23526. private _texelSize;
  23527. private _forcedOutputTexture;
  23528. /**
  23529. * Returns the fragment url or shader name used in the post process.
  23530. * @returns the fragment url or name in the shader store.
  23531. */
  23532. getEffectName(): string;
  23533. /**
  23534. * An event triggered when the postprocess is activated.
  23535. */
  23536. onActivateObservable: Observable<Camera>;
  23537. private _onActivateObserver;
  23538. /**
  23539. * A function that is added to the onActivateObservable
  23540. */
  23541. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23542. /**
  23543. * An event triggered when the postprocess changes its size.
  23544. */
  23545. onSizeChangedObservable: Observable<PostProcess>;
  23546. private _onSizeChangedObserver;
  23547. /**
  23548. * A function that is added to the onSizeChangedObservable
  23549. */
  23550. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23551. /**
  23552. * An event triggered when the postprocess applies its effect.
  23553. */
  23554. onApplyObservable: Observable<Effect>;
  23555. private _onApplyObserver;
  23556. /**
  23557. * A function that is added to the onApplyObservable
  23558. */
  23559. set onApply(callback: (effect: Effect) => void);
  23560. /**
  23561. * An event triggered before rendering the postprocess
  23562. */
  23563. onBeforeRenderObservable: Observable<Effect>;
  23564. private _onBeforeRenderObserver;
  23565. /**
  23566. * A function that is added to the onBeforeRenderObservable
  23567. */
  23568. set onBeforeRender(callback: (effect: Effect) => void);
  23569. /**
  23570. * An event triggered after rendering the postprocess
  23571. */
  23572. onAfterRenderObservable: Observable<Effect>;
  23573. private _onAfterRenderObserver;
  23574. /**
  23575. * A function that is added to the onAfterRenderObservable
  23576. */
  23577. set onAfterRender(callback: (efect: Effect) => void);
  23578. /**
  23579. * 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
  23580. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23581. */
  23582. get inputTexture(): InternalTexture;
  23583. set inputTexture(value: InternalTexture);
  23584. /**
  23585. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23586. * the only way to unset it is to use this function to restore its internal state
  23587. */
  23588. restoreDefaultInputTexture(): void;
  23589. /**
  23590. * Gets the camera which post process is applied to.
  23591. * @returns The camera the post process is applied to.
  23592. */
  23593. getCamera(): Camera;
  23594. /**
  23595. * Gets the texel size of the postprocess.
  23596. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23597. */
  23598. get texelSize(): Vector2;
  23599. /**
  23600. * Creates a new instance PostProcess
  23601. * @param name The name of the PostProcess.
  23602. * @param fragmentUrl The url of the fragment shader to be used.
  23603. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23604. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23605. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23606. * @param camera The camera to apply the render pass to.
  23607. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23608. * @param engine The engine which the post process will be applied. (default: current engine)
  23609. * @param reusable If the post process can be reused on the same frame. (default: false)
  23610. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23611. * @param textureType Type of textures used when performing the post process. (default: 0)
  23612. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23613. * @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
  23614. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23615. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23616. */
  23617. constructor(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, textureFormat?: number);
  23618. /**
  23619. * Gets a string identifying the name of the class
  23620. * @returns "PostProcess" string
  23621. */
  23622. getClassName(): string;
  23623. /**
  23624. * Gets the engine which this post process belongs to.
  23625. * @returns The engine the post process was enabled with.
  23626. */
  23627. getEngine(): Engine;
  23628. /**
  23629. * The effect that is created when initializing the post process.
  23630. * @returns The created effect corresponding the the postprocess.
  23631. */
  23632. getEffect(): Effect;
  23633. /**
  23634. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23635. * @param postProcess The post process to share the output with.
  23636. * @returns This post process.
  23637. */
  23638. shareOutputWith(postProcess: PostProcess): PostProcess;
  23639. /**
  23640. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23641. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23642. */
  23643. useOwnOutput(): void;
  23644. /**
  23645. * Updates the effect with the current post process compile time values and recompiles the shader.
  23646. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23647. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23648. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23649. * @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
  23650. * @param onCompiled Called when the shader has been compiled.
  23651. * @param onError Called if there is an error when compiling a shader.
  23652. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23653. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23654. */
  23655. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23656. /**
  23657. * The post process is reusable if it can be used multiple times within one frame.
  23658. * @returns If the post process is reusable
  23659. */
  23660. isReusable(): boolean;
  23661. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23662. markTextureDirty(): void;
  23663. /**
  23664. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23665. * 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.
  23666. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23667. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23668. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23669. * @returns The target texture that was bound to be written to.
  23670. */
  23671. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23672. /**
  23673. * If the post process is supported.
  23674. */
  23675. get isSupported(): boolean;
  23676. /**
  23677. * The aspect ratio of the output texture.
  23678. */
  23679. get aspectRatio(): number;
  23680. /**
  23681. * Get a value indicating if the post-process is ready to be used
  23682. * @returns true if the post-process is ready (shader is compiled)
  23683. */
  23684. isReady(): boolean;
  23685. /**
  23686. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23687. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23688. */
  23689. apply(): Nullable<Effect>;
  23690. private _disposeTextures;
  23691. /**
  23692. * Disposes the post process.
  23693. * @param camera The camera to dispose the post process on.
  23694. */
  23695. dispose(camera?: Camera): void;
  23696. /**
  23697. * Serializes the particle system to a JSON object
  23698. * @returns the JSON object
  23699. */
  23700. serialize(): any;
  23701. /**
  23702. * Creates a material from parsed material data
  23703. * @param parsedPostProcess defines parsed post process data
  23704. * @param scene defines the hosting scene
  23705. * @param rootUrl defines the root URL to use to load textures
  23706. * @returns a new post process
  23707. */
  23708. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23709. }
  23710. }
  23711. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23712. /** @hidden */
  23713. export var kernelBlurVaryingDeclaration: {
  23714. name: string;
  23715. shader: string;
  23716. };
  23717. }
  23718. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23719. /** @hidden */
  23720. export var kernelBlurFragment: {
  23721. name: string;
  23722. shader: string;
  23723. };
  23724. }
  23725. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23726. /** @hidden */
  23727. export var kernelBlurFragment2: {
  23728. name: string;
  23729. shader: string;
  23730. };
  23731. }
  23732. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23733. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23734. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23736. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23737. /** @hidden */
  23738. export var kernelBlurPixelShader: {
  23739. name: string;
  23740. shader: string;
  23741. };
  23742. }
  23743. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23744. /** @hidden */
  23745. export var kernelBlurVertex: {
  23746. name: string;
  23747. shader: string;
  23748. };
  23749. }
  23750. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23752. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23753. /** @hidden */
  23754. export var kernelBlurVertexShader: {
  23755. name: string;
  23756. shader: string;
  23757. };
  23758. }
  23759. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23760. import { Vector2 } from "babylonjs/Maths/math.vector";
  23761. import { Nullable } from "babylonjs/types";
  23762. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23763. import { Camera } from "babylonjs/Cameras/camera";
  23764. import { Effect } from "babylonjs/Materials/effect";
  23765. import { Engine } from "babylonjs/Engines/engine";
  23766. import "babylonjs/Shaders/kernelBlur.fragment";
  23767. import "babylonjs/Shaders/kernelBlur.vertex";
  23768. import { Scene } from "babylonjs/scene";
  23769. /**
  23770. * The Blur Post Process which blurs an image based on a kernel and direction.
  23771. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23772. */
  23773. export class BlurPostProcess extends PostProcess {
  23774. private blockCompilation;
  23775. protected _kernel: number;
  23776. protected _idealKernel: number;
  23777. protected _packedFloat: boolean;
  23778. private _staticDefines;
  23779. /** The direction in which to blur the image. */
  23780. direction: Vector2;
  23781. /**
  23782. * Sets the length in pixels of the blur sample region
  23783. */
  23784. set kernel(v: number);
  23785. /**
  23786. * Gets the length in pixels of the blur sample region
  23787. */
  23788. get kernel(): number;
  23789. /**
  23790. * Sets wether or not the blur needs to unpack/repack floats
  23791. */
  23792. set packedFloat(v: boolean);
  23793. /**
  23794. * Gets wether or not the blur is unpacking/repacking floats
  23795. */
  23796. get packedFloat(): boolean;
  23797. /**
  23798. * Gets a string identifying the name of the class
  23799. * @returns "BlurPostProcess" string
  23800. */
  23801. getClassName(): string;
  23802. /**
  23803. * Creates a new instance BlurPostProcess
  23804. * @param name The name of the effect.
  23805. * @param direction The direction in which to blur the image.
  23806. * @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.
  23807. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23808. * @param camera The camera to apply the render pass to.
  23809. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23810. * @param engine The engine which the post process will be applied. (default: current engine)
  23811. * @param reusable If the post process can be reused on the same frame. (default: false)
  23812. * @param textureType Type of textures used when performing the post process. (default: 0)
  23813. * @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)
  23814. */
  23815. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23816. /**
  23817. * Updates the effect with the current post process compile time values and recompiles the shader.
  23818. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23819. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23820. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23821. * @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
  23822. * @param onCompiled Called when the shader has been compiled.
  23823. * @param onError Called if there is an error when compiling a shader.
  23824. */
  23825. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23827. /**
  23828. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23829. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23830. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23831. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23832. * The gaps between physical kernels are compensated for in the weighting of the samples
  23833. * @param idealKernel Ideal blur kernel.
  23834. * @return Nearest best kernel.
  23835. */
  23836. protected _nearestBestKernel(idealKernel: number): number;
  23837. /**
  23838. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23839. * @param x The point on the Gaussian distribution to sample.
  23840. * @return the value of the Gaussian function at x.
  23841. */
  23842. protected _gaussianWeight(x: number): number;
  23843. /**
  23844. * Generates a string that can be used as a floating point number in GLSL.
  23845. * @param x Value to print.
  23846. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23847. * @return GLSL float string.
  23848. */
  23849. protected _glslFloat(x: number, decimalFigures?: number): string;
  23850. /** @hidden */
  23851. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23852. }
  23853. }
  23854. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23855. import { Scene } from "babylonjs/scene";
  23856. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23857. import { Plane } from "babylonjs/Maths/math.plane";
  23858. /**
  23859. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23860. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23861. * You can then easily use it as a reflectionTexture on a flat surface.
  23862. * In case the surface is not a plane, please consider relying on reflection probes.
  23863. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23864. */
  23865. export class MirrorTexture extends RenderTargetTexture {
  23866. private scene;
  23867. /**
  23868. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23869. * 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.
  23870. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23871. */
  23872. mirrorPlane: Plane;
  23873. /**
  23874. * Define the blur ratio used to blur the reflection if needed.
  23875. */
  23876. set blurRatio(value: number);
  23877. get blurRatio(): number;
  23878. /**
  23879. * Define the adaptive blur kernel used to blur the reflection if needed.
  23880. * This will autocompute the closest best match for the `blurKernel`
  23881. */
  23882. set adaptiveBlurKernel(value: number);
  23883. /**
  23884. * Define the blur kernel used to blur the reflection if needed.
  23885. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23886. */
  23887. set blurKernel(value: number);
  23888. /**
  23889. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23890. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23891. */
  23892. set blurKernelX(value: number);
  23893. get blurKernelX(): number;
  23894. /**
  23895. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23896. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23897. */
  23898. set blurKernelY(value: number);
  23899. get blurKernelY(): number;
  23900. private _autoComputeBlurKernel;
  23901. protected _onRatioRescale(): void;
  23902. private _updateGammaSpace;
  23903. private _imageProcessingConfigChangeObserver;
  23904. private _transformMatrix;
  23905. private _mirrorMatrix;
  23906. private _savedViewMatrix;
  23907. private _blurX;
  23908. private _blurY;
  23909. private _adaptiveBlurKernel;
  23910. private _blurKernelX;
  23911. private _blurKernelY;
  23912. private _blurRatio;
  23913. /**
  23914. * Instantiates a Mirror Texture.
  23915. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23916. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23917. * You can then easily use it as a reflectionTexture on a flat surface.
  23918. * In case the surface is not a plane, please consider relying on reflection probes.
  23919. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23920. * @param name
  23921. * @param size
  23922. * @param scene
  23923. * @param generateMipMaps
  23924. * @param type
  23925. * @param samplingMode
  23926. * @param generateDepthBuffer
  23927. */
  23928. constructor(name: string, size: number | {
  23929. width: number;
  23930. height: number;
  23931. } | {
  23932. ratio: number;
  23933. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23934. private _preparePostProcesses;
  23935. /**
  23936. * Clone the mirror texture.
  23937. * @returns the cloned texture
  23938. */
  23939. clone(): MirrorTexture;
  23940. /**
  23941. * Serialize the texture to a JSON representation you could use in Parse later on
  23942. * @returns the serialized JSON representation
  23943. */
  23944. serialize(): any;
  23945. /**
  23946. * Dispose the texture and release its associated resources.
  23947. */
  23948. dispose(): void;
  23949. }
  23950. }
  23951. declare module "babylonjs/Materials/Textures/texture" {
  23952. import { Observable } from "babylonjs/Misc/observable";
  23953. import { Nullable } from "babylonjs/types";
  23954. import { Matrix } from "babylonjs/Maths/math.vector";
  23955. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23956. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23957. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23958. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23959. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23960. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23961. import { Scene } from "babylonjs/scene";
  23962. /**
  23963. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23964. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23965. */
  23966. export class Texture extends BaseTexture {
  23967. /**
  23968. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23969. */
  23970. static SerializeBuffers: boolean;
  23971. /** @hidden */
  23972. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23973. /** @hidden */
  23974. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23975. /** @hidden */
  23976. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23977. /** nearest is mag = nearest and min = nearest and mip = linear */
  23978. static readonly NEAREST_SAMPLINGMODE: number;
  23979. /** nearest is mag = nearest and min = nearest and mip = linear */
  23980. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23981. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23982. static readonly BILINEAR_SAMPLINGMODE: number;
  23983. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23984. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23985. /** Trilinear is mag = linear and min = linear and mip = linear */
  23986. static readonly TRILINEAR_SAMPLINGMODE: number;
  23987. /** Trilinear is mag = linear and min = linear and mip = linear */
  23988. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23989. /** mag = nearest and min = nearest and mip = nearest */
  23990. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23991. /** mag = nearest and min = linear and mip = nearest */
  23992. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23993. /** mag = nearest and min = linear and mip = linear */
  23994. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23995. /** mag = nearest and min = linear and mip = none */
  23996. static readonly NEAREST_LINEAR: number;
  23997. /** mag = nearest and min = nearest and mip = none */
  23998. static readonly NEAREST_NEAREST: number;
  23999. /** mag = linear and min = nearest and mip = nearest */
  24000. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24001. /** mag = linear and min = nearest and mip = linear */
  24002. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24003. /** mag = linear and min = linear and mip = none */
  24004. static readonly LINEAR_LINEAR: number;
  24005. /** mag = linear and min = nearest and mip = none */
  24006. static readonly LINEAR_NEAREST: number;
  24007. /** Explicit coordinates mode */
  24008. static readonly EXPLICIT_MODE: number;
  24009. /** Spherical coordinates mode */
  24010. static readonly SPHERICAL_MODE: number;
  24011. /** Planar coordinates mode */
  24012. static readonly PLANAR_MODE: number;
  24013. /** Cubic coordinates mode */
  24014. static readonly CUBIC_MODE: number;
  24015. /** Projection coordinates mode */
  24016. static readonly PROJECTION_MODE: number;
  24017. /** Inverse Cubic coordinates mode */
  24018. static readonly SKYBOX_MODE: number;
  24019. /** Inverse Cubic coordinates mode */
  24020. static readonly INVCUBIC_MODE: number;
  24021. /** Equirectangular coordinates mode */
  24022. static readonly EQUIRECTANGULAR_MODE: number;
  24023. /** Equirectangular Fixed coordinates mode */
  24024. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24025. /** Equirectangular Fixed Mirrored coordinates mode */
  24026. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24027. /** Texture is not repeating outside of 0..1 UVs */
  24028. static readonly CLAMP_ADDRESSMODE: number;
  24029. /** Texture is repeating outside of 0..1 UVs */
  24030. static readonly WRAP_ADDRESSMODE: number;
  24031. /** Texture is repeating and mirrored */
  24032. static readonly MIRROR_ADDRESSMODE: number;
  24033. /**
  24034. * 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
  24035. */
  24036. static UseSerializedUrlIfAny: boolean;
  24037. /**
  24038. * Define the url of the texture.
  24039. */
  24040. url: Nullable<string>;
  24041. /**
  24042. * Define an offset on the texture to offset the u coordinates of the UVs
  24043. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24044. */
  24045. uOffset: number;
  24046. /**
  24047. * Define an offset on the texture to offset the v coordinates of the UVs
  24048. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24049. */
  24050. vOffset: number;
  24051. /**
  24052. * Define an offset on the texture to scale the u coordinates of the UVs
  24053. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24054. */
  24055. uScale: number;
  24056. /**
  24057. * Define an offset on the texture to scale the v coordinates of the UVs
  24058. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24059. */
  24060. vScale: number;
  24061. /**
  24062. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24063. * @see https://doc.babylonjs.com/how_to/more_materials
  24064. */
  24065. uAng: number;
  24066. /**
  24067. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24068. * @see https://doc.babylonjs.com/how_to/more_materials
  24069. */
  24070. vAng: number;
  24071. /**
  24072. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24073. * @see https://doc.babylonjs.com/how_to/more_materials
  24074. */
  24075. wAng: number;
  24076. /**
  24077. * Defines the center of rotation (U)
  24078. */
  24079. uRotationCenter: number;
  24080. /**
  24081. * Defines the center of rotation (V)
  24082. */
  24083. vRotationCenter: number;
  24084. /**
  24085. * Defines the center of rotation (W)
  24086. */
  24087. wRotationCenter: number;
  24088. /**
  24089. * Are mip maps generated for this texture or not.
  24090. */
  24091. get noMipmap(): boolean;
  24092. /**
  24093. * List of inspectable custom properties (used by the Inspector)
  24094. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24095. */
  24096. inspectableCustomProperties: Nullable<IInspectable[]>;
  24097. private _noMipmap;
  24098. /** @hidden */
  24099. _invertY: boolean;
  24100. private _rowGenerationMatrix;
  24101. private _cachedTextureMatrix;
  24102. private _projectionModeMatrix;
  24103. private _t0;
  24104. private _t1;
  24105. private _t2;
  24106. private _cachedUOffset;
  24107. private _cachedVOffset;
  24108. private _cachedUScale;
  24109. private _cachedVScale;
  24110. private _cachedUAng;
  24111. private _cachedVAng;
  24112. private _cachedWAng;
  24113. private _cachedProjectionMatrixId;
  24114. private _cachedCoordinatesMode;
  24115. /** @hidden */
  24116. protected _initialSamplingMode: number;
  24117. /** @hidden */
  24118. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24119. private _deleteBuffer;
  24120. protected _format: Nullable<number>;
  24121. private _delayedOnLoad;
  24122. private _delayedOnError;
  24123. private _mimeType?;
  24124. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24125. get mimeType(): string | undefined;
  24126. /**
  24127. * Observable triggered once the texture has been loaded.
  24128. */
  24129. onLoadObservable: Observable<Texture>;
  24130. protected _isBlocking: boolean;
  24131. /**
  24132. * Is the texture preventing material to render while loading.
  24133. * If false, a default texture will be used instead of the loading one during the preparation step.
  24134. */
  24135. set isBlocking(value: boolean);
  24136. get isBlocking(): boolean;
  24137. /**
  24138. * Get the current sampling mode associated with the texture.
  24139. */
  24140. get samplingMode(): number;
  24141. /**
  24142. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24143. */
  24144. get invertY(): boolean;
  24145. /**
  24146. * Instantiates a new texture.
  24147. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24148. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24149. * @param url defines the url of the picture to load as a texture
  24150. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24151. * @param noMipmap defines if the texture will require mip maps or not
  24152. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24153. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24154. * @param onLoad defines a callback triggered when the texture has been loaded
  24155. * @param onError defines a callback triggered when an error occurred during the loading session
  24156. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24157. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24158. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24159. * @param mimeType defines an optional mime type information
  24160. */
  24161. 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);
  24162. /**
  24163. * Update the url (and optional buffer) of this texture if url was null during construction.
  24164. * @param url the url of the texture
  24165. * @param buffer the buffer of the texture (defaults to null)
  24166. * @param onLoad callback called when the texture is loaded (defaults to null)
  24167. */
  24168. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24169. /**
  24170. * Finish the loading sequence of a texture flagged as delayed load.
  24171. * @hidden
  24172. */
  24173. delayLoad(): void;
  24174. private _prepareRowForTextureGeneration;
  24175. /**
  24176. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24177. * @returns the transform matrix of the texture.
  24178. */
  24179. getTextureMatrix(uBase?: number): Matrix;
  24180. /**
  24181. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24182. * @returns The reflection texture transform
  24183. */
  24184. getReflectionTextureMatrix(): Matrix;
  24185. /**
  24186. * Clones the texture.
  24187. * @returns the cloned texture
  24188. */
  24189. clone(): Texture;
  24190. /**
  24191. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24192. * @returns The JSON representation of the texture
  24193. */
  24194. serialize(): any;
  24195. /**
  24196. * Get the current class name of the texture useful for serialization or dynamic coding.
  24197. * @returns "Texture"
  24198. */
  24199. getClassName(): string;
  24200. /**
  24201. * Dispose the texture and release its associated resources.
  24202. */
  24203. dispose(): void;
  24204. /**
  24205. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24206. * @param parsedTexture Define the JSON representation of the texture
  24207. * @param scene Define the scene the parsed texture should be instantiated in
  24208. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24209. * @returns The parsed texture if successful
  24210. */
  24211. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24212. /**
  24213. * Creates a texture from its base 64 representation.
  24214. * @param data Define the base64 payload without the data: prefix
  24215. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24216. * @param scene Define the scene the texture should belong to
  24217. * @param noMipmap Forces the texture to not create mip map information if true
  24218. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24219. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24220. * @param onLoad define a callback triggered when the texture has been loaded
  24221. * @param onError define a callback triggered when an error occurred during the loading session
  24222. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24223. * @returns the created texture
  24224. */
  24225. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24226. /**
  24227. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24228. * @param data Define the base64 payload without the data: prefix
  24229. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24230. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24231. * @param scene Define the scene the texture should belong to
  24232. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24233. * @param noMipmap Forces the texture to not create mip map information if true
  24234. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24235. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24236. * @param onLoad define a callback triggered when the texture has been loaded
  24237. * @param onError define a callback triggered when an error occurred during the loading session
  24238. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24239. * @returns the created texture
  24240. */
  24241. 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;
  24242. }
  24243. }
  24244. declare module "babylonjs/PostProcesses/postProcessManager" {
  24245. import { Nullable } from "babylonjs/types";
  24246. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24247. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24248. import { Scene } from "babylonjs/scene";
  24249. /**
  24250. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24251. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24252. */
  24253. export class PostProcessManager {
  24254. private _scene;
  24255. private _indexBuffer;
  24256. private _vertexBuffers;
  24257. /**
  24258. * Creates a new instance PostProcess
  24259. * @param scene The scene that the post process is associated with.
  24260. */
  24261. constructor(scene: Scene);
  24262. private _prepareBuffers;
  24263. private _buildIndexBuffer;
  24264. /**
  24265. * Rebuilds the vertex buffers of the manager.
  24266. * @hidden
  24267. */
  24268. _rebuild(): void;
  24269. /**
  24270. * Prepares a frame to be run through a post process.
  24271. * @param sourceTexture The input texture to the post procesess. (default: null)
  24272. * @param postProcesses An array of post processes to be run. (default: null)
  24273. * @returns True if the post processes were able to be run.
  24274. * @hidden
  24275. */
  24276. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24277. /**
  24278. * Manually render a set of post processes to a texture.
  24279. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24280. * @param postProcesses An array of post processes to be run.
  24281. * @param targetTexture The target texture to render to.
  24282. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24283. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24284. * @param lodLevel defines which lod of the texture to render to
  24285. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24286. */
  24287. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24288. /**
  24289. * Finalize the result of the output of the postprocesses.
  24290. * @param doNotPresent If true the result will not be displayed to the screen.
  24291. * @param targetTexture The target texture to render to.
  24292. * @param faceIndex The index of the face to bind the target texture to.
  24293. * @param postProcesses The array of post processes to render.
  24294. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24295. * @hidden
  24296. */
  24297. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24298. /**
  24299. * Disposes of the post process manager.
  24300. */
  24301. dispose(): void;
  24302. }
  24303. }
  24304. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24305. import { Observable } from "babylonjs/Misc/observable";
  24306. import { SmartArray } from "babylonjs/Misc/smartArray";
  24307. import { Nullable, Immutable } from "babylonjs/types";
  24308. import { Camera } from "babylonjs/Cameras/camera";
  24309. import { Scene } from "babylonjs/scene";
  24310. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24311. import { Color4 } from "babylonjs/Maths/math.color";
  24312. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24314. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24315. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24316. import { Texture } from "babylonjs/Materials/Textures/texture";
  24317. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24318. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24319. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24320. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24321. import { Engine } from "babylonjs/Engines/engine";
  24322. /**
  24323. * This Helps creating a texture that will be created from a camera in your scene.
  24324. * It is basically a dynamic texture that could be used to create special effects for instance.
  24325. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24326. */
  24327. export class RenderTargetTexture extends Texture {
  24328. /**
  24329. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24330. */
  24331. static readonly REFRESHRATE_RENDER_ONCE: number;
  24332. /**
  24333. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24334. */
  24335. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24336. /**
  24337. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24338. * the central point of your effect and can save a lot of performances.
  24339. */
  24340. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24341. /**
  24342. * Use this predicate to dynamically define the list of mesh you want to render.
  24343. * If set, the renderList property will be overwritten.
  24344. */
  24345. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24346. private _renderList;
  24347. /**
  24348. * Use this list to define the list of mesh you want to render.
  24349. */
  24350. get renderList(): Nullable<Array<AbstractMesh>>;
  24351. set renderList(value: Nullable<Array<AbstractMesh>>);
  24352. /**
  24353. * Use this function to overload the renderList array at rendering time.
  24354. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24355. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24356. * the cube (if the RTT is a cube, else layerOrFace=0).
  24357. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24358. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24359. * hold dummy elements!
  24360. */
  24361. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24362. private _hookArray;
  24363. /**
  24364. * Define if particles should be rendered in your texture.
  24365. */
  24366. renderParticles: boolean;
  24367. /**
  24368. * Define if sprites should be rendered in your texture.
  24369. */
  24370. renderSprites: boolean;
  24371. /**
  24372. * Define the camera used to render the texture.
  24373. */
  24374. activeCamera: Nullable<Camera>;
  24375. /**
  24376. * Override the mesh isReady function with your own one.
  24377. */
  24378. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24379. /**
  24380. * Override the render function of the texture with your own one.
  24381. */
  24382. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24383. /**
  24384. * Define if camera post processes should be use while rendering the texture.
  24385. */
  24386. useCameraPostProcesses: boolean;
  24387. /**
  24388. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24389. */
  24390. ignoreCameraViewport: boolean;
  24391. private _postProcessManager;
  24392. private _postProcesses;
  24393. private _resizeObserver;
  24394. /**
  24395. * An event triggered when the texture is unbind.
  24396. */
  24397. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24398. /**
  24399. * An event triggered when the texture is unbind.
  24400. */
  24401. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24402. private _onAfterUnbindObserver;
  24403. /**
  24404. * Set a after unbind callback in the texture.
  24405. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24406. */
  24407. set onAfterUnbind(callback: () => void);
  24408. /**
  24409. * An event triggered before rendering the texture
  24410. */
  24411. onBeforeRenderObservable: Observable<number>;
  24412. private _onBeforeRenderObserver;
  24413. /**
  24414. * Set a before render callback in the texture.
  24415. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24416. */
  24417. set onBeforeRender(callback: (faceIndex: number) => void);
  24418. /**
  24419. * An event triggered after rendering the texture
  24420. */
  24421. onAfterRenderObservable: Observable<number>;
  24422. private _onAfterRenderObserver;
  24423. /**
  24424. * Set a after render callback in the texture.
  24425. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24426. */
  24427. set onAfterRender(callback: (faceIndex: number) => void);
  24428. /**
  24429. * An event triggered after the texture clear
  24430. */
  24431. onClearObservable: Observable<Engine>;
  24432. private _onClearObserver;
  24433. /**
  24434. * Set a clear callback in the texture.
  24435. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24436. */
  24437. set onClear(callback: (Engine: Engine) => void);
  24438. /**
  24439. * An event triggered when the texture is resized.
  24440. */
  24441. onResizeObservable: Observable<RenderTargetTexture>;
  24442. /**
  24443. * Define the clear color of the Render Target if it should be different from the scene.
  24444. */
  24445. clearColor: Color4;
  24446. protected _size: number | {
  24447. width: number;
  24448. height: number;
  24449. layers?: number;
  24450. };
  24451. protected _initialSizeParameter: number | {
  24452. width: number;
  24453. height: number;
  24454. } | {
  24455. ratio: number;
  24456. };
  24457. protected _sizeRatio: Nullable<number>;
  24458. /** @hidden */
  24459. _generateMipMaps: boolean;
  24460. protected _renderingManager: RenderingManager;
  24461. /** @hidden */
  24462. _waitingRenderList?: string[];
  24463. protected _doNotChangeAspectRatio: boolean;
  24464. protected _currentRefreshId: number;
  24465. protected _refreshRate: number;
  24466. protected _textureMatrix: Matrix;
  24467. protected _samples: number;
  24468. protected _renderTargetOptions: RenderTargetCreationOptions;
  24469. /**
  24470. * Gets render target creation options that were used.
  24471. */
  24472. get renderTargetOptions(): RenderTargetCreationOptions;
  24473. protected _onRatioRescale(): void;
  24474. /**
  24475. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24476. * It must define where the camera used to render the texture is set
  24477. */
  24478. boundingBoxPosition: Vector3;
  24479. private _boundingBoxSize;
  24480. /**
  24481. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24482. * When defined, the cubemap will switch to local mode
  24483. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24484. * @example https://www.babylonjs-playground.com/#RNASML
  24485. */
  24486. set boundingBoxSize(value: Vector3);
  24487. get boundingBoxSize(): Vector3;
  24488. /**
  24489. * In case the RTT has been created with a depth texture, get the associated
  24490. * depth texture.
  24491. * Otherwise, return null.
  24492. */
  24493. get depthStencilTexture(): Nullable<InternalTexture>;
  24494. /**
  24495. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24496. * or used a shadow, depth texture...
  24497. * @param name The friendly name of the texture
  24498. * @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)
  24499. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24500. * @param generateMipMaps True if mip maps need to be generated after render.
  24501. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24502. * @param type The type of the buffer in the RTT (int, half float, float...)
  24503. * @param isCube True if a cube texture needs to be created
  24504. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24505. * @param generateDepthBuffer True to generate a depth buffer
  24506. * @param generateStencilBuffer True to generate a stencil buffer
  24507. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24508. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24509. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24510. */
  24511. constructor(name: string, size: number | {
  24512. width: number;
  24513. height: number;
  24514. layers?: number;
  24515. } | {
  24516. ratio: number;
  24517. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24518. /**
  24519. * Creates a depth stencil texture.
  24520. * This is only available in WebGL 2 or with the depth texture extension available.
  24521. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24522. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24523. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24524. */
  24525. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24526. private _processSizeParameter;
  24527. /**
  24528. * Define the number of samples to use in case of MSAA.
  24529. * It defaults to one meaning no MSAA has been enabled.
  24530. */
  24531. get samples(): number;
  24532. set samples(value: number);
  24533. /**
  24534. * Resets the refresh counter of the texture and start bak from scratch.
  24535. * Could be useful to regenerate the texture if it is setup to render only once.
  24536. */
  24537. resetRefreshCounter(): void;
  24538. /**
  24539. * Define the refresh rate of the texture or the rendering frequency.
  24540. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24541. */
  24542. get refreshRate(): number;
  24543. set refreshRate(value: number);
  24544. /**
  24545. * Adds a post process to the render target rendering passes.
  24546. * @param postProcess define the post process to add
  24547. */
  24548. addPostProcess(postProcess: PostProcess): void;
  24549. /**
  24550. * Clear all the post processes attached to the render target
  24551. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24552. */
  24553. clearPostProcesses(dispose?: boolean): void;
  24554. /**
  24555. * Remove one of the post process from the list of attached post processes to the texture
  24556. * @param postProcess define the post process to remove from the list
  24557. */
  24558. removePostProcess(postProcess: PostProcess): void;
  24559. /** @hidden */
  24560. _shouldRender(): boolean;
  24561. /**
  24562. * Gets the actual render size of the texture.
  24563. * @returns the width of the render size
  24564. */
  24565. getRenderSize(): number;
  24566. /**
  24567. * Gets the actual render width of the texture.
  24568. * @returns the width of the render size
  24569. */
  24570. getRenderWidth(): number;
  24571. /**
  24572. * Gets the actual render height of the texture.
  24573. * @returns the height of the render size
  24574. */
  24575. getRenderHeight(): number;
  24576. /**
  24577. * Gets the actual number of layers of the texture.
  24578. * @returns the number of layers
  24579. */
  24580. getRenderLayers(): number;
  24581. /**
  24582. * Get if the texture can be rescaled or not.
  24583. */
  24584. get canRescale(): boolean;
  24585. /**
  24586. * Resize the texture using a ratio.
  24587. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24588. */
  24589. scale(ratio: number): void;
  24590. /**
  24591. * Get the texture reflection matrix used to rotate/transform the reflection.
  24592. * @returns the reflection matrix
  24593. */
  24594. getReflectionTextureMatrix(): Matrix;
  24595. /**
  24596. * Resize the texture to a new desired size.
  24597. * Be carrefull as it will recreate all the data in the new texture.
  24598. * @param size Define the new size. It can be:
  24599. * - a number for squared texture,
  24600. * - an object containing { width: number, height: number }
  24601. * - or an object containing a ratio { ratio: number }
  24602. */
  24603. resize(size: number | {
  24604. width: number;
  24605. height: number;
  24606. } | {
  24607. ratio: number;
  24608. }): void;
  24609. private _defaultRenderListPrepared;
  24610. /**
  24611. * Renders all the objects from the render list into the texture.
  24612. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24613. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24614. */
  24615. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24616. private _bestReflectionRenderTargetDimension;
  24617. private _prepareRenderingManager;
  24618. /**
  24619. * @hidden
  24620. * @param faceIndex face index to bind to if this is a cubetexture
  24621. * @param layer defines the index of the texture to bind in the array
  24622. */
  24623. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24624. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24625. private renderToTarget;
  24626. /**
  24627. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24628. * This allowed control for front to back rendering or reversly depending of the special needs.
  24629. *
  24630. * @param renderingGroupId The rendering group id corresponding to its index
  24631. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24632. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24633. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24634. */
  24635. 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;
  24636. /**
  24637. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24638. *
  24639. * @param renderingGroupId The rendering group id corresponding to its index
  24640. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24641. */
  24642. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24643. /**
  24644. * Clones the texture.
  24645. * @returns the cloned texture
  24646. */
  24647. clone(): RenderTargetTexture;
  24648. /**
  24649. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24650. * @returns The JSON representation of the texture
  24651. */
  24652. serialize(): any;
  24653. /**
  24654. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24655. */
  24656. disposeFramebufferObjects(): void;
  24657. /**
  24658. * Dispose the texture and release its associated resources.
  24659. */
  24660. dispose(): void;
  24661. /** @hidden */
  24662. _rebuild(): void;
  24663. /**
  24664. * Clear the info related to rendering groups preventing retention point in material dispose.
  24665. */
  24666. freeRenderingGroups(): void;
  24667. /**
  24668. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24669. * @returns the view count
  24670. */
  24671. getViewCount(): number;
  24672. }
  24673. }
  24674. declare module "babylonjs/Misc/guid" {
  24675. /**
  24676. * Class used to manipulate GUIDs
  24677. */
  24678. export class GUID {
  24679. /**
  24680. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24681. * Be aware Math.random() could cause collisions, but:
  24682. * "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"
  24683. * @returns a pseudo random id
  24684. */
  24685. static RandomId(): string;
  24686. }
  24687. }
  24688. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24689. import { Nullable } from "babylonjs/types";
  24690. import { Scene } from "babylonjs/scene";
  24691. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24692. import { Material } from "babylonjs/Materials/material";
  24693. import { Effect } from "babylonjs/Materials/effect";
  24694. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24695. /**
  24696. * Options to be used when creating a shadow depth material
  24697. */
  24698. export interface IIOptionShadowDepthMaterial {
  24699. /** Variables in the vertex shader code that need to have their names remapped.
  24700. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24701. * "var_name" should be either: worldPos or vNormalW
  24702. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24703. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24704. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24705. */
  24706. remappedVariables?: string[];
  24707. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24708. standalone?: boolean;
  24709. }
  24710. /**
  24711. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24712. */
  24713. export class ShadowDepthWrapper {
  24714. private _scene;
  24715. private _options?;
  24716. private _baseMaterial;
  24717. private _onEffectCreatedObserver;
  24718. private _subMeshToEffect;
  24719. private _subMeshToDepthEffect;
  24720. private _meshes;
  24721. /** @hidden */
  24722. _matriceNames: any;
  24723. /** Gets the standalone status of the wrapper */
  24724. get standalone(): boolean;
  24725. /** Gets the base material the wrapper is built upon */
  24726. get baseMaterial(): Material;
  24727. /**
  24728. * Instantiate a new shadow depth wrapper.
  24729. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24730. * generate the shadow depth map. For more information, please refer to the documentation:
  24731. * https://doc.babylonjs.com/babylon101/shadows
  24732. * @param baseMaterial Material to wrap
  24733. * @param scene Define the scene the material belongs to
  24734. * @param options Options used to create the wrapper
  24735. */
  24736. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24737. /**
  24738. * Gets the effect to use to generate the depth map
  24739. * @param subMesh subMesh to get the effect for
  24740. * @param shadowGenerator shadow generator to get the effect for
  24741. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24742. */
  24743. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24744. /**
  24745. * Specifies that the submesh is ready to be used for depth rendering
  24746. * @param subMesh submesh to check
  24747. * @param defines the list of defines to take into account when checking the effect
  24748. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24749. * @param useInstances specifies that instances should be used
  24750. * @returns a boolean indicating that the submesh is ready or not
  24751. */
  24752. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24753. /**
  24754. * Disposes the resources
  24755. */
  24756. dispose(): void;
  24757. private _makeEffect;
  24758. }
  24759. }
  24760. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24761. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24762. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24763. import { Nullable } from "babylonjs/types";
  24764. module "babylonjs/Engines/thinEngine" {
  24765. interface ThinEngine {
  24766. /**
  24767. * Unbind a list of render target textures from the webGL context
  24768. * This is used only when drawBuffer extension or webGL2 are active
  24769. * @param textures defines the render target textures to unbind
  24770. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24771. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24772. */
  24773. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24774. /**
  24775. * Create a multi render target texture
  24776. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24777. * @param size defines the size of the texture
  24778. * @param options defines the creation options
  24779. * @returns the cube texture as an InternalTexture
  24780. */
  24781. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24782. /**
  24783. * Update the sample count for a given multiple render target texture
  24784. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24785. * @param textures defines the textures to update
  24786. * @param samples defines the sample count to set
  24787. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24788. */
  24789. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24790. /**
  24791. * Select a subsets of attachments to draw to.
  24792. * @param attachments gl attachments
  24793. */
  24794. bindAttachments(attachments: number[]): void;
  24795. }
  24796. }
  24797. }
  24798. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24799. import { Scene } from "babylonjs/scene";
  24800. import { Engine } from "babylonjs/Engines/engine";
  24801. import { Texture } from "babylonjs/Materials/Textures/texture";
  24802. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24803. import "babylonjs/Engines/Extensions/engine.multiRender";
  24804. /**
  24805. * Creation options of the multi render target texture.
  24806. */
  24807. export interface IMultiRenderTargetOptions {
  24808. /**
  24809. * Define if the texture needs to create mip maps after render.
  24810. */
  24811. generateMipMaps?: boolean;
  24812. /**
  24813. * Define the types of all the draw buffers we want to create
  24814. */
  24815. types?: number[];
  24816. /**
  24817. * Define the sampling modes of all the draw buffers we want to create
  24818. */
  24819. samplingModes?: number[];
  24820. /**
  24821. * Define if a depth buffer is required
  24822. */
  24823. generateDepthBuffer?: boolean;
  24824. /**
  24825. * Define if a stencil buffer is required
  24826. */
  24827. generateStencilBuffer?: boolean;
  24828. /**
  24829. * Define if a depth texture is required instead of a depth buffer
  24830. */
  24831. generateDepthTexture?: boolean;
  24832. /**
  24833. * Define the number of desired draw buffers
  24834. */
  24835. textureCount?: number;
  24836. /**
  24837. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24838. */
  24839. doNotChangeAspectRatio?: boolean;
  24840. /**
  24841. * Define the default type of the buffers we are creating
  24842. */
  24843. defaultType?: number;
  24844. }
  24845. /**
  24846. * A multi render target, like a render target provides the ability to render to a texture.
  24847. * Unlike the render target, it can render to several draw buffers in one draw.
  24848. * This is specially interesting in deferred rendering or for any effects requiring more than
  24849. * just one color from a single pass.
  24850. */
  24851. export class MultiRenderTarget extends RenderTargetTexture {
  24852. private _internalTextures;
  24853. private _textures;
  24854. private _multiRenderTargetOptions;
  24855. private _count;
  24856. /**
  24857. * Get if draw buffers are currently supported by the used hardware and browser.
  24858. */
  24859. get isSupported(): boolean;
  24860. /**
  24861. * Get the list of textures generated by the multi render target.
  24862. */
  24863. get textures(): Texture[];
  24864. /**
  24865. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24866. */
  24867. get count(): number;
  24868. /**
  24869. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24870. */
  24871. get depthTexture(): Texture;
  24872. /**
  24873. * Set the wrapping mode on U of all the textures we are rendering to.
  24874. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24875. */
  24876. set wrapU(wrap: number);
  24877. /**
  24878. * Set the wrapping mode on V of all the textures we are rendering to.
  24879. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24880. */
  24881. set wrapV(wrap: number);
  24882. /**
  24883. * Instantiate a new multi render target texture.
  24884. * A multi render target, like a render target provides the ability to render to a texture.
  24885. * Unlike the render target, it can render to several draw buffers in one draw.
  24886. * This is specially interesting in deferred rendering or for any effects requiring more than
  24887. * just one color from a single pass.
  24888. * @param name Define the name of the texture
  24889. * @param size Define the size of the buffers to render to
  24890. * @param count Define the number of target we are rendering into
  24891. * @param scene Define the scene the texture belongs to
  24892. * @param options Define the options used to create the multi render target
  24893. */
  24894. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24895. /** @hidden */
  24896. _rebuild(): void;
  24897. private _createInternalTextures;
  24898. private _createTextures;
  24899. /**
  24900. * Define the number of samples used if MSAA is enabled.
  24901. */
  24902. get samples(): number;
  24903. set samples(value: number);
  24904. /**
  24905. * Resize all the textures in the multi render target.
  24906. * Be carrefull as it will recreate all the data in the new texture.
  24907. * @param size Define the new size
  24908. */
  24909. resize(size: any): void;
  24910. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24911. /**
  24912. * Dispose the render targets and their associated resources
  24913. */
  24914. dispose(): void;
  24915. /**
  24916. * Release all the underlying texture used as draw buffers.
  24917. */
  24918. releaseInternalTextures(): void;
  24919. }
  24920. }
  24921. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24922. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24923. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24924. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24925. /** @hidden */
  24926. export var imageProcessingPixelShader: {
  24927. name: string;
  24928. shader: string;
  24929. };
  24930. }
  24931. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24932. import { Nullable } from "babylonjs/types";
  24933. import { Color4 } from "babylonjs/Maths/math.color";
  24934. import { Camera } from "babylonjs/Cameras/camera";
  24935. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24936. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24937. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24938. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24939. import { Engine } from "babylonjs/Engines/engine";
  24940. import "babylonjs/Shaders/imageProcessing.fragment";
  24941. import "babylonjs/Shaders/postprocess.vertex";
  24942. /**
  24943. * ImageProcessingPostProcess
  24944. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24945. */
  24946. export class ImageProcessingPostProcess extends PostProcess {
  24947. /**
  24948. * Default configuration related to image processing available in the PBR Material.
  24949. */
  24950. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24951. /**
  24952. * Gets the image processing configuration used either in this material.
  24953. */
  24954. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24955. /**
  24956. * Sets the Default image processing configuration used either in the this material.
  24957. *
  24958. * If sets to null, the scene one is in use.
  24959. */
  24960. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24961. /**
  24962. * Keep track of the image processing observer to allow dispose and replace.
  24963. */
  24964. private _imageProcessingObserver;
  24965. /**
  24966. * Attaches a new image processing configuration to the PBR Material.
  24967. * @param configuration
  24968. */
  24969. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24970. /**
  24971. * If the post process is supported.
  24972. */
  24973. get isSupported(): boolean;
  24974. /**
  24975. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24976. */
  24977. get colorCurves(): Nullable<ColorCurves>;
  24978. /**
  24979. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24980. */
  24981. set colorCurves(value: Nullable<ColorCurves>);
  24982. /**
  24983. * Gets wether the color curves effect is enabled.
  24984. */
  24985. get colorCurvesEnabled(): boolean;
  24986. /**
  24987. * Sets wether the color curves effect is enabled.
  24988. */
  24989. set colorCurvesEnabled(value: boolean);
  24990. /**
  24991. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24992. */
  24993. get colorGradingTexture(): Nullable<BaseTexture>;
  24994. /**
  24995. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24996. */
  24997. set colorGradingTexture(value: Nullable<BaseTexture>);
  24998. /**
  24999. * Gets wether the color grading effect is enabled.
  25000. */
  25001. get colorGradingEnabled(): boolean;
  25002. /**
  25003. * Gets wether the color grading effect is enabled.
  25004. */
  25005. set colorGradingEnabled(value: boolean);
  25006. /**
  25007. * Gets exposure used in the effect.
  25008. */
  25009. get exposure(): number;
  25010. /**
  25011. * Sets exposure used in the effect.
  25012. */
  25013. set exposure(value: number);
  25014. /**
  25015. * Gets wether tonemapping is enabled or not.
  25016. */
  25017. get toneMappingEnabled(): boolean;
  25018. /**
  25019. * Sets wether tonemapping is enabled or not
  25020. */
  25021. set toneMappingEnabled(value: boolean);
  25022. /**
  25023. * Gets the type of tone mapping effect.
  25024. */
  25025. get toneMappingType(): number;
  25026. /**
  25027. * Sets the type of tone mapping effect.
  25028. */
  25029. set toneMappingType(value: number);
  25030. /**
  25031. * Gets contrast used in the effect.
  25032. */
  25033. get contrast(): number;
  25034. /**
  25035. * Sets contrast used in the effect.
  25036. */
  25037. set contrast(value: number);
  25038. /**
  25039. * Gets Vignette stretch size.
  25040. */
  25041. get vignetteStretch(): number;
  25042. /**
  25043. * Sets Vignette stretch size.
  25044. */
  25045. set vignetteStretch(value: number);
  25046. /**
  25047. * Gets Vignette centre X Offset.
  25048. */
  25049. get vignetteCentreX(): number;
  25050. /**
  25051. * Sets Vignette centre X Offset.
  25052. */
  25053. set vignetteCentreX(value: number);
  25054. /**
  25055. * Gets Vignette centre Y Offset.
  25056. */
  25057. get vignetteCentreY(): number;
  25058. /**
  25059. * Sets Vignette centre Y Offset.
  25060. */
  25061. set vignetteCentreY(value: number);
  25062. /**
  25063. * Gets Vignette weight or intensity of the vignette effect.
  25064. */
  25065. get vignetteWeight(): number;
  25066. /**
  25067. * Sets Vignette weight or intensity of the vignette effect.
  25068. */
  25069. set vignetteWeight(value: number);
  25070. /**
  25071. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25072. * if vignetteEnabled is set to true.
  25073. */
  25074. get vignetteColor(): Color4;
  25075. /**
  25076. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25077. * if vignetteEnabled is set to true.
  25078. */
  25079. set vignetteColor(value: Color4);
  25080. /**
  25081. * Gets Camera field of view used by the Vignette effect.
  25082. */
  25083. get vignetteCameraFov(): number;
  25084. /**
  25085. * Sets Camera field of view used by the Vignette effect.
  25086. */
  25087. set vignetteCameraFov(value: number);
  25088. /**
  25089. * Gets the vignette blend mode allowing different kind of effect.
  25090. */
  25091. get vignetteBlendMode(): number;
  25092. /**
  25093. * Sets the vignette blend mode allowing different kind of effect.
  25094. */
  25095. set vignetteBlendMode(value: number);
  25096. /**
  25097. * Gets wether the vignette effect is enabled.
  25098. */
  25099. get vignetteEnabled(): boolean;
  25100. /**
  25101. * Sets wether the vignette effect is enabled.
  25102. */
  25103. set vignetteEnabled(value: boolean);
  25104. private _fromLinearSpace;
  25105. /**
  25106. * Gets wether the input of the processing is in Gamma or Linear Space.
  25107. */
  25108. get fromLinearSpace(): boolean;
  25109. /**
  25110. * Sets wether the input of the processing is in Gamma or Linear Space.
  25111. */
  25112. set fromLinearSpace(value: boolean);
  25113. /**
  25114. * Defines cache preventing GC.
  25115. */
  25116. private _defines;
  25117. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25118. /**
  25119. * "ImageProcessingPostProcess"
  25120. * @returns "ImageProcessingPostProcess"
  25121. */
  25122. getClassName(): string;
  25123. /**
  25124. * @hidden
  25125. */
  25126. _updateParameters(): void;
  25127. dispose(camera?: Camera): void;
  25128. }
  25129. }
  25130. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25131. /** @hidden */
  25132. export var fibonacci: {
  25133. name: string;
  25134. shader: string;
  25135. };
  25136. }
  25137. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25138. /** @hidden */
  25139. export var subSurfaceScatteringFunctions: {
  25140. name: string;
  25141. shader: string;
  25142. };
  25143. }
  25144. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25145. /** @hidden */
  25146. export var diffusionProfile: {
  25147. name: string;
  25148. shader: string;
  25149. };
  25150. }
  25151. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25152. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25153. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25155. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25156. /** @hidden */
  25157. export var subSurfaceScatteringPixelShader: {
  25158. name: string;
  25159. shader: string;
  25160. };
  25161. }
  25162. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25163. import { Nullable } from "babylonjs/types";
  25164. import { Camera } from "babylonjs/Cameras/camera";
  25165. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25166. import { Engine } from "babylonjs/Engines/engine";
  25167. import { Scene } from "babylonjs/scene";
  25168. import "babylonjs/Shaders/imageProcessing.fragment";
  25169. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25170. import "babylonjs/Shaders/postprocess.vertex";
  25171. /**
  25172. * Sub surface scattering post process
  25173. */
  25174. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25175. /**
  25176. * Gets a string identifying the name of the class
  25177. * @returns "SubSurfaceScatteringPostProcess" string
  25178. */
  25179. getClassName(): string;
  25180. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25181. }
  25182. }
  25183. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25184. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25185. /**
  25186. * Interface for defining prepass effects in the prepass post-process pipeline
  25187. */
  25188. export interface PrePassEffectConfiguration {
  25189. /**
  25190. * Post process to attach for this effect
  25191. */
  25192. postProcess: PostProcess;
  25193. /**
  25194. * Is the effect enabled
  25195. */
  25196. enabled: boolean;
  25197. /**
  25198. * Disposes the effect configuration
  25199. */
  25200. dispose(): void;
  25201. /**
  25202. * Disposes the effect configuration
  25203. */
  25204. createPostProcess: () => PostProcess;
  25205. }
  25206. }
  25207. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25208. import { Scene } from "babylonjs/scene";
  25209. import { Color3 } from "babylonjs/Maths/math.color";
  25210. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25211. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25212. /**
  25213. * Contains all parameters needed for the prepass to perform
  25214. * screen space subsurface scattering
  25215. */
  25216. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25217. private _ssDiffusionS;
  25218. private _ssFilterRadii;
  25219. private _ssDiffusionD;
  25220. /**
  25221. * Post process to attach for screen space subsurface scattering
  25222. */
  25223. postProcess: SubSurfaceScatteringPostProcess;
  25224. /**
  25225. * Diffusion profile color for subsurface scattering
  25226. */
  25227. get ssDiffusionS(): number[];
  25228. /**
  25229. * Diffusion profile max color channel value for subsurface scattering
  25230. */
  25231. get ssDiffusionD(): number[];
  25232. /**
  25233. * Diffusion profile filter radius for subsurface scattering
  25234. */
  25235. get ssFilterRadii(): number[];
  25236. /**
  25237. * Is subsurface enabled
  25238. */
  25239. enabled: boolean;
  25240. /**
  25241. * Diffusion profile colors for subsurface scattering
  25242. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25243. * See ...
  25244. * Note that you can only store up to 5 of them
  25245. */
  25246. ssDiffusionProfileColors: Color3[];
  25247. /**
  25248. * Defines the ratio real world => scene units.
  25249. * Used for subsurface scattering
  25250. */
  25251. metersPerUnit: number;
  25252. private _scene;
  25253. /**
  25254. * Builds a subsurface configuration object
  25255. * @param scene The scene
  25256. */
  25257. constructor(scene: Scene);
  25258. /**
  25259. * Adds a new diffusion profile.
  25260. * Useful for more realistic subsurface scattering on diverse materials.
  25261. * @param color The color of the diffusion profile. Should be the average color of the material.
  25262. * @return The index of the diffusion profile for the material subsurface configuration
  25263. */
  25264. addDiffusionProfile(color: Color3): number;
  25265. /**
  25266. * Creates the sss post process
  25267. * @return The created post process
  25268. */
  25269. createPostProcess(): SubSurfaceScatteringPostProcess;
  25270. /**
  25271. * Deletes all diffusion profiles.
  25272. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25273. */
  25274. clearAllDiffusionProfiles(): void;
  25275. /**
  25276. * Disposes this object
  25277. */
  25278. dispose(): void;
  25279. /**
  25280. * @hidden
  25281. * https://zero-radiance.github.io/post/sampling-diffusion/
  25282. *
  25283. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25284. * ------------------------------------------------------------------------------------
  25285. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25286. * PDF[r, phi, s] = r * R[r, phi, s]
  25287. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25288. * ------------------------------------------------------------------------------------
  25289. * We importance sample the color channel with the widest scattering distance.
  25290. */
  25291. getDiffusionProfileParameters(color: Color3): number;
  25292. /**
  25293. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25294. * 'u' is the random number (the value of the CDF): [0, 1).
  25295. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25296. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25297. */
  25298. private _sampleBurleyDiffusionProfile;
  25299. }
  25300. }
  25301. declare module "babylonjs/Rendering/prePassRenderer" {
  25302. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25303. import { Scene } from "babylonjs/scene";
  25304. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25305. import { Effect } from "babylonjs/Materials/effect";
  25306. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25307. /**
  25308. * Renders a pre pass of the scene
  25309. * This means every mesh in the scene will be rendered to a render target texture
  25310. * And then this texture will be composited to the rendering canvas with post processes
  25311. * It is necessary for effects like subsurface scattering or deferred shading
  25312. */
  25313. export class PrePassRenderer {
  25314. /** @hidden */
  25315. static _SceneComponentInitialization: (scene: Scene) => void;
  25316. private _scene;
  25317. private _engine;
  25318. private _isDirty;
  25319. /**
  25320. * Number of textures in the multi render target texture where the scene is directly rendered
  25321. */
  25322. readonly mrtCount: number;
  25323. /**
  25324. * The render target where the scene is directly rendered
  25325. */
  25326. prePassRT: MultiRenderTarget;
  25327. private _mrtTypes;
  25328. private _multiRenderAttachments;
  25329. private _defaultAttachments;
  25330. private _clearAttachments;
  25331. private _postProcesses;
  25332. private readonly _clearColor;
  25333. /**
  25334. * Image processing post process for composition
  25335. */
  25336. imageProcessingPostProcess: ImageProcessingPostProcess;
  25337. /**
  25338. * Configuration for sub surface scattering post process
  25339. */
  25340. subSurfaceConfiguration: SubSurfaceConfiguration;
  25341. /**
  25342. * Should materials render their geometry on the MRT
  25343. */
  25344. materialsShouldRenderGeometry: boolean;
  25345. /**
  25346. * Should materials render the irradiance information on the MRT
  25347. */
  25348. materialsShouldRenderIrradiance: boolean;
  25349. private _enabled;
  25350. /**
  25351. * Indicates if the prepass is enabled
  25352. */
  25353. get enabled(): boolean;
  25354. /**
  25355. * How many samples are used for MSAA of the scene render target
  25356. */
  25357. get samples(): number;
  25358. set samples(n: number);
  25359. /**
  25360. * Instanciates a prepass renderer
  25361. * @param scene The scene
  25362. */
  25363. constructor(scene: Scene);
  25364. private _initializeAttachments;
  25365. private _createCompositionEffect;
  25366. /**
  25367. * Indicates if rendering a prepass is supported
  25368. */
  25369. get isSupported(): boolean;
  25370. /**
  25371. * Sets the proper output textures to draw in the engine.
  25372. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25373. */
  25374. bindAttachmentsForEffect(effect: Effect): void;
  25375. /**
  25376. * @hidden
  25377. */
  25378. _beforeCameraDraw(): void;
  25379. /**
  25380. * @hidden
  25381. */
  25382. _afterCameraDraw(): void;
  25383. private _checkRTSize;
  25384. private _bindFrameBuffer;
  25385. /**
  25386. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25387. */
  25388. clear(): void;
  25389. private _setState;
  25390. private _enable;
  25391. private _disable;
  25392. private _resetPostProcessChain;
  25393. private _bindPostProcessChain;
  25394. /**
  25395. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25396. */
  25397. markAsDirty(): void;
  25398. private _update;
  25399. /**
  25400. * Disposes the prepass renderer.
  25401. */
  25402. dispose(): void;
  25403. }
  25404. }
  25405. declare module "babylonjs/Materials/material" {
  25406. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25407. import { SmartArray } from "babylonjs/Misc/smartArray";
  25408. import { Observable } from "babylonjs/Misc/observable";
  25409. import { Nullable } from "babylonjs/types";
  25410. import { Scene } from "babylonjs/scene";
  25411. import { Matrix } from "babylonjs/Maths/math.vector";
  25412. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25413. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25414. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25415. import { Effect } from "babylonjs/Materials/effect";
  25416. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25417. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25418. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25419. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25420. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25421. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25422. import { Mesh } from "babylonjs/Meshes/mesh";
  25423. import { Animation } from "babylonjs/Animations/animation";
  25424. /**
  25425. * Options for compiling materials.
  25426. */
  25427. export interface IMaterialCompilationOptions {
  25428. /**
  25429. * Defines whether clip planes are enabled.
  25430. */
  25431. clipPlane: boolean;
  25432. /**
  25433. * Defines whether instances are enabled.
  25434. */
  25435. useInstances: boolean;
  25436. }
  25437. /**
  25438. * Options passed when calling customShaderNameResolve
  25439. */
  25440. export interface ICustomShaderNameResolveOptions {
  25441. /**
  25442. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25443. */
  25444. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25445. }
  25446. /**
  25447. * Base class for the main features of a material in Babylon.js
  25448. */
  25449. export class Material implements IAnimatable {
  25450. /**
  25451. * Returns the triangle fill mode
  25452. */
  25453. static readonly TriangleFillMode: number;
  25454. /**
  25455. * Returns the wireframe mode
  25456. */
  25457. static readonly WireFrameFillMode: number;
  25458. /**
  25459. * Returns the point fill mode
  25460. */
  25461. static readonly PointFillMode: number;
  25462. /**
  25463. * Returns the point list draw mode
  25464. */
  25465. static readonly PointListDrawMode: number;
  25466. /**
  25467. * Returns the line list draw mode
  25468. */
  25469. static readonly LineListDrawMode: number;
  25470. /**
  25471. * Returns the line loop draw mode
  25472. */
  25473. static readonly LineLoopDrawMode: number;
  25474. /**
  25475. * Returns the line strip draw mode
  25476. */
  25477. static readonly LineStripDrawMode: number;
  25478. /**
  25479. * Returns the triangle strip draw mode
  25480. */
  25481. static readonly TriangleStripDrawMode: number;
  25482. /**
  25483. * Returns the triangle fan draw mode
  25484. */
  25485. static readonly TriangleFanDrawMode: number;
  25486. /**
  25487. * Stores the clock-wise side orientation
  25488. */
  25489. static readonly ClockWiseSideOrientation: number;
  25490. /**
  25491. * Stores the counter clock-wise side orientation
  25492. */
  25493. static readonly CounterClockWiseSideOrientation: number;
  25494. /**
  25495. * The dirty texture flag value
  25496. */
  25497. static readonly TextureDirtyFlag: number;
  25498. /**
  25499. * The dirty light flag value
  25500. */
  25501. static readonly LightDirtyFlag: number;
  25502. /**
  25503. * The dirty fresnel flag value
  25504. */
  25505. static readonly FresnelDirtyFlag: number;
  25506. /**
  25507. * The dirty attribute flag value
  25508. */
  25509. static readonly AttributesDirtyFlag: number;
  25510. /**
  25511. * The dirty misc flag value
  25512. */
  25513. static readonly MiscDirtyFlag: number;
  25514. /**
  25515. * The all dirty flag value
  25516. */
  25517. static readonly AllDirtyFlag: number;
  25518. /**
  25519. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25520. */
  25521. static readonly MATERIAL_OPAQUE: number;
  25522. /**
  25523. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25524. */
  25525. static readonly MATERIAL_ALPHATEST: number;
  25526. /**
  25527. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25528. */
  25529. static readonly MATERIAL_ALPHABLEND: number;
  25530. /**
  25531. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25532. * They are also discarded below the alpha cutoff threshold to improve performances.
  25533. */
  25534. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25535. /**
  25536. * The Whiteout method is used to blend normals.
  25537. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25538. */
  25539. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25540. /**
  25541. * The Reoriented Normal Mapping method is used to blend normals.
  25542. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25543. */
  25544. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25545. /**
  25546. * Custom callback helping to override the default shader used in the material.
  25547. */
  25548. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25549. /**
  25550. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25551. */
  25552. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25553. /**
  25554. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25555. * This means that the material can keep using a previous shader while a new one is being compiled.
  25556. * This is mostly used when shader parallel compilation is supported (true by default)
  25557. */
  25558. allowShaderHotSwapping: boolean;
  25559. /**
  25560. * The ID of the material
  25561. */
  25562. id: string;
  25563. /**
  25564. * Gets or sets the unique id of the material
  25565. */
  25566. uniqueId: number;
  25567. /**
  25568. * The name of the material
  25569. */
  25570. name: string;
  25571. /**
  25572. * Gets or sets user defined metadata
  25573. */
  25574. metadata: any;
  25575. /**
  25576. * For internal use only. Please do not use.
  25577. */
  25578. reservedDataStore: any;
  25579. /**
  25580. * Specifies if the ready state should be checked on each call
  25581. */
  25582. checkReadyOnEveryCall: boolean;
  25583. /**
  25584. * Specifies if the ready state should be checked once
  25585. */
  25586. checkReadyOnlyOnce: boolean;
  25587. /**
  25588. * The state of the material
  25589. */
  25590. state: string;
  25591. /**
  25592. * If the material can be rendered to several textures with MRT extension
  25593. */
  25594. get canRenderToMRT(): boolean;
  25595. /**
  25596. * The alpha value of the material
  25597. */
  25598. protected _alpha: number;
  25599. /**
  25600. * List of inspectable custom properties (used by the Inspector)
  25601. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25602. */
  25603. inspectableCustomProperties: IInspectable[];
  25604. /**
  25605. * Sets the alpha value of the material
  25606. */
  25607. set alpha(value: number);
  25608. /**
  25609. * Gets the alpha value of the material
  25610. */
  25611. get alpha(): number;
  25612. /**
  25613. * Specifies if back face culling is enabled
  25614. */
  25615. protected _backFaceCulling: boolean;
  25616. /**
  25617. * Sets the back-face culling state
  25618. */
  25619. set backFaceCulling(value: boolean);
  25620. /**
  25621. * Gets the back-face culling state
  25622. */
  25623. get backFaceCulling(): boolean;
  25624. /**
  25625. * Stores the value for side orientation
  25626. */
  25627. sideOrientation: number;
  25628. /**
  25629. * Callback triggered when the material is compiled
  25630. */
  25631. onCompiled: Nullable<(effect: Effect) => void>;
  25632. /**
  25633. * Callback triggered when an error occurs
  25634. */
  25635. onError: Nullable<(effect: Effect, errors: string) => void>;
  25636. /**
  25637. * Callback triggered to get the render target textures
  25638. */
  25639. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25640. /**
  25641. * Gets a boolean indicating that current material needs to register RTT
  25642. */
  25643. get hasRenderTargetTextures(): boolean;
  25644. /**
  25645. * Specifies if the material should be serialized
  25646. */
  25647. doNotSerialize: boolean;
  25648. /**
  25649. * @hidden
  25650. */
  25651. _storeEffectOnSubMeshes: boolean;
  25652. /**
  25653. * Stores the animations for the material
  25654. */
  25655. animations: Nullable<Array<Animation>>;
  25656. /**
  25657. * An event triggered when the material is disposed
  25658. */
  25659. onDisposeObservable: Observable<Material>;
  25660. /**
  25661. * An observer which watches for dispose events
  25662. */
  25663. private _onDisposeObserver;
  25664. private _onUnBindObservable;
  25665. /**
  25666. * Called during a dispose event
  25667. */
  25668. set onDispose(callback: () => void);
  25669. private _onBindObservable;
  25670. /**
  25671. * An event triggered when the material is bound
  25672. */
  25673. get onBindObservable(): Observable<AbstractMesh>;
  25674. /**
  25675. * An observer which watches for bind events
  25676. */
  25677. private _onBindObserver;
  25678. /**
  25679. * Called during a bind event
  25680. */
  25681. set onBind(callback: (Mesh: AbstractMesh) => void);
  25682. /**
  25683. * An event triggered when the material is unbound
  25684. */
  25685. get onUnBindObservable(): Observable<Material>;
  25686. protected _onEffectCreatedObservable: Nullable<Observable<{
  25687. effect: Effect;
  25688. subMesh: Nullable<SubMesh>;
  25689. }>>;
  25690. /**
  25691. * An event triggered when the effect is (re)created
  25692. */
  25693. get onEffectCreatedObservable(): Observable<{
  25694. effect: Effect;
  25695. subMesh: Nullable<SubMesh>;
  25696. }>;
  25697. /**
  25698. * Stores the value of the alpha mode
  25699. */
  25700. private _alphaMode;
  25701. /**
  25702. * Sets the value of the alpha mode.
  25703. *
  25704. * | Value | Type | Description |
  25705. * | --- | --- | --- |
  25706. * | 0 | ALPHA_DISABLE | |
  25707. * | 1 | ALPHA_ADD | |
  25708. * | 2 | ALPHA_COMBINE | |
  25709. * | 3 | ALPHA_SUBTRACT | |
  25710. * | 4 | ALPHA_MULTIPLY | |
  25711. * | 5 | ALPHA_MAXIMIZED | |
  25712. * | 6 | ALPHA_ONEONE | |
  25713. * | 7 | ALPHA_PREMULTIPLIED | |
  25714. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25715. * | 9 | ALPHA_INTERPOLATE | |
  25716. * | 10 | ALPHA_SCREENMODE | |
  25717. *
  25718. */
  25719. set alphaMode(value: number);
  25720. /**
  25721. * Gets the value of the alpha mode
  25722. */
  25723. get alphaMode(): number;
  25724. /**
  25725. * Stores the state of the need depth pre-pass value
  25726. */
  25727. private _needDepthPrePass;
  25728. /**
  25729. * Sets the need depth pre-pass value
  25730. */
  25731. set needDepthPrePass(value: boolean);
  25732. /**
  25733. * Gets the depth pre-pass value
  25734. */
  25735. get needDepthPrePass(): boolean;
  25736. /**
  25737. * Specifies if depth writing should be disabled
  25738. */
  25739. disableDepthWrite: boolean;
  25740. /**
  25741. * Specifies if color writing should be disabled
  25742. */
  25743. disableColorWrite: boolean;
  25744. /**
  25745. * Specifies if depth writing should be forced
  25746. */
  25747. forceDepthWrite: boolean;
  25748. /**
  25749. * Specifies the depth function that should be used. 0 means the default engine function
  25750. */
  25751. depthFunction: number;
  25752. /**
  25753. * Specifies if there should be a separate pass for culling
  25754. */
  25755. separateCullingPass: boolean;
  25756. /**
  25757. * Stores the state specifing if fog should be enabled
  25758. */
  25759. private _fogEnabled;
  25760. /**
  25761. * Sets the state for enabling fog
  25762. */
  25763. set fogEnabled(value: boolean);
  25764. /**
  25765. * Gets the value of the fog enabled state
  25766. */
  25767. get fogEnabled(): boolean;
  25768. /**
  25769. * Stores the size of points
  25770. */
  25771. pointSize: number;
  25772. /**
  25773. * Stores the z offset value
  25774. */
  25775. zOffset: number;
  25776. get wireframe(): boolean;
  25777. /**
  25778. * Sets the state of wireframe mode
  25779. */
  25780. set wireframe(value: boolean);
  25781. /**
  25782. * Gets the value specifying if point clouds are enabled
  25783. */
  25784. get pointsCloud(): boolean;
  25785. /**
  25786. * Sets the state of point cloud mode
  25787. */
  25788. set pointsCloud(value: boolean);
  25789. /**
  25790. * Gets the material fill mode
  25791. */
  25792. get fillMode(): number;
  25793. /**
  25794. * Sets the material fill mode
  25795. */
  25796. set fillMode(value: number);
  25797. /**
  25798. * @hidden
  25799. * Stores the effects for the material
  25800. */
  25801. _effect: Nullable<Effect>;
  25802. /**
  25803. * Specifies if uniform buffers should be used
  25804. */
  25805. private _useUBO;
  25806. /**
  25807. * Stores a reference to the scene
  25808. */
  25809. private _scene;
  25810. /**
  25811. * Stores the fill mode state
  25812. */
  25813. private _fillMode;
  25814. /**
  25815. * Specifies if the depth write state should be cached
  25816. */
  25817. private _cachedDepthWriteState;
  25818. /**
  25819. * Specifies if the color write state should be cached
  25820. */
  25821. private _cachedColorWriteState;
  25822. /**
  25823. * Specifies if the depth function state should be cached
  25824. */
  25825. private _cachedDepthFunctionState;
  25826. /**
  25827. * Stores the uniform buffer
  25828. */
  25829. protected _uniformBuffer: UniformBuffer;
  25830. /** @hidden */
  25831. _indexInSceneMaterialArray: number;
  25832. /** @hidden */
  25833. meshMap: Nullable<{
  25834. [id: string]: AbstractMesh | undefined;
  25835. }>;
  25836. /**
  25837. * Creates a material instance
  25838. * @param name defines the name of the material
  25839. * @param scene defines the scene to reference
  25840. * @param doNotAdd specifies if the material should be added to the scene
  25841. */
  25842. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25843. /**
  25844. * Returns a string representation of the current material
  25845. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25846. * @returns a string with material information
  25847. */
  25848. toString(fullDetails?: boolean): string;
  25849. /**
  25850. * Gets the class name of the material
  25851. * @returns a string with the class name of the material
  25852. */
  25853. getClassName(): string;
  25854. /**
  25855. * Specifies if updates for the material been locked
  25856. */
  25857. get isFrozen(): boolean;
  25858. /**
  25859. * Locks updates for the material
  25860. */
  25861. freeze(): void;
  25862. /**
  25863. * Unlocks updates for the material
  25864. */
  25865. unfreeze(): void;
  25866. /**
  25867. * Specifies if the material is ready to be used
  25868. * @param mesh defines the mesh to check
  25869. * @param useInstances specifies if instances should be used
  25870. * @returns a boolean indicating if the material is ready to be used
  25871. */
  25872. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25873. /**
  25874. * Specifies that the submesh is ready to be used
  25875. * @param mesh defines the mesh to check
  25876. * @param subMesh defines which submesh to check
  25877. * @param useInstances specifies that instances should be used
  25878. * @returns a boolean indicating that the submesh is ready or not
  25879. */
  25880. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25881. /**
  25882. * Returns the material effect
  25883. * @returns the effect associated with the material
  25884. */
  25885. getEffect(): Nullable<Effect>;
  25886. /**
  25887. * Returns the current scene
  25888. * @returns a Scene
  25889. */
  25890. getScene(): Scene;
  25891. /**
  25892. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25893. */
  25894. protected _forceAlphaTest: boolean;
  25895. /**
  25896. * The transparency mode of the material.
  25897. */
  25898. protected _transparencyMode: Nullable<number>;
  25899. /**
  25900. * Gets the current transparency mode.
  25901. */
  25902. get transparencyMode(): Nullable<number>;
  25903. /**
  25904. * Sets the transparency mode of the material.
  25905. *
  25906. * | Value | Type | Description |
  25907. * | ----- | ----------------------------------- | ----------- |
  25908. * | 0 | OPAQUE | |
  25909. * | 1 | ALPHATEST | |
  25910. * | 2 | ALPHABLEND | |
  25911. * | 3 | ALPHATESTANDBLEND | |
  25912. *
  25913. */
  25914. set transparencyMode(value: Nullable<number>);
  25915. /**
  25916. * Returns true if alpha blending should be disabled.
  25917. */
  25918. protected get _disableAlphaBlending(): boolean;
  25919. /**
  25920. * Specifies whether or not this material should be rendered in alpha blend mode.
  25921. * @returns a boolean specifying if alpha blending is needed
  25922. */
  25923. needAlphaBlending(): boolean;
  25924. /**
  25925. * Specifies if the mesh will require alpha blending
  25926. * @param mesh defines the mesh to check
  25927. * @returns a boolean specifying if alpha blending is needed for the mesh
  25928. */
  25929. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25930. /**
  25931. * Specifies whether or not this material should be rendered in alpha test mode.
  25932. * @returns a boolean specifying if an alpha test is needed.
  25933. */
  25934. needAlphaTesting(): boolean;
  25935. /**
  25936. * Specifies if material alpha testing should be turned on for the mesh
  25937. * @param mesh defines the mesh to check
  25938. */
  25939. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25940. /**
  25941. * Gets the texture used for the alpha test
  25942. * @returns the texture to use for alpha testing
  25943. */
  25944. getAlphaTestTexture(): Nullable<BaseTexture>;
  25945. /**
  25946. * Marks the material to indicate that it needs to be re-calculated
  25947. */
  25948. markDirty(): void;
  25949. /** @hidden */
  25950. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25951. /**
  25952. * Binds the material to the mesh
  25953. * @param world defines the world transformation matrix
  25954. * @param mesh defines the mesh to bind the material to
  25955. */
  25956. bind(world: Matrix, mesh?: Mesh): void;
  25957. /**
  25958. * Binds the submesh to the material
  25959. * @param world defines the world transformation matrix
  25960. * @param mesh defines the mesh containing the submesh
  25961. * @param subMesh defines the submesh to bind the material to
  25962. */
  25963. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25964. /**
  25965. * Binds the world matrix to the material
  25966. * @param world defines the world transformation matrix
  25967. */
  25968. bindOnlyWorldMatrix(world: Matrix): void;
  25969. /**
  25970. * Binds the scene's uniform buffer to the effect.
  25971. * @param effect defines the effect to bind to the scene uniform buffer
  25972. * @param sceneUbo defines the uniform buffer storing scene data
  25973. */
  25974. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25975. /**
  25976. * Binds the view matrix to the effect
  25977. * @param effect defines the effect to bind the view matrix to
  25978. */
  25979. bindView(effect: Effect): void;
  25980. /**
  25981. * Binds the view projection matrix to the effect
  25982. * @param effect defines the effect to bind the view projection matrix to
  25983. */
  25984. bindViewProjection(effect: Effect): void;
  25985. /**
  25986. * Processes to execute after binding the material to a mesh
  25987. * @param mesh defines the rendered mesh
  25988. */
  25989. protected _afterBind(mesh?: Mesh): void;
  25990. /**
  25991. * Unbinds the material from the mesh
  25992. */
  25993. unbind(): void;
  25994. /**
  25995. * Gets the active textures from the material
  25996. * @returns an array of textures
  25997. */
  25998. getActiveTextures(): BaseTexture[];
  25999. /**
  26000. * Specifies if the material uses a texture
  26001. * @param texture defines the texture to check against the material
  26002. * @returns a boolean specifying if the material uses the texture
  26003. */
  26004. hasTexture(texture: BaseTexture): boolean;
  26005. /**
  26006. * Makes a duplicate of the material, and gives it a new name
  26007. * @param name defines the new name for the duplicated material
  26008. * @returns the cloned material
  26009. */
  26010. clone(name: string): Nullable<Material>;
  26011. /**
  26012. * Gets the meshes bound to the material
  26013. * @returns an array of meshes bound to the material
  26014. */
  26015. getBindedMeshes(): AbstractMesh[];
  26016. /**
  26017. * Force shader compilation
  26018. * @param mesh defines the mesh associated with this material
  26019. * @param onCompiled defines a function to execute once the material is compiled
  26020. * @param options defines the options to configure the compilation
  26021. * @param onError defines a function to execute if the material fails compiling
  26022. */
  26023. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26024. /**
  26025. * Force shader compilation
  26026. * @param mesh defines the mesh that will use this material
  26027. * @param options defines additional options for compiling the shaders
  26028. * @returns a promise that resolves when the compilation completes
  26029. */
  26030. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26031. private static readonly _AllDirtyCallBack;
  26032. private static readonly _ImageProcessingDirtyCallBack;
  26033. private static readonly _TextureDirtyCallBack;
  26034. private static readonly _FresnelDirtyCallBack;
  26035. private static readonly _MiscDirtyCallBack;
  26036. private static readonly _LightsDirtyCallBack;
  26037. private static readonly _AttributeDirtyCallBack;
  26038. private static _FresnelAndMiscDirtyCallBack;
  26039. private static _TextureAndMiscDirtyCallBack;
  26040. private static readonly _DirtyCallbackArray;
  26041. private static readonly _RunDirtyCallBacks;
  26042. /**
  26043. * Marks a define in the material to indicate that it needs to be re-computed
  26044. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26045. */
  26046. markAsDirty(flag: number): void;
  26047. /**
  26048. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26049. * @param func defines a function which checks material defines against the submeshes
  26050. */
  26051. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26052. /**
  26053. * Indicates that the scene should check if the rendering now needs a prepass
  26054. */
  26055. protected _markScenePrePassDirty(): void;
  26056. /**
  26057. * Indicates that we need to re-calculated for all submeshes
  26058. */
  26059. protected _markAllSubMeshesAsAllDirty(): void;
  26060. /**
  26061. * Indicates that image processing needs to be re-calculated for all submeshes
  26062. */
  26063. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26064. /**
  26065. * Indicates that textures need to be re-calculated for all submeshes
  26066. */
  26067. protected _markAllSubMeshesAsTexturesDirty(): void;
  26068. /**
  26069. * Indicates that fresnel needs to be re-calculated for all submeshes
  26070. */
  26071. protected _markAllSubMeshesAsFresnelDirty(): void;
  26072. /**
  26073. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26074. */
  26075. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26076. /**
  26077. * Indicates that lights need to be re-calculated for all submeshes
  26078. */
  26079. protected _markAllSubMeshesAsLightsDirty(): void;
  26080. /**
  26081. * Indicates that attributes need to be re-calculated for all submeshes
  26082. */
  26083. protected _markAllSubMeshesAsAttributesDirty(): void;
  26084. /**
  26085. * Indicates that misc needs to be re-calculated for all submeshes
  26086. */
  26087. protected _markAllSubMeshesAsMiscDirty(): void;
  26088. /**
  26089. * Indicates that textures and misc need to be re-calculated for all submeshes
  26090. */
  26091. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26092. /**
  26093. * Sets the required values to the prepass renderer.
  26094. * @param prePassRenderer defines the prepass renderer to setup.
  26095. * @returns true if the pre pass is needed.
  26096. */
  26097. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26098. /**
  26099. * Disposes the material
  26100. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26101. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26102. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26103. */
  26104. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26105. /** @hidden */
  26106. private releaseVertexArrayObject;
  26107. /**
  26108. * Serializes this material
  26109. * @returns the serialized material object
  26110. */
  26111. serialize(): any;
  26112. /**
  26113. * Creates a material from parsed material data
  26114. * @param parsedMaterial defines parsed material data
  26115. * @param scene defines the hosting scene
  26116. * @param rootUrl defines the root URL to use to load textures
  26117. * @returns a new material
  26118. */
  26119. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26120. }
  26121. }
  26122. declare module "babylonjs/Materials/multiMaterial" {
  26123. import { Nullable } from "babylonjs/types";
  26124. import { Scene } from "babylonjs/scene";
  26125. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26126. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26127. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26128. import { Material } from "babylonjs/Materials/material";
  26129. /**
  26130. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26131. * separate meshes. This can be use to improve performances.
  26132. * @see https://doc.babylonjs.com/how_to/multi_materials
  26133. */
  26134. export class MultiMaterial extends Material {
  26135. private _subMaterials;
  26136. /**
  26137. * Gets or Sets the list of Materials used within the multi material.
  26138. * They need to be ordered according to the submeshes order in the associated mesh
  26139. */
  26140. get subMaterials(): Nullable<Material>[];
  26141. set subMaterials(value: Nullable<Material>[]);
  26142. /**
  26143. * Function used to align with Node.getChildren()
  26144. * @returns the list of Materials used within the multi material
  26145. */
  26146. getChildren(): Nullable<Material>[];
  26147. /**
  26148. * Instantiates a new Multi Material
  26149. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26150. * separate meshes. This can be use to improve performances.
  26151. * @see https://doc.babylonjs.com/how_to/multi_materials
  26152. * @param name Define the name in the scene
  26153. * @param scene Define the scene the material belongs to
  26154. */
  26155. constructor(name: string, scene: Scene);
  26156. private _hookArray;
  26157. /**
  26158. * Get one of the submaterial by its index in the submaterials array
  26159. * @param index The index to look the sub material at
  26160. * @returns The Material if the index has been defined
  26161. */
  26162. getSubMaterial(index: number): Nullable<Material>;
  26163. /**
  26164. * Get the list of active textures for the whole sub materials list.
  26165. * @returns All the textures that will be used during the rendering
  26166. */
  26167. getActiveTextures(): BaseTexture[];
  26168. /**
  26169. * Gets the current class name of the material e.g. "MultiMaterial"
  26170. * Mainly use in serialization.
  26171. * @returns the class name
  26172. */
  26173. getClassName(): string;
  26174. /**
  26175. * Checks if the material is ready to render the requested sub mesh
  26176. * @param mesh Define the mesh the submesh belongs to
  26177. * @param subMesh Define the sub mesh to look readyness for
  26178. * @param useInstances Define whether or not the material is used with instances
  26179. * @returns true if ready, otherwise false
  26180. */
  26181. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26182. /**
  26183. * Clones the current material and its related sub materials
  26184. * @param name Define the name of the newly cloned material
  26185. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26186. * @returns the cloned material
  26187. */
  26188. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26189. /**
  26190. * Serializes the materials into a JSON representation.
  26191. * @returns the JSON representation
  26192. */
  26193. serialize(): any;
  26194. /**
  26195. * Dispose the material and release its associated resources
  26196. * @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)
  26197. * @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)
  26198. * @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)
  26199. */
  26200. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26201. /**
  26202. * Creates a MultiMaterial from parsed MultiMaterial data.
  26203. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26204. * @param scene defines the hosting scene
  26205. * @returns a new MultiMaterial
  26206. */
  26207. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26208. }
  26209. }
  26210. declare module "babylonjs/Meshes/subMesh" {
  26211. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26212. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26213. import { Engine } from "babylonjs/Engines/engine";
  26214. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26215. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26216. import { Effect } from "babylonjs/Materials/effect";
  26217. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26218. import { Plane } from "babylonjs/Maths/math.plane";
  26219. import { Collider } from "babylonjs/Collisions/collider";
  26220. import { Material } from "babylonjs/Materials/material";
  26221. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26222. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26223. import { Mesh } from "babylonjs/Meshes/mesh";
  26224. import { Ray } from "babylonjs/Culling/ray";
  26225. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26226. /**
  26227. * Defines a subdivision inside a mesh
  26228. */
  26229. export class SubMesh implements ICullable {
  26230. /** the material index to use */
  26231. materialIndex: number;
  26232. /** vertex index start */
  26233. verticesStart: number;
  26234. /** vertices count */
  26235. verticesCount: number;
  26236. /** index start */
  26237. indexStart: number;
  26238. /** indices count */
  26239. indexCount: number;
  26240. /** @hidden */
  26241. _materialDefines: Nullable<MaterialDefines>;
  26242. /** @hidden */
  26243. _materialEffect: Nullable<Effect>;
  26244. /** @hidden */
  26245. _effectOverride: Nullable<Effect>;
  26246. /**
  26247. * Gets material defines used by the effect associated to the sub mesh
  26248. */
  26249. get materialDefines(): Nullable<MaterialDefines>;
  26250. /**
  26251. * Sets material defines used by the effect associated to the sub mesh
  26252. */
  26253. set materialDefines(defines: Nullable<MaterialDefines>);
  26254. /**
  26255. * Gets associated effect
  26256. */
  26257. get effect(): Nullable<Effect>;
  26258. /**
  26259. * Sets associated effect (effect used to render this submesh)
  26260. * @param effect defines the effect to associate with
  26261. * @param defines defines the set of defines used to compile this effect
  26262. */
  26263. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26264. /** @hidden */
  26265. _linesIndexCount: number;
  26266. private _mesh;
  26267. private _renderingMesh;
  26268. private _boundingInfo;
  26269. private _linesIndexBuffer;
  26270. /** @hidden */
  26271. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26272. /** @hidden */
  26273. _trianglePlanes: Plane[];
  26274. /** @hidden */
  26275. _lastColliderTransformMatrix: Nullable<Matrix>;
  26276. /** @hidden */
  26277. _renderId: number;
  26278. /** @hidden */
  26279. _alphaIndex: number;
  26280. /** @hidden */
  26281. _distanceToCamera: number;
  26282. /** @hidden */
  26283. _id: number;
  26284. private _currentMaterial;
  26285. /**
  26286. * Add a new submesh to a mesh
  26287. * @param materialIndex defines the material index to use
  26288. * @param verticesStart defines vertex index start
  26289. * @param verticesCount defines vertices count
  26290. * @param indexStart defines index start
  26291. * @param indexCount defines indices count
  26292. * @param mesh defines the parent mesh
  26293. * @param renderingMesh defines an optional rendering mesh
  26294. * @param createBoundingBox defines if bounding box should be created for this submesh
  26295. * @returns the new submesh
  26296. */
  26297. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26298. /**
  26299. * Creates a new submesh
  26300. * @param materialIndex defines the material index to use
  26301. * @param verticesStart defines vertex index start
  26302. * @param verticesCount defines vertices count
  26303. * @param indexStart defines index start
  26304. * @param indexCount defines indices count
  26305. * @param mesh defines the parent mesh
  26306. * @param renderingMesh defines an optional rendering mesh
  26307. * @param createBoundingBox defines if bounding box should be created for this submesh
  26308. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26309. */
  26310. constructor(
  26311. /** the material index to use */
  26312. materialIndex: number,
  26313. /** vertex index start */
  26314. verticesStart: number,
  26315. /** vertices count */
  26316. verticesCount: number,
  26317. /** index start */
  26318. indexStart: number,
  26319. /** indices count */
  26320. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26321. /**
  26322. * Returns true if this submesh covers the entire parent mesh
  26323. * @ignorenaming
  26324. */
  26325. get IsGlobal(): boolean;
  26326. /**
  26327. * Returns the submesh BoudingInfo object
  26328. * @returns current bounding info (or mesh's one if the submesh is global)
  26329. */
  26330. getBoundingInfo(): BoundingInfo;
  26331. /**
  26332. * Sets the submesh BoundingInfo
  26333. * @param boundingInfo defines the new bounding info to use
  26334. * @returns the SubMesh
  26335. */
  26336. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26337. /**
  26338. * Returns the mesh of the current submesh
  26339. * @return the parent mesh
  26340. */
  26341. getMesh(): AbstractMesh;
  26342. /**
  26343. * Returns the rendering mesh of the submesh
  26344. * @returns the rendering mesh (could be different from parent mesh)
  26345. */
  26346. getRenderingMesh(): Mesh;
  26347. /**
  26348. * Returns the replacement mesh of the submesh
  26349. * @returns the replacement mesh (could be different from parent mesh)
  26350. */
  26351. getReplacementMesh(): Nullable<AbstractMesh>;
  26352. /**
  26353. * Returns the effective mesh of the submesh
  26354. * @returns the effective mesh (could be different from parent mesh)
  26355. */
  26356. getEffectiveMesh(): AbstractMesh;
  26357. /**
  26358. * Returns the submesh material
  26359. * @returns null or the current material
  26360. */
  26361. getMaterial(): Nullable<Material>;
  26362. private _IsMultiMaterial;
  26363. /**
  26364. * Sets a new updated BoundingInfo object to the submesh
  26365. * @param data defines an optional position array to use to determine the bounding info
  26366. * @returns the SubMesh
  26367. */
  26368. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26369. /** @hidden */
  26370. _checkCollision(collider: Collider): boolean;
  26371. /**
  26372. * Updates the submesh BoundingInfo
  26373. * @param world defines the world matrix to use to update the bounding info
  26374. * @returns the submesh
  26375. */
  26376. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26377. /**
  26378. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26379. * @param frustumPlanes defines the frustum planes
  26380. * @returns true if the submesh is intersecting with the frustum
  26381. */
  26382. isInFrustum(frustumPlanes: Plane[]): boolean;
  26383. /**
  26384. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26385. * @param frustumPlanes defines the frustum planes
  26386. * @returns true if the submesh is inside the frustum
  26387. */
  26388. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26389. /**
  26390. * Renders the submesh
  26391. * @param enableAlphaMode defines if alpha needs to be used
  26392. * @returns the submesh
  26393. */
  26394. render(enableAlphaMode: boolean): SubMesh;
  26395. /**
  26396. * @hidden
  26397. */
  26398. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26399. /**
  26400. * Checks if the submesh intersects with a ray
  26401. * @param ray defines the ray to test
  26402. * @returns true is the passed ray intersects the submesh bounding box
  26403. */
  26404. canIntersects(ray: Ray): boolean;
  26405. /**
  26406. * Intersects current submesh with a ray
  26407. * @param ray defines the ray to test
  26408. * @param positions defines mesh's positions array
  26409. * @param indices defines mesh's indices array
  26410. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26411. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26412. * @returns intersection info or null if no intersection
  26413. */
  26414. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26415. /** @hidden */
  26416. private _intersectLines;
  26417. /** @hidden */
  26418. private _intersectUnIndexedLines;
  26419. /** @hidden */
  26420. private _intersectTriangles;
  26421. /** @hidden */
  26422. private _intersectUnIndexedTriangles;
  26423. /** @hidden */
  26424. _rebuild(): void;
  26425. /**
  26426. * Creates a new submesh from the passed mesh
  26427. * @param newMesh defines the new hosting mesh
  26428. * @param newRenderingMesh defines an optional rendering mesh
  26429. * @returns the new submesh
  26430. */
  26431. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26432. /**
  26433. * Release associated resources
  26434. */
  26435. dispose(): void;
  26436. /**
  26437. * Gets the class name
  26438. * @returns the string "SubMesh".
  26439. */
  26440. getClassName(): string;
  26441. /**
  26442. * Creates a new submesh from indices data
  26443. * @param materialIndex the index of the main mesh material
  26444. * @param startIndex the index where to start the copy in the mesh indices array
  26445. * @param indexCount the number of indices to copy then from the startIndex
  26446. * @param mesh the main mesh to create the submesh from
  26447. * @param renderingMesh the optional rendering mesh
  26448. * @returns a new submesh
  26449. */
  26450. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26451. }
  26452. }
  26453. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26454. /**
  26455. * Class used to represent data loading progression
  26456. */
  26457. export class SceneLoaderFlags {
  26458. private static _ForceFullSceneLoadingForIncremental;
  26459. private static _ShowLoadingScreen;
  26460. private static _CleanBoneMatrixWeights;
  26461. private static _loggingLevel;
  26462. /**
  26463. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26464. */
  26465. static get ForceFullSceneLoadingForIncremental(): boolean;
  26466. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26467. /**
  26468. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26469. */
  26470. static get ShowLoadingScreen(): boolean;
  26471. static set ShowLoadingScreen(value: boolean);
  26472. /**
  26473. * Defines the current logging level (while loading the scene)
  26474. * @ignorenaming
  26475. */
  26476. static get loggingLevel(): number;
  26477. static set loggingLevel(value: number);
  26478. /**
  26479. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26480. */
  26481. static get CleanBoneMatrixWeights(): boolean;
  26482. static set CleanBoneMatrixWeights(value: boolean);
  26483. }
  26484. }
  26485. declare module "babylonjs/Meshes/geometry" {
  26486. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26487. import { Scene } from "babylonjs/scene";
  26488. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26489. import { Engine } from "babylonjs/Engines/engine";
  26490. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26491. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26492. import { Effect } from "babylonjs/Materials/effect";
  26493. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26494. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26495. import { Mesh } from "babylonjs/Meshes/mesh";
  26496. /**
  26497. * Class used to store geometry data (vertex buffers + index buffer)
  26498. */
  26499. export class Geometry implements IGetSetVerticesData {
  26500. /**
  26501. * Gets or sets the ID of the geometry
  26502. */
  26503. id: string;
  26504. /**
  26505. * Gets or sets the unique ID of the geometry
  26506. */
  26507. uniqueId: number;
  26508. /**
  26509. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26510. */
  26511. delayLoadState: number;
  26512. /**
  26513. * Gets the file containing the data to load when running in delay load state
  26514. */
  26515. delayLoadingFile: Nullable<string>;
  26516. /**
  26517. * Callback called when the geometry is updated
  26518. */
  26519. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26520. private _scene;
  26521. private _engine;
  26522. private _meshes;
  26523. private _totalVertices;
  26524. /** @hidden */
  26525. _indices: IndicesArray;
  26526. /** @hidden */
  26527. _vertexBuffers: {
  26528. [key: string]: VertexBuffer;
  26529. };
  26530. private _isDisposed;
  26531. private _extend;
  26532. private _boundingBias;
  26533. /** @hidden */
  26534. _delayInfo: Array<string>;
  26535. private _indexBuffer;
  26536. private _indexBufferIsUpdatable;
  26537. /** @hidden */
  26538. _boundingInfo: Nullable<BoundingInfo>;
  26539. /** @hidden */
  26540. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26541. /** @hidden */
  26542. _softwareSkinningFrameId: number;
  26543. private _vertexArrayObjects;
  26544. private _updatable;
  26545. /** @hidden */
  26546. _positions: Nullable<Vector3[]>;
  26547. /**
  26548. * 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
  26549. */
  26550. get boundingBias(): Vector2;
  26551. /**
  26552. * 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
  26553. */
  26554. set boundingBias(value: Vector2);
  26555. /**
  26556. * Static function used to attach a new empty geometry to a mesh
  26557. * @param mesh defines the mesh to attach the geometry to
  26558. * @returns the new Geometry
  26559. */
  26560. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26561. /** Get the list of meshes using this geometry */
  26562. get meshes(): Mesh[];
  26563. /**
  26564. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26565. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26566. */
  26567. useBoundingInfoFromGeometry: boolean;
  26568. /**
  26569. * Creates a new geometry
  26570. * @param id defines the unique ID
  26571. * @param scene defines the hosting scene
  26572. * @param vertexData defines the VertexData used to get geometry data
  26573. * @param updatable defines if geometry must be updatable (false by default)
  26574. * @param mesh defines the mesh that will be associated with the geometry
  26575. */
  26576. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26577. /**
  26578. * Gets the current extend of the geometry
  26579. */
  26580. get extend(): {
  26581. minimum: Vector3;
  26582. maximum: Vector3;
  26583. };
  26584. /**
  26585. * Gets the hosting scene
  26586. * @returns the hosting Scene
  26587. */
  26588. getScene(): Scene;
  26589. /**
  26590. * Gets the hosting engine
  26591. * @returns the hosting Engine
  26592. */
  26593. getEngine(): Engine;
  26594. /**
  26595. * Defines if the geometry is ready to use
  26596. * @returns true if the geometry is ready to be used
  26597. */
  26598. isReady(): boolean;
  26599. /**
  26600. * Gets a value indicating that the geometry should not be serialized
  26601. */
  26602. get doNotSerialize(): boolean;
  26603. /** @hidden */
  26604. _rebuild(): void;
  26605. /**
  26606. * Affects all geometry data in one call
  26607. * @param vertexData defines the geometry data
  26608. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26609. */
  26610. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26611. /**
  26612. * Set specific vertex data
  26613. * @param kind defines the data kind (Position, normal, etc...)
  26614. * @param data defines the vertex data to use
  26615. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26616. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26617. */
  26618. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26619. /**
  26620. * Removes a specific vertex data
  26621. * @param kind defines the data kind (Position, normal, etc...)
  26622. */
  26623. removeVerticesData(kind: string): void;
  26624. /**
  26625. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26626. * @param buffer defines the vertex buffer to use
  26627. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26628. */
  26629. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26630. /**
  26631. * Update a specific vertex buffer
  26632. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26633. * It will do nothing if the buffer is not updatable
  26634. * @param kind defines the data kind (Position, normal, etc...)
  26635. * @param data defines the data to use
  26636. * @param offset defines the offset in the target buffer where to store the data
  26637. * @param useBytes set to true if the offset is in bytes
  26638. */
  26639. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26640. /**
  26641. * Update a specific vertex buffer
  26642. * This function will create a new buffer if the current one is not updatable
  26643. * @param kind defines the data kind (Position, normal, etc...)
  26644. * @param data defines the data to use
  26645. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26646. */
  26647. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26648. private _updateBoundingInfo;
  26649. /** @hidden */
  26650. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26651. /**
  26652. * Gets total number of vertices
  26653. * @returns the total number of vertices
  26654. */
  26655. getTotalVertices(): number;
  26656. /**
  26657. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26658. * @param kind defines the data kind (Position, normal, etc...)
  26659. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26660. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26661. * @returns a float array containing vertex data
  26662. */
  26663. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26664. /**
  26665. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26666. * @param kind defines the data kind (Position, normal, etc...)
  26667. * @returns true if the vertex buffer with the specified kind is updatable
  26668. */
  26669. isVertexBufferUpdatable(kind: string): boolean;
  26670. /**
  26671. * Gets a specific vertex buffer
  26672. * @param kind defines the data kind (Position, normal, etc...)
  26673. * @returns a VertexBuffer
  26674. */
  26675. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26676. /**
  26677. * Returns all vertex buffers
  26678. * @return an object holding all vertex buffers indexed by kind
  26679. */
  26680. getVertexBuffers(): Nullable<{
  26681. [key: string]: VertexBuffer;
  26682. }>;
  26683. /**
  26684. * Gets a boolean indicating if specific vertex buffer is present
  26685. * @param kind defines the data kind (Position, normal, etc...)
  26686. * @returns true if data is present
  26687. */
  26688. isVerticesDataPresent(kind: string): boolean;
  26689. /**
  26690. * Gets a list of all attached data kinds (Position, normal, etc...)
  26691. * @returns a list of string containing all kinds
  26692. */
  26693. getVerticesDataKinds(): string[];
  26694. /**
  26695. * Update index buffer
  26696. * @param indices defines the indices to store in the index buffer
  26697. * @param offset defines the offset in the target buffer where to store the data
  26698. * @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)
  26699. */
  26700. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26701. /**
  26702. * Creates a new index buffer
  26703. * @param indices defines the indices to store in the index buffer
  26704. * @param totalVertices defines the total number of vertices (could be null)
  26705. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26706. */
  26707. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26708. /**
  26709. * Return the total number of indices
  26710. * @returns the total number of indices
  26711. */
  26712. getTotalIndices(): number;
  26713. /**
  26714. * Gets the index buffer array
  26715. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26716. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26717. * @returns the index buffer array
  26718. */
  26719. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26720. /**
  26721. * Gets the index buffer
  26722. * @return the index buffer
  26723. */
  26724. getIndexBuffer(): Nullable<DataBuffer>;
  26725. /** @hidden */
  26726. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26727. /**
  26728. * Release the associated resources for a specific mesh
  26729. * @param mesh defines the source mesh
  26730. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26731. */
  26732. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26733. /**
  26734. * Apply current geometry to a given mesh
  26735. * @param mesh defines the mesh to apply geometry to
  26736. */
  26737. applyToMesh(mesh: Mesh): void;
  26738. private _updateExtend;
  26739. private _applyToMesh;
  26740. private notifyUpdate;
  26741. /**
  26742. * Load the geometry if it was flagged as delay loaded
  26743. * @param scene defines the hosting scene
  26744. * @param onLoaded defines a callback called when the geometry is loaded
  26745. */
  26746. load(scene: Scene, onLoaded?: () => void): void;
  26747. private _queueLoad;
  26748. /**
  26749. * Invert the geometry to move from a right handed system to a left handed one.
  26750. */
  26751. toLeftHanded(): void;
  26752. /** @hidden */
  26753. _resetPointsArrayCache(): void;
  26754. /** @hidden */
  26755. _generatePointsArray(): boolean;
  26756. /**
  26757. * Gets a value indicating if the geometry is disposed
  26758. * @returns true if the geometry was disposed
  26759. */
  26760. isDisposed(): boolean;
  26761. private _disposeVertexArrayObjects;
  26762. /**
  26763. * Free all associated resources
  26764. */
  26765. dispose(): void;
  26766. /**
  26767. * Clone the current geometry into a new geometry
  26768. * @param id defines the unique ID of the new geometry
  26769. * @returns a new geometry object
  26770. */
  26771. copy(id: string): Geometry;
  26772. /**
  26773. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26774. * @return a JSON representation of the current geometry data (without the vertices data)
  26775. */
  26776. serialize(): any;
  26777. private toNumberArray;
  26778. /**
  26779. * Serialize all vertices data into a JSON oject
  26780. * @returns a JSON representation of the current geometry data
  26781. */
  26782. serializeVerticeData(): any;
  26783. /**
  26784. * Extracts a clone of a mesh geometry
  26785. * @param mesh defines the source mesh
  26786. * @param id defines the unique ID of the new geometry object
  26787. * @returns the new geometry object
  26788. */
  26789. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26790. /**
  26791. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26792. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26793. * Be aware Math.random() could cause collisions, but:
  26794. * "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"
  26795. * @returns a string containing a new GUID
  26796. */
  26797. static RandomId(): string;
  26798. /** @hidden */
  26799. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26800. private static _CleanMatricesWeights;
  26801. /**
  26802. * Create a new geometry from persisted data (Using .babylon file format)
  26803. * @param parsedVertexData defines the persisted data
  26804. * @param scene defines the hosting scene
  26805. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26806. * @returns the new geometry object
  26807. */
  26808. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26809. }
  26810. }
  26811. declare module "babylonjs/Meshes/mesh.vertexData" {
  26812. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26813. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26814. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26815. import { Geometry } from "babylonjs/Meshes/geometry";
  26816. import { Mesh } from "babylonjs/Meshes/mesh";
  26817. /**
  26818. * Define an interface for all classes that will get and set the data on vertices
  26819. */
  26820. export interface IGetSetVerticesData {
  26821. /**
  26822. * Gets a boolean indicating if specific vertex data is present
  26823. * @param kind defines the vertex data kind to use
  26824. * @returns true is data kind is present
  26825. */
  26826. isVerticesDataPresent(kind: string): boolean;
  26827. /**
  26828. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26829. * @param kind defines the data kind (Position, normal, etc...)
  26830. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26831. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26832. * @returns a float array containing vertex data
  26833. */
  26834. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26835. /**
  26836. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26837. * @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.
  26838. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26839. * @returns the indices array or an empty array if the mesh has no geometry
  26840. */
  26841. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26842. /**
  26843. * Set specific vertex data
  26844. * @param kind defines the data kind (Position, normal, etc...)
  26845. * @param data defines the vertex data to use
  26846. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26847. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26848. */
  26849. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26850. /**
  26851. * Update a specific associated vertex buffer
  26852. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26853. * - VertexBuffer.PositionKind
  26854. * - VertexBuffer.UVKind
  26855. * - VertexBuffer.UV2Kind
  26856. * - VertexBuffer.UV3Kind
  26857. * - VertexBuffer.UV4Kind
  26858. * - VertexBuffer.UV5Kind
  26859. * - VertexBuffer.UV6Kind
  26860. * - VertexBuffer.ColorKind
  26861. * - VertexBuffer.MatricesIndicesKind
  26862. * - VertexBuffer.MatricesIndicesExtraKind
  26863. * - VertexBuffer.MatricesWeightsKind
  26864. * - VertexBuffer.MatricesWeightsExtraKind
  26865. * @param data defines the data source
  26866. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26867. * @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)
  26868. */
  26869. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26870. /**
  26871. * Creates a new index buffer
  26872. * @param indices defines the indices to store in the index buffer
  26873. * @param totalVertices defines the total number of vertices (could be null)
  26874. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26875. */
  26876. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26877. }
  26878. /**
  26879. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26880. */
  26881. export class VertexData {
  26882. /**
  26883. * Mesh side orientation : usually the external or front surface
  26884. */
  26885. static readonly FRONTSIDE: number;
  26886. /**
  26887. * Mesh side orientation : usually the internal or back surface
  26888. */
  26889. static readonly BACKSIDE: number;
  26890. /**
  26891. * Mesh side orientation : both internal and external or front and back surfaces
  26892. */
  26893. static readonly DOUBLESIDE: number;
  26894. /**
  26895. * Mesh side orientation : by default, `FRONTSIDE`
  26896. */
  26897. static readonly DEFAULTSIDE: number;
  26898. /**
  26899. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26900. */
  26901. positions: Nullable<FloatArray>;
  26902. /**
  26903. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26904. */
  26905. normals: Nullable<FloatArray>;
  26906. /**
  26907. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26908. */
  26909. tangents: Nullable<FloatArray>;
  26910. /**
  26911. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26912. */
  26913. uvs: Nullable<FloatArray>;
  26914. /**
  26915. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26916. */
  26917. uvs2: Nullable<FloatArray>;
  26918. /**
  26919. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26920. */
  26921. uvs3: Nullable<FloatArray>;
  26922. /**
  26923. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26924. */
  26925. uvs4: Nullable<FloatArray>;
  26926. /**
  26927. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26928. */
  26929. uvs5: Nullable<FloatArray>;
  26930. /**
  26931. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26932. */
  26933. uvs6: Nullable<FloatArray>;
  26934. /**
  26935. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26936. */
  26937. colors: Nullable<FloatArray>;
  26938. /**
  26939. * 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).
  26940. */
  26941. matricesIndices: Nullable<FloatArray>;
  26942. /**
  26943. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26944. */
  26945. matricesWeights: Nullable<FloatArray>;
  26946. /**
  26947. * An array extending the number of possible indices
  26948. */
  26949. matricesIndicesExtra: Nullable<FloatArray>;
  26950. /**
  26951. * An array extending the number of possible weights when the number of indices is extended
  26952. */
  26953. matricesWeightsExtra: Nullable<FloatArray>;
  26954. /**
  26955. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26956. */
  26957. indices: Nullable<IndicesArray>;
  26958. /**
  26959. * Uses the passed data array to set the set the values for the specified kind of data
  26960. * @param data a linear array of floating numbers
  26961. * @param kind the type of data that is being set, eg positions, colors etc
  26962. */
  26963. set(data: FloatArray, kind: string): void;
  26964. /**
  26965. * Associates the vertexData to the passed Mesh.
  26966. * Sets it as updatable or not (default `false`)
  26967. * @param mesh the mesh the vertexData is applied to
  26968. * @param updatable when used and having the value true allows new data to update the vertexData
  26969. * @returns the VertexData
  26970. */
  26971. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26972. /**
  26973. * Associates the vertexData to the passed Geometry.
  26974. * Sets it as updatable or not (default `false`)
  26975. * @param geometry the geometry the vertexData is applied to
  26976. * @param updatable when used and having the value true allows new data to update the vertexData
  26977. * @returns VertexData
  26978. */
  26979. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26980. /**
  26981. * Updates the associated mesh
  26982. * @param mesh the mesh to be updated
  26983. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26984. * @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
  26985. * @returns VertexData
  26986. */
  26987. updateMesh(mesh: Mesh): VertexData;
  26988. /**
  26989. * Updates the associated geometry
  26990. * @param geometry the geometry to be updated
  26991. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26992. * @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
  26993. * @returns VertexData.
  26994. */
  26995. updateGeometry(geometry: Geometry): VertexData;
  26996. private _applyTo;
  26997. private _update;
  26998. /**
  26999. * Transforms each position and each normal of the vertexData according to the passed Matrix
  27000. * @param matrix the transforming matrix
  27001. * @returns the VertexData
  27002. */
  27003. transform(matrix: Matrix): VertexData;
  27004. /**
  27005. * Merges the passed VertexData into the current one
  27006. * @param other the VertexData to be merged into the current one
  27007. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27008. * @returns the modified VertexData
  27009. */
  27010. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27011. private _mergeElement;
  27012. private _validate;
  27013. /**
  27014. * Serializes the VertexData
  27015. * @returns a serialized object
  27016. */
  27017. serialize(): any;
  27018. /**
  27019. * Extracts the vertexData from a mesh
  27020. * @param mesh the mesh from which to extract the VertexData
  27021. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27022. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27023. * @returns the object VertexData associated to the passed mesh
  27024. */
  27025. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27026. /**
  27027. * Extracts the vertexData from the geometry
  27028. * @param geometry the geometry from which to extract the VertexData
  27029. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27030. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27031. * @returns the object VertexData associated to the passed mesh
  27032. */
  27033. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27034. private static _ExtractFrom;
  27035. /**
  27036. * Creates the VertexData for a Ribbon
  27037. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27038. * * pathArray array of paths, each of which an array of successive Vector3
  27039. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27040. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27041. * * 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
  27042. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27043. * * 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)
  27044. * * 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)
  27045. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27046. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27047. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27048. * @returns the VertexData of the ribbon
  27049. */
  27050. static CreateRibbon(options: {
  27051. pathArray: Vector3[][];
  27052. closeArray?: boolean;
  27053. closePath?: boolean;
  27054. offset?: number;
  27055. sideOrientation?: number;
  27056. frontUVs?: Vector4;
  27057. backUVs?: Vector4;
  27058. invertUV?: boolean;
  27059. uvs?: Vector2[];
  27060. colors?: Color4[];
  27061. }): VertexData;
  27062. /**
  27063. * Creates the VertexData for a box
  27064. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27065. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27066. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27067. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27068. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27069. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27070. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27071. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27072. * * 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)
  27073. * * 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)
  27074. * @returns the VertexData of the box
  27075. */
  27076. static CreateBox(options: {
  27077. size?: number;
  27078. width?: number;
  27079. height?: number;
  27080. depth?: number;
  27081. faceUV?: Vector4[];
  27082. faceColors?: Color4[];
  27083. sideOrientation?: number;
  27084. frontUVs?: Vector4;
  27085. backUVs?: Vector4;
  27086. }): VertexData;
  27087. /**
  27088. * Creates the VertexData for a tiled box
  27089. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27090. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27091. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27092. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27093. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27094. * @returns the VertexData of the box
  27095. */
  27096. static CreateTiledBox(options: {
  27097. pattern?: number;
  27098. width?: number;
  27099. height?: number;
  27100. depth?: number;
  27101. tileSize?: number;
  27102. tileWidth?: number;
  27103. tileHeight?: number;
  27104. alignHorizontal?: number;
  27105. alignVertical?: number;
  27106. faceUV?: Vector4[];
  27107. faceColors?: Color4[];
  27108. sideOrientation?: number;
  27109. }): VertexData;
  27110. /**
  27111. * Creates the VertexData for a tiled plane
  27112. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27113. * * pattern a limited pattern arrangement depending on the number
  27114. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27115. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27116. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27117. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27118. * * 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)
  27119. * * 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)
  27120. * @returns the VertexData of the tiled plane
  27121. */
  27122. static CreateTiledPlane(options: {
  27123. pattern?: number;
  27124. tileSize?: number;
  27125. tileWidth?: number;
  27126. tileHeight?: number;
  27127. size?: number;
  27128. width?: number;
  27129. height?: number;
  27130. alignHorizontal?: number;
  27131. alignVertical?: number;
  27132. sideOrientation?: number;
  27133. frontUVs?: Vector4;
  27134. backUVs?: Vector4;
  27135. }): VertexData;
  27136. /**
  27137. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27138. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27139. * * segments sets the number of horizontal strips optional, default 32
  27140. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27141. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27142. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27143. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27144. * * 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
  27145. * * 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
  27146. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27147. * * 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)
  27148. * * 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)
  27149. * @returns the VertexData of the ellipsoid
  27150. */
  27151. static CreateSphere(options: {
  27152. segments?: number;
  27153. diameter?: number;
  27154. diameterX?: number;
  27155. diameterY?: number;
  27156. diameterZ?: number;
  27157. arc?: number;
  27158. slice?: number;
  27159. sideOrientation?: number;
  27160. frontUVs?: Vector4;
  27161. backUVs?: Vector4;
  27162. }): VertexData;
  27163. /**
  27164. * Creates the VertexData for a cylinder, cone or prism
  27165. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27166. * * height sets the height (y direction) of the cylinder, optional, default 2
  27167. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27168. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27169. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27170. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27171. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27172. * * 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
  27173. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27174. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27175. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27176. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27177. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27178. * * 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)
  27179. * * 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)
  27180. * @returns the VertexData of the cylinder, cone or prism
  27181. */
  27182. static CreateCylinder(options: {
  27183. height?: number;
  27184. diameterTop?: number;
  27185. diameterBottom?: number;
  27186. diameter?: number;
  27187. tessellation?: number;
  27188. subdivisions?: number;
  27189. arc?: number;
  27190. faceColors?: Color4[];
  27191. faceUV?: Vector4[];
  27192. hasRings?: boolean;
  27193. enclose?: boolean;
  27194. sideOrientation?: number;
  27195. frontUVs?: Vector4;
  27196. backUVs?: Vector4;
  27197. }): VertexData;
  27198. /**
  27199. * Creates the VertexData for a torus
  27200. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27201. * * diameter the diameter of the torus, optional default 1
  27202. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27203. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27204. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27205. * * 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)
  27206. * * 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)
  27207. * @returns the VertexData of the torus
  27208. */
  27209. static CreateTorus(options: {
  27210. diameter?: number;
  27211. thickness?: number;
  27212. tessellation?: number;
  27213. sideOrientation?: number;
  27214. frontUVs?: Vector4;
  27215. backUVs?: Vector4;
  27216. }): VertexData;
  27217. /**
  27218. * Creates the VertexData of the LineSystem
  27219. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27220. * - lines an array of lines, each line being an array of successive Vector3
  27221. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27222. * @returns the VertexData of the LineSystem
  27223. */
  27224. static CreateLineSystem(options: {
  27225. lines: Vector3[][];
  27226. colors?: Nullable<Color4[][]>;
  27227. }): VertexData;
  27228. /**
  27229. * Create the VertexData for a DashedLines
  27230. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27231. * - points an array successive Vector3
  27232. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27233. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27234. * - dashNb the intended total number of dashes, optional, default 200
  27235. * @returns the VertexData for the DashedLines
  27236. */
  27237. static CreateDashedLines(options: {
  27238. points: Vector3[];
  27239. dashSize?: number;
  27240. gapSize?: number;
  27241. dashNb?: number;
  27242. }): VertexData;
  27243. /**
  27244. * Creates the VertexData for a Ground
  27245. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27246. * - width the width (x direction) of the ground, optional, default 1
  27247. * - height the height (z direction) of the ground, optional, default 1
  27248. * - subdivisions the number of subdivisions per side, optional, default 1
  27249. * @returns the VertexData of the Ground
  27250. */
  27251. static CreateGround(options: {
  27252. width?: number;
  27253. height?: number;
  27254. subdivisions?: number;
  27255. subdivisionsX?: number;
  27256. subdivisionsY?: number;
  27257. }): VertexData;
  27258. /**
  27259. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27260. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27261. * * xmin the ground minimum X coordinate, optional, default -1
  27262. * * zmin the ground minimum Z coordinate, optional, default -1
  27263. * * xmax the ground maximum X coordinate, optional, default 1
  27264. * * zmax the ground maximum Z coordinate, optional, default 1
  27265. * * 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}
  27266. * * 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}
  27267. * @returns the VertexData of the TiledGround
  27268. */
  27269. static CreateTiledGround(options: {
  27270. xmin: number;
  27271. zmin: number;
  27272. xmax: number;
  27273. zmax: number;
  27274. subdivisions?: {
  27275. w: number;
  27276. h: number;
  27277. };
  27278. precision?: {
  27279. w: number;
  27280. h: number;
  27281. };
  27282. }): VertexData;
  27283. /**
  27284. * Creates the VertexData of the Ground designed from a heightmap
  27285. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27286. * * width the width (x direction) of the ground
  27287. * * height the height (z direction) of the ground
  27288. * * subdivisions the number of subdivisions per side
  27289. * * minHeight the minimum altitude on the ground, optional, default 0
  27290. * * maxHeight the maximum altitude on the ground, optional default 1
  27291. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27292. * * buffer the array holding the image color data
  27293. * * bufferWidth the width of image
  27294. * * bufferHeight the height of image
  27295. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27296. * @returns the VertexData of the Ground designed from a heightmap
  27297. */
  27298. static CreateGroundFromHeightMap(options: {
  27299. width: number;
  27300. height: number;
  27301. subdivisions: number;
  27302. minHeight: number;
  27303. maxHeight: number;
  27304. colorFilter: Color3;
  27305. buffer: Uint8Array;
  27306. bufferWidth: number;
  27307. bufferHeight: number;
  27308. alphaFilter: number;
  27309. }): VertexData;
  27310. /**
  27311. * Creates the VertexData for a Plane
  27312. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27313. * * size sets the width and height of the plane to the value of size, optional default 1
  27314. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27315. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27316. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27317. * * 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)
  27318. * * 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)
  27319. * @returns the VertexData of the box
  27320. */
  27321. static CreatePlane(options: {
  27322. size?: number;
  27323. width?: number;
  27324. height?: number;
  27325. sideOrientation?: number;
  27326. frontUVs?: Vector4;
  27327. backUVs?: Vector4;
  27328. }): VertexData;
  27329. /**
  27330. * Creates the VertexData of the Disc or regular Polygon
  27331. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27332. * * radius the radius of the disc, optional default 0.5
  27333. * * tessellation the number of polygon sides, optional, default 64
  27334. * * 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
  27335. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27336. * * 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)
  27337. * * 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)
  27338. * @returns the VertexData of the box
  27339. */
  27340. static CreateDisc(options: {
  27341. radius?: number;
  27342. tessellation?: number;
  27343. arc?: number;
  27344. sideOrientation?: number;
  27345. frontUVs?: Vector4;
  27346. backUVs?: Vector4;
  27347. }): VertexData;
  27348. /**
  27349. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27350. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27351. * @param polygon a mesh built from polygonTriangulation.build()
  27352. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27353. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27354. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27355. * @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)
  27356. * @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)
  27357. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27358. * @returns the VertexData of the Polygon
  27359. */
  27360. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27361. /**
  27362. * Creates the VertexData of the IcoSphere
  27363. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27364. * * radius the radius of the IcoSphere, optional default 1
  27365. * * radiusX allows stretching in the x direction, optional, default radius
  27366. * * radiusY allows stretching in the y direction, optional, default radius
  27367. * * radiusZ allows stretching in the z direction, optional, default radius
  27368. * * flat when true creates a flat shaded mesh, optional, default true
  27369. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27370. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27371. * * 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)
  27372. * * 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)
  27373. * @returns the VertexData of the IcoSphere
  27374. */
  27375. static CreateIcoSphere(options: {
  27376. radius?: number;
  27377. radiusX?: number;
  27378. radiusY?: number;
  27379. radiusZ?: number;
  27380. flat?: boolean;
  27381. subdivisions?: number;
  27382. sideOrientation?: number;
  27383. frontUVs?: Vector4;
  27384. backUVs?: Vector4;
  27385. }): VertexData;
  27386. /**
  27387. * Creates the VertexData for a Polyhedron
  27388. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27389. * * type provided types are:
  27390. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27391. * * 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)
  27392. * * size the size of the IcoSphere, optional default 1
  27393. * * sizeX allows stretching in the x direction, optional, default size
  27394. * * sizeY allows stretching in the y direction, optional, default size
  27395. * * sizeZ allows stretching in the z direction, optional, default size
  27396. * * 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
  27397. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27398. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27399. * * flat when true creates a flat shaded mesh, optional, default true
  27400. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27401. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27402. * * 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)
  27403. * * 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)
  27404. * @returns the VertexData of the Polyhedron
  27405. */
  27406. static CreatePolyhedron(options: {
  27407. type?: number;
  27408. size?: number;
  27409. sizeX?: number;
  27410. sizeY?: number;
  27411. sizeZ?: number;
  27412. custom?: any;
  27413. faceUV?: Vector4[];
  27414. faceColors?: Color4[];
  27415. flat?: boolean;
  27416. sideOrientation?: number;
  27417. frontUVs?: Vector4;
  27418. backUVs?: Vector4;
  27419. }): VertexData;
  27420. /**
  27421. * Creates the VertexData for a TorusKnot
  27422. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27423. * * radius the radius of the torus knot, optional, default 2
  27424. * * tube the thickness of the tube, optional, default 0.5
  27425. * * radialSegments the number of sides on each tube segments, optional, default 32
  27426. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27427. * * p the number of windings around the z axis, optional, default 2
  27428. * * q the number of windings around the x axis, optional, default 3
  27429. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27430. * * 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)
  27431. * * 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)
  27432. * @returns the VertexData of the Torus Knot
  27433. */
  27434. static CreateTorusKnot(options: {
  27435. radius?: number;
  27436. tube?: number;
  27437. radialSegments?: number;
  27438. tubularSegments?: number;
  27439. p?: number;
  27440. q?: number;
  27441. sideOrientation?: number;
  27442. frontUVs?: Vector4;
  27443. backUVs?: Vector4;
  27444. }): VertexData;
  27445. /**
  27446. * Compute normals for given positions and indices
  27447. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27448. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27449. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27450. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27451. * * facetNormals : optional array of facet normals (vector3)
  27452. * * facetPositions : optional array of facet positions (vector3)
  27453. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27454. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27455. * * bInfo : optional bounding info, required for facetPartitioning computation
  27456. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27457. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27458. * * useRightHandedSystem: optional boolean to for right handed system computation
  27459. * * depthSort : optional boolean to enable the facet depth sort computation
  27460. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27461. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27462. */
  27463. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27464. facetNormals?: any;
  27465. facetPositions?: any;
  27466. facetPartitioning?: any;
  27467. ratio?: number;
  27468. bInfo?: any;
  27469. bbSize?: Vector3;
  27470. subDiv?: any;
  27471. useRightHandedSystem?: boolean;
  27472. depthSort?: boolean;
  27473. distanceTo?: Vector3;
  27474. depthSortedFacets?: any;
  27475. }): void;
  27476. /** @hidden */
  27477. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27478. /**
  27479. * Applies VertexData created from the imported parameters to the geometry
  27480. * @param parsedVertexData the parsed data from an imported file
  27481. * @param geometry the geometry to apply the VertexData to
  27482. */
  27483. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27484. }
  27485. }
  27486. declare module "babylonjs/Morph/morphTarget" {
  27487. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27488. import { Observable } from "babylonjs/Misc/observable";
  27489. import { Nullable, FloatArray } from "babylonjs/types";
  27490. import { Scene } from "babylonjs/scene";
  27491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27492. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27493. /**
  27494. * Defines a target to use with MorphTargetManager
  27495. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27496. */
  27497. export class MorphTarget implements IAnimatable {
  27498. /** defines the name of the target */
  27499. name: string;
  27500. /**
  27501. * Gets or sets the list of animations
  27502. */
  27503. animations: import("babylonjs/Animations/animation").Animation[];
  27504. private _scene;
  27505. private _positions;
  27506. private _normals;
  27507. private _tangents;
  27508. private _uvs;
  27509. private _influence;
  27510. private _uniqueId;
  27511. /**
  27512. * Observable raised when the influence changes
  27513. */
  27514. onInfluenceChanged: Observable<boolean>;
  27515. /** @hidden */
  27516. _onDataLayoutChanged: Observable<void>;
  27517. /**
  27518. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27519. */
  27520. get influence(): number;
  27521. set influence(influence: number);
  27522. /**
  27523. * Gets or sets the id of the morph Target
  27524. */
  27525. id: string;
  27526. private _animationPropertiesOverride;
  27527. /**
  27528. * Gets or sets the animation properties override
  27529. */
  27530. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27531. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27532. /**
  27533. * Creates a new MorphTarget
  27534. * @param name defines the name of the target
  27535. * @param influence defines the influence to use
  27536. * @param scene defines the scene the morphtarget belongs to
  27537. */
  27538. constructor(
  27539. /** defines the name of the target */
  27540. name: string, influence?: number, scene?: Nullable<Scene>);
  27541. /**
  27542. * Gets the unique ID of this manager
  27543. */
  27544. get uniqueId(): number;
  27545. /**
  27546. * Gets a boolean defining if the target contains position data
  27547. */
  27548. get hasPositions(): boolean;
  27549. /**
  27550. * Gets a boolean defining if the target contains normal data
  27551. */
  27552. get hasNormals(): boolean;
  27553. /**
  27554. * Gets a boolean defining if the target contains tangent data
  27555. */
  27556. get hasTangents(): boolean;
  27557. /**
  27558. * Gets a boolean defining if the target contains texture coordinates data
  27559. */
  27560. get hasUVs(): boolean;
  27561. /**
  27562. * Affects position data to this target
  27563. * @param data defines the position data to use
  27564. */
  27565. setPositions(data: Nullable<FloatArray>): void;
  27566. /**
  27567. * Gets the position data stored in this target
  27568. * @returns a FloatArray containing the position data (or null if not present)
  27569. */
  27570. getPositions(): Nullable<FloatArray>;
  27571. /**
  27572. * Affects normal data to this target
  27573. * @param data defines the normal data to use
  27574. */
  27575. setNormals(data: Nullable<FloatArray>): void;
  27576. /**
  27577. * Gets the normal data stored in this target
  27578. * @returns a FloatArray containing the normal data (or null if not present)
  27579. */
  27580. getNormals(): Nullable<FloatArray>;
  27581. /**
  27582. * Affects tangent data to this target
  27583. * @param data defines the tangent data to use
  27584. */
  27585. setTangents(data: Nullable<FloatArray>): void;
  27586. /**
  27587. * Gets the tangent data stored in this target
  27588. * @returns a FloatArray containing the tangent data (or null if not present)
  27589. */
  27590. getTangents(): Nullable<FloatArray>;
  27591. /**
  27592. * Affects texture coordinates data to this target
  27593. * @param data defines the texture coordinates data to use
  27594. */
  27595. setUVs(data: Nullable<FloatArray>): void;
  27596. /**
  27597. * Gets the texture coordinates data stored in this target
  27598. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27599. */
  27600. getUVs(): Nullable<FloatArray>;
  27601. /**
  27602. * Clone the current target
  27603. * @returns a new MorphTarget
  27604. */
  27605. clone(): MorphTarget;
  27606. /**
  27607. * Serializes the current target into a Serialization object
  27608. * @returns the serialized object
  27609. */
  27610. serialize(): any;
  27611. /**
  27612. * Returns the string "MorphTarget"
  27613. * @returns "MorphTarget"
  27614. */
  27615. getClassName(): string;
  27616. /**
  27617. * Creates a new target from serialized data
  27618. * @param serializationObject defines the serialized data to use
  27619. * @returns a new MorphTarget
  27620. */
  27621. static Parse(serializationObject: any): MorphTarget;
  27622. /**
  27623. * Creates a MorphTarget from mesh data
  27624. * @param mesh defines the source mesh
  27625. * @param name defines the name to use for the new target
  27626. * @param influence defines the influence to attach to the target
  27627. * @returns a new MorphTarget
  27628. */
  27629. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27630. }
  27631. }
  27632. declare module "babylonjs/Morph/morphTargetManager" {
  27633. import { Nullable } from "babylonjs/types";
  27634. import { Scene } from "babylonjs/scene";
  27635. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27636. /**
  27637. * This class is used to deform meshes using morphing between different targets
  27638. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27639. */
  27640. export class MorphTargetManager {
  27641. private _targets;
  27642. private _targetInfluenceChangedObservers;
  27643. private _targetDataLayoutChangedObservers;
  27644. private _activeTargets;
  27645. private _scene;
  27646. private _influences;
  27647. private _supportsNormals;
  27648. private _supportsTangents;
  27649. private _supportsUVs;
  27650. private _vertexCount;
  27651. private _uniqueId;
  27652. private _tempInfluences;
  27653. /**
  27654. * Gets or sets a boolean indicating if normals must be morphed
  27655. */
  27656. enableNormalMorphing: boolean;
  27657. /**
  27658. * Gets or sets a boolean indicating if tangents must be morphed
  27659. */
  27660. enableTangentMorphing: boolean;
  27661. /**
  27662. * Gets or sets a boolean indicating if UV must be morphed
  27663. */
  27664. enableUVMorphing: boolean;
  27665. /**
  27666. * Creates a new MorphTargetManager
  27667. * @param scene defines the current scene
  27668. */
  27669. constructor(scene?: Nullable<Scene>);
  27670. /**
  27671. * Gets the unique ID of this manager
  27672. */
  27673. get uniqueId(): number;
  27674. /**
  27675. * Gets the number of vertices handled by this manager
  27676. */
  27677. get vertexCount(): number;
  27678. /**
  27679. * Gets a boolean indicating if this manager supports morphing of normals
  27680. */
  27681. get supportsNormals(): boolean;
  27682. /**
  27683. * Gets a boolean indicating if this manager supports morphing of tangents
  27684. */
  27685. get supportsTangents(): boolean;
  27686. /**
  27687. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27688. */
  27689. get supportsUVs(): boolean;
  27690. /**
  27691. * Gets the number of targets stored in this manager
  27692. */
  27693. get numTargets(): number;
  27694. /**
  27695. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27696. */
  27697. get numInfluencers(): number;
  27698. /**
  27699. * Gets the list of influences (one per target)
  27700. */
  27701. get influences(): Float32Array;
  27702. /**
  27703. * Gets the active target at specified index. An active target is a target with an influence > 0
  27704. * @param index defines the index to check
  27705. * @returns the requested target
  27706. */
  27707. getActiveTarget(index: number): MorphTarget;
  27708. /**
  27709. * Gets the target at specified index
  27710. * @param index defines the index to check
  27711. * @returns the requested target
  27712. */
  27713. getTarget(index: number): MorphTarget;
  27714. /**
  27715. * Add a new target to this manager
  27716. * @param target defines the target to add
  27717. */
  27718. addTarget(target: MorphTarget): void;
  27719. /**
  27720. * Removes a target from the manager
  27721. * @param target defines the target to remove
  27722. */
  27723. removeTarget(target: MorphTarget): void;
  27724. /**
  27725. * Clone the current manager
  27726. * @returns a new MorphTargetManager
  27727. */
  27728. clone(): MorphTargetManager;
  27729. /**
  27730. * Serializes the current manager into a Serialization object
  27731. * @returns the serialized object
  27732. */
  27733. serialize(): any;
  27734. private _syncActiveTargets;
  27735. /**
  27736. * Syncrhonize the targets with all the meshes using this morph target manager
  27737. */
  27738. synchronize(): void;
  27739. /**
  27740. * Creates a new MorphTargetManager from serialized data
  27741. * @param serializationObject defines the serialized data
  27742. * @param scene defines the hosting scene
  27743. * @returns the new MorphTargetManager
  27744. */
  27745. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27746. }
  27747. }
  27748. declare module "babylonjs/Meshes/meshLODLevel" {
  27749. import { Mesh } from "babylonjs/Meshes/mesh";
  27750. import { Nullable } from "babylonjs/types";
  27751. /**
  27752. * Class used to represent a specific level of detail of a mesh
  27753. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27754. */
  27755. export class MeshLODLevel {
  27756. /** Defines the distance where this level should start being displayed */
  27757. distance: number;
  27758. /** Defines the mesh to use to render this level */
  27759. mesh: Nullable<Mesh>;
  27760. /**
  27761. * Creates a new LOD level
  27762. * @param distance defines the distance where this level should star being displayed
  27763. * @param mesh defines the mesh to use to render this level
  27764. */
  27765. constructor(
  27766. /** Defines the distance where this level should start being displayed */
  27767. distance: number,
  27768. /** Defines the mesh to use to render this level */
  27769. mesh: Nullable<Mesh>);
  27770. }
  27771. }
  27772. declare module "babylonjs/Misc/canvasGenerator" {
  27773. /**
  27774. * Helper class used to generate a canvas to manipulate images
  27775. */
  27776. export class CanvasGenerator {
  27777. /**
  27778. * Create a new canvas (or offscreen canvas depending on the context)
  27779. * @param width defines the expected width
  27780. * @param height defines the expected height
  27781. * @return a new canvas or offscreen canvas
  27782. */
  27783. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27784. }
  27785. }
  27786. declare module "babylonjs/Meshes/groundMesh" {
  27787. import { Scene } from "babylonjs/scene";
  27788. import { Vector3 } from "babylonjs/Maths/math.vector";
  27789. import { Mesh } from "babylonjs/Meshes/mesh";
  27790. /**
  27791. * Mesh representing the gorund
  27792. */
  27793. export class GroundMesh extends Mesh {
  27794. /** If octree should be generated */
  27795. generateOctree: boolean;
  27796. private _heightQuads;
  27797. /** @hidden */
  27798. _subdivisionsX: number;
  27799. /** @hidden */
  27800. _subdivisionsY: number;
  27801. /** @hidden */
  27802. _width: number;
  27803. /** @hidden */
  27804. _height: number;
  27805. /** @hidden */
  27806. _minX: number;
  27807. /** @hidden */
  27808. _maxX: number;
  27809. /** @hidden */
  27810. _minZ: number;
  27811. /** @hidden */
  27812. _maxZ: number;
  27813. constructor(name: string, scene: Scene);
  27814. /**
  27815. * "GroundMesh"
  27816. * @returns "GroundMesh"
  27817. */
  27818. getClassName(): string;
  27819. /**
  27820. * The minimum of x and y subdivisions
  27821. */
  27822. get subdivisions(): number;
  27823. /**
  27824. * X subdivisions
  27825. */
  27826. get subdivisionsX(): number;
  27827. /**
  27828. * Y subdivisions
  27829. */
  27830. get subdivisionsY(): number;
  27831. /**
  27832. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27833. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27834. * @param chunksCount the number of subdivisions for x and y
  27835. * @param octreeBlocksSize (Default: 32)
  27836. */
  27837. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27838. /**
  27839. * Returns a height (y) value in the Worl system :
  27840. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27841. * @param x x coordinate
  27842. * @param z z coordinate
  27843. * @returns the ground y position if (x, z) are outside the ground surface.
  27844. */
  27845. getHeightAtCoordinates(x: number, z: number): number;
  27846. /**
  27847. * Returns a normalized vector (Vector3) orthogonal to the ground
  27848. * at the ground coordinates (x, z) expressed in the World system.
  27849. * @param x x coordinate
  27850. * @param z z coordinate
  27851. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27852. */
  27853. getNormalAtCoordinates(x: number, z: number): Vector3;
  27854. /**
  27855. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27856. * at the ground coordinates (x, z) expressed in the World system.
  27857. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27858. * @param x x coordinate
  27859. * @param z z coordinate
  27860. * @param ref vector to store the result
  27861. * @returns the GroundMesh.
  27862. */
  27863. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27864. /**
  27865. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27866. * if the ground has been updated.
  27867. * This can be used in the render loop.
  27868. * @returns the GroundMesh.
  27869. */
  27870. updateCoordinateHeights(): GroundMesh;
  27871. private _getFacetAt;
  27872. private _initHeightQuads;
  27873. private _computeHeightQuads;
  27874. /**
  27875. * Serializes this ground mesh
  27876. * @param serializationObject object to write serialization to
  27877. */
  27878. serialize(serializationObject: any): void;
  27879. /**
  27880. * Parses a serialized ground mesh
  27881. * @param parsedMesh the serialized mesh
  27882. * @param scene the scene to create the ground mesh in
  27883. * @returns the created ground mesh
  27884. */
  27885. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27886. }
  27887. }
  27888. declare module "babylonjs/Physics/physicsJoint" {
  27889. import { Vector3 } from "babylonjs/Maths/math.vector";
  27890. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27891. /**
  27892. * Interface for Physics-Joint data
  27893. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27894. */
  27895. export interface PhysicsJointData {
  27896. /**
  27897. * The main pivot of the joint
  27898. */
  27899. mainPivot?: Vector3;
  27900. /**
  27901. * The connected pivot of the joint
  27902. */
  27903. connectedPivot?: Vector3;
  27904. /**
  27905. * The main axis of the joint
  27906. */
  27907. mainAxis?: Vector3;
  27908. /**
  27909. * The connected axis of the joint
  27910. */
  27911. connectedAxis?: Vector3;
  27912. /**
  27913. * The collision of the joint
  27914. */
  27915. collision?: boolean;
  27916. /**
  27917. * Native Oimo/Cannon/Energy data
  27918. */
  27919. nativeParams?: any;
  27920. }
  27921. /**
  27922. * This is a holder class for the physics joint created by the physics plugin
  27923. * It holds a set of functions to control the underlying joint
  27924. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27925. */
  27926. export class PhysicsJoint {
  27927. /**
  27928. * The type of the physics joint
  27929. */
  27930. type: number;
  27931. /**
  27932. * The data for the physics joint
  27933. */
  27934. jointData: PhysicsJointData;
  27935. private _physicsJoint;
  27936. protected _physicsPlugin: IPhysicsEnginePlugin;
  27937. /**
  27938. * Initializes the physics joint
  27939. * @param type The type of the physics joint
  27940. * @param jointData The data for the physics joint
  27941. */
  27942. constructor(
  27943. /**
  27944. * The type of the physics joint
  27945. */
  27946. type: number,
  27947. /**
  27948. * The data for the physics joint
  27949. */
  27950. jointData: PhysicsJointData);
  27951. /**
  27952. * Gets the physics joint
  27953. */
  27954. get physicsJoint(): any;
  27955. /**
  27956. * Sets the physics joint
  27957. */
  27958. set physicsJoint(newJoint: any);
  27959. /**
  27960. * Sets the physics plugin
  27961. */
  27962. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27963. /**
  27964. * Execute a function that is physics-plugin specific.
  27965. * @param {Function} func the function that will be executed.
  27966. * It accepts two parameters: the physics world and the physics joint
  27967. */
  27968. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27969. /**
  27970. * Distance-Joint type
  27971. */
  27972. static DistanceJoint: number;
  27973. /**
  27974. * Hinge-Joint type
  27975. */
  27976. static HingeJoint: number;
  27977. /**
  27978. * Ball-and-Socket joint type
  27979. */
  27980. static BallAndSocketJoint: number;
  27981. /**
  27982. * Wheel-Joint type
  27983. */
  27984. static WheelJoint: number;
  27985. /**
  27986. * Slider-Joint type
  27987. */
  27988. static SliderJoint: number;
  27989. /**
  27990. * Prismatic-Joint type
  27991. */
  27992. static PrismaticJoint: number;
  27993. /**
  27994. * Universal-Joint type
  27995. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27996. */
  27997. static UniversalJoint: number;
  27998. /**
  27999. * Hinge-Joint 2 type
  28000. */
  28001. static Hinge2Joint: number;
  28002. /**
  28003. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28004. */
  28005. static PointToPointJoint: number;
  28006. /**
  28007. * Spring-Joint type
  28008. */
  28009. static SpringJoint: number;
  28010. /**
  28011. * Lock-Joint type
  28012. */
  28013. static LockJoint: number;
  28014. }
  28015. /**
  28016. * A class representing a physics distance joint
  28017. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28018. */
  28019. export class DistanceJoint extends PhysicsJoint {
  28020. /**
  28021. *
  28022. * @param jointData The data for the Distance-Joint
  28023. */
  28024. constructor(jointData: DistanceJointData);
  28025. /**
  28026. * Update the predefined distance.
  28027. * @param maxDistance The maximum preferred distance
  28028. * @param minDistance The minimum preferred distance
  28029. */
  28030. updateDistance(maxDistance: number, minDistance?: number): void;
  28031. }
  28032. /**
  28033. * Represents a Motor-Enabled Joint
  28034. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28035. */
  28036. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28037. /**
  28038. * Initializes the Motor-Enabled Joint
  28039. * @param type The type of the joint
  28040. * @param jointData The physica joint data for the joint
  28041. */
  28042. constructor(type: number, jointData: PhysicsJointData);
  28043. /**
  28044. * Set the motor values.
  28045. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28046. * @param force the force to apply
  28047. * @param maxForce max force for this motor.
  28048. */
  28049. setMotor(force?: number, maxForce?: number): void;
  28050. /**
  28051. * Set the motor's limits.
  28052. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28053. * @param upperLimit The upper limit of the motor
  28054. * @param lowerLimit The lower limit of the motor
  28055. */
  28056. setLimit(upperLimit: number, lowerLimit?: number): void;
  28057. }
  28058. /**
  28059. * This class represents a single physics Hinge-Joint
  28060. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28061. */
  28062. export class HingeJoint extends MotorEnabledJoint {
  28063. /**
  28064. * Initializes the Hinge-Joint
  28065. * @param jointData The joint data for the Hinge-Joint
  28066. */
  28067. constructor(jointData: PhysicsJointData);
  28068. /**
  28069. * Set the motor values.
  28070. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28071. * @param {number} force the force to apply
  28072. * @param {number} maxForce max force for this motor.
  28073. */
  28074. setMotor(force?: number, maxForce?: number): void;
  28075. /**
  28076. * Set the motor's limits.
  28077. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28078. * @param upperLimit The upper limit of the motor
  28079. * @param lowerLimit The lower limit of the motor
  28080. */
  28081. setLimit(upperLimit: number, lowerLimit?: number): void;
  28082. }
  28083. /**
  28084. * This class represents a dual hinge physics joint (same as wheel joint)
  28085. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28086. */
  28087. export class Hinge2Joint extends MotorEnabledJoint {
  28088. /**
  28089. * Initializes the Hinge2-Joint
  28090. * @param jointData The joint data for the Hinge2-Joint
  28091. */
  28092. constructor(jointData: PhysicsJointData);
  28093. /**
  28094. * Set the motor values.
  28095. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28096. * @param {number} targetSpeed the speed the motor is to reach
  28097. * @param {number} maxForce max force for this motor.
  28098. * @param {motorIndex} the motor's index, 0 or 1.
  28099. */
  28100. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28101. /**
  28102. * Set the motor limits.
  28103. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28104. * @param {number} upperLimit the upper limit
  28105. * @param {number} lowerLimit lower limit
  28106. * @param {motorIndex} the motor's index, 0 or 1.
  28107. */
  28108. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28109. }
  28110. /**
  28111. * Interface for a motor enabled joint
  28112. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28113. */
  28114. export interface IMotorEnabledJoint {
  28115. /**
  28116. * Physics joint
  28117. */
  28118. physicsJoint: any;
  28119. /**
  28120. * Sets the motor of the motor-enabled joint
  28121. * @param force The force of the motor
  28122. * @param maxForce The maximum force of the motor
  28123. * @param motorIndex The index of the motor
  28124. */
  28125. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28126. /**
  28127. * Sets the limit of the motor
  28128. * @param upperLimit The upper limit of the motor
  28129. * @param lowerLimit The lower limit of the motor
  28130. * @param motorIndex The index of the motor
  28131. */
  28132. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28133. }
  28134. /**
  28135. * Joint data for a Distance-Joint
  28136. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28137. */
  28138. export interface DistanceJointData extends PhysicsJointData {
  28139. /**
  28140. * Max distance the 2 joint objects can be apart
  28141. */
  28142. maxDistance: number;
  28143. }
  28144. /**
  28145. * Joint data from a spring joint
  28146. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28147. */
  28148. export interface SpringJointData extends PhysicsJointData {
  28149. /**
  28150. * Length of the spring
  28151. */
  28152. length: number;
  28153. /**
  28154. * Stiffness of the spring
  28155. */
  28156. stiffness: number;
  28157. /**
  28158. * Damping of the spring
  28159. */
  28160. damping: number;
  28161. /** this callback will be called when applying the force to the impostors. */
  28162. forceApplicationCallback: () => void;
  28163. }
  28164. }
  28165. declare module "babylonjs/Physics/physicsRaycastResult" {
  28166. import { Vector3 } from "babylonjs/Maths/math.vector";
  28167. /**
  28168. * Holds the data for the raycast result
  28169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28170. */
  28171. export class PhysicsRaycastResult {
  28172. private _hasHit;
  28173. private _hitDistance;
  28174. private _hitNormalWorld;
  28175. private _hitPointWorld;
  28176. private _rayFromWorld;
  28177. private _rayToWorld;
  28178. /**
  28179. * Gets if there was a hit
  28180. */
  28181. get hasHit(): boolean;
  28182. /**
  28183. * Gets the distance from the hit
  28184. */
  28185. get hitDistance(): number;
  28186. /**
  28187. * Gets the hit normal/direction in the world
  28188. */
  28189. get hitNormalWorld(): Vector3;
  28190. /**
  28191. * Gets the hit point in the world
  28192. */
  28193. get hitPointWorld(): Vector3;
  28194. /**
  28195. * Gets the ray "start point" of the ray in the world
  28196. */
  28197. get rayFromWorld(): Vector3;
  28198. /**
  28199. * Gets the ray "end point" of the ray in the world
  28200. */
  28201. get rayToWorld(): Vector3;
  28202. /**
  28203. * Sets the hit data (normal & point in world space)
  28204. * @param hitNormalWorld defines the normal in world space
  28205. * @param hitPointWorld defines the point in world space
  28206. */
  28207. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28208. /**
  28209. * Sets the distance from the start point to the hit point
  28210. * @param distance
  28211. */
  28212. setHitDistance(distance: number): void;
  28213. /**
  28214. * Calculates the distance manually
  28215. */
  28216. calculateHitDistance(): void;
  28217. /**
  28218. * Resets all the values to default
  28219. * @param from The from point on world space
  28220. * @param to The to point on world space
  28221. */
  28222. reset(from?: Vector3, to?: Vector3): void;
  28223. }
  28224. /**
  28225. * Interface for the size containing width and height
  28226. */
  28227. interface IXYZ {
  28228. /**
  28229. * X
  28230. */
  28231. x: number;
  28232. /**
  28233. * Y
  28234. */
  28235. y: number;
  28236. /**
  28237. * Z
  28238. */
  28239. z: number;
  28240. }
  28241. }
  28242. declare module "babylonjs/Physics/IPhysicsEngine" {
  28243. import { Nullable } from "babylonjs/types";
  28244. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28245. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28246. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28247. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28248. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28249. /**
  28250. * Interface used to describe a physics joint
  28251. */
  28252. export interface PhysicsImpostorJoint {
  28253. /** Defines the main impostor to which the joint is linked */
  28254. mainImpostor: PhysicsImpostor;
  28255. /** Defines the impostor that is connected to the main impostor using this joint */
  28256. connectedImpostor: PhysicsImpostor;
  28257. /** Defines the joint itself */
  28258. joint: PhysicsJoint;
  28259. }
  28260. /** @hidden */
  28261. export interface IPhysicsEnginePlugin {
  28262. world: any;
  28263. name: string;
  28264. setGravity(gravity: Vector3): void;
  28265. setTimeStep(timeStep: number): void;
  28266. getTimeStep(): number;
  28267. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28268. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28270. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28271. removePhysicsBody(impostor: PhysicsImpostor): void;
  28272. generateJoint(joint: PhysicsImpostorJoint): void;
  28273. removeJoint(joint: PhysicsImpostorJoint): void;
  28274. isSupported(): boolean;
  28275. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28276. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28277. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28279. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28281. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28282. getBodyMass(impostor: PhysicsImpostor): number;
  28283. getBodyFriction(impostor: PhysicsImpostor): number;
  28284. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28285. getBodyRestitution(impostor: PhysicsImpostor): number;
  28286. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28287. getBodyPressure?(impostor: PhysicsImpostor): number;
  28288. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28289. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28290. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28291. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28292. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28293. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28294. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28295. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28297. sleepBody(impostor: PhysicsImpostor): void;
  28298. wakeUpBody(impostor: PhysicsImpostor): void;
  28299. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28300. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28301. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28302. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28303. getRadius(impostor: PhysicsImpostor): number;
  28304. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28305. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28306. dispose(): void;
  28307. }
  28308. /**
  28309. * Interface used to define a physics engine
  28310. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28311. */
  28312. export interface IPhysicsEngine {
  28313. /**
  28314. * Gets the gravity vector used by the simulation
  28315. */
  28316. gravity: Vector3;
  28317. /**
  28318. * Sets the gravity vector used by the simulation
  28319. * @param gravity defines the gravity vector to use
  28320. */
  28321. setGravity(gravity: Vector3): void;
  28322. /**
  28323. * Set the time step of the physics engine.
  28324. * Default is 1/60.
  28325. * To slow it down, enter 1/600 for example.
  28326. * To speed it up, 1/30
  28327. * @param newTimeStep the new timestep to apply to this world.
  28328. */
  28329. setTimeStep(newTimeStep: number): void;
  28330. /**
  28331. * Get the time step of the physics engine.
  28332. * @returns the current time step
  28333. */
  28334. getTimeStep(): number;
  28335. /**
  28336. * Set the sub time step of the physics engine.
  28337. * Default is 0 meaning there is no sub steps
  28338. * To increase physics resolution precision, set a small value (like 1 ms)
  28339. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28340. */
  28341. setSubTimeStep(subTimeStep: number): void;
  28342. /**
  28343. * Get the sub time step of the physics engine.
  28344. * @returns the current sub time step
  28345. */
  28346. getSubTimeStep(): number;
  28347. /**
  28348. * Release all resources
  28349. */
  28350. dispose(): void;
  28351. /**
  28352. * Gets the name of the current physics plugin
  28353. * @returns the name of the plugin
  28354. */
  28355. getPhysicsPluginName(): string;
  28356. /**
  28357. * Adding a new impostor for the impostor tracking.
  28358. * This will be done by the impostor itself.
  28359. * @param impostor the impostor to add
  28360. */
  28361. addImpostor(impostor: PhysicsImpostor): void;
  28362. /**
  28363. * Remove an impostor from the engine.
  28364. * This impostor and its mesh will not longer be updated by the physics engine.
  28365. * @param impostor the impostor to remove
  28366. */
  28367. removeImpostor(impostor: PhysicsImpostor): void;
  28368. /**
  28369. * Add a joint to the physics engine
  28370. * @param mainImpostor defines the main impostor to which the joint is added.
  28371. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28372. * @param joint defines the joint that will connect both impostors.
  28373. */
  28374. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28375. /**
  28376. * Removes a joint from the simulation
  28377. * @param mainImpostor defines the impostor used with the joint
  28378. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28379. * @param joint defines the joint to remove
  28380. */
  28381. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28382. /**
  28383. * Gets the current plugin used to run the simulation
  28384. * @returns current plugin
  28385. */
  28386. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28387. /**
  28388. * Gets the list of physic impostors
  28389. * @returns an array of PhysicsImpostor
  28390. */
  28391. getImpostors(): Array<PhysicsImpostor>;
  28392. /**
  28393. * Gets the impostor for a physics enabled object
  28394. * @param object defines the object impersonated by the impostor
  28395. * @returns the PhysicsImpostor or null if not found
  28396. */
  28397. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28398. /**
  28399. * Gets the impostor for a physics body object
  28400. * @param body defines physics body used by the impostor
  28401. * @returns the PhysicsImpostor or null if not found
  28402. */
  28403. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28404. /**
  28405. * Does a raycast in the physics world
  28406. * @param from when should the ray start?
  28407. * @param to when should the ray end?
  28408. * @returns PhysicsRaycastResult
  28409. */
  28410. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28411. /**
  28412. * Called by the scene. No need to call it.
  28413. * @param delta defines the timespam between frames
  28414. */
  28415. _step(delta: number): void;
  28416. }
  28417. }
  28418. declare module "babylonjs/Physics/physicsImpostor" {
  28419. import { Nullable, IndicesArray } from "babylonjs/types";
  28420. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28421. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28422. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28423. import { Scene } from "babylonjs/scene";
  28424. import { Bone } from "babylonjs/Bones/bone";
  28425. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28426. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28427. import { Space } from "babylonjs/Maths/math.axis";
  28428. /**
  28429. * The interface for the physics imposter parameters
  28430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28431. */
  28432. export interface PhysicsImpostorParameters {
  28433. /**
  28434. * The mass of the physics imposter
  28435. */
  28436. mass: number;
  28437. /**
  28438. * The friction of the physics imposter
  28439. */
  28440. friction?: number;
  28441. /**
  28442. * The coefficient of restitution of the physics imposter
  28443. */
  28444. restitution?: number;
  28445. /**
  28446. * The native options of the physics imposter
  28447. */
  28448. nativeOptions?: any;
  28449. /**
  28450. * Specifies if the parent should be ignored
  28451. */
  28452. ignoreParent?: boolean;
  28453. /**
  28454. * Specifies if bi-directional transformations should be disabled
  28455. */
  28456. disableBidirectionalTransformation?: boolean;
  28457. /**
  28458. * The pressure inside the physics imposter, soft object only
  28459. */
  28460. pressure?: number;
  28461. /**
  28462. * The stiffness the physics imposter, soft object only
  28463. */
  28464. stiffness?: number;
  28465. /**
  28466. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28467. */
  28468. velocityIterations?: number;
  28469. /**
  28470. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28471. */
  28472. positionIterations?: number;
  28473. /**
  28474. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28475. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28476. * Add to fix multiple points
  28477. */
  28478. fixedPoints?: number;
  28479. /**
  28480. * The collision margin around a soft object
  28481. */
  28482. margin?: number;
  28483. /**
  28484. * The collision margin around a soft object
  28485. */
  28486. damping?: number;
  28487. /**
  28488. * The path for a rope based on an extrusion
  28489. */
  28490. path?: any;
  28491. /**
  28492. * The shape of an extrusion used for a rope based on an extrusion
  28493. */
  28494. shape?: any;
  28495. }
  28496. /**
  28497. * Interface for a physics-enabled object
  28498. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28499. */
  28500. export interface IPhysicsEnabledObject {
  28501. /**
  28502. * The position of the physics-enabled object
  28503. */
  28504. position: Vector3;
  28505. /**
  28506. * The rotation of the physics-enabled object
  28507. */
  28508. rotationQuaternion: Nullable<Quaternion>;
  28509. /**
  28510. * The scale of the physics-enabled object
  28511. */
  28512. scaling: Vector3;
  28513. /**
  28514. * The rotation of the physics-enabled object
  28515. */
  28516. rotation?: Vector3;
  28517. /**
  28518. * The parent of the physics-enabled object
  28519. */
  28520. parent?: any;
  28521. /**
  28522. * The bounding info of the physics-enabled object
  28523. * @returns The bounding info of the physics-enabled object
  28524. */
  28525. getBoundingInfo(): BoundingInfo;
  28526. /**
  28527. * Computes the world matrix
  28528. * @param force Specifies if the world matrix should be computed by force
  28529. * @returns A world matrix
  28530. */
  28531. computeWorldMatrix(force: boolean): Matrix;
  28532. /**
  28533. * Gets the world matrix
  28534. * @returns A world matrix
  28535. */
  28536. getWorldMatrix?(): Matrix;
  28537. /**
  28538. * Gets the child meshes
  28539. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28540. * @returns An array of abstract meshes
  28541. */
  28542. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28543. /**
  28544. * Gets the vertex data
  28545. * @param kind The type of vertex data
  28546. * @returns A nullable array of numbers, or a float32 array
  28547. */
  28548. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28549. /**
  28550. * Gets the indices from the mesh
  28551. * @returns A nullable array of index arrays
  28552. */
  28553. getIndices?(): Nullable<IndicesArray>;
  28554. /**
  28555. * Gets the scene from the mesh
  28556. * @returns the indices array or null
  28557. */
  28558. getScene?(): Scene;
  28559. /**
  28560. * Gets the absolute position from the mesh
  28561. * @returns the absolute position
  28562. */
  28563. getAbsolutePosition(): Vector3;
  28564. /**
  28565. * Gets the absolute pivot point from the mesh
  28566. * @returns the absolute pivot point
  28567. */
  28568. getAbsolutePivotPoint(): Vector3;
  28569. /**
  28570. * Rotates the mesh
  28571. * @param axis The axis of rotation
  28572. * @param amount The amount of rotation
  28573. * @param space The space of the rotation
  28574. * @returns The rotation transform node
  28575. */
  28576. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28577. /**
  28578. * Translates the mesh
  28579. * @param axis The axis of translation
  28580. * @param distance The distance of translation
  28581. * @param space The space of the translation
  28582. * @returns The transform node
  28583. */
  28584. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28585. /**
  28586. * Sets the absolute position of the mesh
  28587. * @param absolutePosition The absolute position of the mesh
  28588. * @returns The transform node
  28589. */
  28590. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28591. /**
  28592. * Gets the class name of the mesh
  28593. * @returns The class name
  28594. */
  28595. getClassName(): string;
  28596. }
  28597. /**
  28598. * Represents a physics imposter
  28599. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28600. */
  28601. export class PhysicsImpostor {
  28602. /**
  28603. * The physics-enabled object used as the physics imposter
  28604. */
  28605. object: IPhysicsEnabledObject;
  28606. /**
  28607. * The type of the physics imposter
  28608. */
  28609. type: number;
  28610. private _options;
  28611. private _scene?;
  28612. /**
  28613. * The default object size of the imposter
  28614. */
  28615. static DEFAULT_OBJECT_SIZE: Vector3;
  28616. /**
  28617. * The identity quaternion of the imposter
  28618. */
  28619. static IDENTITY_QUATERNION: Quaternion;
  28620. /** @hidden */
  28621. _pluginData: any;
  28622. private _physicsEngine;
  28623. private _physicsBody;
  28624. private _bodyUpdateRequired;
  28625. private _onBeforePhysicsStepCallbacks;
  28626. private _onAfterPhysicsStepCallbacks;
  28627. /** @hidden */
  28628. _onPhysicsCollideCallbacks: Array<{
  28629. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28630. otherImpostors: Array<PhysicsImpostor>;
  28631. }>;
  28632. private _deltaPosition;
  28633. private _deltaRotation;
  28634. private _deltaRotationConjugated;
  28635. /** @hidden */
  28636. _isFromLine: boolean;
  28637. private _parent;
  28638. private _isDisposed;
  28639. private static _tmpVecs;
  28640. private static _tmpQuat;
  28641. /**
  28642. * Specifies if the physics imposter is disposed
  28643. */
  28644. get isDisposed(): boolean;
  28645. /**
  28646. * Gets the mass of the physics imposter
  28647. */
  28648. get mass(): number;
  28649. set mass(value: number);
  28650. /**
  28651. * Gets the coefficient of friction
  28652. */
  28653. get friction(): number;
  28654. /**
  28655. * Sets the coefficient of friction
  28656. */
  28657. set friction(value: number);
  28658. /**
  28659. * Gets the coefficient of restitution
  28660. */
  28661. get restitution(): number;
  28662. /**
  28663. * Sets the coefficient of restitution
  28664. */
  28665. set restitution(value: number);
  28666. /**
  28667. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28668. */
  28669. get pressure(): number;
  28670. /**
  28671. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28672. */
  28673. set pressure(value: number);
  28674. /**
  28675. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28676. */
  28677. get stiffness(): number;
  28678. /**
  28679. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28680. */
  28681. set stiffness(value: number);
  28682. /**
  28683. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28684. */
  28685. get velocityIterations(): number;
  28686. /**
  28687. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28688. */
  28689. set velocityIterations(value: number);
  28690. /**
  28691. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28692. */
  28693. get positionIterations(): number;
  28694. /**
  28695. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28696. */
  28697. set positionIterations(value: number);
  28698. /**
  28699. * The unique id of the physics imposter
  28700. * set by the physics engine when adding this impostor to the array
  28701. */
  28702. uniqueId: number;
  28703. /**
  28704. * @hidden
  28705. */
  28706. soft: boolean;
  28707. /**
  28708. * @hidden
  28709. */
  28710. segments: number;
  28711. private _joints;
  28712. /**
  28713. * Initializes the physics imposter
  28714. * @param object The physics-enabled object used as the physics imposter
  28715. * @param type The type of the physics imposter
  28716. * @param _options The options for the physics imposter
  28717. * @param _scene The Babylon scene
  28718. */
  28719. constructor(
  28720. /**
  28721. * The physics-enabled object used as the physics imposter
  28722. */
  28723. object: IPhysicsEnabledObject,
  28724. /**
  28725. * The type of the physics imposter
  28726. */
  28727. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28728. /**
  28729. * This function will completly initialize this impostor.
  28730. * It will create a new body - but only if this mesh has no parent.
  28731. * If it has, this impostor will not be used other than to define the impostor
  28732. * of the child mesh.
  28733. * @hidden
  28734. */
  28735. _init(): void;
  28736. private _getPhysicsParent;
  28737. /**
  28738. * Should a new body be generated.
  28739. * @returns boolean specifying if body initialization is required
  28740. */
  28741. isBodyInitRequired(): boolean;
  28742. /**
  28743. * Sets the updated scaling
  28744. * @param updated Specifies if the scaling is updated
  28745. */
  28746. setScalingUpdated(): void;
  28747. /**
  28748. * Force a regeneration of this or the parent's impostor's body.
  28749. * Use under cautious - This will remove all joints already implemented.
  28750. */
  28751. forceUpdate(): void;
  28752. /**
  28753. * Gets the body that holds this impostor. Either its own, or its parent.
  28754. */
  28755. get physicsBody(): any;
  28756. /**
  28757. * Get the parent of the physics imposter
  28758. * @returns Physics imposter or null
  28759. */
  28760. get parent(): Nullable<PhysicsImpostor>;
  28761. /**
  28762. * Sets the parent of the physics imposter
  28763. */
  28764. set parent(value: Nullable<PhysicsImpostor>);
  28765. /**
  28766. * Set the physics body. Used mainly by the physics engine/plugin
  28767. */
  28768. set physicsBody(physicsBody: any);
  28769. /**
  28770. * Resets the update flags
  28771. */
  28772. resetUpdateFlags(): void;
  28773. /**
  28774. * Gets the object extend size
  28775. * @returns the object extend size
  28776. */
  28777. getObjectExtendSize(): Vector3;
  28778. /**
  28779. * Gets the object center
  28780. * @returns The object center
  28781. */
  28782. getObjectCenter(): Vector3;
  28783. /**
  28784. * Get a specific parameter from the options parameters
  28785. * @param paramName The object parameter name
  28786. * @returns The object parameter
  28787. */
  28788. getParam(paramName: string): any;
  28789. /**
  28790. * Sets a specific parameter in the options given to the physics plugin
  28791. * @param paramName The parameter name
  28792. * @param value The value of the parameter
  28793. */
  28794. setParam(paramName: string, value: number): void;
  28795. /**
  28796. * Specifically change the body's mass option. Won't recreate the physics body object
  28797. * @param mass The mass of the physics imposter
  28798. */
  28799. setMass(mass: number): void;
  28800. /**
  28801. * Gets the linear velocity
  28802. * @returns linear velocity or null
  28803. */
  28804. getLinearVelocity(): Nullable<Vector3>;
  28805. /**
  28806. * Sets the linear velocity
  28807. * @param velocity linear velocity or null
  28808. */
  28809. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28810. /**
  28811. * Gets the angular velocity
  28812. * @returns angular velocity or null
  28813. */
  28814. getAngularVelocity(): Nullable<Vector3>;
  28815. /**
  28816. * Sets the angular velocity
  28817. * @param velocity The velocity or null
  28818. */
  28819. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28820. /**
  28821. * Execute a function with the physics plugin native code
  28822. * Provide a function the will have two variables - the world object and the physics body object
  28823. * @param func The function to execute with the physics plugin native code
  28824. */
  28825. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28826. /**
  28827. * Register a function that will be executed before the physics world is stepping forward
  28828. * @param func The function to execute before the physics world is stepped forward
  28829. */
  28830. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28831. /**
  28832. * Unregister a function that will be executed before the physics world is stepping forward
  28833. * @param func The function to execute before the physics world is stepped forward
  28834. */
  28835. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28836. /**
  28837. * Register a function that will be executed after the physics step
  28838. * @param func The function to execute after physics step
  28839. */
  28840. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28841. /**
  28842. * Unregisters a function that will be executed after the physics step
  28843. * @param func The function to execute after physics step
  28844. */
  28845. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28846. /**
  28847. * register a function that will be executed when this impostor collides against a different body
  28848. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28849. * @param func Callback that is executed on collision
  28850. */
  28851. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28852. /**
  28853. * Unregisters the physics imposter on contact
  28854. * @param collideAgainst The physics object to collide against
  28855. * @param func Callback to execute on collision
  28856. */
  28857. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28858. private _tmpQuat;
  28859. private _tmpQuat2;
  28860. /**
  28861. * Get the parent rotation
  28862. * @returns The parent rotation
  28863. */
  28864. getParentsRotation(): Quaternion;
  28865. /**
  28866. * this function is executed by the physics engine.
  28867. */
  28868. beforeStep: () => void;
  28869. /**
  28870. * this function is executed by the physics engine
  28871. */
  28872. afterStep: () => void;
  28873. /**
  28874. * Legacy collision detection event support
  28875. */
  28876. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28877. /**
  28878. * event and body object due to cannon's event-based architecture.
  28879. */
  28880. onCollide: (e: {
  28881. body: any;
  28882. }) => void;
  28883. /**
  28884. * Apply a force
  28885. * @param force The force to apply
  28886. * @param contactPoint The contact point for the force
  28887. * @returns The physics imposter
  28888. */
  28889. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28890. /**
  28891. * Apply an impulse
  28892. * @param force The impulse force
  28893. * @param contactPoint The contact point for the impulse force
  28894. * @returns The physics imposter
  28895. */
  28896. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28897. /**
  28898. * A help function to create a joint
  28899. * @param otherImpostor A physics imposter used to create a joint
  28900. * @param jointType The type of joint
  28901. * @param jointData The data for the joint
  28902. * @returns The physics imposter
  28903. */
  28904. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28905. /**
  28906. * Add a joint to this impostor with a different impostor
  28907. * @param otherImpostor A physics imposter used to add a joint
  28908. * @param joint The joint to add
  28909. * @returns The physics imposter
  28910. */
  28911. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28912. /**
  28913. * Add an anchor to a cloth impostor
  28914. * @param otherImpostor rigid impostor to anchor to
  28915. * @param width ratio across width from 0 to 1
  28916. * @param height ratio up height from 0 to 1
  28917. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28918. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28919. * @returns impostor the soft imposter
  28920. */
  28921. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28922. /**
  28923. * Add a hook to a rope impostor
  28924. * @param otherImpostor rigid impostor to anchor to
  28925. * @param length ratio across rope from 0 to 1
  28926. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28927. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28928. * @returns impostor the rope imposter
  28929. */
  28930. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28931. /**
  28932. * Will keep this body still, in a sleep mode.
  28933. * @returns the physics imposter
  28934. */
  28935. sleep(): PhysicsImpostor;
  28936. /**
  28937. * Wake the body up.
  28938. * @returns The physics imposter
  28939. */
  28940. wakeUp(): PhysicsImpostor;
  28941. /**
  28942. * Clones the physics imposter
  28943. * @param newObject The physics imposter clones to this physics-enabled object
  28944. * @returns A nullable physics imposter
  28945. */
  28946. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28947. /**
  28948. * Disposes the physics imposter
  28949. */
  28950. dispose(): void;
  28951. /**
  28952. * Sets the delta position
  28953. * @param position The delta position amount
  28954. */
  28955. setDeltaPosition(position: Vector3): void;
  28956. /**
  28957. * Sets the delta rotation
  28958. * @param rotation The delta rotation amount
  28959. */
  28960. setDeltaRotation(rotation: Quaternion): void;
  28961. /**
  28962. * Gets the box size of the physics imposter and stores the result in the input parameter
  28963. * @param result Stores the box size
  28964. * @returns The physics imposter
  28965. */
  28966. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28967. /**
  28968. * Gets the radius of the physics imposter
  28969. * @returns Radius of the physics imposter
  28970. */
  28971. getRadius(): number;
  28972. /**
  28973. * Sync a bone with this impostor
  28974. * @param bone The bone to sync to the impostor.
  28975. * @param boneMesh The mesh that the bone is influencing.
  28976. * @param jointPivot The pivot of the joint / bone in local space.
  28977. * @param distToJoint Optional distance from the impostor to the joint.
  28978. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28979. */
  28980. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28981. /**
  28982. * Sync impostor to a bone
  28983. * @param bone The bone that the impostor will be synced to.
  28984. * @param boneMesh The mesh that the bone is influencing.
  28985. * @param jointPivot The pivot of the joint / bone in local space.
  28986. * @param distToJoint Optional distance from the impostor to the joint.
  28987. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28988. * @param boneAxis Optional vector3 axis the bone is aligned with
  28989. */
  28990. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28991. /**
  28992. * No-Imposter type
  28993. */
  28994. static NoImpostor: number;
  28995. /**
  28996. * Sphere-Imposter type
  28997. */
  28998. static SphereImpostor: number;
  28999. /**
  29000. * Box-Imposter type
  29001. */
  29002. static BoxImpostor: number;
  29003. /**
  29004. * Plane-Imposter type
  29005. */
  29006. static PlaneImpostor: number;
  29007. /**
  29008. * Mesh-imposter type
  29009. */
  29010. static MeshImpostor: number;
  29011. /**
  29012. * Capsule-Impostor type (Ammo.js plugin only)
  29013. */
  29014. static CapsuleImpostor: number;
  29015. /**
  29016. * Cylinder-Imposter type
  29017. */
  29018. static CylinderImpostor: number;
  29019. /**
  29020. * Particle-Imposter type
  29021. */
  29022. static ParticleImpostor: number;
  29023. /**
  29024. * Heightmap-Imposter type
  29025. */
  29026. static HeightmapImpostor: number;
  29027. /**
  29028. * ConvexHull-Impostor type (Ammo.js plugin only)
  29029. */
  29030. static ConvexHullImpostor: number;
  29031. /**
  29032. * Custom-Imposter type (Ammo.js plugin only)
  29033. */
  29034. static CustomImpostor: number;
  29035. /**
  29036. * Rope-Imposter type
  29037. */
  29038. static RopeImpostor: number;
  29039. /**
  29040. * Cloth-Imposter type
  29041. */
  29042. static ClothImpostor: number;
  29043. /**
  29044. * Softbody-Imposter type
  29045. */
  29046. static SoftbodyImpostor: number;
  29047. }
  29048. }
  29049. declare module "babylonjs/Meshes/mesh" {
  29050. import { Observable } from "babylonjs/Misc/observable";
  29051. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29052. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29053. import { Camera } from "babylonjs/Cameras/camera";
  29054. import { Scene } from "babylonjs/scene";
  29055. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29056. import { Color4 } from "babylonjs/Maths/math.color";
  29057. import { Engine } from "babylonjs/Engines/engine";
  29058. import { Node } from "babylonjs/node";
  29059. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29060. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29061. import { Buffer } from "babylonjs/Meshes/buffer";
  29062. import { Geometry } from "babylonjs/Meshes/geometry";
  29063. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29064. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29065. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29066. import { Effect } from "babylonjs/Materials/effect";
  29067. import { Material } from "babylonjs/Materials/material";
  29068. import { Skeleton } from "babylonjs/Bones/skeleton";
  29069. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29070. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29071. import { Path3D } from "babylonjs/Maths/math.path";
  29072. import { Plane } from "babylonjs/Maths/math.plane";
  29073. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29074. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29075. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29076. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29077. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29078. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29079. /**
  29080. * @hidden
  29081. **/
  29082. export class _CreationDataStorage {
  29083. closePath?: boolean;
  29084. closeArray?: boolean;
  29085. idx: number[];
  29086. dashSize: number;
  29087. gapSize: number;
  29088. path3D: Path3D;
  29089. pathArray: Vector3[][];
  29090. arc: number;
  29091. radius: number;
  29092. cap: number;
  29093. tessellation: number;
  29094. }
  29095. /**
  29096. * @hidden
  29097. **/
  29098. class _InstanceDataStorage {
  29099. visibleInstances: any;
  29100. batchCache: _InstancesBatch;
  29101. instancesBufferSize: number;
  29102. instancesBuffer: Nullable<Buffer>;
  29103. instancesData: Float32Array;
  29104. overridenInstanceCount: number;
  29105. isFrozen: boolean;
  29106. previousBatch: Nullable<_InstancesBatch>;
  29107. hardwareInstancedRendering: boolean;
  29108. sideOrientation: number;
  29109. manualUpdate: boolean;
  29110. }
  29111. /**
  29112. * @hidden
  29113. **/
  29114. export class _InstancesBatch {
  29115. mustReturn: boolean;
  29116. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29117. renderSelf: boolean[];
  29118. hardwareInstancedRendering: boolean[];
  29119. }
  29120. /**
  29121. * @hidden
  29122. **/
  29123. class _ThinInstanceDataStorage {
  29124. instancesCount: number;
  29125. matrixBuffer: Nullable<Buffer>;
  29126. matrixBufferSize: number;
  29127. matrixData: Nullable<Float32Array>;
  29128. boundingVectors: Array<Vector3>;
  29129. worldMatrices: Nullable<Matrix[]>;
  29130. }
  29131. /**
  29132. * Class used to represent renderable models
  29133. */
  29134. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29135. /**
  29136. * Mesh side orientation : usually the external or front surface
  29137. */
  29138. static readonly FRONTSIDE: number;
  29139. /**
  29140. * Mesh side orientation : usually the internal or back surface
  29141. */
  29142. static readonly BACKSIDE: number;
  29143. /**
  29144. * Mesh side orientation : both internal and external or front and back surfaces
  29145. */
  29146. static readonly DOUBLESIDE: number;
  29147. /**
  29148. * Mesh side orientation : by default, `FRONTSIDE`
  29149. */
  29150. static readonly DEFAULTSIDE: number;
  29151. /**
  29152. * Mesh cap setting : no cap
  29153. */
  29154. static readonly NO_CAP: number;
  29155. /**
  29156. * Mesh cap setting : one cap at the beginning of the mesh
  29157. */
  29158. static readonly CAP_START: number;
  29159. /**
  29160. * Mesh cap setting : one cap at the end of the mesh
  29161. */
  29162. static readonly CAP_END: number;
  29163. /**
  29164. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29165. */
  29166. static readonly CAP_ALL: number;
  29167. /**
  29168. * Mesh pattern setting : no flip or rotate
  29169. */
  29170. static readonly NO_FLIP: number;
  29171. /**
  29172. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29173. */
  29174. static readonly FLIP_TILE: number;
  29175. /**
  29176. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29177. */
  29178. static readonly ROTATE_TILE: number;
  29179. /**
  29180. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29181. */
  29182. static readonly FLIP_ROW: number;
  29183. /**
  29184. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29185. */
  29186. static readonly ROTATE_ROW: number;
  29187. /**
  29188. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29189. */
  29190. static readonly FLIP_N_ROTATE_TILE: number;
  29191. /**
  29192. * Mesh pattern setting : rotate pattern and rotate
  29193. */
  29194. static readonly FLIP_N_ROTATE_ROW: number;
  29195. /**
  29196. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29197. */
  29198. static readonly CENTER: number;
  29199. /**
  29200. * Mesh tile positioning : part tiles on left
  29201. */
  29202. static readonly LEFT: number;
  29203. /**
  29204. * Mesh tile positioning : part tiles on right
  29205. */
  29206. static readonly RIGHT: number;
  29207. /**
  29208. * Mesh tile positioning : part tiles on top
  29209. */
  29210. static readonly TOP: number;
  29211. /**
  29212. * Mesh tile positioning : part tiles on bottom
  29213. */
  29214. static readonly BOTTOM: number;
  29215. /**
  29216. * Gets the default side orientation.
  29217. * @param orientation the orientation to value to attempt to get
  29218. * @returns the default orientation
  29219. * @hidden
  29220. */
  29221. static _GetDefaultSideOrientation(orientation?: number): number;
  29222. private _internalMeshDataInfo;
  29223. get computeBonesUsingShaders(): boolean;
  29224. set computeBonesUsingShaders(value: boolean);
  29225. /**
  29226. * An event triggered before rendering the mesh
  29227. */
  29228. get onBeforeRenderObservable(): Observable<Mesh>;
  29229. /**
  29230. * An event triggered before binding the mesh
  29231. */
  29232. get onBeforeBindObservable(): Observable<Mesh>;
  29233. /**
  29234. * An event triggered after rendering the mesh
  29235. */
  29236. get onAfterRenderObservable(): Observable<Mesh>;
  29237. /**
  29238. * An event triggered before drawing the mesh
  29239. */
  29240. get onBeforeDrawObservable(): Observable<Mesh>;
  29241. private _onBeforeDrawObserver;
  29242. /**
  29243. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29244. */
  29245. set onBeforeDraw(callback: () => void);
  29246. get hasInstances(): boolean;
  29247. get hasThinInstances(): boolean;
  29248. /**
  29249. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29250. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29251. */
  29252. delayLoadState: number;
  29253. /**
  29254. * Gets the list of instances created from this mesh
  29255. * it is not supposed to be modified manually.
  29256. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29257. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29258. */
  29259. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29260. /**
  29261. * Gets the file containing delay loading data for this mesh
  29262. */
  29263. delayLoadingFile: string;
  29264. /** @hidden */
  29265. _binaryInfo: any;
  29266. /**
  29267. * User defined function used to change how LOD level selection is done
  29268. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29269. */
  29270. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29271. /**
  29272. * Gets or sets the morph target manager
  29273. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29274. */
  29275. get morphTargetManager(): Nullable<MorphTargetManager>;
  29276. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29277. /** @hidden */
  29278. _creationDataStorage: Nullable<_CreationDataStorage>;
  29279. /** @hidden */
  29280. _geometry: Nullable<Geometry>;
  29281. /** @hidden */
  29282. _delayInfo: Array<string>;
  29283. /** @hidden */
  29284. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29285. /** @hidden */
  29286. _instanceDataStorage: _InstanceDataStorage;
  29287. /** @hidden */
  29288. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29289. private _effectiveMaterial;
  29290. /** @hidden */
  29291. _shouldGenerateFlatShading: boolean;
  29292. /** @hidden */
  29293. _originalBuilderSideOrientation: number;
  29294. /**
  29295. * Use this property to change the original side orientation defined at construction time
  29296. */
  29297. overrideMaterialSideOrientation: Nullable<number>;
  29298. /**
  29299. * Gets the source mesh (the one used to clone this one from)
  29300. */
  29301. get source(): Nullable<Mesh>;
  29302. /**
  29303. * Gets the list of clones of this mesh
  29304. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29305. * Note that useClonedMeshMap=true is the default setting
  29306. */
  29307. get cloneMeshMap(): Nullable<{
  29308. [id: string]: Mesh | undefined;
  29309. }>;
  29310. /**
  29311. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29312. */
  29313. get isUnIndexed(): boolean;
  29314. set isUnIndexed(value: boolean);
  29315. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29316. get worldMatrixInstancedBuffer(): Float32Array;
  29317. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29318. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29319. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29320. /**
  29321. * @constructor
  29322. * @param name The value used by scene.getMeshByName() to do a lookup.
  29323. * @param scene The scene to add this mesh to.
  29324. * @param parent The parent of this mesh, if it has one
  29325. * @param source An optional Mesh from which geometry is shared, cloned.
  29326. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29327. * When false, achieved by calling a clone(), also passing False.
  29328. * This will make creation of children, recursive.
  29329. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29330. */
  29331. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29332. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29333. doNotInstantiate: boolean;
  29334. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29335. /**
  29336. * Gets the class name
  29337. * @returns the string "Mesh".
  29338. */
  29339. getClassName(): string;
  29340. /** @hidden */
  29341. get _isMesh(): boolean;
  29342. /**
  29343. * Returns a description of this mesh
  29344. * @param fullDetails define if full details about this mesh must be used
  29345. * @returns a descriptive string representing this mesh
  29346. */
  29347. toString(fullDetails?: boolean): string;
  29348. /** @hidden */
  29349. _unBindEffect(): void;
  29350. /**
  29351. * Gets a boolean indicating if this mesh has LOD
  29352. */
  29353. get hasLODLevels(): boolean;
  29354. /**
  29355. * Gets the list of MeshLODLevel associated with the current mesh
  29356. * @returns an array of MeshLODLevel
  29357. */
  29358. getLODLevels(): MeshLODLevel[];
  29359. private _sortLODLevels;
  29360. /**
  29361. * Add a mesh as LOD level triggered at the given distance.
  29362. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29363. * @param distance The distance from the center of the object to show this level
  29364. * @param mesh The mesh to be added as LOD level (can be null)
  29365. * @return This mesh (for chaining)
  29366. */
  29367. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29368. /**
  29369. * Returns the LOD level mesh at the passed distance or null if not found.
  29370. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29371. * @param distance The distance from the center of the object to show this level
  29372. * @returns a Mesh or `null`
  29373. */
  29374. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29375. /**
  29376. * Remove a mesh from the LOD array
  29377. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29378. * @param mesh defines the mesh to be removed
  29379. * @return This mesh (for chaining)
  29380. */
  29381. removeLODLevel(mesh: Mesh): Mesh;
  29382. /**
  29383. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29384. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29385. * @param camera defines the camera to use to compute distance
  29386. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29387. * @return This mesh (for chaining)
  29388. */
  29389. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29390. /**
  29391. * Gets the mesh internal Geometry object
  29392. */
  29393. get geometry(): Nullable<Geometry>;
  29394. /**
  29395. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29396. * @returns the total number of vertices
  29397. */
  29398. getTotalVertices(): number;
  29399. /**
  29400. * Returns the content of an associated vertex buffer
  29401. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29402. * - VertexBuffer.PositionKind
  29403. * - VertexBuffer.UVKind
  29404. * - VertexBuffer.UV2Kind
  29405. * - VertexBuffer.UV3Kind
  29406. * - VertexBuffer.UV4Kind
  29407. * - VertexBuffer.UV5Kind
  29408. * - VertexBuffer.UV6Kind
  29409. * - VertexBuffer.ColorKind
  29410. * - VertexBuffer.MatricesIndicesKind
  29411. * - VertexBuffer.MatricesIndicesExtraKind
  29412. * - VertexBuffer.MatricesWeightsKind
  29413. * - VertexBuffer.MatricesWeightsExtraKind
  29414. * @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
  29415. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29416. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29417. */
  29418. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29419. /**
  29420. * Returns the mesh VertexBuffer object from the requested `kind`
  29421. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29422. * - VertexBuffer.PositionKind
  29423. * - VertexBuffer.NormalKind
  29424. * - VertexBuffer.UVKind
  29425. * - VertexBuffer.UV2Kind
  29426. * - VertexBuffer.UV3Kind
  29427. * - VertexBuffer.UV4Kind
  29428. * - VertexBuffer.UV5Kind
  29429. * - VertexBuffer.UV6Kind
  29430. * - VertexBuffer.ColorKind
  29431. * - VertexBuffer.MatricesIndicesKind
  29432. * - VertexBuffer.MatricesIndicesExtraKind
  29433. * - VertexBuffer.MatricesWeightsKind
  29434. * - VertexBuffer.MatricesWeightsExtraKind
  29435. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29436. */
  29437. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29438. /**
  29439. * Tests if a specific vertex buffer is associated with this mesh
  29440. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29441. * - VertexBuffer.PositionKind
  29442. * - VertexBuffer.NormalKind
  29443. * - VertexBuffer.UVKind
  29444. * - VertexBuffer.UV2Kind
  29445. * - VertexBuffer.UV3Kind
  29446. * - VertexBuffer.UV4Kind
  29447. * - VertexBuffer.UV5Kind
  29448. * - VertexBuffer.UV6Kind
  29449. * - VertexBuffer.ColorKind
  29450. * - VertexBuffer.MatricesIndicesKind
  29451. * - VertexBuffer.MatricesIndicesExtraKind
  29452. * - VertexBuffer.MatricesWeightsKind
  29453. * - VertexBuffer.MatricesWeightsExtraKind
  29454. * @returns a boolean
  29455. */
  29456. isVerticesDataPresent(kind: string): boolean;
  29457. /**
  29458. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29459. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29460. * - VertexBuffer.PositionKind
  29461. * - VertexBuffer.UVKind
  29462. * - VertexBuffer.UV2Kind
  29463. * - VertexBuffer.UV3Kind
  29464. * - VertexBuffer.UV4Kind
  29465. * - VertexBuffer.UV5Kind
  29466. * - VertexBuffer.UV6Kind
  29467. * - VertexBuffer.ColorKind
  29468. * - VertexBuffer.MatricesIndicesKind
  29469. * - VertexBuffer.MatricesIndicesExtraKind
  29470. * - VertexBuffer.MatricesWeightsKind
  29471. * - VertexBuffer.MatricesWeightsExtraKind
  29472. * @returns a boolean
  29473. */
  29474. isVertexBufferUpdatable(kind: string): boolean;
  29475. /**
  29476. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29477. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29478. * - VertexBuffer.PositionKind
  29479. * - VertexBuffer.NormalKind
  29480. * - VertexBuffer.UVKind
  29481. * - VertexBuffer.UV2Kind
  29482. * - VertexBuffer.UV3Kind
  29483. * - VertexBuffer.UV4Kind
  29484. * - VertexBuffer.UV5Kind
  29485. * - VertexBuffer.UV6Kind
  29486. * - VertexBuffer.ColorKind
  29487. * - VertexBuffer.MatricesIndicesKind
  29488. * - VertexBuffer.MatricesIndicesExtraKind
  29489. * - VertexBuffer.MatricesWeightsKind
  29490. * - VertexBuffer.MatricesWeightsExtraKind
  29491. * @returns an array of strings
  29492. */
  29493. getVerticesDataKinds(): string[];
  29494. /**
  29495. * Returns a positive integer : the total number of indices in this mesh geometry.
  29496. * @returns the numner of indices or zero if the mesh has no geometry.
  29497. */
  29498. getTotalIndices(): number;
  29499. /**
  29500. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29501. * @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.
  29502. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29503. * @returns the indices array or an empty array if the mesh has no geometry
  29504. */
  29505. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29506. get isBlocked(): boolean;
  29507. /**
  29508. * Determine if the current mesh is ready to be rendered
  29509. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29510. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29511. * @returns true if all associated assets are ready (material, textures, shaders)
  29512. */
  29513. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29514. /**
  29515. * 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.
  29516. */
  29517. get areNormalsFrozen(): boolean;
  29518. /**
  29519. * 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.
  29520. * @returns the current mesh
  29521. */
  29522. freezeNormals(): Mesh;
  29523. /**
  29524. * 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
  29525. * @returns the current mesh
  29526. */
  29527. unfreezeNormals(): Mesh;
  29528. /**
  29529. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29530. */
  29531. set overridenInstanceCount(count: number);
  29532. /** @hidden */
  29533. _preActivate(): Mesh;
  29534. /** @hidden */
  29535. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29536. /** @hidden */
  29537. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29538. protected _afterComputeWorldMatrix(): void;
  29539. /** @hidden */
  29540. _postActivate(): void;
  29541. /**
  29542. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29543. * This means the mesh underlying bounding box and sphere are recomputed.
  29544. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29545. * @returns the current mesh
  29546. */
  29547. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29548. /** @hidden */
  29549. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29550. /**
  29551. * This function will subdivide the mesh into multiple submeshes
  29552. * @param count defines the expected number of submeshes
  29553. */
  29554. subdivide(count: number): void;
  29555. /**
  29556. * Copy a FloatArray into a specific associated vertex buffer
  29557. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29558. * - VertexBuffer.PositionKind
  29559. * - VertexBuffer.UVKind
  29560. * - VertexBuffer.UV2Kind
  29561. * - VertexBuffer.UV3Kind
  29562. * - VertexBuffer.UV4Kind
  29563. * - VertexBuffer.UV5Kind
  29564. * - VertexBuffer.UV6Kind
  29565. * - VertexBuffer.ColorKind
  29566. * - VertexBuffer.MatricesIndicesKind
  29567. * - VertexBuffer.MatricesIndicesExtraKind
  29568. * - VertexBuffer.MatricesWeightsKind
  29569. * - VertexBuffer.MatricesWeightsExtraKind
  29570. * @param data defines the data source
  29571. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29572. * @param stride defines the data stride size (can be null)
  29573. * @returns the current mesh
  29574. */
  29575. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29576. /**
  29577. * Delete a vertex buffer associated with this mesh
  29578. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29579. * - VertexBuffer.PositionKind
  29580. * - VertexBuffer.UVKind
  29581. * - VertexBuffer.UV2Kind
  29582. * - VertexBuffer.UV3Kind
  29583. * - VertexBuffer.UV4Kind
  29584. * - VertexBuffer.UV5Kind
  29585. * - VertexBuffer.UV6Kind
  29586. * - VertexBuffer.ColorKind
  29587. * - VertexBuffer.MatricesIndicesKind
  29588. * - VertexBuffer.MatricesIndicesExtraKind
  29589. * - VertexBuffer.MatricesWeightsKind
  29590. * - VertexBuffer.MatricesWeightsExtraKind
  29591. */
  29592. removeVerticesData(kind: string): void;
  29593. /**
  29594. * Flags an associated vertex buffer as updatable
  29595. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29596. * - VertexBuffer.PositionKind
  29597. * - VertexBuffer.UVKind
  29598. * - VertexBuffer.UV2Kind
  29599. * - VertexBuffer.UV3Kind
  29600. * - VertexBuffer.UV4Kind
  29601. * - VertexBuffer.UV5Kind
  29602. * - VertexBuffer.UV6Kind
  29603. * - VertexBuffer.ColorKind
  29604. * - VertexBuffer.MatricesIndicesKind
  29605. * - VertexBuffer.MatricesIndicesExtraKind
  29606. * - VertexBuffer.MatricesWeightsKind
  29607. * - VertexBuffer.MatricesWeightsExtraKind
  29608. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29609. */
  29610. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29611. /**
  29612. * Sets the mesh global Vertex Buffer
  29613. * @param buffer defines the buffer to use
  29614. * @returns the current mesh
  29615. */
  29616. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29617. /**
  29618. * Update a specific associated vertex buffer
  29619. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29620. * - VertexBuffer.PositionKind
  29621. * - VertexBuffer.UVKind
  29622. * - VertexBuffer.UV2Kind
  29623. * - VertexBuffer.UV3Kind
  29624. * - VertexBuffer.UV4Kind
  29625. * - VertexBuffer.UV5Kind
  29626. * - VertexBuffer.UV6Kind
  29627. * - VertexBuffer.ColorKind
  29628. * - VertexBuffer.MatricesIndicesKind
  29629. * - VertexBuffer.MatricesIndicesExtraKind
  29630. * - VertexBuffer.MatricesWeightsKind
  29631. * - VertexBuffer.MatricesWeightsExtraKind
  29632. * @param data defines the data source
  29633. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29634. * @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)
  29635. * @returns the current mesh
  29636. */
  29637. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29638. /**
  29639. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29640. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29641. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29642. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29643. * @returns the current mesh
  29644. */
  29645. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29646. /**
  29647. * Creates a un-shared specific occurence of the geometry for the mesh.
  29648. * @returns the current mesh
  29649. */
  29650. makeGeometryUnique(): Mesh;
  29651. /**
  29652. * Set the index buffer of this mesh
  29653. * @param indices defines the source data
  29654. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29655. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29656. * @returns the current mesh
  29657. */
  29658. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29659. /**
  29660. * Update the current index buffer
  29661. * @param indices defines the source data
  29662. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29663. * @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)
  29664. * @returns the current mesh
  29665. */
  29666. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29667. /**
  29668. * Invert the geometry to move from a right handed system to a left handed one.
  29669. * @returns the current mesh
  29670. */
  29671. toLeftHanded(): Mesh;
  29672. /** @hidden */
  29673. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29674. /** @hidden */
  29675. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29676. /**
  29677. * Registers for this mesh a javascript function called just before the rendering process
  29678. * @param func defines the function to call before rendering this mesh
  29679. * @returns the current mesh
  29680. */
  29681. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29682. /**
  29683. * Disposes a previously registered javascript function called before the rendering
  29684. * @param func defines the function to remove
  29685. * @returns the current mesh
  29686. */
  29687. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29688. /**
  29689. * Registers for this mesh a javascript function called just after the rendering is complete
  29690. * @param func defines the function to call after rendering this mesh
  29691. * @returns the current mesh
  29692. */
  29693. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29694. /**
  29695. * Disposes a previously registered javascript function called after the rendering.
  29696. * @param func defines the function to remove
  29697. * @returns the current mesh
  29698. */
  29699. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29700. /** @hidden */
  29701. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29702. /** @hidden */
  29703. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29704. /** @hidden */
  29705. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29706. /** @hidden */
  29707. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29708. /** @hidden */
  29709. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29710. /** @hidden */
  29711. _rebuild(): void;
  29712. /** @hidden */
  29713. _freeze(): void;
  29714. /** @hidden */
  29715. _unFreeze(): void;
  29716. /**
  29717. * 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
  29718. * @param subMesh defines the subMesh to render
  29719. * @param enableAlphaMode defines if alpha mode can be changed
  29720. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29721. * @returns the current mesh
  29722. */
  29723. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29724. private _onBeforeDraw;
  29725. /**
  29726. * Renormalize the mesh and patch it up if there are no weights
  29727. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29728. * However in the case of zero weights then we set just a single influence to 1.
  29729. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29730. */
  29731. cleanMatrixWeights(): void;
  29732. private normalizeSkinFourWeights;
  29733. private normalizeSkinWeightsAndExtra;
  29734. /**
  29735. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29736. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29737. * the user know there was an issue with importing the mesh
  29738. * @returns a validation object with skinned, valid and report string
  29739. */
  29740. validateSkinning(): {
  29741. skinned: boolean;
  29742. valid: boolean;
  29743. report: string;
  29744. };
  29745. /** @hidden */
  29746. _checkDelayState(): Mesh;
  29747. private _queueLoad;
  29748. /**
  29749. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29750. * A mesh is in the frustum if its bounding box intersects the frustum
  29751. * @param frustumPlanes defines the frustum to test
  29752. * @returns true if the mesh is in the frustum planes
  29753. */
  29754. isInFrustum(frustumPlanes: Plane[]): boolean;
  29755. /**
  29756. * Sets the mesh material by the material or multiMaterial `id` property
  29757. * @param id is a string identifying the material or the multiMaterial
  29758. * @returns the current mesh
  29759. */
  29760. setMaterialByID(id: string): Mesh;
  29761. /**
  29762. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29763. * @returns an array of IAnimatable
  29764. */
  29765. getAnimatables(): IAnimatable[];
  29766. /**
  29767. * Modifies the mesh geometry according to the passed transformation matrix.
  29768. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29769. * The mesh normals are modified using the same transformation.
  29770. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29771. * @param transform defines the transform matrix to use
  29772. * @see https://doc.babylonjs.com/resources/baking_transformations
  29773. * @returns the current mesh
  29774. */
  29775. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29776. /**
  29777. * Modifies the mesh geometry according to its own current World Matrix.
  29778. * The mesh World Matrix is then reset.
  29779. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29780. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29781. * @see https://doc.babylonjs.com/resources/baking_transformations
  29782. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29783. * @returns the current mesh
  29784. */
  29785. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29786. /** @hidden */
  29787. get _positions(): Nullable<Vector3[]>;
  29788. /** @hidden */
  29789. _resetPointsArrayCache(): Mesh;
  29790. /** @hidden */
  29791. _generatePointsArray(): boolean;
  29792. /**
  29793. * Returns a new Mesh object generated from the current mesh properties.
  29794. * This method must not get confused with createInstance()
  29795. * @param name is a string, the name given to the new mesh
  29796. * @param newParent can be any Node object (default `null`)
  29797. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29798. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29799. * @returns a new mesh
  29800. */
  29801. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29802. /**
  29803. * Releases resources associated with this mesh.
  29804. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29805. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29806. */
  29807. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29808. /** @hidden */
  29809. _disposeInstanceSpecificData(): void;
  29810. /** @hidden */
  29811. _disposeThinInstanceSpecificData(): void;
  29812. /**
  29813. * Modifies the mesh geometry according to a displacement map.
  29814. * 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.
  29815. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29816. * @param url is a string, the URL from the image file is to be downloaded.
  29817. * @param minHeight is the lower limit of the displacement.
  29818. * @param maxHeight is the upper limit of the displacement.
  29819. * @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.
  29820. * @param uvOffset is an optional vector2 used to offset UV.
  29821. * @param uvScale is an optional vector2 used to scale UV.
  29822. * @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.
  29823. * @returns the Mesh.
  29824. */
  29825. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29826. /**
  29827. * Modifies the mesh geometry according to a displacementMap buffer.
  29828. * 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.
  29829. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29830. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29831. * @param heightMapWidth is the width of the buffer image.
  29832. * @param heightMapHeight is the height of the buffer image.
  29833. * @param minHeight is the lower limit of the displacement.
  29834. * @param maxHeight is the upper limit of the displacement.
  29835. * @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.
  29836. * @param uvOffset is an optional vector2 used to offset UV.
  29837. * @param uvScale is an optional vector2 used to scale UV.
  29838. * @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.
  29839. * @returns the Mesh.
  29840. */
  29841. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29842. /**
  29843. * Modify the mesh to get a flat shading rendering.
  29844. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29845. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29846. * @returns current mesh
  29847. */
  29848. convertToFlatShadedMesh(): Mesh;
  29849. /**
  29850. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29851. * In other words, more vertices, no more indices and a single bigger VBO.
  29852. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29853. * @returns current mesh
  29854. */
  29855. convertToUnIndexedMesh(): Mesh;
  29856. /**
  29857. * Inverses facet orientations.
  29858. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29859. * @param flipNormals will also inverts the normals
  29860. * @returns current mesh
  29861. */
  29862. flipFaces(flipNormals?: boolean): Mesh;
  29863. /**
  29864. * Increase the number of facets and hence vertices in a mesh
  29865. * Vertex normals are interpolated from existing vertex normals
  29866. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29867. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29868. */
  29869. increaseVertices(numberPerEdge: number): void;
  29870. /**
  29871. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29872. * This will undo any application of covertToFlatShadedMesh
  29873. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29874. */
  29875. forceSharedVertices(): void;
  29876. /** @hidden */
  29877. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29878. /** @hidden */
  29879. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29880. /**
  29881. * Creates a new InstancedMesh object from the mesh model.
  29882. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29883. * @param name defines the name of the new instance
  29884. * @returns a new InstancedMesh
  29885. */
  29886. createInstance(name: string): InstancedMesh;
  29887. /**
  29888. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29889. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29890. * @returns the current mesh
  29891. */
  29892. synchronizeInstances(): Mesh;
  29893. /**
  29894. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29895. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29896. * This should be used together with the simplification to avoid disappearing triangles.
  29897. * @param successCallback an optional success callback to be called after the optimization finished.
  29898. * @returns the current mesh
  29899. */
  29900. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29901. /**
  29902. * Serialize current mesh
  29903. * @param serializationObject defines the object which will receive the serialization data
  29904. */
  29905. serialize(serializationObject: any): void;
  29906. /** @hidden */
  29907. _syncGeometryWithMorphTargetManager(): void;
  29908. /** @hidden */
  29909. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29910. /**
  29911. * Returns a new Mesh object parsed from the source provided.
  29912. * @param parsedMesh is the source
  29913. * @param scene defines the hosting scene
  29914. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29915. * @returns a new Mesh
  29916. */
  29917. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29918. /**
  29919. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29920. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29921. * @param name defines the name of the mesh to create
  29922. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29923. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29924. * @param closePath creates a seam between the first and the last points of each path of the path array
  29925. * @param offset is taken in account only if the `pathArray` is containing a single path
  29926. * @param scene defines the hosting scene
  29927. * @param updatable defines if the mesh must be flagged as updatable
  29928. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29929. * @param instance defines 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)
  29930. * @returns a new Mesh
  29931. */
  29932. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29933. /**
  29934. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29935. * @param name defines the name of the mesh to create
  29936. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29937. * @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
  29938. * @param scene defines the hosting scene
  29939. * @param updatable defines if the mesh must be flagged as updatable
  29940. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29941. * @returns a new Mesh
  29942. */
  29943. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29944. /**
  29945. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29946. * @param name defines the name of the mesh to create
  29947. * @param size sets the size (float) of each box side (default 1)
  29948. * @param scene defines the hosting scene
  29949. * @param updatable defines if the mesh must be flagged as updatable
  29950. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29951. * @returns a new Mesh
  29952. */
  29953. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29954. /**
  29955. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29956. * @param name defines the name of the mesh to create
  29957. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29958. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29959. * @param scene defines the hosting scene
  29960. * @param updatable defines if the mesh must be flagged as updatable
  29961. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29962. * @returns a new Mesh
  29963. */
  29964. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29965. /**
  29966. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29967. * @param name defines the name of the mesh to create
  29968. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29969. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29970. * @param scene defines the hosting scene
  29971. * @returns a new Mesh
  29972. */
  29973. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29974. /**
  29975. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29976. * @param name defines the name of the mesh to create
  29977. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29978. * @param diameterTop set the top cap diameter (floats, default 1)
  29979. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29980. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29981. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29982. * @param scene defines the hosting scene
  29983. * @param updatable defines if the mesh must be flagged as updatable
  29984. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29985. * @returns a new Mesh
  29986. */
  29987. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29988. /**
  29989. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29990. * @param name defines the name of the mesh to create
  29991. * @param diameter sets the diameter size (float) of the torus (default 1)
  29992. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29993. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29994. * @param scene defines the hosting scene
  29995. * @param updatable defines if the mesh must be flagged as updatable
  29996. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29997. * @returns a new Mesh
  29998. */
  29999. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30000. /**
  30001. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30002. * @param name defines the name of the mesh to create
  30003. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30004. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30005. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30006. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30007. * @param p the number of windings on X axis (positive integers, default 2)
  30008. * @param q the number of windings on Y axis (positive integers, default 3)
  30009. * @param scene defines the hosting scene
  30010. * @param updatable defines if the mesh must be flagged as updatable
  30011. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30012. * @returns a new Mesh
  30013. */
  30014. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30015. /**
  30016. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30017. * @param name defines the name of the mesh to create
  30018. * @param points is an array successive Vector3
  30019. * @param scene defines the hosting scene
  30020. * @param updatable defines if the mesh must be flagged as updatable
  30021. * @param 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).
  30022. * @returns a new Mesh
  30023. */
  30024. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30025. /**
  30026. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30027. * @param name defines the name of the mesh to create
  30028. * @param points is an array successive Vector3
  30029. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30030. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30031. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30032. * @param scene defines the hosting scene
  30033. * @param updatable defines if the mesh must be flagged as updatable
  30034. * @param 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)
  30035. * @returns a new Mesh
  30036. */
  30037. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30038. /**
  30039. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30040. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30041. * 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.
  30042. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30043. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30044. * Remember you can only change the shape positions, not their number when updating a polygon.
  30045. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30046. * @param name defines the name of the mesh to create
  30047. * @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
  30048. * @param scene defines the hosting scene
  30049. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30050. * @param updatable defines if the mesh must be flagged as updatable
  30051. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30052. * @param earcutInjection can be used to inject your own earcut reference
  30053. * @returns a new Mesh
  30054. */
  30055. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30056. /**
  30057. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30058. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30059. * @param name defines the name of the mesh to create
  30060. * @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
  30061. * @param depth defines the height of extrusion
  30062. * @param scene defines the hosting scene
  30063. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30064. * @param updatable defines if the mesh must be flagged as updatable
  30065. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30066. * @param earcutInjection can be used to inject your own earcut reference
  30067. * @returns a new Mesh
  30068. */
  30069. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30070. /**
  30071. * Creates an extruded shape mesh.
  30072. * 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
  30073. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30074. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30075. * @param name defines the name of the mesh to create
  30076. * @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
  30077. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30078. * @param scale is the value to scale the shape
  30079. * @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
  30080. * @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
  30081. * @param scene defines the hosting scene
  30082. * @param updatable defines if the mesh must be flagged as updatable
  30083. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30084. * @param 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)
  30085. * @returns a new Mesh
  30086. */
  30087. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30088. /**
  30089. * Creates an custom extruded shape mesh.
  30090. * The custom extrusion is a parametric shape.
  30091. * It has no predefined shape. Its final shape will depend on the input parameters.
  30092. * Please consider using the same method from the MeshBuilder class instead
  30093. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30094. * @param name defines the name of the mesh to create
  30095. * @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
  30096. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30097. * @param scaleFunction is a custom Javascript function called on each path point
  30098. * @param rotationFunction is a custom Javascript function called on each path point
  30099. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30100. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30101. * @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
  30102. * @param scene defines the hosting scene
  30103. * @param updatable defines if the mesh must be flagged as updatable
  30104. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30105. * @param 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)
  30106. * @returns a new Mesh
  30107. */
  30108. 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;
  30109. /**
  30110. * Creates lathe mesh.
  30111. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30112. * Please consider using the same method from the MeshBuilder class instead
  30113. * @param name defines the name of the mesh to create
  30114. * @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
  30115. * @param radius is the radius value of the lathe
  30116. * @param tessellation is the side number of the lathe.
  30117. * @param scene defines the hosting scene
  30118. * @param updatable defines if the mesh must be flagged as updatable
  30119. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30120. * @returns a new Mesh
  30121. */
  30122. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30123. /**
  30124. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30125. * @param name defines the name of the mesh to create
  30126. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30127. * @param scene defines the hosting scene
  30128. * @param updatable defines if the mesh must be flagged as updatable
  30129. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30130. * @returns a new Mesh
  30131. */
  30132. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30133. /**
  30134. * Creates a ground mesh.
  30135. * Please consider using the same method from the MeshBuilder class instead
  30136. * @param name defines the name of the mesh to create
  30137. * @param width set the width of the ground
  30138. * @param height set the height of the ground
  30139. * @param subdivisions sets the number of subdivisions per side
  30140. * @param scene defines the hosting scene
  30141. * @param updatable defines if the mesh must be flagged as updatable
  30142. * @returns a new Mesh
  30143. */
  30144. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30145. /**
  30146. * Creates a tiled ground mesh.
  30147. * Please consider using the same method from the MeshBuilder class instead
  30148. * @param name defines the name of the mesh to create
  30149. * @param xmin set the ground minimum X coordinate
  30150. * @param zmin set the ground minimum Y coordinate
  30151. * @param xmax set the ground maximum X coordinate
  30152. * @param zmax set the ground maximum Z coordinate
  30153. * @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
  30154. * @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
  30155. * @param scene defines the hosting scene
  30156. * @param updatable defines if the mesh must be flagged as updatable
  30157. * @returns a new Mesh
  30158. */
  30159. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30160. w: number;
  30161. h: number;
  30162. }, precision: {
  30163. w: number;
  30164. h: number;
  30165. }, scene: Scene, updatable?: boolean): Mesh;
  30166. /**
  30167. * Creates a ground mesh from a height map.
  30168. * Please consider using the same method from the MeshBuilder class instead
  30169. * @see https://doc.babylonjs.com/babylon101/height_map
  30170. * @param name defines the name of the mesh to create
  30171. * @param url sets the URL of the height map image resource
  30172. * @param width set the ground width size
  30173. * @param height set the ground height size
  30174. * @param subdivisions sets the number of subdivision per side
  30175. * @param minHeight is the minimum altitude on the ground
  30176. * @param maxHeight is the maximum altitude on the ground
  30177. * @param scene defines the hosting scene
  30178. * @param updatable defines if the mesh must be flagged as updatable
  30179. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30180. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30181. * @returns a new Mesh
  30182. */
  30183. 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;
  30184. /**
  30185. * Creates a tube mesh.
  30186. * The tube is a parametric shape.
  30187. * It has no predefined shape. Its final shape will depend on the input parameters.
  30188. * Please consider using the same method from the MeshBuilder class instead
  30189. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30190. * @param name defines the name of the mesh to create
  30191. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30192. * @param radius sets the tube radius size
  30193. * @param tessellation is the number of sides on the tubular surface
  30194. * @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
  30195. * @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
  30196. * @param scene defines the hosting scene
  30197. * @param updatable defines if the mesh must be flagged as updatable
  30198. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30199. * @param 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)
  30200. * @returns a new Mesh
  30201. */
  30202. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30203. (i: number, distance: number): number;
  30204. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30205. /**
  30206. * Creates a polyhedron mesh.
  30207. * Please consider using the same method from the MeshBuilder class instead.
  30208. * * 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
  30209. * * The parameter `size` (positive float, default 1) sets the polygon size
  30210. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30211. * * 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`
  30212. * * 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
  30213. * * 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)`)
  30214. * * 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
  30215. * * 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
  30216. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30217. * * 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
  30218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30219. * @param name defines the name of the mesh to create
  30220. * @param options defines the options used to create the mesh
  30221. * @param scene defines the hosting scene
  30222. * @returns a new Mesh
  30223. */
  30224. static CreatePolyhedron(name: string, options: {
  30225. type?: number;
  30226. size?: number;
  30227. sizeX?: number;
  30228. sizeY?: number;
  30229. sizeZ?: number;
  30230. custom?: any;
  30231. faceUV?: Vector4[];
  30232. faceColors?: Color4[];
  30233. updatable?: boolean;
  30234. sideOrientation?: number;
  30235. }, scene: Scene): Mesh;
  30236. /**
  30237. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30238. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30239. * * 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`)
  30240. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30241. * * 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
  30242. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30243. * * 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
  30244. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30245. * @param name defines the name of the mesh
  30246. * @param options defines the options used to create the mesh
  30247. * @param scene defines the hosting scene
  30248. * @returns a new Mesh
  30249. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30250. */
  30251. static CreateIcoSphere(name: string, options: {
  30252. radius?: number;
  30253. flat?: boolean;
  30254. subdivisions?: number;
  30255. sideOrientation?: number;
  30256. updatable?: boolean;
  30257. }, scene: Scene): Mesh;
  30258. /**
  30259. * Creates a decal mesh.
  30260. * Please consider using the same method from the MeshBuilder class instead.
  30261. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30262. * @param name defines the name of the mesh
  30263. * @param sourceMesh defines the mesh receiving the decal
  30264. * @param position sets the position of the decal in world coordinates
  30265. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30266. * @param size sets the decal scaling
  30267. * @param angle sets the angle to rotate the decal
  30268. * @returns a new Mesh
  30269. */
  30270. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30271. /**
  30272. * Prepare internal position array for software CPU skinning
  30273. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30274. */
  30275. setPositionsForCPUSkinning(): Float32Array;
  30276. /**
  30277. * Prepare internal normal array for software CPU skinning
  30278. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30279. */
  30280. setNormalsForCPUSkinning(): Float32Array;
  30281. /**
  30282. * Updates the vertex buffer by applying transformation from the bones
  30283. * @param skeleton defines the skeleton to apply to current mesh
  30284. * @returns the current mesh
  30285. */
  30286. applySkeleton(skeleton: Skeleton): Mesh;
  30287. /**
  30288. * 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
  30289. * @param meshes defines the list of meshes to scan
  30290. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30291. */
  30292. static MinMax(meshes: AbstractMesh[]): {
  30293. min: Vector3;
  30294. max: Vector3;
  30295. };
  30296. /**
  30297. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30298. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30299. * @returns a vector3
  30300. */
  30301. static Center(meshesOrMinMaxVector: {
  30302. min: Vector3;
  30303. max: Vector3;
  30304. } | AbstractMesh[]): Vector3;
  30305. /**
  30306. * Merge the array of meshes into a single mesh for performance reasons.
  30307. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30308. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30309. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30310. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30311. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30312. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30313. * @returns a new mesh
  30314. */
  30315. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30316. /** @hidden */
  30317. addInstance(instance: InstancedMesh): void;
  30318. /** @hidden */
  30319. removeInstance(instance: InstancedMesh): void;
  30320. }
  30321. }
  30322. declare module "babylonjs/Cameras/camera" {
  30323. import { SmartArray } from "babylonjs/Misc/smartArray";
  30324. import { Observable } from "babylonjs/Misc/observable";
  30325. import { Nullable } from "babylonjs/types";
  30326. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30327. import { Scene } from "babylonjs/scene";
  30328. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30329. import { Node } from "babylonjs/node";
  30330. import { Mesh } from "babylonjs/Meshes/mesh";
  30331. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30332. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30333. import { Viewport } from "babylonjs/Maths/math.viewport";
  30334. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30335. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30336. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30337. import { Ray } from "babylonjs/Culling/ray";
  30338. /**
  30339. * This is the base class of all the camera used in the application.
  30340. * @see https://doc.babylonjs.com/features/cameras
  30341. */
  30342. export class Camera extends Node {
  30343. /** @hidden */
  30344. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30345. /**
  30346. * This is the default projection mode used by the cameras.
  30347. * It helps recreating a feeling of perspective and better appreciate depth.
  30348. * This is the best way to simulate real life cameras.
  30349. */
  30350. static readonly PERSPECTIVE_CAMERA: number;
  30351. /**
  30352. * This helps creating camera with an orthographic mode.
  30353. * 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.
  30354. */
  30355. static readonly ORTHOGRAPHIC_CAMERA: number;
  30356. /**
  30357. * This is the default FOV mode for perspective cameras.
  30358. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30359. */
  30360. static readonly FOVMODE_VERTICAL_FIXED: number;
  30361. /**
  30362. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30363. */
  30364. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30365. /**
  30366. * This specifies ther is no need for a camera rig.
  30367. * Basically only one eye is rendered corresponding to the camera.
  30368. */
  30369. static readonly RIG_MODE_NONE: number;
  30370. /**
  30371. * Simulates a camera Rig with one blue eye and one red eye.
  30372. * This can be use with 3d blue and red glasses.
  30373. */
  30374. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30375. /**
  30376. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30377. */
  30378. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30379. /**
  30380. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30381. */
  30382. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30383. /**
  30384. * Defines that both eyes of the camera will be rendered over under each other.
  30385. */
  30386. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30387. /**
  30388. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30389. */
  30390. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30391. /**
  30392. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30393. */
  30394. static readonly RIG_MODE_VR: number;
  30395. /**
  30396. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30397. */
  30398. static readonly RIG_MODE_WEBVR: number;
  30399. /**
  30400. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30401. */
  30402. static readonly RIG_MODE_CUSTOM: number;
  30403. /**
  30404. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30405. */
  30406. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30407. /**
  30408. * Define the input manager associated with the camera.
  30409. */
  30410. inputs: CameraInputsManager<Camera>;
  30411. /** @hidden */
  30412. _position: Vector3;
  30413. /**
  30414. * Define the current local position of the camera in the scene
  30415. */
  30416. get position(): Vector3;
  30417. set position(newPosition: Vector3);
  30418. protected _upVector: Vector3;
  30419. /**
  30420. * The vector the camera should consider as up.
  30421. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30422. */
  30423. set upVector(vec: Vector3);
  30424. get upVector(): Vector3;
  30425. /**
  30426. * Define the current limit on the left side for an orthographic camera
  30427. * In scene unit
  30428. */
  30429. orthoLeft: Nullable<number>;
  30430. /**
  30431. * Define the current limit on the right side for an orthographic camera
  30432. * In scene unit
  30433. */
  30434. orthoRight: Nullable<number>;
  30435. /**
  30436. * Define the current limit on the bottom side for an orthographic camera
  30437. * In scene unit
  30438. */
  30439. orthoBottom: Nullable<number>;
  30440. /**
  30441. * Define the current limit on the top side for an orthographic camera
  30442. * In scene unit
  30443. */
  30444. orthoTop: Nullable<number>;
  30445. /**
  30446. * Field Of View is set in Radians. (default is 0.8)
  30447. */
  30448. fov: number;
  30449. /**
  30450. * Define the minimum distance the camera can see from.
  30451. * This is important to note that the depth buffer are not infinite and the closer it starts
  30452. * the more your scene might encounter depth fighting issue.
  30453. */
  30454. minZ: number;
  30455. /**
  30456. * Define the maximum distance the camera can see to.
  30457. * This is important to note that the depth buffer are not infinite and the further it end
  30458. * the more your scene might encounter depth fighting issue.
  30459. */
  30460. maxZ: number;
  30461. /**
  30462. * Define the default inertia of the camera.
  30463. * This helps giving a smooth feeling to the camera movement.
  30464. */
  30465. inertia: number;
  30466. /**
  30467. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30468. */
  30469. mode: number;
  30470. /**
  30471. * Define whether the camera is intermediate.
  30472. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30473. */
  30474. isIntermediate: boolean;
  30475. /**
  30476. * Define the viewport of the camera.
  30477. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30478. */
  30479. viewport: Viewport;
  30480. /**
  30481. * Restricts the camera to viewing objects with the same layerMask.
  30482. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30483. */
  30484. layerMask: number;
  30485. /**
  30486. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30487. */
  30488. fovMode: number;
  30489. /**
  30490. * Rig mode of the camera.
  30491. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30492. * This is normally controlled byt the camera themselves as internal use.
  30493. */
  30494. cameraRigMode: number;
  30495. /**
  30496. * Defines the distance between both "eyes" in case of a RIG
  30497. */
  30498. interaxialDistance: number;
  30499. /**
  30500. * Defines if stereoscopic rendering is done side by side or over under.
  30501. */
  30502. isStereoscopicSideBySide: boolean;
  30503. /**
  30504. * 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
  30505. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30506. * else in the scene. (Eg. security camera)
  30507. *
  30508. * 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)
  30509. */
  30510. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30511. /**
  30512. * When set, the camera will render to this render target instead of the default canvas
  30513. *
  30514. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30515. */
  30516. outputRenderTarget: Nullable<RenderTargetTexture>;
  30517. /**
  30518. * Observable triggered when the camera view matrix has changed.
  30519. */
  30520. onViewMatrixChangedObservable: Observable<Camera>;
  30521. /**
  30522. * Observable triggered when the camera Projection matrix has changed.
  30523. */
  30524. onProjectionMatrixChangedObservable: Observable<Camera>;
  30525. /**
  30526. * Observable triggered when the inputs have been processed.
  30527. */
  30528. onAfterCheckInputsObservable: Observable<Camera>;
  30529. /**
  30530. * Observable triggered when reset has been called and applied to the camera.
  30531. */
  30532. onRestoreStateObservable: Observable<Camera>;
  30533. /**
  30534. * Is this camera a part of a rig system?
  30535. */
  30536. isRigCamera: boolean;
  30537. /**
  30538. * If isRigCamera set to true this will be set with the parent camera.
  30539. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30540. */
  30541. rigParent?: Camera;
  30542. /** @hidden */
  30543. _cameraRigParams: any;
  30544. /** @hidden */
  30545. _rigCameras: Camera[];
  30546. /** @hidden */
  30547. _rigPostProcess: Nullable<PostProcess>;
  30548. protected _webvrViewMatrix: Matrix;
  30549. /** @hidden */
  30550. _skipRendering: boolean;
  30551. /** @hidden */
  30552. _projectionMatrix: Matrix;
  30553. /** @hidden */
  30554. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30555. /** @hidden */
  30556. _activeMeshes: SmartArray<AbstractMesh>;
  30557. protected _globalPosition: Vector3;
  30558. /** @hidden */
  30559. _computedViewMatrix: Matrix;
  30560. private _doNotComputeProjectionMatrix;
  30561. private _transformMatrix;
  30562. private _frustumPlanes;
  30563. private _refreshFrustumPlanes;
  30564. private _storedFov;
  30565. private _stateStored;
  30566. /**
  30567. * Instantiates a new camera object.
  30568. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30569. * @see https://doc.babylonjs.com/features/cameras
  30570. * @param name Defines the name of the camera in the scene
  30571. * @param position Defines the position of the camera
  30572. * @param scene Defines the scene the camera belongs too
  30573. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30574. */
  30575. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30576. /**
  30577. * Store current camera state (fov, position, etc..)
  30578. * @returns the camera
  30579. */
  30580. storeState(): Camera;
  30581. /**
  30582. * Restores the camera state values if it has been stored. You must call storeState() first
  30583. */
  30584. protected _restoreStateValues(): boolean;
  30585. /**
  30586. * Restored camera state. You must call storeState() first.
  30587. * @returns true if restored and false otherwise
  30588. */
  30589. restoreState(): boolean;
  30590. /**
  30591. * Gets the class name of the camera.
  30592. * @returns the class name
  30593. */
  30594. getClassName(): string;
  30595. /** @hidden */
  30596. readonly _isCamera: boolean;
  30597. /**
  30598. * Gets a string representation of the camera useful for debug purpose.
  30599. * @param fullDetails Defines that a more verboe level of logging is required
  30600. * @returns the string representation
  30601. */
  30602. toString(fullDetails?: boolean): string;
  30603. /**
  30604. * Gets the current world space position of the camera.
  30605. */
  30606. get globalPosition(): Vector3;
  30607. /**
  30608. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30609. * @returns the active meshe list
  30610. */
  30611. getActiveMeshes(): SmartArray<AbstractMesh>;
  30612. /**
  30613. * Check whether a mesh is part of the current active mesh list of the camera
  30614. * @param mesh Defines the mesh to check
  30615. * @returns true if active, false otherwise
  30616. */
  30617. isActiveMesh(mesh: Mesh): boolean;
  30618. /**
  30619. * Is this camera ready to be used/rendered
  30620. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30621. * @return true if the camera is ready
  30622. */
  30623. isReady(completeCheck?: boolean): boolean;
  30624. /** @hidden */
  30625. _initCache(): void;
  30626. /** @hidden */
  30627. _updateCache(ignoreParentClass?: boolean): void;
  30628. /** @hidden */
  30629. _isSynchronized(): boolean;
  30630. /** @hidden */
  30631. _isSynchronizedViewMatrix(): boolean;
  30632. /** @hidden */
  30633. _isSynchronizedProjectionMatrix(): boolean;
  30634. /**
  30635. * Attach the input controls to a specific dom element to get the input from.
  30636. * @param element Defines the element the controls should be listened from
  30637. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30638. */
  30639. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30640. /**
  30641. * Detach the current controls from the specified dom element.
  30642. * @param element Defines the element to stop listening the inputs from
  30643. */
  30644. detachControl(element: HTMLElement): void;
  30645. /**
  30646. * Update the camera state according to the different inputs gathered during the frame.
  30647. */
  30648. update(): void;
  30649. /** @hidden */
  30650. _checkInputs(): void;
  30651. /** @hidden */
  30652. get rigCameras(): Camera[];
  30653. /**
  30654. * Gets the post process used by the rig cameras
  30655. */
  30656. get rigPostProcess(): Nullable<PostProcess>;
  30657. /**
  30658. * Internal, gets the first post proces.
  30659. * @returns the first post process to be run on this camera.
  30660. */
  30661. _getFirstPostProcess(): Nullable<PostProcess>;
  30662. private _cascadePostProcessesToRigCams;
  30663. /**
  30664. * Attach a post process to the camera.
  30665. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30666. * @param postProcess The post process to attach to the camera
  30667. * @param insertAt The position of the post process in case several of them are in use in the scene
  30668. * @returns the position the post process has been inserted at
  30669. */
  30670. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30671. /**
  30672. * Detach a post process to the camera.
  30673. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30674. * @param postProcess The post process to detach from the camera
  30675. */
  30676. detachPostProcess(postProcess: PostProcess): void;
  30677. /**
  30678. * Gets the current world matrix of the camera
  30679. */
  30680. getWorldMatrix(): Matrix;
  30681. /** @hidden */
  30682. _getViewMatrix(): Matrix;
  30683. /**
  30684. * Gets the current view matrix of the camera.
  30685. * @param force forces the camera to recompute the matrix without looking at the cached state
  30686. * @returns the view matrix
  30687. */
  30688. getViewMatrix(force?: boolean): Matrix;
  30689. /**
  30690. * Freeze the projection matrix.
  30691. * It will prevent the cache check of the camera projection compute and can speed up perf
  30692. * if no parameter of the camera are meant to change
  30693. * @param projection Defines manually a projection if necessary
  30694. */
  30695. freezeProjectionMatrix(projection?: Matrix): void;
  30696. /**
  30697. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30698. */
  30699. unfreezeProjectionMatrix(): void;
  30700. /**
  30701. * Gets the current projection matrix of the camera.
  30702. * @param force forces the camera to recompute the matrix without looking at the cached state
  30703. * @returns the projection matrix
  30704. */
  30705. getProjectionMatrix(force?: boolean): Matrix;
  30706. /**
  30707. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30708. * @returns a Matrix
  30709. */
  30710. getTransformationMatrix(): Matrix;
  30711. private _updateFrustumPlanes;
  30712. /**
  30713. * Checks if a cullable object (mesh...) is in the camera frustum
  30714. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30715. * @param target The object to check
  30716. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30717. * @returns true if the object is in frustum otherwise false
  30718. */
  30719. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30720. /**
  30721. * Checks if a cullable object (mesh...) is in the camera frustum
  30722. * Unlike isInFrustum this cheks the full bounding box
  30723. * @param target The object to check
  30724. * @returns true if the object is in frustum otherwise false
  30725. */
  30726. isCompletelyInFrustum(target: ICullable): boolean;
  30727. /**
  30728. * Gets a ray in the forward direction from the camera.
  30729. * @param length Defines the length of the ray to create
  30730. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30731. * @param origin Defines the start point of the ray which defaults to the camera position
  30732. * @returns the forward ray
  30733. */
  30734. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30735. /**
  30736. * Gets a ray in the forward direction from the camera.
  30737. * @param refRay the ray to (re)use when setting the values
  30738. * @param length Defines the length of the ray to create
  30739. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30740. * @param origin Defines the start point of the ray which defaults to the camera position
  30741. * @returns the forward ray
  30742. */
  30743. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30744. /**
  30745. * Releases resources associated with this node.
  30746. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30747. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30748. */
  30749. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30750. /** @hidden */
  30751. _isLeftCamera: boolean;
  30752. /**
  30753. * Gets the left camera of a rig setup in case of Rigged Camera
  30754. */
  30755. get isLeftCamera(): boolean;
  30756. /** @hidden */
  30757. _isRightCamera: boolean;
  30758. /**
  30759. * Gets the right camera of a rig setup in case of Rigged Camera
  30760. */
  30761. get isRightCamera(): boolean;
  30762. /**
  30763. * Gets the left camera of a rig setup in case of Rigged Camera
  30764. */
  30765. get leftCamera(): Nullable<FreeCamera>;
  30766. /**
  30767. * Gets the right camera of a rig setup in case of Rigged Camera
  30768. */
  30769. get rightCamera(): Nullable<FreeCamera>;
  30770. /**
  30771. * Gets the left camera target of a rig setup in case of Rigged Camera
  30772. * @returns the target position
  30773. */
  30774. getLeftTarget(): Nullable<Vector3>;
  30775. /**
  30776. * Gets the right camera target of a rig setup in case of Rigged Camera
  30777. * @returns the target position
  30778. */
  30779. getRightTarget(): Nullable<Vector3>;
  30780. /**
  30781. * @hidden
  30782. */
  30783. setCameraRigMode(mode: number, rigParams: any): void;
  30784. /** @hidden */
  30785. static _setStereoscopicRigMode(camera: Camera): void;
  30786. /** @hidden */
  30787. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30788. /** @hidden */
  30789. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30790. /** @hidden */
  30791. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30792. /** @hidden */
  30793. _getVRProjectionMatrix(): Matrix;
  30794. protected _updateCameraRotationMatrix(): void;
  30795. protected _updateWebVRCameraRotationMatrix(): void;
  30796. /**
  30797. * This function MUST be overwritten by the different WebVR cameras available.
  30798. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30799. * @hidden
  30800. */
  30801. _getWebVRProjectionMatrix(): Matrix;
  30802. /**
  30803. * This function MUST be overwritten by the different WebVR cameras available.
  30804. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30805. * @hidden
  30806. */
  30807. _getWebVRViewMatrix(): Matrix;
  30808. /** @hidden */
  30809. setCameraRigParameter(name: string, value: any): void;
  30810. /**
  30811. * needs to be overridden by children so sub has required properties to be copied
  30812. * @hidden
  30813. */
  30814. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30815. /**
  30816. * May need to be overridden by children
  30817. * @hidden
  30818. */
  30819. _updateRigCameras(): void;
  30820. /** @hidden */
  30821. _setupInputs(): void;
  30822. /**
  30823. * Serialiaze the camera setup to a json represention
  30824. * @returns the JSON representation
  30825. */
  30826. serialize(): any;
  30827. /**
  30828. * Clones the current camera.
  30829. * @param name The cloned camera name
  30830. * @returns the cloned camera
  30831. */
  30832. clone(name: string): Camera;
  30833. /**
  30834. * Gets the direction of the camera relative to a given local axis.
  30835. * @param localAxis Defines the reference axis to provide a relative direction.
  30836. * @return the direction
  30837. */
  30838. getDirection(localAxis: Vector3): Vector3;
  30839. /**
  30840. * Returns the current camera absolute rotation
  30841. */
  30842. get absoluteRotation(): Quaternion;
  30843. /**
  30844. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30845. * @param localAxis Defines the reference axis to provide a relative direction.
  30846. * @param result Defines the vector to store the result in
  30847. */
  30848. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30849. /**
  30850. * Gets a camera constructor for a given camera type
  30851. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30852. * @param name The name of the camera the result will be able to instantiate
  30853. * @param scene The scene the result will construct the camera in
  30854. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30855. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30856. * @returns a factory method to construc the camera
  30857. */
  30858. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30859. /**
  30860. * Compute the world matrix of the camera.
  30861. * @returns the camera world matrix
  30862. */
  30863. computeWorldMatrix(): Matrix;
  30864. /**
  30865. * Parse a JSON and creates the camera from the parsed information
  30866. * @param parsedCamera The JSON to parse
  30867. * @param scene The scene to instantiate the camera in
  30868. * @returns the newly constructed camera
  30869. */
  30870. static Parse(parsedCamera: any, scene: Scene): Camera;
  30871. }
  30872. }
  30873. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30874. import { Nullable } from "babylonjs/types";
  30875. import { Scene } from "babylonjs/scene";
  30876. import { Vector4 } from "babylonjs/Maths/math.vector";
  30877. import { Mesh } from "babylonjs/Meshes/mesh";
  30878. /**
  30879. * Class containing static functions to help procedurally build meshes
  30880. */
  30881. export class DiscBuilder {
  30882. /**
  30883. * Creates a plane polygonal mesh. By default, this is a disc
  30884. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30885. * * 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
  30886. * * 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
  30887. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30888. * * 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
  30889. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30890. * @param name defines the name of the mesh
  30891. * @param options defines the options used to create the mesh
  30892. * @param scene defines the hosting scene
  30893. * @returns the plane polygonal mesh
  30894. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30895. */
  30896. static CreateDisc(name: string, options: {
  30897. radius?: number;
  30898. tessellation?: number;
  30899. arc?: number;
  30900. updatable?: boolean;
  30901. sideOrientation?: number;
  30902. frontUVs?: Vector4;
  30903. backUVs?: Vector4;
  30904. }, scene?: Nullable<Scene>): Mesh;
  30905. }
  30906. }
  30907. declare module "babylonjs/Materials/fresnelParameters" {
  30908. import { DeepImmutable } from "babylonjs/types";
  30909. import { Color3 } from "babylonjs/Maths/math.color";
  30910. /**
  30911. * Options to be used when creating a FresnelParameters.
  30912. */
  30913. export type IFresnelParametersCreationOptions = {
  30914. /**
  30915. * Define the color used on edges (grazing angle)
  30916. */
  30917. leftColor?: Color3;
  30918. /**
  30919. * Define the color used on center
  30920. */
  30921. rightColor?: Color3;
  30922. /**
  30923. * Define bias applied to computed fresnel term
  30924. */
  30925. bias?: number;
  30926. /**
  30927. * Defined the power exponent applied to fresnel term
  30928. */
  30929. power?: number;
  30930. /**
  30931. * Define if the fresnel effect is enable or not.
  30932. */
  30933. isEnabled?: boolean;
  30934. };
  30935. /**
  30936. * Serialized format for FresnelParameters.
  30937. */
  30938. export type IFresnelParametersSerialized = {
  30939. /**
  30940. * Define the color used on edges (grazing angle) [as an array]
  30941. */
  30942. leftColor: number[];
  30943. /**
  30944. * Define the color used on center [as an array]
  30945. */
  30946. rightColor: number[];
  30947. /**
  30948. * Define bias applied to computed fresnel term
  30949. */
  30950. bias: number;
  30951. /**
  30952. * Defined the power exponent applied to fresnel term
  30953. */
  30954. power?: number;
  30955. /**
  30956. * Define if the fresnel effect is enable or not.
  30957. */
  30958. isEnabled: boolean;
  30959. };
  30960. /**
  30961. * This represents all the required information to add a fresnel effect on a material:
  30962. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30963. */
  30964. export class FresnelParameters {
  30965. private _isEnabled;
  30966. /**
  30967. * Define if the fresnel effect is enable or not.
  30968. */
  30969. get isEnabled(): boolean;
  30970. set isEnabled(value: boolean);
  30971. /**
  30972. * Define the color used on edges (grazing angle)
  30973. */
  30974. leftColor: Color3;
  30975. /**
  30976. * Define the color used on center
  30977. */
  30978. rightColor: Color3;
  30979. /**
  30980. * Define bias applied to computed fresnel term
  30981. */
  30982. bias: number;
  30983. /**
  30984. * Defined the power exponent applied to fresnel term
  30985. */
  30986. power: number;
  30987. /**
  30988. * Creates a new FresnelParameters object.
  30989. *
  30990. * @param options provide your own settings to optionally to override defaults
  30991. */
  30992. constructor(options?: IFresnelParametersCreationOptions);
  30993. /**
  30994. * Clones the current fresnel and its valuues
  30995. * @returns a clone fresnel configuration
  30996. */
  30997. clone(): FresnelParameters;
  30998. /**
  30999. * Determines equality between FresnelParameters objects
  31000. * @param otherFresnelParameters defines the second operand
  31001. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31002. */
  31003. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31004. /**
  31005. * Serializes the current fresnel parameters to a JSON representation.
  31006. * @return the JSON serialization
  31007. */
  31008. serialize(): IFresnelParametersSerialized;
  31009. /**
  31010. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31011. * @param parsedFresnelParameters Define the JSON representation
  31012. * @returns the parsed parameters
  31013. */
  31014. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31015. }
  31016. }
  31017. declare module "babylonjs/Materials/materialFlags" {
  31018. /**
  31019. * This groups all the flags used to control the materials channel.
  31020. */
  31021. export class MaterialFlags {
  31022. private static _DiffuseTextureEnabled;
  31023. /**
  31024. * Are diffuse textures enabled in the application.
  31025. */
  31026. static get DiffuseTextureEnabled(): boolean;
  31027. static set DiffuseTextureEnabled(value: boolean);
  31028. private static _DetailTextureEnabled;
  31029. /**
  31030. * Are detail textures enabled in the application.
  31031. */
  31032. static get DetailTextureEnabled(): boolean;
  31033. static set DetailTextureEnabled(value: boolean);
  31034. private static _AmbientTextureEnabled;
  31035. /**
  31036. * Are ambient textures enabled in the application.
  31037. */
  31038. static get AmbientTextureEnabled(): boolean;
  31039. static set AmbientTextureEnabled(value: boolean);
  31040. private static _OpacityTextureEnabled;
  31041. /**
  31042. * Are opacity textures enabled in the application.
  31043. */
  31044. static get OpacityTextureEnabled(): boolean;
  31045. static set OpacityTextureEnabled(value: boolean);
  31046. private static _ReflectionTextureEnabled;
  31047. /**
  31048. * Are reflection textures enabled in the application.
  31049. */
  31050. static get ReflectionTextureEnabled(): boolean;
  31051. static set ReflectionTextureEnabled(value: boolean);
  31052. private static _EmissiveTextureEnabled;
  31053. /**
  31054. * Are emissive textures enabled in the application.
  31055. */
  31056. static get EmissiveTextureEnabled(): boolean;
  31057. static set EmissiveTextureEnabled(value: boolean);
  31058. private static _SpecularTextureEnabled;
  31059. /**
  31060. * Are specular textures enabled in the application.
  31061. */
  31062. static get SpecularTextureEnabled(): boolean;
  31063. static set SpecularTextureEnabled(value: boolean);
  31064. private static _BumpTextureEnabled;
  31065. /**
  31066. * Are bump textures enabled in the application.
  31067. */
  31068. static get BumpTextureEnabled(): boolean;
  31069. static set BumpTextureEnabled(value: boolean);
  31070. private static _LightmapTextureEnabled;
  31071. /**
  31072. * Are lightmap textures enabled in the application.
  31073. */
  31074. static get LightmapTextureEnabled(): boolean;
  31075. static set LightmapTextureEnabled(value: boolean);
  31076. private static _RefractionTextureEnabled;
  31077. /**
  31078. * Are refraction textures enabled in the application.
  31079. */
  31080. static get RefractionTextureEnabled(): boolean;
  31081. static set RefractionTextureEnabled(value: boolean);
  31082. private static _ColorGradingTextureEnabled;
  31083. /**
  31084. * Are color grading textures enabled in the application.
  31085. */
  31086. static get ColorGradingTextureEnabled(): boolean;
  31087. static set ColorGradingTextureEnabled(value: boolean);
  31088. private static _FresnelEnabled;
  31089. /**
  31090. * Are fresnels enabled in the application.
  31091. */
  31092. static get FresnelEnabled(): boolean;
  31093. static set FresnelEnabled(value: boolean);
  31094. private static _ClearCoatTextureEnabled;
  31095. /**
  31096. * Are clear coat textures enabled in the application.
  31097. */
  31098. static get ClearCoatTextureEnabled(): boolean;
  31099. static set ClearCoatTextureEnabled(value: boolean);
  31100. private static _ClearCoatBumpTextureEnabled;
  31101. /**
  31102. * Are clear coat bump textures enabled in the application.
  31103. */
  31104. static get ClearCoatBumpTextureEnabled(): boolean;
  31105. static set ClearCoatBumpTextureEnabled(value: boolean);
  31106. private static _ClearCoatTintTextureEnabled;
  31107. /**
  31108. * Are clear coat tint textures enabled in the application.
  31109. */
  31110. static get ClearCoatTintTextureEnabled(): boolean;
  31111. static set ClearCoatTintTextureEnabled(value: boolean);
  31112. private static _SheenTextureEnabled;
  31113. /**
  31114. * Are sheen textures enabled in the application.
  31115. */
  31116. static get SheenTextureEnabled(): boolean;
  31117. static set SheenTextureEnabled(value: boolean);
  31118. private static _AnisotropicTextureEnabled;
  31119. /**
  31120. * Are anisotropic textures enabled in the application.
  31121. */
  31122. static get AnisotropicTextureEnabled(): boolean;
  31123. static set AnisotropicTextureEnabled(value: boolean);
  31124. private static _ThicknessTextureEnabled;
  31125. /**
  31126. * Are thickness textures enabled in the application.
  31127. */
  31128. static get ThicknessTextureEnabled(): boolean;
  31129. static set ThicknessTextureEnabled(value: boolean);
  31130. }
  31131. }
  31132. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31133. /** @hidden */
  31134. export var defaultFragmentDeclaration: {
  31135. name: string;
  31136. shader: string;
  31137. };
  31138. }
  31139. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31140. /** @hidden */
  31141. export var defaultUboDeclaration: {
  31142. name: string;
  31143. shader: string;
  31144. };
  31145. }
  31146. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31147. /** @hidden */
  31148. export var prePassDeclaration: {
  31149. name: string;
  31150. shader: string;
  31151. };
  31152. }
  31153. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31154. /** @hidden */
  31155. export var lightFragmentDeclaration: {
  31156. name: string;
  31157. shader: string;
  31158. };
  31159. }
  31160. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31161. /** @hidden */
  31162. export var lightUboDeclaration: {
  31163. name: string;
  31164. shader: string;
  31165. };
  31166. }
  31167. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31168. /** @hidden */
  31169. export var lightsFragmentFunctions: {
  31170. name: string;
  31171. shader: string;
  31172. };
  31173. }
  31174. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31175. /** @hidden */
  31176. export var shadowsFragmentFunctions: {
  31177. name: string;
  31178. shader: string;
  31179. };
  31180. }
  31181. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31182. /** @hidden */
  31183. export var fresnelFunction: {
  31184. name: string;
  31185. shader: string;
  31186. };
  31187. }
  31188. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31189. /** @hidden */
  31190. export var bumpFragmentMainFunctions: {
  31191. name: string;
  31192. shader: string;
  31193. };
  31194. }
  31195. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31196. /** @hidden */
  31197. export var bumpFragmentFunctions: {
  31198. name: string;
  31199. shader: string;
  31200. };
  31201. }
  31202. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31203. /** @hidden */
  31204. export var logDepthDeclaration: {
  31205. name: string;
  31206. shader: string;
  31207. };
  31208. }
  31209. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31210. /** @hidden */
  31211. export var bumpFragment: {
  31212. name: string;
  31213. shader: string;
  31214. };
  31215. }
  31216. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31217. /** @hidden */
  31218. export var depthPrePass: {
  31219. name: string;
  31220. shader: string;
  31221. };
  31222. }
  31223. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31224. /** @hidden */
  31225. export var lightFragment: {
  31226. name: string;
  31227. shader: string;
  31228. };
  31229. }
  31230. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31231. /** @hidden */
  31232. export var logDepthFragment: {
  31233. name: string;
  31234. shader: string;
  31235. };
  31236. }
  31237. declare module "babylonjs/Shaders/default.fragment" {
  31238. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31239. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31241. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31242. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31245. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31246. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31247. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31248. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31249. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31250. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31251. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31252. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31253. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31254. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31255. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31256. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31257. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31258. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31259. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31260. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31261. /** @hidden */
  31262. export var defaultPixelShader: {
  31263. name: string;
  31264. shader: string;
  31265. };
  31266. }
  31267. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31268. /** @hidden */
  31269. export var defaultVertexDeclaration: {
  31270. name: string;
  31271. shader: string;
  31272. };
  31273. }
  31274. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31275. /** @hidden */
  31276. export var bumpVertexDeclaration: {
  31277. name: string;
  31278. shader: string;
  31279. };
  31280. }
  31281. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31282. /** @hidden */
  31283. export var bumpVertex: {
  31284. name: string;
  31285. shader: string;
  31286. };
  31287. }
  31288. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31289. /** @hidden */
  31290. export var fogVertex: {
  31291. name: string;
  31292. shader: string;
  31293. };
  31294. }
  31295. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31296. /** @hidden */
  31297. export var shadowsVertex: {
  31298. name: string;
  31299. shader: string;
  31300. };
  31301. }
  31302. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31303. /** @hidden */
  31304. export var pointCloudVertex: {
  31305. name: string;
  31306. shader: string;
  31307. };
  31308. }
  31309. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31310. /** @hidden */
  31311. export var logDepthVertex: {
  31312. name: string;
  31313. shader: string;
  31314. };
  31315. }
  31316. declare module "babylonjs/Shaders/default.vertex" {
  31317. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31320. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31322. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31323. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31327. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31330. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31331. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31332. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31333. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31334. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31335. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31336. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31337. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31338. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31339. /** @hidden */
  31340. export var defaultVertexShader: {
  31341. name: string;
  31342. shader: string;
  31343. };
  31344. }
  31345. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31346. import { Nullable } from "babylonjs/types";
  31347. import { Scene } from "babylonjs/scene";
  31348. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31349. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31350. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31351. /**
  31352. * @hidden
  31353. */
  31354. export interface IMaterialDetailMapDefines {
  31355. DETAIL: boolean;
  31356. DETAILDIRECTUV: number;
  31357. DETAIL_NORMALBLENDMETHOD: number;
  31358. /** @hidden */
  31359. _areTexturesDirty: boolean;
  31360. }
  31361. /**
  31362. * Define the code related to the detail map parameters of a material
  31363. *
  31364. * Inspired from:
  31365. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  31366. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31367. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31368. */
  31369. export class DetailMapConfiguration {
  31370. private _texture;
  31371. /**
  31372. * The detail texture of the material.
  31373. */
  31374. texture: Nullable<BaseTexture>;
  31375. /**
  31376. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31377. * Bigger values mean stronger blending
  31378. */
  31379. diffuseBlendLevel: number;
  31380. /**
  31381. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31382. * Bigger values mean stronger blending. Only used with PBR materials
  31383. */
  31384. roughnessBlendLevel: number;
  31385. /**
  31386. * Defines how strong the bump effect from the detail map is
  31387. * Bigger values mean stronger effect
  31388. */
  31389. bumpLevel: number;
  31390. private _normalBlendMethod;
  31391. /**
  31392. * The method used to blend the bump and detail normals together
  31393. */
  31394. normalBlendMethod: number;
  31395. private _isEnabled;
  31396. /**
  31397. * Enable or disable the detail map on this material
  31398. */
  31399. isEnabled: boolean;
  31400. /** @hidden */
  31401. private _internalMarkAllSubMeshesAsTexturesDirty;
  31402. /** @hidden */
  31403. _markAllSubMeshesAsTexturesDirty(): void;
  31404. /**
  31405. * Instantiate a new detail map
  31406. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31407. */
  31408. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31409. /**
  31410. * Gets whether the submesh is ready to be used or not.
  31411. * @param defines the list of "defines" to update.
  31412. * @param scene defines the scene the material belongs to.
  31413. * @returns - boolean indicating that the submesh is ready or not.
  31414. */
  31415. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31416. /**
  31417. * Update the defines for detail map usage
  31418. * @param defines the list of "defines" to update.
  31419. * @param scene defines the scene the material belongs to.
  31420. */
  31421. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31422. /**
  31423. * Binds the material data.
  31424. * @param uniformBuffer defines the Uniform buffer to fill in.
  31425. * @param scene defines the scene the material belongs to.
  31426. * @param isFrozen defines whether the material is frozen or not.
  31427. */
  31428. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31429. /**
  31430. * Checks to see if a texture is used in the material.
  31431. * @param texture - Base texture to use.
  31432. * @returns - Boolean specifying if a texture is used in the material.
  31433. */
  31434. hasTexture(texture: BaseTexture): boolean;
  31435. /**
  31436. * Returns an array of the actively used textures.
  31437. * @param activeTextures Array of BaseTextures
  31438. */
  31439. getActiveTextures(activeTextures: BaseTexture[]): void;
  31440. /**
  31441. * Returns the animatable textures.
  31442. * @param animatables Array of animatable textures.
  31443. */
  31444. getAnimatables(animatables: IAnimatable[]): void;
  31445. /**
  31446. * Disposes the resources of the material.
  31447. * @param forceDisposeTextures - Forces the disposal of all textures.
  31448. */
  31449. dispose(forceDisposeTextures?: boolean): void;
  31450. /**
  31451. * Get the current class name useful for serialization or dynamic coding.
  31452. * @returns "DetailMap"
  31453. */
  31454. getClassName(): string;
  31455. /**
  31456. * Add the required uniforms to the current list.
  31457. * @param uniforms defines the current uniform list.
  31458. */
  31459. static AddUniforms(uniforms: string[]): void;
  31460. /**
  31461. * Add the required samplers to the current list.
  31462. * @param samplers defines the current sampler list.
  31463. */
  31464. static AddSamplers(samplers: string[]): void;
  31465. /**
  31466. * Add the required uniforms to the current buffer.
  31467. * @param uniformBuffer defines the current uniform buffer.
  31468. */
  31469. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31470. /**
  31471. * Makes a duplicate of the current instance into another one.
  31472. * @param detailMap define the instance where to copy the info
  31473. */
  31474. copyTo(detailMap: DetailMapConfiguration): void;
  31475. /**
  31476. * Serializes this detail map instance
  31477. * @returns - An object with the serialized instance.
  31478. */
  31479. serialize(): any;
  31480. /**
  31481. * Parses a detail map setting from a serialized object.
  31482. * @param source - Serialized object.
  31483. * @param scene Defines the scene we are parsing for
  31484. * @param rootUrl Defines the rootUrl to load from
  31485. */
  31486. parse(source: any, scene: Scene, rootUrl: string): void;
  31487. }
  31488. }
  31489. declare module "babylonjs/Materials/standardMaterial" {
  31490. import { SmartArray } from "babylonjs/Misc/smartArray";
  31491. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31492. import { Nullable } from "babylonjs/types";
  31493. import { Scene } from "babylonjs/scene";
  31494. import { Matrix } from "babylonjs/Maths/math.vector";
  31495. import { Color3 } from "babylonjs/Maths/math.color";
  31496. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31497. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31498. import { Mesh } from "babylonjs/Meshes/mesh";
  31499. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31500. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31501. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31502. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31503. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31504. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31505. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31506. import "babylonjs/Shaders/default.fragment";
  31507. import "babylonjs/Shaders/default.vertex";
  31508. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31509. /** @hidden */
  31510. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31511. MAINUV1: boolean;
  31512. MAINUV2: boolean;
  31513. DIFFUSE: boolean;
  31514. DIFFUSEDIRECTUV: number;
  31515. DETAIL: boolean;
  31516. DETAILDIRECTUV: number;
  31517. DETAIL_NORMALBLENDMETHOD: number;
  31518. AMBIENT: boolean;
  31519. AMBIENTDIRECTUV: number;
  31520. OPACITY: boolean;
  31521. OPACITYDIRECTUV: number;
  31522. OPACITYRGB: boolean;
  31523. REFLECTION: boolean;
  31524. EMISSIVE: boolean;
  31525. EMISSIVEDIRECTUV: number;
  31526. SPECULAR: boolean;
  31527. SPECULARDIRECTUV: number;
  31528. BUMP: boolean;
  31529. BUMPDIRECTUV: number;
  31530. PARALLAX: boolean;
  31531. PARALLAXOCCLUSION: boolean;
  31532. SPECULAROVERALPHA: boolean;
  31533. CLIPPLANE: boolean;
  31534. CLIPPLANE2: boolean;
  31535. CLIPPLANE3: boolean;
  31536. CLIPPLANE4: boolean;
  31537. CLIPPLANE5: boolean;
  31538. CLIPPLANE6: boolean;
  31539. ALPHATEST: boolean;
  31540. DEPTHPREPASS: boolean;
  31541. ALPHAFROMDIFFUSE: boolean;
  31542. POINTSIZE: boolean;
  31543. FOG: boolean;
  31544. SPECULARTERM: boolean;
  31545. DIFFUSEFRESNEL: boolean;
  31546. OPACITYFRESNEL: boolean;
  31547. REFLECTIONFRESNEL: boolean;
  31548. REFRACTIONFRESNEL: boolean;
  31549. EMISSIVEFRESNEL: boolean;
  31550. FRESNEL: boolean;
  31551. NORMAL: boolean;
  31552. UV1: boolean;
  31553. UV2: boolean;
  31554. VERTEXCOLOR: boolean;
  31555. VERTEXALPHA: boolean;
  31556. NUM_BONE_INFLUENCERS: number;
  31557. BonesPerMesh: number;
  31558. BONETEXTURE: boolean;
  31559. INSTANCES: boolean;
  31560. THIN_INSTANCES: boolean;
  31561. GLOSSINESS: boolean;
  31562. ROUGHNESS: boolean;
  31563. EMISSIVEASILLUMINATION: boolean;
  31564. LINKEMISSIVEWITHDIFFUSE: boolean;
  31565. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31566. LIGHTMAP: boolean;
  31567. LIGHTMAPDIRECTUV: number;
  31568. OBJECTSPACE_NORMALMAP: boolean;
  31569. USELIGHTMAPASSHADOWMAP: boolean;
  31570. REFLECTIONMAP_3D: boolean;
  31571. REFLECTIONMAP_SPHERICAL: boolean;
  31572. REFLECTIONMAP_PLANAR: boolean;
  31573. REFLECTIONMAP_CUBIC: boolean;
  31574. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31575. REFLECTIONMAP_PROJECTION: boolean;
  31576. REFLECTIONMAP_SKYBOX: boolean;
  31577. REFLECTIONMAP_EXPLICIT: boolean;
  31578. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31579. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31580. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31581. INVERTCUBICMAP: boolean;
  31582. LOGARITHMICDEPTH: boolean;
  31583. REFRACTION: boolean;
  31584. REFRACTIONMAP_3D: boolean;
  31585. REFLECTIONOVERALPHA: boolean;
  31586. TWOSIDEDLIGHTING: boolean;
  31587. SHADOWFLOAT: boolean;
  31588. MORPHTARGETS: boolean;
  31589. MORPHTARGETS_NORMAL: boolean;
  31590. MORPHTARGETS_TANGENT: boolean;
  31591. MORPHTARGETS_UV: boolean;
  31592. NUM_MORPH_INFLUENCERS: number;
  31593. NONUNIFORMSCALING: boolean;
  31594. PREMULTIPLYALPHA: boolean;
  31595. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31596. ALPHABLEND: boolean;
  31597. PREPASS: boolean;
  31598. SCENE_MRT_COUNT: number;
  31599. RGBDLIGHTMAP: boolean;
  31600. RGBDREFLECTION: boolean;
  31601. RGBDREFRACTION: boolean;
  31602. IMAGEPROCESSING: boolean;
  31603. VIGNETTE: boolean;
  31604. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31605. VIGNETTEBLENDMODEOPAQUE: boolean;
  31606. TONEMAPPING: boolean;
  31607. TONEMAPPING_ACES: boolean;
  31608. CONTRAST: boolean;
  31609. COLORCURVES: boolean;
  31610. COLORGRADING: boolean;
  31611. COLORGRADING3D: boolean;
  31612. SAMPLER3DGREENDEPTH: boolean;
  31613. SAMPLER3DBGRMAP: boolean;
  31614. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31615. MULTIVIEW: boolean;
  31616. /**
  31617. * If the reflection texture on this material is in linear color space
  31618. * @hidden
  31619. */
  31620. IS_REFLECTION_LINEAR: boolean;
  31621. /**
  31622. * If the refraction texture on this material is in linear color space
  31623. * @hidden
  31624. */
  31625. IS_REFRACTION_LINEAR: boolean;
  31626. EXPOSURE: boolean;
  31627. constructor();
  31628. setReflectionMode(modeToEnable: string): void;
  31629. }
  31630. /**
  31631. * This is the default material used in Babylon. It is the best trade off between quality
  31632. * and performances.
  31633. * @see https://doc.babylonjs.com/babylon101/materials
  31634. */
  31635. export class StandardMaterial extends PushMaterial {
  31636. private _diffuseTexture;
  31637. /**
  31638. * The basic texture of the material as viewed under a light.
  31639. */
  31640. diffuseTexture: Nullable<BaseTexture>;
  31641. private _ambientTexture;
  31642. /**
  31643. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31644. */
  31645. ambientTexture: Nullable<BaseTexture>;
  31646. private _opacityTexture;
  31647. /**
  31648. * Define the transparency of the material from a texture.
  31649. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31650. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31651. */
  31652. opacityTexture: Nullable<BaseTexture>;
  31653. private _reflectionTexture;
  31654. /**
  31655. * Define the texture used to display the reflection.
  31656. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31657. */
  31658. reflectionTexture: Nullable<BaseTexture>;
  31659. private _emissiveTexture;
  31660. /**
  31661. * Define texture of the material as if self lit.
  31662. * This will be mixed in the final result even in the absence of light.
  31663. */
  31664. emissiveTexture: Nullable<BaseTexture>;
  31665. private _specularTexture;
  31666. /**
  31667. * Define how the color and intensity of the highlight given by the light in the material.
  31668. */
  31669. specularTexture: Nullable<BaseTexture>;
  31670. private _bumpTexture;
  31671. /**
  31672. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31673. * 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.
  31674. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31675. */
  31676. bumpTexture: Nullable<BaseTexture>;
  31677. private _lightmapTexture;
  31678. /**
  31679. * Complex lighting can be computationally expensive to compute at runtime.
  31680. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31681. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31682. */
  31683. lightmapTexture: Nullable<BaseTexture>;
  31684. private _refractionTexture;
  31685. /**
  31686. * Define the texture used to display the refraction.
  31687. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31688. */
  31689. refractionTexture: Nullable<BaseTexture>;
  31690. /**
  31691. * The color of the material lit by the environmental background lighting.
  31692. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31693. */
  31694. ambientColor: Color3;
  31695. /**
  31696. * The basic color of the material as viewed under a light.
  31697. */
  31698. diffuseColor: Color3;
  31699. /**
  31700. * Define how the color and intensity of the highlight given by the light in the material.
  31701. */
  31702. specularColor: Color3;
  31703. /**
  31704. * Define the color of the material as if self lit.
  31705. * This will be mixed in the final result even in the absence of light.
  31706. */
  31707. emissiveColor: Color3;
  31708. /**
  31709. * Defines how sharp are the highlights in the material.
  31710. * The bigger the value the sharper giving a more glossy feeling to the result.
  31711. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31712. */
  31713. specularPower: number;
  31714. private _useAlphaFromDiffuseTexture;
  31715. /**
  31716. * Does the transparency come from the diffuse texture alpha channel.
  31717. */
  31718. useAlphaFromDiffuseTexture: boolean;
  31719. private _useEmissiveAsIllumination;
  31720. /**
  31721. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31722. */
  31723. useEmissiveAsIllumination: boolean;
  31724. private _linkEmissiveWithDiffuse;
  31725. /**
  31726. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31727. * the emissive level when the final color is close to one.
  31728. */
  31729. linkEmissiveWithDiffuse: boolean;
  31730. private _useSpecularOverAlpha;
  31731. /**
  31732. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31733. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31734. */
  31735. useSpecularOverAlpha: boolean;
  31736. private _useReflectionOverAlpha;
  31737. /**
  31738. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31739. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31740. */
  31741. useReflectionOverAlpha: boolean;
  31742. private _disableLighting;
  31743. /**
  31744. * Does lights from the scene impacts this material.
  31745. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31746. */
  31747. disableLighting: boolean;
  31748. private _useObjectSpaceNormalMap;
  31749. /**
  31750. * Allows using an object space normal map (instead of tangent space).
  31751. */
  31752. useObjectSpaceNormalMap: boolean;
  31753. private _useParallax;
  31754. /**
  31755. * Is parallax enabled or not.
  31756. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31757. */
  31758. useParallax: boolean;
  31759. private _useParallaxOcclusion;
  31760. /**
  31761. * Is parallax occlusion enabled or not.
  31762. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31763. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31764. */
  31765. useParallaxOcclusion: boolean;
  31766. /**
  31767. * 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.
  31768. */
  31769. parallaxScaleBias: number;
  31770. private _roughness;
  31771. /**
  31772. * Helps to define how blurry the reflections should appears in the material.
  31773. */
  31774. roughness: number;
  31775. /**
  31776. * In case of refraction, define the value of the index of refraction.
  31777. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31778. */
  31779. indexOfRefraction: number;
  31780. /**
  31781. * Invert the refraction texture alongside the y axis.
  31782. * It can be useful with procedural textures or probe for instance.
  31783. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31784. */
  31785. invertRefractionY: boolean;
  31786. /**
  31787. * Defines the alpha limits in alpha test mode.
  31788. */
  31789. alphaCutOff: number;
  31790. private _useLightmapAsShadowmap;
  31791. /**
  31792. * In case of light mapping, define whether the map contains light or shadow informations.
  31793. */
  31794. useLightmapAsShadowmap: boolean;
  31795. private _diffuseFresnelParameters;
  31796. /**
  31797. * Define the diffuse fresnel parameters of the material.
  31798. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31799. */
  31800. diffuseFresnelParameters: FresnelParameters;
  31801. private _opacityFresnelParameters;
  31802. /**
  31803. * Define the opacity fresnel parameters of the material.
  31804. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31805. */
  31806. opacityFresnelParameters: FresnelParameters;
  31807. private _reflectionFresnelParameters;
  31808. /**
  31809. * Define the reflection fresnel parameters of the material.
  31810. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31811. */
  31812. reflectionFresnelParameters: FresnelParameters;
  31813. private _refractionFresnelParameters;
  31814. /**
  31815. * Define the refraction fresnel parameters of the material.
  31816. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31817. */
  31818. refractionFresnelParameters: FresnelParameters;
  31819. private _emissiveFresnelParameters;
  31820. /**
  31821. * Define the emissive fresnel parameters of the material.
  31822. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31823. */
  31824. emissiveFresnelParameters: FresnelParameters;
  31825. private _useReflectionFresnelFromSpecular;
  31826. /**
  31827. * If true automatically deducts the fresnels values from the material specularity.
  31828. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31829. */
  31830. useReflectionFresnelFromSpecular: boolean;
  31831. private _useGlossinessFromSpecularMapAlpha;
  31832. /**
  31833. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31834. */
  31835. useGlossinessFromSpecularMapAlpha: boolean;
  31836. private _maxSimultaneousLights;
  31837. /**
  31838. * Defines the maximum number of lights that can be used in the material
  31839. */
  31840. maxSimultaneousLights: number;
  31841. private _invertNormalMapX;
  31842. /**
  31843. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31844. */
  31845. invertNormalMapX: boolean;
  31846. private _invertNormalMapY;
  31847. /**
  31848. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31849. */
  31850. invertNormalMapY: boolean;
  31851. private _twoSidedLighting;
  31852. /**
  31853. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31854. */
  31855. twoSidedLighting: boolean;
  31856. /**
  31857. * Default configuration related to image processing available in the standard Material.
  31858. */
  31859. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31860. /**
  31861. * Gets the image processing configuration used either in this material.
  31862. */
  31863. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31864. /**
  31865. * Sets the Default image processing configuration used either in the this material.
  31866. *
  31867. * If sets to null, the scene one is in use.
  31868. */
  31869. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31870. /**
  31871. * Keep track of the image processing observer to allow dispose and replace.
  31872. */
  31873. private _imageProcessingObserver;
  31874. /**
  31875. * Attaches a new image processing configuration to the Standard Material.
  31876. * @param configuration
  31877. */
  31878. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31879. /**
  31880. * Gets wether the color curves effect is enabled.
  31881. */
  31882. get cameraColorCurvesEnabled(): boolean;
  31883. /**
  31884. * Sets wether the color curves effect is enabled.
  31885. */
  31886. set cameraColorCurvesEnabled(value: boolean);
  31887. /**
  31888. * Gets wether the color grading effect is enabled.
  31889. */
  31890. get cameraColorGradingEnabled(): boolean;
  31891. /**
  31892. * Gets wether the color grading effect is enabled.
  31893. */
  31894. set cameraColorGradingEnabled(value: boolean);
  31895. /**
  31896. * Gets wether tonemapping is enabled or not.
  31897. */
  31898. get cameraToneMappingEnabled(): boolean;
  31899. /**
  31900. * Sets wether tonemapping is enabled or not
  31901. */
  31902. set cameraToneMappingEnabled(value: boolean);
  31903. /**
  31904. * The camera exposure used on this material.
  31905. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31906. * This corresponds to a photographic exposure.
  31907. */
  31908. get cameraExposure(): number;
  31909. /**
  31910. * The camera exposure used on this material.
  31911. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31912. * This corresponds to a photographic exposure.
  31913. */
  31914. set cameraExposure(value: number);
  31915. /**
  31916. * Gets The camera contrast used on this material.
  31917. */
  31918. get cameraContrast(): number;
  31919. /**
  31920. * Sets The camera contrast used on this material.
  31921. */
  31922. set cameraContrast(value: number);
  31923. /**
  31924. * Gets the Color Grading 2D Lookup Texture.
  31925. */
  31926. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31927. /**
  31928. * Sets the Color Grading 2D Lookup Texture.
  31929. */
  31930. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31931. /**
  31932. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31933. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31934. * 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;
  31935. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31936. */
  31937. get cameraColorCurves(): Nullable<ColorCurves>;
  31938. /**
  31939. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31940. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31941. * 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;
  31942. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31943. */
  31944. set cameraColorCurves(value: Nullable<ColorCurves>);
  31945. /**
  31946. * Can this material render to several textures at once
  31947. */
  31948. get canRenderToMRT(): boolean;
  31949. /**
  31950. * Defines the detail map parameters for the material.
  31951. */
  31952. readonly detailMap: DetailMapConfiguration;
  31953. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31954. protected _worldViewProjectionMatrix: Matrix;
  31955. protected _globalAmbientColor: Color3;
  31956. protected _useLogarithmicDepth: boolean;
  31957. protected _rebuildInParallel: boolean;
  31958. /**
  31959. * Instantiates a new standard material.
  31960. * This is the default material used in Babylon. It is the best trade off between quality
  31961. * and performances.
  31962. * @see https://doc.babylonjs.com/babylon101/materials
  31963. * @param name Define the name of the material in the scene
  31964. * @param scene Define the scene the material belong to
  31965. */
  31966. constructor(name: string, scene: Scene);
  31967. /**
  31968. * Gets a boolean indicating that current material needs to register RTT
  31969. */
  31970. get hasRenderTargetTextures(): boolean;
  31971. /**
  31972. * Gets the current class name of the material e.g. "StandardMaterial"
  31973. * Mainly use in serialization.
  31974. * @returns the class name
  31975. */
  31976. getClassName(): string;
  31977. /**
  31978. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31979. * You can try switching to logarithmic depth.
  31980. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31981. */
  31982. get useLogarithmicDepth(): boolean;
  31983. set useLogarithmicDepth(value: boolean);
  31984. /**
  31985. * Specifies if the material will require alpha blending
  31986. * @returns a boolean specifying if alpha blending is needed
  31987. */
  31988. needAlphaBlending(): boolean;
  31989. /**
  31990. * Specifies if this material should be rendered in alpha test mode
  31991. * @returns a boolean specifying if an alpha test is needed.
  31992. */
  31993. needAlphaTesting(): boolean;
  31994. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31995. /**
  31996. * Get the texture used for alpha test purpose.
  31997. * @returns the diffuse texture in case of the standard material.
  31998. */
  31999. getAlphaTestTexture(): Nullable<BaseTexture>;
  32000. /**
  32001. * Get if the submesh is ready to be used and all its information available.
  32002. * Child classes can use it to update shaders
  32003. * @param mesh defines the mesh to check
  32004. * @param subMesh defines which submesh to check
  32005. * @param useInstances specifies that instances should be used
  32006. * @returns a boolean indicating that the submesh is ready or not
  32007. */
  32008. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32009. /**
  32010. * Builds the material UBO layouts.
  32011. * Used internally during the effect preparation.
  32012. */
  32013. buildUniformLayout(): void;
  32014. /**
  32015. * Unbinds the material from the mesh
  32016. */
  32017. unbind(): void;
  32018. /**
  32019. * Binds the submesh to this material by preparing the effect and shader to draw
  32020. * @param world defines the world transformation matrix
  32021. * @param mesh defines the mesh containing the submesh
  32022. * @param subMesh defines the submesh to bind the material to
  32023. */
  32024. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32025. /**
  32026. * Get the list of animatables in the material.
  32027. * @returns the list of animatables object used in the material
  32028. */
  32029. getAnimatables(): IAnimatable[];
  32030. /**
  32031. * Gets the active textures from the material
  32032. * @returns an array of textures
  32033. */
  32034. getActiveTextures(): BaseTexture[];
  32035. /**
  32036. * Specifies if the material uses a texture
  32037. * @param texture defines the texture to check against the material
  32038. * @returns a boolean specifying if the material uses the texture
  32039. */
  32040. hasTexture(texture: BaseTexture): boolean;
  32041. /**
  32042. * Disposes the material
  32043. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32044. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32045. */
  32046. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32047. /**
  32048. * Makes a duplicate of the material, and gives it a new name
  32049. * @param name defines the new name for the duplicated material
  32050. * @returns the cloned material
  32051. */
  32052. clone(name: string): StandardMaterial;
  32053. /**
  32054. * Serializes this material in a JSON representation
  32055. * @returns the serialized material object
  32056. */
  32057. serialize(): any;
  32058. /**
  32059. * Creates a standard material from parsed material data
  32060. * @param source defines the JSON representation of the material
  32061. * @param scene defines the hosting scene
  32062. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32063. * @returns a new standard material
  32064. */
  32065. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32066. /**
  32067. * Are diffuse textures enabled in the application.
  32068. */
  32069. static get DiffuseTextureEnabled(): boolean;
  32070. static set DiffuseTextureEnabled(value: boolean);
  32071. /**
  32072. * Are detail textures enabled in the application.
  32073. */
  32074. static get DetailTextureEnabled(): boolean;
  32075. static set DetailTextureEnabled(value: boolean);
  32076. /**
  32077. * Are ambient textures enabled in the application.
  32078. */
  32079. static get AmbientTextureEnabled(): boolean;
  32080. static set AmbientTextureEnabled(value: boolean);
  32081. /**
  32082. * Are opacity textures enabled in the application.
  32083. */
  32084. static get OpacityTextureEnabled(): boolean;
  32085. static set OpacityTextureEnabled(value: boolean);
  32086. /**
  32087. * Are reflection textures enabled in the application.
  32088. */
  32089. static get ReflectionTextureEnabled(): boolean;
  32090. static set ReflectionTextureEnabled(value: boolean);
  32091. /**
  32092. * Are emissive textures enabled in the application.
  32093. */
  32094. static get EmissiveTextureEnabled(): boolean;
  32095. static set EmissiveTextureEnabled(value: boolean);
  32096. /**
  32097. * Are specular textures enabled in the application.
  32098. */
  32099. static get SpecularTextureEnabled(): boolean;
  32100. static set SpecularTextureEnabled(value: boolean);
  32101. /**
  32102. * Are bump textures enabled in the application.
  32103. */
  32104. static get BumpTextureEnabled(): boolean;
  32105. static set BumpTextureEnabled(value: boolean);
  32106. /**
  32107. * Are lightmap textures enabled in the application.
  32108. */
  32109. static get LightmapTextureEnabled(): boolean;
  32110. static set LightmapTextureEnabled(value: boolean);
  32111. /**
  32112. * Are refraction textures enabled in the application.
  32113. */
  32114. static get RefractionTextureEnabled(): boolean;
  32115. static set RefractionTextureEnabled(value: boolean);
  32116. /**
  32117. * Are color grading textures enabled in the application.
  32118. */
  32119. static get ColorGradingTextureEnabled(): boolean;
  32120. static set ColorGradingTextureEnabled(value: boolean);
  32121. /**
  32122. * Are fresnels enabled in the application.
  32123. */
  32124. static get FresnelEnabled(): boolean;
  32125. static set FresnelEnabled(value: boolean);
  32126. }
  32127. }
  32128. declare module "babylonjs/Particles/solidParticleSystem" {
  32129. import { Nullable } from "babylonjs/types";
  32130. import { Mesh } from "babylonjs/Meshes/mesh";
  32131. import { Scene, IDisposable } from "babylonjs/scene";
  32132. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32133. import { Material } from "babylonjs/Materials/material";
  32134. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32135. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32136. /**
  32137. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32138. *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.
  32139. * The SPS is also a particle system. It provides some methods to manage the particles.
  32140. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32141. *
  32142. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32143. */
  32144. export class SolidParticleSystem implements IDisposable {
  32145. /**
  32146. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32147. * Example : var p = SPS.particles[i];
  32148. */
  32149. particles: SolidParticle[];
  32150. /**
  32151. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32152. */
  32153. nbParticles: number;
  32154. /**
  32155. * If the particles must ever face the camera (default false). Useful for planar particles.
  32156. */
  32157. billboard: boolean;
  32158. /**
  32159. * Recompute normals when adding a shape
  32160. */
  32161. recomputeNormals: boolean;
  32162. /**
  32163. * This a counter ofr your own usage. It's not set by any SPS functions.
  32164. */
  32165. counter: number;
  32166. /**
  32167. * The SPS name. This name is also given to the underlying mesh.
  32168. */
  32169. name: string;
  32170. /**
  32171. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32172. */
  32173. mesh: Mesh;
  32174. /**
  32175. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32176. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32177. */
  32178. vars: any;
  32179. /**
  32180. * This array is populated when the SPS is set as 'pickable'.
  32181. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32182. * Each element of this array is an object `{idx: int, faceId: int}`.
  32183. * `idx` is the picked particle index in the `SPS.particles` array
  32184. * `faceId` is the picked face index counted within this particle.
  32185. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32186. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32187. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32188. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32189. */
  32190. pickedParticles: {
  32191. idx: number;
  32192. faceId: number;
  32193. }[];
  32194. /**
  32195. * This array is populated when the SPS is set as 'pickable'
  32196. * Each key of this array is a submesh index.
  32197. * Each element of this array is a second array defined like this :
  32198. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32199. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32200. * `idx` is the picked particle index in the `SPS.particles` array
  32201. * `faceId` is the picked face index counted within this particle.
  32202. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32203. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32204. */
  32205. pickedBySubMesh: {
  32206. idx: number;
  32207. faceId: number;
  32208. }[][];
  32209. /**
  32210. * This array is populated when `enableDepthSort` is set to true.
  32211. * Each element of this array is an instance of the class DepthSortedParticle.
  32212. */
  32213. depthSortedParticles: DepthSortedParticle[];
  32214. /**
  32215. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32216. * @hidden
  32217. */
  32218. _bSphereOnly: boolean;
  32219. /**
  32220. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32221. * @hidden
  32222. */
  32223. _bSphereRadiusFactor: number;
  32224. private _scene;
  32225. private _positions;
  32226. private _indices;
  32227. private _normals;
  32228. private _colors;
  32229. private _uvs;
  32230. private _indices32;
  32231. private _positions32;
  32232. private _normals32;
  32233. private _fixedNormal32;
  32234. private _colors32;
  32235. private _uvs32;
  32236. private _index;
  32237. private _updatable;
  32238. private _pickable;
  32239. private _isVisibilityBoxLocked;
  32240. private _alwaysVisible;
  32241. private _depthSort;
  32242. private _expandable;
  32243. private _shapeCounter;
  32244. private _copy;
  32245. private _color;
  32246. private _computeParticleColor;
  32247. private _computeParticleTexture;
  32248. private _computeParticleRotation;
  32249. private _computeParticleVertex;
  32250. private _computeBoundingBox;
  32251. private _depthSortParticles;
  32252. private _camera;
  32253. private _mustUnrotateFixedNormals;
  32254. private _particlesIntersect;
  32255. private _needs32Bits;
  32256. private _isNotBuilt;
  32257. private _lastParticleId;
  32258. private _idxOfId;
  32259. private _multimaterialEnabled;
  32260. private _useModelMaterial;
  32261. private _indicesByMaterial;
  32262. private _materialIndexes;
  32263. private _depthSortFunction;
  32264. private _materialSortFunction;
  32265. private _materials;
  32266. private _multimaterial;
  32267. private _materialIndexesById;
  32268. private _defaultMaterial;
  32269. private _autoUpdateSubMeshes;
  32270. private _tmpVertex;
  32271. /**
  32272. * Creates a SPS (Solid Particle System) object.
  32273. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32274. * @param scene (Scene) is the scene in which the SPS is added.
  32275. * @param options defines the options of the sps e.g.
  32276. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32277. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32278. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32279. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  32280. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32281. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32282. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32283. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32284. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32285. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32286. */
  32287. constructor(name: string, scene: Scene, options?: {
  32288. updatable?: boolean;
  32289. isPickable?: boolean;
  32290. enableDepthSort?: boolean;
  32291. particleIntersection?: boolean;
  32292. boundingSphereOnly?: boolean;
  32293. bSphereRadiusFactor?: number;
  32294. expandable?: boolean;
  32295. useModelMaterial?: boolean;
  32296. enableMultiMaterial?: boolean;
  32297. });
  32298. /**
  32299. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32300. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32301. * @returns the created mesh
  32302. */
  32303. buildMesh(): Mesh;
  32304. /**
  32305. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32306. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32307. * Thus the particles generated from `digest()` have their property `position` set yet.
  32308. * @param mesh ( Mesh ) is the mesh to be digested
  32309. * @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
  32310. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32311. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32312. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32313. * @returns the current SPS
  32314. */
  32315. digest(mesh: Mesh, options?: {
  32316. facetNb?: number;
  32317. number?: number;
  32318. delta?: number;
  32319. storage?: [];
  32320. }): SolidParticleSystem;
  32321. /**
  32322. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32323. * @hidden
  32324. */
  32325. private _unrotateFixedNormals;
  32326. /**
  32327. * Resets the temporary working copy particle
  32328. * @hidden
  32329. */
  32330. private _resetCopy;
  32331. /**
  32332. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32333. * @param p the current index in the positions array to be updated
  32334. * @param ind the current index in the indices array
  32335. * @param shape a Vector3 array, the shape geometry
  32336. * @param positions the positions array to be updated
  32337. * @param meshInd the shape indices array
  32338. * @param indices the indices array to be updated
  32339. * @param meshUV the shape uv array
  32340. * @param uvs the uv array to be updated
  32341. * @param meshCol the shape color array
  32342. * @param colors the color array to be updated
  32343. * @param meshNor the shape normals array
  32344. * @param normals the normals array to be updated
  32345. * @param idx the particle index
  32346. * @param idxInShape the particle index in its shape
  32347. * @param options the addShape() method passed options
  32348. * @model the particle model
  32349. * @hidden
  32350. */
  32351. private _meshBuilder;
  32352. /**
  32353. * Returns a shape Vector3 array from positions float array
  32354. * @param positions float array
  32355. * @returns a vector3 array
  32356. * @hidden
  32357. */
  32358. private _posToShape;
  32359. /**
  32360. * Returns a shapeUV array from a float uvs (array deep copy)
  32361. * @param uvs as a float array
  32362. * @returns a shapeUV array
  32363. * @hidden
  32364. */
  32365. private _uvsToShapeUV;
  32366. /**
  32367. * Adds a new particle object in the particles array
  32368. * @param idx particle index in particles array
  32369. * @param id particle id
  32370. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32371. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32372. * @param model particle ModelShape object
  32373. * @param shapeId model shape identifier
  32374. * @param idxInShape index of the particle in the current model
  32375. * @param bInfo model bounding info object
  32376. * @param storage target storage array, if any
  32377. * @hidden
  32378. */
  32379. private _addParticle;
  32380. /**
  32381. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32382. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32383. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32384. * @param nb (positive integer) the number of particles to be created from this model
  32385. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32386. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32387. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32388. * @returns the number of shapes in the system
  32389. */
  32390. addShape(mesh: Mesh, nb: number, options?: {
  32391. positionFunction?: any;
  32392. vertexFunction?: any;
  32393. storage?: [];
  32394. }): number;
  32395. /**
  32396. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32397. * @hidden
  32398. */
  32399. private _rebuildParticle;
  32400. /**
  32401. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32402. * @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.
  32403. * @returns the SPS.
  32404. */
  32405. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32406. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32407. * Returns an array with the removed particles.
  32408. * 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.
  32409. * The SPS can't be empty so at least one particle needs to remain in place.
  32410. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32411. * @param start index of the first particle to remove
  32412. * @param end index of the last particle to remove (included)
  32413. * @returns an array populated with the removed particles
  32414. */
  32415. removeParticles(start: number, end: number): SolidParticle[];
  32416. /**
  32417. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32418. * @param solidParticleArray an array populated with Solid Particles objects
  32419. * @returns the SPS
  32420. */
  32421. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32422. /**
  32423. * Creates a new particle and modifies the SPS mesh geometry :
  32424. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32425. * - calls _addParticle() to populate the particle array
  32426. * factorized code from addShape() and insertParticlesFromArray()
  32427. * @param idx particle index in the particles array
  32428. * @param i particle index in its shape
  32429. * @param modelShape particle ModelShape object
  32430. * @param shape shape vertex array
  32431. * @param meshInd shape indices array
  32432. * @param meshUV shape uv array
  32433. * @param meshCol shape color array
  32434. * @param meshNor shape normals array
  32435. * @param bbInfo shape bounding info
  32436. * @param storage target particle storage
  32437. * @options addShape() passed options
  32438. * @hidden
  32439. */
  32440. private _insertNewParticle;
  32441. /**
  32442. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32443. * This method calls `updateParticle()` for each particle of the SPS.
  32444. * For an animated SPS, it is usually called within the render loop.
  32445. * 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.
  32446. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32447. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32448. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32449. * @returns the SPS.
  32450. */
  32451. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32452. /**
  32453. * Disposes the SPS.
  32454. */
  32455. dispose(): void;
  32456. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32457. * idx is the particle index in the SPS
  32458. * faceId is the picked face index counted within this particle.
  32459. * Returns null if the pickInfo can't identify a picked particle.
  32460. * @param pickingInfo (PickingInfo object)
  32461. * @returns {idx: number, faceId: number} or null
  32462. */
  32463. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32464. idx: number;
  32465. faceId: number;
  32466. }>;
  32467. /**
  32468. * Returns a SolidParticle object from its identifier : particle.id
  32469. * @param id (integer) the particle Id
  32470. * @returns the searched particle or null if not found in the SPS.
  32471. */
  32472. getParticleById(id: number): Nullable<SolidParticle>;
  32473. /**
  32474. * Returns a new array populated with the particles having the passed shapeId.
  32475. * @param shapeId (integer) the shape identifier
  32476. * @returns a new solid particle array
  32477. */
  32478. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32479. /**
  32480. * Populates the passed array "ref" with the particles having the passed shapeId.
  32481. * @param shapeId the shape identifier
  32482. * @returns the SPS
  32483. * @param ref
  32484. */
  32485. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32486. /**
  32487. * Computes the required SubMeshes according the materials assigned to the particles.
  32488. * @returns the solid particle system.
  32489. * Does nothing if called before the SPS mesh is built.
  32490. */
  32491. computeSubMeshes(): SolidParticleSystem;
  32492. /**
  32493. * Sorts the solid particles by material when MultiMaterial is enabled.
  32494. * Updates the indices32 array.
  32495. * Updates the indicesByMaterial array.
  32496. * Updates the mesh indices array.
  32497. * @returns the SPS
  32498. * @hidden
  32499. */
  32500. private _sortParticlesByMaterial;
  32501. /**
  32502. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32503. * @hidden
  32504. */
  32505. private _setMaterialIndexesById;
  32506. /**
  32507. * Returns an array with unique values of Materials from the passed array
  32508. * @param array the material array to be checked and filtered
  32509. * @hidden
  32510. */
  32511. private _filterUniqueMaterialId;
  32512. /**
  32513. * Sets a new Standard Material as _defaultMaterial if not already set.
  32514. * @hidden
  32515. */
  32516. private _setDefaultMaterial;
  32517. /**
  32518. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32519. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32520. * @returns the SPS.
  32521. */
  32522. refreshVisibleSize(): SolidParticleSystem;
  32523. /**
  32524. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32525. * @param size the size (float) of the visibility box
  32526. * note : this doesn't lock the SPS mesh bounding box.
  32527. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32528. */
  32529. setVisibilityBox(size: number): void;
  32530. /**
  32531. * Gets whether the SPS as always visible or not
  32532. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32533. */
  32534. get isAlwaysVisible(): boolean;
  32535. /**
  32536. * Sets the SPS as always visible or not
  32537. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32538. */
  32539. set isAlwaysVisible(val: boolean);
  32540. /**
  32541. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32542. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32543. */
  32544. set isVisibilityBoxLocked(val: boolean);
  32545. /**
  32546. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32547. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32548. */
  32549. get isVisibilityBoxLocked(): boolean;
  32550. /**
  32551. * Tells to `setParticles()` to compute the particle rotations or not.
  32552. * Default value : true. The SPS is faster when it's set to false.
  32553. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32554. */
  32555. set computeParticleRotation(val: boolean);
  32556. /**
  32557. * Tells to `setParticles()` to compute the particle colors or not.
  32558. * Default value : true. The SPS is faster when it's set to false.
  32559. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32560. */
  32561. set computeParticleColor(val: boolean);
  32562. set computeParticleTexture(val: boolean);
  32563. /**
  32564. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32565. * Default value : false. The SPS is faster when it's set to false.
  32566. * Note : the particle custom vertex positions aren't stored values.
  32567. */
  32568. set computeParticleVertex(val: boolean);
  32569. /**
  32570. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32571. */
  32572. set computeBoundingBox(val: boolean);
  32573. /**
  32574. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32575. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32576. * Default : `true`
  32577. */
  32578. set depthSortParticles(val: boolean);
  32579. /**
  32580. * Gets if `setParticles()` computes the particle rotations or not.
  32581. * Default value : true. The SPS is faster when it's set to false.
  32582. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32583. */
  32584. get computeParticleRotation(): boolean;
  32585. /**
  32586. * Gets if `setParticles()` computes the particle colors or not.
  32587. * Default value : true. The SPS is faster when it's set to false.
  32588. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32589. */
  32590. get computeParticleColor(): boolean;
  32591. /**
  32592. * Gets if `setParticles()` computes the particle textures or not.
  32593. * Default value : true. The SPS is faster when it's set to false.
  32594. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32595. */
  32596. get computeParticleTexture(): boolean;
  32597. /**
  32598. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32599. * Default value : false. The SPS is faster when it's set to false.
  32600. * Note : the particle custom vertex positions aren't stored values.
  32601. */
  32602. get computeParticleVertex(): boolean;
  32603. /**
  32604. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32605. */
  32606. get computeBoundingBox(): boolean;
  32607. /**
  32608. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32609. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32610. * Default : `true`
  32611. */
  32612. get depthSortParticles(): boolean;
  32613. /**
  32614. * Gets if the SPS is created as expandable at construction time.
  32615. * Default : `false`
  32616. */
  32617. get expandable(): boolean;
  32618. /**
  32619. * Gets if the SPS supports the Multi Materials
  32620. */
  32621. get multimaterialEnabled(): boolean;
  32622. /**
  32623. * Gets if the SPS uses the model materials for its own multimaterial.
  32624. */
  32625. get useModelMaterial(): boolean;
  32626. /**
  32627. * The SPS used material array.
  32628. */
  32629. get materials(): Material[];
  32630. /**
  32631. * Sets the SPS MultiMaterial from the passed materials.
  32632. * Note : the passed array is internally copied and not used then by reference.
  32633. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32634. */
  32635. setMultiMaterial(materials: Material[]): void;
  32636. /**
  32637. * The SPS computed multimaterial object
  32638. */
  32639. get multimaterial(): MultiMaterial;
  32640. set multimaterial(mm: MultiMaterial);
  32641. /**
  32642. * If the subMeshes must be updated on the next call to setParticles()
  32643. */
  32644. get autoUpdateSubMeshes(): boolean;
  32645. set autoUpdateSubMeshes(val: boolean);
  32646. /**
  32647. * This function does nothing. It may be overwritten to set all the particle first values.
  32648. * The SPS doesn't call this function, you may have to call it by your own.
  32649. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32650. */
  32651. initParticles(): void;
  32652. /**
  32653. * This function does nothing. It may be overwritten to recycle a particle.
  32654. * The SPS doesn't call this function, you may have to call it by your own.
  32655. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32656. * @param particle The particle to recycle
  32657. * @returns the recycled particle
  32658. */
  32659. recycleParticle(particle: SolidParticle): SolidParticle;
  32660. /**
  32661. * Updates a particle : this function should be overwritten by the user.
  32662. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32663. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32664. * @example : just set a particle position or velocity and recycle conditions
  32665. * @param particle The particle to update
  32666. * @returns the updated particle
  32667. */
  32668. updateParticle(particle: SolidParticle): SolidParticle;
  32669. /**
  32670. * Updates a vertex of a particle : it can be overwritten by the user.
  32671. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32672. * @param particle the current particle
  32673. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32674. * @param pt the index of the current vertex in the particle shape
  32675. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32676. * @example : just set a vertex particle position or color
  32677. * @returns the sps
  32678. */
  32679. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32680. /**
  32681. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32682. * This does nothing and may be overwritten by the user.
  32683. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32685. * @param update the boolean update value actually passed to setParticles()
  32686. */
  32687. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32688. /**
  32689. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32690. * This will be passed three parameters.
  32691. * This does nothing and may be overwritten by the user.
  32692. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32693. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32694. * @param update the boolean update value actually passed to setParticles()
  32695. */
  32696. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32697. }
  32698. }
  32699. declare module "babylonjs/Particles/solidParticle" {
  32700. import { Nullable } from "babylonjs/types";
  32701. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32702. import { Color4 } from "babylonjs/Maths/math.color";
  32703. import { Mesh } from "babylonjs/Meshes/mesh";
  32704. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32705. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32706. import { Plane } from "babylonjs/Maths/math.plane";
  32707. import { Material } from "babylonjs/Materials/material";
  32708. /**
  32709. * Represents one particle of a solid particle system.
  32710. */
  32711. export class SolidParticle {
  32712. /**
  32713. * particle global index
  32714. */
  32715. idx: number;
  32716. /**
  32717. * particle identifier
  32718. */
  32719. id: number;
  32720. /**
  32721. * The color of the particle
  32722. */
  32723. color: Nullable<Color4>;
  32724. /**
  32725. * The world space position of the particle.
  32726. */
  32727. position: Vector3;
  32728. /**
  32729. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32730. */
  32731. rotation: Vector3;
  32732. /**
  32733. * The world space rotation quaternion of the particle.
  32734. */
  32735. rotationQuaternion: Nullable<Quaternion>;
  32736. /**
  32737. * The scaling of the particle.
  32738. */
  32739. scaling: Vector3;
  32740. /**
  32741. * The uvs of the particle.
  32742. */
  32743. uvs: Vector4;
  32744. /**
  32745. * The current speed of the particle.
  32746. */
  32747. velocity: Vector3;
  32748. /**
  32749. * The pivot point in the particle local space.
  32750. */
  32751. pivot: Vector3;
  32752. /**
  32753. * Must the particle be translated from its pivot point in its local space ?
  32754. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32755. * Default : false
  32756. */
  32757. translateFromPivot: boolean;
  32758. /**
  32759. * Is the particle active or not ?
  32760. */
  32761. alive: boolean;
  32762. /**
  32763. * Is the particle visible or not ?
  32764. */
  32765. isVisible: boolean;
  32766. /**
  32767. * Index of this particle in the global "positions" array (Internal use)
  32768. * @hidden
  32769. */
  32770. _pos: number;
  32771. /**
  32772. * @hidden Index of this particle in the global "indices" array (Internal use)
  32773. */
  32774. _ind: number;
  32775. /**
  32776. * @hidden ModelShape of this particle (Internal use)
  32777. */
  32778. _model: ModelShape;
  32779. /**
  32780. * ModelShape id of this particle
  32781. */
  32782. shapeId: number;
  32783. /**
  32784. * Index of the particle in its shape id
  32785. */
  32786. idxInShape: number;
  32787. /**
  32788. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32789. */
  32790. _modelBoundingInfo: BoundingInfo;
  32791. /**
  32792. * @hidden Particle BoundingInfo object (Internal use)
  32793. */
  32794. _boundingInfo: BoundingInfo;
  32795. /**
  32796. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32797. */
  32798. _sps: SolidParticleSystem;
  32799. /**
  32800. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32801. */
  32802. _stillInvisible: boolean;
  32803. /**
  32804. * @hidden Last computed particle rotation matrix
  32805. */
  32806. _rotationMatrix: number[];
  32807. /**
  32808. * Parent particle Id, if any.
  32809. * Default null.
  32810. */
  32811. parentId: Nullable<number>;
  32812. /**
  32813. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32814. */
  32815. materialIndex: Nullable<number>;
  32816. /**
  32817. * Custom object or properties.
  32818. */
  32819. props: Nullable<any>;
  32820. /**
  32821. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32822. * The possible values are :
  32823. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32824. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32826. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32827. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32828. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32829. * */
  32830. cullingStrategy: number;
  32831. /**
  32832. * @hidden Internal global position in the SPS.
  32833. */
  32834. _globalPosition: Vector3;
  32835. /**
  32836. * Creates a Solid Particle object.
  32837. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32838. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32839. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32840. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32841. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32842. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32843. * @param shapeId (integer) is the model shape identifier in the SPS.
  32844. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32845. * @param sps defines the sps it is associated to
  32846. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32847. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32848. */
  32849. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32850. /**
  32851. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32852. * @param target the particle target
  32853. * @returns the current particle
  32854. */
  32855. copyToRef(target: SolidParticle): SolidParticle;
  32856. /**
  32857. * Legacy support, changed scale to scaling
  32858. */
  32859. get scale(): Vector3;
  32860. /**
  32861. * Legacy support, changed scale to scaling
  32862. */
  32863. set scale(scale: Vector3);
  32864. /**
  32865. * Legacy support, changed quaternion to rotationQuaternion
  32866. */
  32867. get quaternion(): Nullable<Quaternion>;
  32868. /**
  32869. * Legacy support, changed quaternion to rotationQuaternion
  32870. */
  32871. set quaternion(q: Nullable<Quaternion>);
  32872. /**
  32873. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32874. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32875. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32876. * @returns true if it intersects
  32877. */
  32878. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32879. /**
  32880. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32881. * A particle is in the frustum if its bounding box intersects the frustum
  32882. * @param frustumPlanes defines the frustum to test
  32883. * @returns true if the particle is in the frustum planes
  32884. */
  32885. isInFrustum(frustumPlanes: Plane[]): boolean;
  32886. /**
  32887. * get the rotation matrix of the particle
  32888. * @hidden
  32889. */
  32890. getRotationMatrix(m: Matrix): void;
  32891. }
  32892. /**
  32893. * Represents the shape of the model used by one particle of a solid particle system.
  32894. * SPS internal tool, don't use it manually.
  32895. */
  32896. export class ModelShape {
  32897. /**
  32898. * The shape id
  32899. * @hidden
  32900. */
  32901. shapeID: number;
  32902. /**
  32903. * flat array of model positions (internal use)
  32904. * @hidden
  32905. */
  32906. _shape: Vector3[];
  32907. /**
  32908. * flat array of model UVs (internal use)
  32909. * @hidden
  32910. */
  32911. _shapeUV: number[];
  32912. /**
  32913. * color array of the model
  32914. * @hidden
  32915. */
  32916. _shapeColors: number[];
  32917. /**
  32918. * indices array of the model
  32919. * @hidden
  32920. */
  32921. _indices: number[];
  32922. /**
  32923. * normals array of the model
  32924. * @hidden
  32925. */
  32926. _normals: number[];
  32927. /**
  32928. * length of the shape in the model indices array (internal use)
  32929. * @hidden
  32930. */
  32931. _indicesLength: number;
  32932. /**
  32933. * Custom position function (internal use)
  32934. * @hidden
  32935. */
  32936. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32937. /**
  32938. * Custom vertex function (internal use)
  32939. * @hidden
  32940. */
  32941. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32942. /**
  32943. * Model material (internal use)
  32944. * @hidden
  32945. */
  32946. _material: Nullable<Material>;
  32947. /**
  32948. * 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.
  32949. * SPS internal tool, don't use it manually.
  32950. * @hidden
  32951. */
  32952. 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>, material: Nullable<Material>);
  32953. }
  32954. /**
  32955. * Represents a Depth Sorted Particle in the solid particle system.
  32956. * @hidden
  32957. */
  32958. export class DepthSortedParticle {
  32959. /**
  32960. * Particle index
  32961. */
  32962. idx: number;
  32963. /**
  32964. * Index of the particle in the "indices" array
  32965. */
  32966. ind: number;
  32967. /**
  32968. * Length of the particle shape in the "indices" array
  32969. */
  32970. indicesLength: number;
  32971. /**
  32972. * Squared distance from the particle to the camera
  32973. */
  32974. sqDistance: number;
  32975. /**
  32976. * Material index when used with MultiMaterials
  32977. */
  32978. materialIndex: number;
  32979. /**
  32980. * Creates a new sorted particle
  32981. * @param materialIndex
  32982. */
  32983. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32984. }
  32985. /**
  32986. * Represents a solid particle vertex
  32987. */
  32988. export class SolidParticleVertex {
  32989. /**
  32990. * Vertex position
  32991. */
  32992. position: Vector3;
  32993. /**
  32994. * Vertex color
  32995. */
  32996. color: Color4;
  32997. /**
  32998. * Vertex UV
  32999. */
  33000. uv: Vector2;
  33001. /**
  33002. * Creates a new solid particle vertex
  33003. */
  33004. constructor();
  33005. /** Vertex x coordinate */
  33006. get x(): number;
  33007. set x(val: number);
  33008. /** Vertex y coordinate */
  33009. get y(): number;
  33010. set y(val: number);
  33011. /** Vertex z coordinate */
  33012. get z(): number;
  33013. set z(val: number);
  33014. }
  33015. }
  33016. declare module "babylonjs/Collisions/meshCollisionData" {
  33017. import { Collider } from "babylonjs/Collisions/collider";
  33018. import { Vector3 } from "babylonjs/Maths/math.vector";
  33019. import { Nullable } from "babylonjs/types";
  33020. import { Observer } from "babylonjs/Misc/observable";
  33021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33022. /**
  33023. * @hidden
  33024. */
  33025. export class _MeshCollisionData {
  33026. _checkCollisions: boolean;
  33027. _collisionMask: number;
  33028. _collisionGroup: number;
  33029. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33030. _collider: Nullable<Collider>;
  33031. _oldPositionForCollisions: Vector3;
  33032. _diffPositionForCollisions: Vector3;
  33033. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33034. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33035. }
  33036. }
  33037. declare module "babylonjs/Meshes/abstractMesh" {
  33038. import { Observable } from "babylonjs/Misc/observable";
  33039. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33040. import { Camera } from "babylonjs/Cameras/camera";
  33041. import { Scene, IDisposable } from "babylonjs/scene";
  33042. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33043. import { Node } from "babylonjs/node";
  33044. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33045. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33046. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33047. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33048. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33049. import { Material } from "babylonjs/Materials/material";
  33050. import { Light } from "babylonjs/Lights/light";
  33051. import { Skeleton } from "babylonjs/Bones/skeleton";
  33052. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33053. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33054. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33055. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33056. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33057. import { Plane } from "babylonjs/Maths/math.plane";
  33058. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33059. import { Ray } from "babylonjs/Culling/ray";
  33060. import { Collider } from "babylonjs/Collisions/collider";
  33061. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33062. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33063. /** @hidden */
  33064. class _FacetDataStorage {
  33065. facetPositions: Vector3[];
  33066. facetNormals: Vector3[];
  33067. facetPartitioning: number[][];
  33068. facetNb: number;
  33069. partitioningSubdivisions: number;
  33070. partitioningBBoxRatio: number;
  33071. facetDataEnabled: boolean;
  33072. facetParameters: any;
  33073. bbSize: Vector3;
  33074. subDiv: {
  33075. max: number;
  33076. X: number;
  33077. Y: number;
  33078. Z: number;
  33079. };
  33080. facetDepthSort: boolean;
  33081. facetDepthSortEnabled: boolean;
  33082. depthSortedIndices: IndicesArray;
  33083. depthSortedFacets: {
  33084. ind: number;
  33085. sqDistance: number;
  33086. }[];
  33087. facetDepthSortFunction: (f1: {
  33088. ind: number;
  33089. sqDistance: number;
  33090. }, f2: {
  33091. ind: number;
  33092. sqDistance: number;
  33093. }) => number;
  33094. facetDepthSortFrom: Vector3;
  33095. facetDepthSortOrigin: Vector3;
  33096. invertedMatrix: Matrix;
  33097. }
  33098. /**
  33099. * @hidden
  33100. **/
  33101. class _InternalAbstractMeshDataInfo {
  33102. _hasVertexAlpha: boolean;
  33103. _useVertexColors: boolean;
  33104. _numBoneInfluencers: number;
  33105. _applyFog: boolean;
  33106. _receiveShadows: boolean;
  33107. _facetData: _FacetDataStorage;
  33108. _visibility: number;
  33109. _skeleton: Nullable<Skeleton>;
  33110. _layerMask: number;
  33111. _computeBonesUsingShaders: boolean;
  33112. _isActive: boolean;
  33113. _onlyForInstances: boolean;
  33114. _isActiveIntermediate: boolean;
  33115. _onlyForInstancesIntermediate: boolean;
  33116. _actAsRegularMesh: boolean;
  33117. }
  33118. /**
  33119. * Class used to store all common mesh properties
  33120. */
  33121. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33122. /** No occlusion */
  33123. static OCCLUSION_TYPE_NONE: number;
  33124. /** Occlusion set to optimisitic */
  33125. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33126. /** Occlusion set to strict */
  33127. static OCCLUSION_TYPE_STRICT: number;
  33128. /** Use an accurante occlusion algorithm */
  33129. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33130. /** Use a conservative occlusion algorithm */
  33131. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33132. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33133. * Test order :
  33134. * Is the bounding sphere outside the frustum ?
  33135. * If not, are the bounding box vertices outside the frustum ?
  33136. * It not, then the cullable object is in the frustum.
  33137. */
  33138. static readonly CULLINGSTRATEGY_STANDARD: number;
  33139. /** Culling strategy : Bounding Sphere Only.
  33140. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33141. * It's also less accurate than the standard because some not visible objects can still be selected.
  33142. * Test : is the bounding sphere outside the frustum ?
  33143. * If not, then the cullable object is in the frustum.
  33144. */
  33145. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33146. /** Culling strategy : Optimistic Inclusion.
  33147. * This in an inclusion test first, then the standard exclusion test.
  33148. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33149. * 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.
  33150. * Anyway, it's as accurate as the standard strategy.
  33151. * Test :
  33152. * Is the cullable object bounding sphere center in the frustum ?
  33153. * If not, apply the default culling strategy.
  33154. */
  33155. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33156. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33157. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33158. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33159. * 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.
  33160. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33161. * Test :
  33162. * Is the cullable object bounding sphere center in the frustum ?
  33163. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33164. */
  33165. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33166. /**
  33167. * No billboard
  33168. */
  33169. static get BILLBOARDMODE_NONE(): number;
  33170. /** Billboard on X axis */
  33171. static get BILLBOARDMODE_X(): number;
  33172. /** Billboard on Y axis */
  33173. static get BILLBOARDMODE_Y(): number;
  33174. /** Billboard on Z axis */
  33175. static get BILLBOARDMODE_Z(): number;
  33176. /** Billboard on all axes */
  33177. static get BILLBOARDMODE_ALL(): number;
  33178. /** Billboard on using position instead of orientation */
  33179. static get BILLBOARDMODE_USE_POSITION(): number;
  33180. /** @hidden */
  33181. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33182. /**
  33183. * The culling strategy to use to check whether the mesh must be rendered or not.
  33184. * This value can be changed at any time and will be used on the next render mesh selection.
  33185. * The possible values are :
  33186. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33187. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33188. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33189. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33190. * Please read each static variable documentation to get details about the culling process.
  33191. * */
  33192. cullingStrategy: number;
  33193. /**
  33194. * Gets the number of facets in the mesh
  33195. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33196. */
  33197. get facetNb(): number;
  33198. /**
  33199. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33200. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33201. */
  33202. get partitioningSubdivisions(): number;
  33203. set partitioningSubdivisions(nb: number);
  33204. /**
  33205. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33206. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33207. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33208. */
  33209. get partitioningBBoxRatio(): number;
  33210. set partitioningBBoxRatio(ratio: number);
  33211. /**
  33212. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33213. * Works only for updatable meshes.
  33214. * Doesn't work with multi-materials
  33215. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33216. */
  33217. get mustDepthSortFacets(): boolean;
  33218. set mustDepthSortFacets(sort: boolean);
  33219. /**
  33220. * The location (Vector3) where the facet depth sort must be computed from.
  33221. * By default, the active camera position.
  33222. * Used only when facet depth sort is enabled
  33223. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33224. */
  33225. get facetDepthSortFrom(): Vector3;
  33226. set facetDepthSortFrom(location: Vector3);
  33227. /**
  33228. * gets a boolean indicating if facetData is enabled
  33229. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33230. */
  33231. get isFacetDataEnabled(): boolean;
  33232. /** @hidden */
  33233. _updateNonUniformScalingState(value: boolean): boolean;
  33234. /**
  33235. * An event triggered when this mesh collides with another one
  33236. */
  33237. onCollideObservable: Observable<AbstractMesh>;
  33238. /** Set a function to call when this mesh collides with another one */
  33239. set onCollide(callback: () => void);
  33240. /**
  33241. * An event triggered when the collision's position changes
  33242. */
  33243. onCollisionPositionChangeObservable: Observable<Vector3>;
  33244. /** Set a function to call when the collision's position changes */
  33245. set onCollisionPositionChange(callback: () => void);
  33246. /**
  33247. * An event triggered when material is changed
  33248. */
  33249. onMaterialChangedObservable: Observable<AbstractMesh>;
  33250. /**
  33251. * Gets or sets the orientation for POV movement & rotation
  33252. */
  33253. definedFacingForward: boolean;
  33254. /** @hidden */
  33255. _occlusionQuery: Nullable<WebGLQuery>;
  33256. /** @hidden */
  33257. _renderingGroup: Nullable<RenderingGroup>;
  33258. /**
  33259. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33260. */
  33261. get visibility(): number;
  33262. /**
  33263. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33264. */
  33265. set visibility(value: number);
  33266. /** Gets or sets the alpha index used to sort transparent meshes
  33267. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33268. */
  33269. alphaIndex: number;
  33270. /**
  33271. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33272. */
  33273. isVisible: boolean;
  33274. /**
  33275. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33276. */
  33277. isPickable: boolean;
  33278. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33279. showSubMeshesBoundingBox: boolean;
  33280. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33281. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33282. */
  33283. isBlocker: boolean;
  33284. /**
  33285. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33286. */
  33287. enablePointerMoveEvents: boolean;
  33288. private _renderingGroupId;
  33289. /**
  33290. * Specifies the rendering group id for this mesh (0 by default)
  33291. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33292. */
  33293. get renderingGroupId(): number;
  33294. set renderingGroupId(value: number);
  33295. private _material;
  33296. /** Gets or sets current material */
  33297. get material(): Nullable<Material>;
  33298. set material(value: Nullable<Material>);
  33299. /**
  33300. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33301. * @see https://doc.babylonjs.com/babylon101/shadows
  33302. */
  33303. get receiveShadows(): boolean;
  33304. set receiveShadows(value: boolean);
  33305. /** Defines color to use when rendering outline */
  33306. outlineColor: Color3;
  33307. /** Define width to use when rendering outline */
  33308. outlineWidth: number;
  33309. /** Defines color to use when rendering overlay */
  33310. overlayColor: Color3;
  33311. /** Defines alpha to use when rendering overlay */
  33312. overlayAlpha: number;
  33313. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33314. get hasVertexAlpha(): boolean;
  33315. set hasVertexAlpha(value: boolean);
  33316. /** 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) */
  33317. get useVertexColors(): boolean;
  33318. set useVertexColors(value: boolean);
  33319. /**
  33320. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33321. */
  33322. get computeBonesUsingShaders(): boolean;
  33323. set computeBonesUsingShaders(value: boolean);
  33324. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33325. get numBoneInfluencers(): number;
  33326. set numBoneInfluencers(value: number);
  33327. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33328. get applyFog(): boolean;
  33329. set applyFog(value: boolean);
  33330. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33331. useOctreeForRenderingSelection: boolean;
  33332. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33333. useOctreeForPicking: boolean;
  33334. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33335. useOctreeForCollisions: boolean;
  33336. /**
  33337. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33338. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33339. */
  33340. get layerMask(): number;
  33341. set layerMask(value: number);
  33342. /**
  33343. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33344. */
  33345. alwaysSelectAsActiveMesh: boolean;
  33346. /**
  33347. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33348. */
  33349. doNotSyncBoundingInfo: boolean;
  33350. /**
  33351. * Gets or sets the current action manager
  33352. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33353. */
  33354. actionManager: Nullable<AbstractActionManager>;
  33355. private _meshCollisionData;
  33356. /**
  33357. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33358. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33359. */
  33360. ellipsoid: Vector3;
  33361. /**
  33362. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33363. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33364. */
  33365. ellipsoidOffset: Vector3;
  33366. /**
  33367. * Gets or sets a collision mask used to mask collisions (default is -1).
  33368. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33369. */
  33370. get collisionMask(): number;
  33371. set collisionMask(mask: number);
  33372. /**
  33373. * Gets or sets the current collision group mask (-1 by default).
  33374. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33375. */
  33376. get collisionGroup(): number;
  33377. set collisionGroup(mask: number);
  33378. /**
  33379. * Gets or sets current surrounding meshes (null by default).
  33380. *
  33381. * By default collision detection is tested against every mesh in the scene.
  33382. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33383. * meshes will be tested for the collision.
  33384. *
  33385. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33386. */
  33387. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33388. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33389. /**
  33390. * Defines edge width used when edgesRenderer is enabled
  33391. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33392. */
  33393. edgesWidth: number;
  33394. /**
  33395. * Defines edge color used when edgesRenderer is enabled
  33396. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33397. */
  33398. edgesColor: Color4;
  33399. /** @hidden */
  33400. _edgesRenderer: Nullable<IEdgesRenderer>;
  33401. /** @hidden */
  33402. _masterMesh: Nullable<AbstractMesh>;
  33403. /** @hidden */
  33404. _boundingInfo: Nullable<BoundingInfo>;
  33405. /** @hidden */
  33406. _renderId: number;
  33407. /**
  33408. * Gets or sets the list of subMeshes
  33409. * @see https://doc.babylonjs.com/how_to/multi_materials
  33410. */
  33411. subMeshes: SubMesh[];
  33412. /** @hidden */
  33413. _intersectionsInProgress: AbstractMesh[];
  33414. /** @hidden */
  33415. _unIndexed: boolean;
  33416. /** @hidden */
  33417. _lightSources: Light[];
  33418. /** Gets the list of lights affecting that mesh */
  33419. get lightSources(): Light[];
  33420. /** @hidden */
  33421. get _positions(): Nullable<Vector3[]>;
  33422. /** @hidden */
  33423. _waitingData: {
  33424. lods: Nullable<any>;
  33425. actions: Nullable<any>;
  33426. freezeWorldMatrix: Nullable<boolean>;
  33427. };
  33428. /** @hidden */
  33429. _bonesTransformMatrices: Nullable<Float32Array>;
  33430. /** @hidden */
  33431. _transformMatrixTexture: Nullable<RawTexture>;
  33432. /**
  33433. * Gets or sets a skeleton to apply skining transformations
  33434. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33435. */
  33436. set skeleton(value: Nullable<Skeleton>);
  33437. get skeleton(): Nullable<Skeleton>;
  33438. /**
  33439. * An event triggered when the mesh is rebuilt.
  33440. */
  33441. onRebuildObservable: Observable<AbstractMesh>;
  33442. /**
  33443. * Creates a new AbstractMesh
  33444. * @param name defines the name of the mesh
  33445. * @param scene defines the hosting scene
  33446. */
  33447. constructor(name: string, scene?: Nullable<Scene>);
  33448. /**
  33449. * Returns the string "AbstractMesh"
  33450. * @returns "AbstractMesh"
  33451. */
  33452. getClassName(): string;
  33453. /**
  33454. * Gets a string representation of the current mesh
  33455. * @param fullDetails defines a boolean indicating if full details must be included
  33456. * @returns a string representation of the current mesh
  33457. */
  33458. toString(fullDetails?: boolean): string;
  33459. /**
  33460. * @hidden
  33461. */
  33462. protected _getEffectiveParent(): Nullable<Node>;
  33463. /** @hidden */
  33464. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33465. /** @hidden */
  33466. _rebuild(): void;
  33467. /** @hidden */
  33468. _resyncLightSources(): void;
  33469. /** @hidden */
  33470. _resyncLightSource(light: Light): void;
  33471. /** @hidden */
  33472. _unBindEffect(): void;
  33473. /** @hidden */
  33474. _removeLightSource(light: Light, dispose: boolean): void;
  33475. private _markSubMeshesAsDirty;
  33476. /** @hidden */
  33477. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33478. /** @hidden */
  33479. _markSubMeshesAsAttributesDirty(): void;
  33480. /** @hidden */
  33481. _markSubMeshesAsMiscDirty(): void;
  33482. /**
  33483. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33484. */
  33485. get scaling(): Vector3;
  33486. set scaling(newScaling: Vector3);
  33487. /**
  33488. * Returns true if the mesh is blocked. Implemented by child classes
  33489. */
  33490. get isBlocked(): boolean;
  33491. /**
  33492. * Returns the mesh itself by default. Implemented by child classes
  33493. * @param camera defines the camera to use to pick the right LOD level
  33494. * @returns the currentAbstractMesh
  33495. */
  33496. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33497. /**
  33498. * Returns 0 by default. Implemented by child classes
  33499. * @returns an integer
  33500. */
  33501. getTotalVertices(): number;
  33502. /**
  33503. * Returns a positive integer : the total number of indices in this mesh geometry.
  33504. * @returns the numner of indices or zero if the mesh has no geometry.
  33505. */
  33506. getTotalIndices(): number;
  33507. /**
  33508. * Returns null by default. Implemented by child classes
  33509. * @returns null
  33510. */
  33511. getIndices(): Nullable<IndicesArray>;
  33512. /**
  33513. * Returns the array of the requested vertex data kind. Implemented by child classes
  33514. * @param kind defines the vertex data kind to use
  33515. * @returns null
  33516. */
  33517. getVerticesData(kind: string): Nullable<FloatArray>;
  33518. /**
  33519. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33520. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33521. * Note that a new underlying VertexBuffer object is created each call.
  33522. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33523. * @param kind defines vertex data kind:
  33524. * * VertexBuffer.PositionKind
  33525. * * VertexBuffer.UVKind
  33526. * * VertexBuffer.UV2Kind
  33527. * * VertexBuffer.UV3Kind
  33528. * * VertexBuffer.UV4Kind
  33529. * * VertexBuffer.UV5Kind
  33530. * * VertexBuffer.UV6Kind
  33531. * * VertexBuffer.ColorKind
  33532. * * VertexBuffer.MatricesIndicesKind
  33533. * * VertexBuffer.MatricesIndicesExtraKind
  33534. * * VertexBuffer.MatricesWeightsKind
  33535. * * VertexBuffer.MatricesWeightsExtraKind
  33536. * @param data defines the data source
  33537. * @param updatable defines if the data must be flagged as updatable (or static)
  33538. * @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
  33539. * @returns the current mesh
  33540. */
  33541. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33542. /**
  33543. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33544. * If the mesh has no geometry, it is simply returned as it is.
  33545. * @param kind defines vertex data kind:
  33546. * * VertexBuffer.PositionKind
  33547. * * VertexBuffer.UVKind
  33548. * * VertexBuffer.UV2Kind
  33549. * * VertexBuffer.UV3Kind
  33550. * * VertexBuffer.UV4Kind
  33551. * * VertexBuffer.UV5Kind
  33552. * * VertexBuffer.UV6Kind
  33553. * * VertexBuffer.ColorKind
  33554. * * VertexBuffer.MatricesIndicesKind
  33555. * * VertexBuffer.MatricesIndicesExtraKind
  33556. * * VertexBuffer.MatricesWeightsKind
  33557. * * VertexBuffer.MatricesWeightsExtraKind
  33558. * @param data defines the data source
  33559. * @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
  33560. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33561. * @returns the current mesh
  33562. */
  33563. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33564. /**
  33565. * Sets the mesh indices,
  33566. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33567. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33568. * @param totalVertices Defines the total number of vertices
  33569. * @returns the current mesh
  33570. */
  33571. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33572. /**
  33573. * Gets a boolean indicating if specific vertex data is present
  33574. * @param kind defines the vertex data kind to use
  33575. * @returns true is data kind is present
  33576. */
  33577. isVerticesDataPresent(kind: string): boolean;
  33578. /**
  33579. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33580. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33581. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33582. * @returns a BoundingInfo
  33583. */
  33584. getBoundingInfo(): BoundingInfo;
  33585. /**
  33586. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33587. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33588. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33589. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33590. * @returns the current mesh
  33591. */
  33592. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33593. /**
  33594. * Overwrite the current bounding info
  33595. * @param boundingInfo defines the new bounding info
  33596. * @returns the current mesh
  33597. */
  33598. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33599. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33600. get useBones(): boolean;
  33601. /** @hidden */
  33602. _preActivate(): void;
  33603. /** @hidden */
  33604. _preActivateForIntermediateRendering(renderId: number): void;
  33605. /** @hidden */
  33606. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33607. /** @hidden */
  33608. _postActivate(): void;
  33609. /** @hidden */
  33610. _freeze(): void;
  33611. /** @hidden */
  33612. _unFreeze(): void;
  33613. /**
  33614. * Gets the current world matrix
  33615. * @returns a Matrix
  33616. */
  33617. getWorldMatrix(): Matrix;
  33618. /** @hidden */
  33619. _getWorldMatrixDeterminant(): number;
  33620. /**
  33621. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33622. */
  33623. get isAnInstance(): boolean;
  33624. /**
  33625. * Gets a boolean indicating if this mesh has instances
  33626. */
  33627. get hasInstances(): boolean;
  33628. /**
  33629. * Gets a boolean indicating if this mesh has thin instances
  33630. */
  33631. get hasThinInstances(): boolean;
  33632. /**
  33633. * Perform relative position change from the point of view of behind the front of the mesh.
  33634. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33635. * Supports definition of mesh facing forward or backward
  33636. * @param amountRight defines the distance on the right axis
  33637. * @param amountUp defines the distance on the up axis
  33638. * @param amountForward defines the distance on the forward axis
  33639. * @returns the current mesh
  33640. */
  33641. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33642. /**
  33643. * Calculate relative position change from the point of view of behind the front of the mesh.
  33644. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33645. * Supports definition of mesh facing forward or backward
  33646. * @param amountRight defines the distance on the right axis
  33647. * @param amountUp defines the distance on the up axis
  33648. * @param amountForward defines the distance on the forward axis
  33649. * @returns the new displacement vector
  33650. */
  33651. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33652. /**
  33653. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33654. * Supports definition of mesh facing forward or backward
  33655. * @param flipBack defines the flip
  33656. * @param twirlClockwise defines the twirl
  33657. * @param tiltRight defines the tilt
  33658. * @returns the current mesh
  33659. */
  33660. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33661. /**
  33662. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33663. * Supports definition of mesh facing forward or backward.
  33664. * @param flipBack defines the flip
  33665. * @param twirlClockwise defines the twirl
  33666. * @param tiltRight defines the tilt
  33667. * @returns the new rotation vector
  33668. */
  33669. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33670. /**
  33671. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33672. * This means the mesh underlying bounding box and sphere are recomputed.
  33673. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33674. * @returns the current mesh
  33675. */
  33676. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33677. /** @hidden */
  33678. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33679. /** @hidden */
  33680. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33681. /** @hidden */
  33682. _updateBoundingInfo(): AbstractMesh;
  33683. /** @hidden */
  33684. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33685. /** @hidden */
  33686. protected _afterComputeWorldMatrix(): void;
  33687. /** @hidden */
  33688. get _effectiveMesh(): AbstractMesh;
  33689. /**
  33690. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33691. * A mesh is in the frustum if its bounding box intersects the frustum
  33692. * @param frustumPlanes defines the frustum to test
  33693. * @returns true if the mesh is in the frustum planes
  33694. */
  33695. isInFrustum(frustumPlanes: Plane[]): boolean;
  33696. /**
  33697. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33698. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33699. * @param frustumPlanes defines the frustum to test
  33700. * @returns true if the mesh is completely in the frustum planes
  33701. */
  33702. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33703. /**
  33704. * True if the mesh intersects another mesh or a SolidParticle object
  33705. * @param mesh defines a target mesh or SolidParticle to test
  33706. * @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)
  33707. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33708. * @returns true if there is an intersection
  33709. */
  33710. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33711. /**
  33712. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33713. * @param point defines the point to test
  33714. * @returns true if there is an intersection
  33715. */
  33716. intersectsPoint(point: Vector3): boolean;
  33717. /**
  33718. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33719. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33720. */
  33721. get checkCollisions(): boolean;
  33722. set checkCollisions(collisionEnabled: boolean);
  33723. /**
  33724. * Gets Collider object used to compute collisions (not physics)
  33725. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33726. */
  33727. get collider(): Nullable<Collider>;
  33728. /**
  33729. * Move the mesh using collision engine
  33730. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33731. * @param displacement defines the requested displacement vector
  33732. * @returns the current mesh
  33733. */
  33734. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33735. private _onCollisionPositionChange;
  33736. /** @hidden */
  33737. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33738. /** @hidden */
  33739. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33740. /** @hidden */
  33741. _checkCollision(collider: Collider): AbstractMesh;
  33742. /** @hidden */
  33743. _generatePointsArray(): boolean;
  33744. /**
  33745. * Checks if the passed Ray intersects with the mesh
  33746. * @param ray defines the ray to use
  33747. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33748. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33749. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33750. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33751. * @returns the picking info
  33752. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33753. */
  33754. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33755. /**
  33756. * Clones the current mesh
  33757. * @param name defines the mesh name
  33758. * @param newParent defines the new mesh parent
  33759. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33760. * @returns the new mesh
  33761. */
  33762. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33763. /**
  33764. * Disposes all the submeshes of the current meshnp
  33765. * @returns the current mesh
  33766. */
  33767. releaseSubMeshes(): AbstractMesh;
  33768. /**
  33769. * Releases resources associated with this abstract mesh.
  33770. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33771. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33772. */
  33773. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33774. /**
  33775. * Adds the passed mesh as a child to the current mesh
  33776. * @param mesh defines the child mesh
  33777. * @returns the current mesh
  33778. */
  33779. addChild(mesh: AbstractMesh): AbstractMesh;
  33780. /**
  33781. * Removes the passed mesh from the current mesh children list
  33782. * @param mesh defines the child mesh
  33783. * @returns the current mesh
  33784. */
  33785. removeChild(mesh: AbstractMesh): AbstractMesh;
  33786. /** @hidden */
  33787. private _initFacetData;
  33788. /**
  33789. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33790. * This method can be called within the render loop.
  33791. * 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
  33792. * @returns the current mesh
  33793. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33794. */
  33795. updateFacetData(): AbstractMesh;
  33796. /**
  33797. * Returns the facetLocalNormals array.
  33798. * The normals are expressed in the mesh local spac
  33799. * @returns an array of Vector3
  33800. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33801. */
  33802. getFacetLocalNormals(): Vector3[];
  33803. /**
  33804. * Returns the facetLocalPositions array.
  33805. * The facet positions are expressed in the mesh local space
  33806. * @returns an array of Vector3
  33807. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33808. */
  33809. getFacetLocalPositions(): Vector3[];
  33810. /**
  33811. * Returns the facetLocalPartioning array
  33812. * @returns an array of array of numbers
  33813. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33814. */
  33815. getFacetLocalPartitioning(): number[][];
  33816. /**
  33817. * Returns the i-th facet position in the world system.
  33818. * This method allocates a new Vector3 per call
  33819. * @param i defines the facet index
  33820. * @returns a new Vector3
  33821. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33822. */
  33823. getFacetPosition(i: number): Vector3;
  33824. /**
  33825. * Sets the reference Vector3 with the i-th facet position in the world system
  33826. * @param i defines the facet index
  33827. * @param ref defines the target vector
  33828. * @returns the current mesh
  33829. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33830. */
  33831. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33832. /**
  33833. * Returns the i-th facet normal in the world system.
  33834. * This method allocates a new Vector3 per call
  33835. * @param i defines the facet index
  33836. * @returns a new Vector3
  33837. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33838. */
  33839. getFacetNormal(i: number): Vector3;
  33840. /**
  33841. * Sets the reference Vector3 with the i-th facet normal in the world system
  33842. * @param i defines the facet index
  33843. * @param ref defines the target vector
  33844. * @returns the current mesh
  33845. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33846. */
  33847. getFacetNormalToRef(i: number, ref: Vector3): this;
  33848. /**
  33849. * 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)
  33850. * @param x defines x coordinate
  33851. * @param y defines y coordinate
  33852. * @param z defines z coordinate
  33853. * @returns the array of facet indexes
  33854. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33855. */
  33856. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33857. /**
  33858. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33859. * @param projected sets as the (x,y,z) world projection on the facet
  33860. * @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
  33861. * @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
  33862. * @param x defines x coordinate
  33863. * @param y defines y coordinate
  33864. * @param z defines z coordinate
  33865. * @returns the face index if found (or null instead)
  33866. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33867. */
  33868. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33869. /**
  33870. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33871. * @param projected sets as the (x,y,z) local projection on the facet
  33872. * @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
  33873. * @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
  33874. * @param x defines x coordinate
  33875. * @param y defines y coordinate
  33876. * @param z defines z coordinate
  33877. * @returns the face index if found (or null instead)
  33878. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33879. */
  33880. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33881. /**
  33882. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33883. * @returns the parameters
  33884. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33885. */
  33886. getFacetDataParameters(): any;
  33887. /**
  33888. * Disables the feature FacetData and frees the related memory
  33889. * @returns the current mesh
  33890. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33891. */
  33892. disableFacetData(): AbstractMesh;
  33893. /**
  33894. * Updates the AbstractMesh indices array
  33895. * @param indices defines the data source
  33896. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33897. * @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)
  33898. * @returns the current mesh
  33899. */
  33900. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33901. /**
  33902. * Creates new normals data for the mesh
  33903. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33904. * @returns the current mesh
  33905. */
  33906. createNormals(updatable: boolean): AbstractMesh;
  33907. /**
  33908. * Align the mesh with a normal
  33909. * @param normal defines the normal to use
  33910. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33911. * @returns the current mesh
  33912. */
  33913. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33914. /** @hidden */
  33915. _checkOcclusionQuery(): boolean;
  33916. /**
  33917. * Disables the mesh edge rendering mode
  33918. * @returns the currentAbstractMesh
  33919. */
  33920. disableEdgesRendering(): AbstractMesh;
  33921. /**
  33922. * Enables the edge rendering mode on the mesh.
  33923. * This mode makes the mesh edges visible
  33924. * @param epsilon defines the maximal distance between two angles to detect a face
  33925. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33926. * @returns the currentAbstractMesh
  33927. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33928. */
  33929. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33930. /**
  33931. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33932. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33933. */
  33934. getConnectedParticleSystems(): IParticleSystem[];
  33935. }
  33936. }
  33937. declare module "babylonjs/Actions/actionEvent" {
  33938. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33939. import { Nullable } from "babylonjs/types";
  33940. import { Sprite } from "babylonjs/Sprites/sprite";
  33941. import { Scene } from "babylonjs/scene";
  33942. import { Vector2 } from "babylonjs/Maths/math.vector";
  33943. /**
  33944. * Interface used to define ActionEvent
  33945. */
  33946. export interface IActionEvent {
  33947. /** The mesh or sprite that triggered the action */
  33948. source: any;
  33949. /** The X mouse cursor position at the time of the event */
  33950. pointerX: number;
  33951. /** The Y mouse cursor position at the time of the event */
  33952. pointerY: number;
  33953. /** The mesh that is currently pointed at (can be null) */
  33954. meshUnderPointer: Nullable<AbstractMesh>;
  33955. /** the original (browser) event that triggered the ActionEvent */
  33956. sourceEvent?: any;
  33957. /** additional data for the event */
  33958. additionalData?: any;
  33959. }
  33960. /**
  33961. * ActionEvent is the event being sent when an action is triggered.
  33962. */
  33963. export class ActionEvent implements IActionEvent {
  33964. /** The mesh or sprite that triggered the action */
  33965. source: any;
  33966. /** The X mouse cursor position at the time of the event */
  33967. pointerX: number;
  33968. /** The Y mouse cursor position at the time of the event */
  33969. pointerY: number;
  33970. /** The mesh that is currently pointed at (can be null) */
  33971. meshUnderPointer: Nullable<AbstractMesh>;
  33972. /** the original (browser) event that triggered the ActionEvent */
  33973. sourceEvent?: any;
  33974. /** additional data for the event */
  33975. additionalData?: any;
  33976. /**
  33977. * Creates a new ActionEvent
  33978. * @param source The mesh or sprite that triggered the action
  33979. * @param pointerX The X mouse cursor position at the time of the event
  33980. * @param pointerY The Y mouse cursor position at the time of the event
  33981. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33982. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33983. * @param additionalData additional data for the event
  33984. */
  33985. constructor(
  33986. /** The mesh or sprite that triggered the action */
  33987. source: any,
  33988. /** The X mouse cursor position at the time of the event */
  33989. pointerX: number,
  33990. /** The Y mouse cursor position at the time of the event */
  33991. pointerY: number,
  33992. /** The mesh that is currently pointed at (can be null) */
  33993. meshUnderPointer: Nullable<AbstractMesh>,
  33994. /** the original (browser) event that triggered the ActionEvent */
  33995. sourceEvent?: any,
  33996. /** additional data for the event */
  33997. additionalData?: any);
  33998. /**
  33999. * Helper function to auto-create an ActionEvent from a source mesh.
  34000. * @param source The source mesh that triggered the event
  34001. * @param evt The original (browser) event
  34002. * @param additionalData additional data for the event
  34003. * @returns the new ActionEvent
  34004. */
  34005. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34006. /**
  34007. * Helper function to auto-create an ActionEvent from a source sprite
  34008. * @param source The source sprite that triggered the event
  34009. * @param scene Scene associated with the sprite
  34010. * @param evt The original (browser) event
  34011. * @param additionalData additional data for the event
  34012. * @returns the new ActionEvent
  34013. */
  34014. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34015. /**
  34016. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34017. * @param scene the scene where the event occurred
  34018. * @param evt The original (browser) event
  34019. * @returns the new ActionEvent
  34020. */
  34021. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34022. /**
  34023. * Helper function to auto-create an ActionEvent from a primitive
  34024. * @param prim defines the target primitive
  34025. * @param pointerPos defines the pointer position
  34026. * @param evt The original (browser) event
  34027. * @param additionalData additional data for the event
  34028. * @returns the new ActionEvent
  34029. */
  34030. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34031. }
  34032. }
  34033. declare module "babylonjs/Actions/abstractActionManager" {
  34034. import { IDisposable } from "babylonjs/scene";
  34035. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34036. import { IAction } from "babylonjs/Actions/action";
  34037. import { Nullable } from "babylonjs/types";
  34038. /**
  34039. * Abstract class used to decouple action Manager from scene and meshes.
  34040. * Do not instantiate.
  34041. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34042. */
  34043. export abstract class AbstractActionManager implements IDisposable {
  34044. /** Gets the list of active triggers */
  34045. static Triggers: {
  34046. [key: string]: number;
  34047. };
  34048. /** Gets the cursor to use when hovering items */
  34049. hoverCursor: string;
  34050. /** Gets the list of actions */
  34051. actions: IAction[];
  34052. /**
  34053. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34054. */
  34055. isRecursive: boolean;
  34056. /**
  34057. * Releases all associated resources
  34058. */
  34059. abstract dispose(): void;
  34060. /**
  34061. * Does this action manager has pointer triggers
  34062. */
  34063. abstract get hasPointerTriggers(): boolean;
  34064. /**
  34065. * Does this action manager has pick triggers
  34066. */
  34067. abstract get hasPickTriggers(): boolean;
  34068. /**
  34069. * Process a specific trigger
  34070. * @param trigger defines the trigger to process
  34071. * @param evt defines the event details to be processed
  34072. */
  34073. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34074. /**
  34075. * Does this action manager handles actions of any of the given triggers
  34076. * @param triggers defines the triggers to be tested
  34077. * @return a boolean indicating whether one (or more) of the triggers is handled
  34078. */
  34079. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34080. /**
  34081. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34082. * speed.
  34083. * @param triggerA defines the trigger to be tested
  34084. * @param triggerB defines the trigger to be tested
  34085. * @return a boolean indicating whether one (or more) of the triggers is handled
  34086. */
  34087. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34088. /**
  34089. * Does this action manager handles actions of a given trigger
  34090. * @param trigger defines the trigger to be tested
  34091. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34092. * @return whether the trigger is handled
  34093. */
  34094. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34095. /**
  34096. * Serialize this manager to a JSON object
  34097. * @param name defines the property name to store this manager
  34098. * @returns a JSON representation of this manager
  34099. */
  34100. abstract serialize(name: string): any;
  34101. /**
  34102. * Registers an action to this action manager
  34103. * @param action defines the action to be registered
  34104. * @return the action amended (prepared) after registration
  34105. */
  34106. abstract registerAction(action: IAction): Nullable<IAction>;
  34107. /**
  34108. * Unregisters an action to this action manager
  34109. * @param action defines the action to be unregistered
  34110. * @return a boolean indicating whether the action has been unregistered
  34111. */
  34112. abstract unregisterAction(action: IAction): Boolean;
  34113. /**
  34114. * Does exist one action manager with at least one trigger
  34115. **/
  34116. static get HasTriggers(): boolean;
  34117. /**
  34118. * Does exist one action manager with at least one pick trigger
  34119. **/
  34120. static get HasPickTriggers(): boolean;
  34121. /**
  34122. * Does exist one action manager that handles actions of a given trigger
  34123. * @param trigger defines the trigger to be tested
  34124. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34125. **/
  34126. static HasSpecificTrigger(trigger: number): boolean;
  34127. }
  34128. }
  34129. declare module "babylonjs/node" {
  34130. import { Scene } from "babylonjs/scene";
  34131. import { Nullable } from "babylonjs/types";
  34132. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34133. import { Engine } from "babylonjs/Engines/engine";
  34134. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34135. import { Observable } from "babylonjs/Misc/observable";
  34136. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34137. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34138. import { Animatable } from "babylonjs/Animations/animatable";
  34139. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34140. import { Animation } from "babylonjs/Animations/animation";
  34141. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34143. /**
  34144. * Defines how a node can be built from a string name.
  34145. */
  34146. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34147. /**
  34148. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34149. */
  34150. export class Node implements IBehaviorAware<Node> {
  34151. /** @hidden */
  34152. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34153. private static _NodeConstructors;
  34154. /**
  34155. * Add a new node constructor
  34156. * @param type defines the type name of the node to construct
  34157. * @param constructorFunc defines the constructor function
  34158. */
  34159. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34160. /**
  34161. * Returns a node constructor based on type name
  34162. * @param type defines the type name
  34163. * @param name defines the new node name
  34164. * @param scene defines the hosting scene
  34165. * @param options defines optional options to transmit to constructors
  34166. * @returns the new constructor or null
  34167. */
  34168. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34169. /**
  34170. * Gets or sets the name of the node
  34171. */
  34172. name: string;
  34173. /**
  34174. * Gets or sets the id of the node
  34175. */
  34176. id: string;
  34177. /**
  34178. * Gets or sets the unique id of the node
  34179. */
  34180. uniqueId: number;
  34181. /**
  34182. * Gets or sets a string used to store user defined state for the node
  34183. */
  34184. state: string;
  34185. /**
  34186. * Gets or sets an object used to store user defined information for the node
  34187. */
  34188. metadata: any;
  34189. /**
  34190. * For internal use only. Please do not use.
  34191. */
  34192. reservedDataStore: any;
  34193. /**
  34194. * List of inspectable custom properties (used by the Inspector)
  34195. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34196. */
  34197. inspectableCustomProperties: IInspectable[];
  34198. private _doNotSerialize;
  34199. /**
  34200. * Gets or sets a boolean used to define if the node must be serialized
  34201. */
  34202. get doNotSerialize(): boolean;
  34203. set doNotSerialize(value: boolean);
  34204. /** @hidden */
  34205. _isDisposed: boolean;
  34206. /**
  34207. * Gets a list of Animations associated with the node
  34208. */
  34209. animations: import("babylonjs/Animations/animation").Animation[];
  34210. protected _ranges: {
  34211. [name: string]: Nullable<AnimationRange>;
  34212. };
  34213. /**
  34214. * Callback raised when the node is ready to be used
  34215. */
  34216. onReady: Nullable<(node: Node) => void>;
  34217. private _isEnabled;
  34218. private _isParentEnabled;
  34219. private _isReady;
  34220. /** @hidden */
  34221. _currentRenderId: number;
  34222. private _parentUpdateId;
  34223. /** @hidden */
  34224. _childUpdateId: number;
  34225. /** @hidden */
  34226. _waitingParentId: Nullable<string>;
  34227. /** @hidden */
  34228. _scene: Scene;
  34229. /** @hidden */
  34230. _cache: any;
  34231. private _parentNode;
  34232. private _children;
  34233. /** @hidden */
  34234. _worldMatrix: Matrix;
  34235. /** @hidden */
  34236. _worldMatrixDeterminant: number;
  34237. /** @hidden */
  34238. _worldMatrixDeterminantIsDirty: boolean;
  34239. /** @hidden */
  34240. private _sceneRootNodesIndex;
  34241. /**
  34242. * Gets a boolean indicating if the node has been disposed
  34243. * @returns true if the node was disposed
  34244. */
  34245. isDisposed(): boolean;
  34246. /**
  34247. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34248. * @see https://doc.babylonjs.com/how_to/parenting
  34249. */
  34250. set parent(parent: Nullable<Node>);
  34251. get parent(): Nullable<Node>;
  34252. /** @hidden */
  34253. _addToSceneRootNodes(): void;
  34254. /** @hidden */
  34255. _removeFromSceneRootNodes(): void;
  34256. private _animationPropertiesOverride;
  34257. /**
  34258. * Gets or sets the animation properties override
  34259. */
  34260. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34261. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34262. /**
  34263. * Gets a string identifying the name of the class
  34264. * @returns "Node" string
  34265. */
  34266. getClassName(): string;
  34267. /** @hidden */
  34268. readonly _isNode: boolean;
  34269. /**
  34270. * An event triggered when the mesh is disposed
  34271. */
  34272. onDisposeObservable: Observable<Node>;
  34273. private _onDisposeObserver;
  34274. /**
  34275. * Sets a callback that will be raised when the node will be disposed
  34276. */
  34277. set onDispose(callback: () => void);
  34278. /**
  34279. * Creates a new Node
  34280. * @param name the name and id to be given to this node
  34281. * @param scene the scene this node will be added to
  34282. */
  34283. constructor(name: string, scene?: Nullable<Scene>);
  34284. /**
  34285. * Gets the scene of the node
  34286. * @returns a scene
  34287. */
  34288. getScene(): Scene;
  34289. /**
  34290. * Gets the engine of the node
  34291. * @returns a Engine
  34292. */
  34293. getEngine(): Engine;
  34294. private _behaviors;
  34295. /**
  34296. * Attach a behavior to the node
  34297. * @see https://doc.babylonjs.com/features/behaviour
  34298. * @param behavior defines the behavior to attach
  34299. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34300. * @returns the current Node
  34301. */
  34302. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34303. /**
  34304. * Remove an attached behavior
  34305. * @see https://doc.babylonjs.com/features/behaviour
  34306. * @param behavior defines the behavior to attach
  34307. * @returns the current Node
  34308. */
  34309. removeBehavior(behavior: Behavior<Node>): Node;
  34310. /**
  34311. * Gets the list of attached behaviors
  34312. * @see https://doc.babylonjs.com/features/behaviour
  34313. */
  34314. get behaviors(): Behavior<Node>[];
  34315. /**
  34316. * Gets an attached behavior by name
  34317. * @param name defines the name of the behavior to look for
  34318. * @see https://doc.babylonjs.com/features/behaviour
  34319. * @returns null if behavior was not found else the requested behavior
  34320. */
  34321. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34322. /**
  34323. * Returns the latest update of the World matrix
  34324. * @returns a Matrix
  34325. */
  34326. getWorldMatrix(): Matrix;
  34327. /** @hidden */
  34328. _getWorldMatrixDeterminant(): number;
  34329. /**
  34330. * Returns directly the latest state of the mesh World matrix.
  34331. * A Matrix is returned.
  34332. */
  34333. get worldMatrixFromCache(): Matrix;
  34334. /** @hidden */
  34335. _initCache(): void;
  34336. /** @hidden */
  34337. updateCache(force?: boolean): void;
  34338. /** @hidden */
  34339. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34340. /** @hidden */
  34341. _updateCache(ignoreParentClass?: boolean): void;
  34342. /** @hidden */
  34343. _isSynchronized(): boolean;
  34344. /** @hidden */
  34345. _markSyncedWithParent(): void;
  34346. /** @hidden */
  34347. isSynchronizedWithParent(): boolean;
  34348. /** @hidden */
  34349. isSynchronized(): boolean;
  34350. /**
  34351. * Is this node ready to be used/rendered
  34352. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34353. * @return true if the node is ready
  34354. */
  34355. isReady(completeCheck?: boolean): boolean;
  34356. /**
  34357. * Is this node enabled?
  34358. * 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
  34359. * @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
  34360. * @return whether this node (and its parent) is enabled
  34361. */
  34362. isEnabled(checkAncestors?: boolean): boolean;
  34363. /** @hidden */
  34364. protected _syncParentEnabledState(): void;
  34365. /**
  34366. * Set the enabled state of this node
  34367. * @param value defines the new enabled state
  34368. */
  34369. setEnabled(value: boolean): void;
  34370. /**
  34371. * Is this node a descendant of the given node?
  34372. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34373. * @param ancestor defines the parent node to inspect
  34374. * @returns a boolean indicating if this node is a descendant of the given node
  34375. */
  34376. isDescendantOf(ancestor: Node): boolean;
  34377. /** @hidden */
  34378. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34379. /**
  34380. * Will return all nodes that have this node as ascendant
  34381. * @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
  34382. * @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
  34383. * @return all children nodes of all types
  34384. */
  34385. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34386. /**
  34387. * Get all child-meshes of this node
  34388. * @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)
  34389. * @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
  34390. * @returns an array of AbstractMesh
  34391. */
  34392. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34393. /**
  34394. * Get all direct children of this node
  34395. * @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
  34396. * @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)
  34397. * @returns an array of Node
  34398. */
  34399. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34400. /** @hidden */
  34401. _setReady(state: boolean): void;
  34402. /**
  34403. * Get an animation by name
  34404. * @param name defines the name of the animation to look for
  34405. * @returns null if not found else the requested animation
  34406. */
  34407. getAnimationByName(name: string): Nullable<Animation>;
  34408. /**
  34409. * Creates an animation range for this node
  34410. * @param name defines the name of the range
  34411. * @param from defines the starting key
  34412. * @param to defines the end key
  34413. */
  34414. createAnimationRange(name: string, from: number, to: number): void;
  34415. /**
  34416. * Delete a specific animation range
  34417. * @param name defines the name of the range to delete
  34418. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34419. */
  34420. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34421. /**
  34422. * Get an animation range by name
  34423. * @param name defines the name of the animation range to look for
  34424. * @returns null if not found else the requested animation range
  34425. */
  34426. getAnimationRange(name: string): Nullable<AnimationRange>;
  34427. /**
  34428. * Gets the list of all animation ranges defined on this node
  34429. * @returns an array
  34430. */
  34431. getAnimationRanges(): Nullable<AnimationRange>[];
  34432. /**
  34433. * Will start the animation sequence
  34434. * @param name defines the range frames for animation sequence
  34435. * @param loop defines if the animation should loop (false by default)
  34436. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34437. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34438. * @returns the object created for this animation. If range does not exist, it will return null
  34439. */
  34440. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34441. /**
  34442. * Serialize animation ranges into a JSON compatible object
  34443. * @returns serialization object
  34444. */
  34445. serializeAnimationRanges(): any;
  34446. /**
  34447. * Computes the world matrix of the node
  34448. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34449. * @returns the world matrix
  34450. */
  34451. computeWorldMatrix(force?: boolean): Matrix;
  34452. /**
  34453. * Releases resources associated with this node.
  34454. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34455. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34456. */
  34457. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34458. /**
  34459. * Parse animation range data from a serialization object and store them into a given node
  34460. * @param node defines where to store the animation ranges
  34461. * @param parsedNode defines the serialization object to read data from
  34462. * @param scene defines the hosting scene
  34463. */
  34464. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34465. /**
  34466. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34467. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34468. * @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
  34469. * @returns the new bounding vectors
  34470. */
  34471. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34472. min: Vector3;
  34473. max: Vector3;
  34474. };
  34475. }
  34476. }
  34477. declare module "babylonjs/Animations/animation" {
  34478. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34479. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34480. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34481. import { Nullable } from "babylonjs/types";
  34482. import { Scene } from "babylonjs/scene";
  34483. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34484. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34485. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34486. import { Node } from "babylonjs/node";
  34487. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34488. import { Size } from "babylonjs/Maths/math.size";
  34489. import { Animatable } from "babylonjs/Animations/animatable";
  34490. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34491. /**
  34492. * @hidden
  34493. */
  34494. export class _IAnimationState {
  34495. key: number;
  34496. repeatCount: number;
  34497. workValue?: any;
  34498. loopMode?: number;
  34499. offsetValue?: any;
  34500. highLimitValue?: any;
  34501. }
  34502. /**
  34503. * Class used to store any kind of animation
  34504. */
  34505. export class Animation {
  34506. /**Name of the animation */
  34507. name: string;
  34508. /**Property to animate */
  34509. targetProperty: string;
  34510. /**The frames per second of the animation */
  34511. framePerSecond: number;
  34512. /**The data type of the animation */
  34513. dataType: number;
  34514. /**The loop mode of the animation */
  34515. loopMode?: number | undefined;
  34516. /**Specifies if blending should be enabled */
  34517. enableBlending?: boolean | undefined;
  34518. /**
  34519. * Use matrix interpolation instead of using direct key value when animating matrices
  34520. */
  34521. static AllowMatricesInterpolation: boolean;
  34522. /**
  34523. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34524. */
  34525. static AllowMatrixDecomposeForInterpolation: boolean;
  34526. /** Define the Url to load snippets */
  34527. static SnippetUrl: string;
  34528. /** Snippet ID if the animation was created from the snippet server */
  34529. snippetId: string;
  34530. /**
  34531. * Stores the key frames of the animation
  34532. */
  34533. private _keys;
  34534. /**
  34535. * Stores the easing function of the animation
  34536. */
  34537. private _easingFunction;
  34538. /**
  34539. * @hidden Internal use only
  34540. */
  34541. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34542. /**
  34543. * The set of event that will be linked to this animation
  34544. */
  34545. private _events;
  34546. /**
  34547. * Stores an array of target property paths
  34548. */
  34549. targetPropertyPath: string[];
  34550. /**
  34551. * Stores the blending speed of the animation
  34552. */
  34553. blendingSpeed: number;
  34554. /**
  34555. * Stores the animation ranges for the animation
  34556. */
  34557. private _ranges;
  34558. /**
  34559. * @hidden Internal use
  34560. */
  34561. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34562. /**
  34563. * Sets up an animation
  34564. * @param property The property to animate
  34565. * @param animationType The animation type to apply
  34566. * @param framePerSecond The frames per second of the animation
  34567. * @param easingFunction The easing function used in the animation
  34568. * @returns The created animation
  34569. */
  34570. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34571. /**
  34572. * Create and start an animation on a node
  34573. * @param name defines the name of the global animation that will be run on all nodes
  34574. * @param node defines the root node where the animation will take place
  34575. * @param targetProperty defines property to animate
  34576. * @param framePerSecond defines the number of frame per second yo use
  34577. * @param totalFrame defines the number of frames in total
  34578. * @param from defines the initial value
  34579. * @param to defines the final value
  34580. * @param loopMode defines which loop mode you want to use (off by default)
  34581. * @param easingFunction defines the easing function to use (linear by default)
  34582. * @param onAnimationEnd defines the callback to call when animation end
  34583. * @returns the animatable created for this animation
  34584. */
  34585. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34586. /**
  34587. * Create and start an animation on a node and its descendants
  34588. * @param name defines the name of the global animation that will be run on all nodes
  34589. * @param node defines the root node where the animation will take place
  34590. * @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
  34591. * @param targetProperty defines property to animate
  34592. * @param framePerSecond defines the number of frame per second to use
  34593. * @param totalFrame defines the number of frames in total
  34594. * @param from defines the initial value
  34595. * @param to defines the final value
  34596. * @param loopMode defines which loop mode you want to use (off by default)
  34597. * @param easingFunction defines the easing function to use (linear by default)
  34598. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34599. * @returns the list of animatables created for all nodes
  34600. * @example https://www.babylonjs-playground.com/#MH0VLI
  34601. */
  34602. 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[]>;
  34603. /**
  34604. * Creates a new animation, merges it with the existing animations and starts it
  34605. * @param name Name of the animation
  34606. * @param node Node which contains the scene that begins the animations
  34607. * @param targetProperty Specifies which property to animate
  34608. * @param framePerSecond The frames per second of the animation
  34609. * @param totalFrame The total number of frames
  34610. * @param from The frame at the beginning of the animation
  34611. * @param to The frame at the end of the animation
  34612. * @param loopMode Specifies the loop mode of the animation
  34613. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34614. * @param onAnimationEnd Callback to run once the animation is complete
  34615. * @returns Nullable animation
  34616. */
  34617. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34618. /**
  34619. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34620. * @param sourceAnimation defines the Animation containing keyframes to convert
  34621. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34622. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34623. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34624. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34625. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34626. */
  34627. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34628. /**
  34629. * Transition property of an host to the target Value
  34630. * @param property The property to transition
  34631. * @param targetValue The target Value of the property
  34632. * @param host The object where the property to animate belongs
  34633. * @param scene Scene used to run the animation
  34634. * @param frameRate Framerate (in frame/s) to use
  34635. * @param transition The transition type we want to use
  34636. * @param duration The duration of the animation, in milliseconds
  34637. * @param onAnimationEnd Callback trigger at the end of the animation
  34638. * @returns Nullable animation
  34639. */
  34640. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34641. /**
  34642. * Return the array of runtime animations currently using this animation
  34643. */
  34644. get runtimeAnimations(): RuntimeAnimation[];
  34645. /**
  34646. * Specifies if any of the runtime animations are currently running
  34647. */
  34648. get hasRunningRuntimeAnimations(): boolean;
  34649. /**
  34650. * Initializes the animation
  34651. * @param name Name of the animation
  34652. * @param targetProperty Property to animate
  34653. * @param framePerSecond The frames per second of the animation
  34654. * @param dataType The data type of the animation
  34655. * @param loopMode The loop mode of the animation
  34656. * @param enableBlending Specifies if blending should be enabled
  34657. */
  34658. constructor(
  34659. /**Name of the animation */
  34660. name: string,
  34661. /**Property to animate */
  34662. targetProperty: string,
  34663. /**The frames per second of the animation */
  34664. framePerSecond: number,
  34665. /**The data type of the animation */
  34666. dataType: number,
  34667. /**The loop mode of the animation */
  34668. loopMode?: number | undefined,
  34669. /**Specifies if blending should be enabled */
  34670. enableBlending?: boolean | undefined);
  34671. /**
  34672. * Converts the animation to a string
  34673. * @param fullDetails support for multiple levels of logging within scene loading
  34674. * @returns String form of the animation
  34675. */
  34676. toString(fullDetails?: boolean): string;
  34677. /**
  34678. * Add an event to this animation
  34679. * @param event Event to add
  34680. */
  34681. addEvent(event: AnimationEvent): void;
  34682. /**
  34683. * Remove all events found at the given frame
  34684. * @param frame The frame to remove events from
  34685. */
  34686. removeEvents(frame: number): void;
  34687. /**
  34688. * Retrieves all the events from the animation
  34689. * @returns Events from the animation
  34690. */
  34691. getEvents(): AnimationEvent[];
  34692. /**
  34693. * Creates an animation range
  34694. * @param name Name of the animation range
  34695. * @param from Starting frame of the animation range
  34696. * @param to Ending frame of the animation
  34697. */
  34698. createRange(name: string, from: number, to: number): void;
  34699. /**
  34700. * Deletes an animation range by name
  34701. * @param name Name of the animation range to delete
  34702. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34703. */
  34704. deleteRange(name: string, deleteFrames?: boolean): void;
  34705. /**
  34706. * Gets the animation range by name, or null if not defined
  34707. * @param name Name of the animation range
  34708. * @returns Nullable animation range
  34709. */
  34710. getRange(name: string): Nullable<AnimationRange>;
  34711. /**
  34712. * Gets the key frames from the animation
  34713. * @returns The key frames of the animation
  34714. */
  34715. getKeys(): Array<IAnimationKey>;
  34716. /**
  34717. * Gets the highest frame rate of the animation
  34718. * @returns Highest frame rate of the animation
  34719. */
  34720. getHighestFrame(): number;
  34721. /**
  34722. * Gets the easing function of the animation
  34723. * @returns Easing function of the animation
  34724. */
  34725. getEasingFunction(): IEasingFunction;
  34726. /**
  34727. * Sets the easing function of the animation
  34728. * @param easingFunction A custom mathematical formula for animation
  34729. */
  34730. setEasingFunction(easingFunction: EasingFunction): void;
  34731. /**
  34732. * Interpolates a scalar linearly
  34733. * @param startValue Start value of the animation curve
  34734. * @param endValue End value of the animation curve
  34735. * @param gradient Scalar amount to interpolate
  34736. * @returns Interpolated scalar value
  34737. */
  34738. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34739. /**
  34740. * Interpolates a scalar cubically
  34741. * @param startValue Start value of the animation curve
  34742. * @param outTangent End tangent of the animation
  34743. * @param endValue End value of the animation curve
  34744. * @param inTangent Start tangent of the animation curve
  34745. * @param gradient Scalar amount to interpolate
  34746. * @returns Interpolated scalar value
  34747. */
  34748. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34749. /**
  34750. * Interpolates a quaternion using a spherical linear interpolation
  34751. * @param startValue Start value of the animation curve
  34752. * @param endValue End value of the animation curve
  34753. * @param gradient Scalar amount to interpolate
  34754. * @returns Interpolated quaternion value
  34755. */
  34756. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34757. /**
  34758. * Interpolates a quaternion cubically
  34759. * @param startValue Start value of the animation curve
  34760. * @param outTangent End tangent of the animation curve
  34761. * @param endValue End value of the animation curve
  34762. * @param inTangent Start tangent of the animation curve
  34763. * @param gradient Scalar amount to interpolate
  34764. * @returns Interpolated quaternion value
  34765. */
  34766. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34767. /**
  34768. * Interpolates a Vector3 linearl
  34769. * @param startValue Start value of the animation curve
  34770. * @param endValue End value of the animation curve
  34771. * @param gradient Scalar amount to interpolate
  34772. * @returns Interpolated scalar value
  34773. */
  34774. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34775. /**
  34776. * Interpolates a Vector3 cubically
  34777. * @param startValue Start value of the animation curve
  34778. * @param outTangent End tangent of the animation
  34779. * @param endValue End value of the animation curve
  34780. * @param inTangent Start tangent of the animation curve
  34781. * @param gradient Scalar amount to interpolate
  34782. * @returns InterpolatedVector3 value
  34783. */
  34784. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34785. /**
  34786. * Interpolates a Vector2 linearly
  34787. * @param startValue Start value of the animation curve
  34788. * @param endValue End value of the animation curve
  34789. * @param gradient Scalar amount to interpolate
  34790. * @returns Interpolated Vector2 value
  34791. */
  34792. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34793. /**
  34794. * Interpolates a Vector2 cubically
  34795. * @param startValue Start value of the animation curve
  34796. * @param outTangent End tangent of the animation
  34797. * @param endValue End value of the animation curve
  34798. * @param inTangent Start tangent of the animation curve
  34799. * @param gradient Scalar amount to interpolate
  34800. * @returns Interpolated Vector2 value
  34801. */
  34802. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34803. /**
  34804. * Interpolates a size linearly
  34805. * @param startValue Start value of the animation curve
  34806. * @param endValue End value of the animation curve
  34807. * @param gradient Scalar amount to interpolate
  34808. * @returns Interpolated Size value
  34809. */
  34810. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34811. /**
  34812. * Interpolates a Color3 linearly
  34813. * @param startValue Start value of the animation curve
  34814. * @param endValue End value of the animation curve
  34815. * @param gradient Scalar amount to interpolate
  34816. * @returns Interpolated Color3 value
  34817. */
  34818. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34819. /**
  34820. * Interpolates a Color4 linearly
  34821. * @param startValue Start value of the animation curve
  34822. * @param endValue End value of the animation curve
  34823. * @param gradient Scalar amount to interpolate
  34824. * @returns Interpolated Color3 value
  34825. */
  34826. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34827. /**
  34828. * @hidden Internal use only
  34829. */
  34830. _getKeyValue(value: any): any;
  34831. /**
  34832. * @hidden Internal use only
  34833. */
  34834. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34835. /**
  34836. * Defines the function to use to interpolate matrices
  34837. * @param startValue defines the start matrix
  34838. * @param endValue defines the end matrix
  34839. * @param gradient defines the gradient between both matrices
  34840. * @param result defines an optional target matrix where to store the interpolation
  34841. * @returns the interpolated matrix
  34842. */
  34843. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34844. /**
  34845. * Makes a copy of the animation
  34846. * @returns Cloned animation
  34847. */
  34848. clone(): Animation;
  34849. /**
  34850. * Sets the key frames of the animation
  34851. * @param values The animation key frames to set
  34852. */
  34853. setKeys(values: Array<IAnimationKey>): void;
  34854. /**
  34855. * Serializes the animation to an object
  34856. * @returns Serialized object
  34857. */
  34858. serialize(): any;
  34859. /**
  34860. * Float animation type
  34861. */
  34862. static readonly ANIMATIONTYPE_FLOAT: number;
  34863. /**
  34864. * Vector3 animation type
  34865. */
  34866. static readonly ANIMATIONTYPE_VECTOR3: number;
  34867. /**
  34868. * Quaternion animation type
  34869. */
  34870. static readonly ANIMATIONTYPE_QUATERNION: number;
  34871. /**
  34872. * Matrix animation type
  34873. */
  34874. static readonly ANIMATIONTYPE_MATRIX: number;
  34875. /**
  34876. * Color3 animation type
  34877. */
  34878. static readonly ANIMATIONTYPE_COLOR3: number;
  34879. /**
  34880. * Color3 animation type
  34881. */
  34882. static readonly ANIMATIONTYPE_COLOR4: number;
  34883. /**
  34884. * Vector2 animation type
  34885. */
  34886. static readonly ANIMATIONTYPE_VECTOR2: number;
  34887. /**
  34888. * Size animation type
  34889. */
  34890. static readonly ANIMATIONTYPE_SIZE: number;
  34891. /**
  34892. * Relative Loop Mode
  34893. */
  34894. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34895. /**
  34896. * Cycle Loop Mode
  34897. */
  34898. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34899. /**
  34900. * Constant Loop Mode
  34901. */
  34902. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34903. /** @hidden */
  34904. static _UniversalLerp(left: any, right: any, amount: number): any;
  34905. /**
  34906. * Parses an animation object and creates an animation
  34907. * @param parsedAnimation Parsed animation object
  34908. * @returns Animation object
  34909. */
  34910. static Parse(parsedAnimation: any): Animation;
  34911. /**
  34912. * Appends the serialized animations from the source animations
  34913. * @param source Source containing the animations
  34914. * @param destination Target to store the animations
  34915. */
  34916. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34917. /**
  34918. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34919. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34920. * @param url defines the url to load from
  34921. * @returns a promise that will resolve to the new animation or an array of animations
  34922. */
  34923. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34924. /**
  34925. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34926. * @param snippetId defines the snippet to load
  34927. * @returns a promise that will resolve to the new animation or a new array of animations
  34928. */
  34929. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34930. }
  34931. }
  34932. declare module "babylonjs/Animations/animatable.interface" {
  34933. import { Nullable } from "babylonjs/types";
  34934. import { Animation } from "babylonjs/Animations/animation";
  34935. /**
  34936. * Interface containing an array of animations
  34937. */
  34938. export interface IAnimatable {
  34939. /**
  34940. * Array of animations
  34941. */
  34942. animations: Nullable<Array<Animation>>;
  34943. }
  34944. }
  34945. declare module "babylonjs/Misc/decorators" {
  34946. import { Nullable } from "babylonjs/types";
  34947. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34948. import { Scene } from "babylonjs/scene";
  34949. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34950. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34951. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34953. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34954. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34958. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34959. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34961. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34963. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34964. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34965. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34966. /**
  34967. * Decorator used to define property that can be serialized as reference to a camera
  34968. * @param sourceName defines the name of the property to decorate
  34969. */
  34970. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34971. /**
  34972. * Class used to help serialization objects
  34973. */
  34974. export class SerializationHelper {
  34975. /** @hidden */
  34976. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34977. /** @hidden */
  34978. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34979. /** @hidden */
  34980. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34981. /** @hidden */
  34982. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34983. /**
  34984. * Appends the serialized animations from the source animations
  34985. * @param source Source containing the animations
  34986. * @param destination Target to store the animations
  34987. */
  34988. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34989. /**
  34990. * Static function used to serialized a specific entity
  34991. * @param entity defines the entity to serialize
  34992. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34993. * @returns a JSON compatible object representing the serialization of the entity
  34994. */
  34995. static Serialize<T>(entity: T, serializationObject?: any): any;
  34996. /**
  34997. * Creates a new entity from a serialization data object
  34998. * @param creationFunction defines a function used to instanciated the new entity
  34999. * @param source defines the source serialization data
  35000. * @param scene defines the hosting scene
  35001. * @param rootUrl defines the root url for resources
  35002. * @returns a new entity
  35003. */
  35004. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35005. /**
  35006. * Clones an object
  35007. * @param creationFunction defines the function used to instanciate the new object
  35008. * @param source defines the source object
  35009. * @returns the cloned object
  35010. */
  35011. static Clone<T>(creationFunction: () => T, source: T): T;
  35012. /**
  35013. * Instanciates a new object based on a source one (some data will be shared between both object)
  35014. * @param creationFunction defines the function used to instanciate the new object
  35015. * @param source defines the source object
  35016. * @returns the new object
  35017. */
  35018. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35019. }
  35020. }
  35021. declare module "babylonjs/Materials/Textures/baseTexture" {
  35022. import { Observable } from "babylonjs/Misc/observable";
  35023. import { Nullable } from "babylonjs/types";
  35024. import { Scene } from "babylonjs/scene";
  35025. import { Matrix } from "babylonjs/Maths/math.vector";
  35026. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35027. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35028. import { ISize } from "babylonjs/Maths/math.size";
  35029. import "babylonjs/Misc/fileTools";
  35030. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35031. /**
  35032. * Base class of all the textures in babylon.
  35033. * It groups all the common properties the materials, post process, lights... might need
  35034. * in order to make a correct use of the texture.
  35035. */
  35036. export class BaseTexture implements IAnimatable {
  35037. /**
  35038. * Default anisotropic filtering level for the application.
  35039. * It is set to 4 as a good tradeoff between perf and quality.
  35040. */
  35041. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35042. /**
  35043. * Gets or sets the unique id of the texture
  35044. */
  35045. uniqueId: number;
  35046. /**
  35047. * Define the name of the texture.
  35048. */
  35049. name: string;
  35050. /**
  35051. * Gets or sets an object used to store user defined information.
  35052. */
  35053. metadata: any;
  35054. /**
  35055. * For internal use only. Please do not use.
  35056. */
  35057. reservedDataStore: any;
  35058. private _hasAlpha;
  35059. /**
  35060. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35061. */
  35062. set hasAlpha(value: boolean);
  35063. get hasAlpha(): boolean;
  35064. /**
  35065. * Defines if the alpha value should be determined via the rgb values.
  35066. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35067. */
  35068. getAlphaFromRGB: boolean;
  35069. /**
  35070. * Intensity or strength of the texture.
  35071. * It is commonly used by materials to fine tune the intensity of the texture
  35072. */
  35073. level: number;
  35074. /**
  35075. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35076. * This is part of the texture as textures usually maps to one uv set.
  35077. */
  35078. coordinatesIndex: number;
  35079. protected _coordinatesMode: number;
  35080. /**
  35081. * How a texture is mapped.
  35082. *
  35083. * | Value | Type | Description |
  35084. * | ----- | ----------------------------------- | ----------- |
  35085. * | 0 | EXPLICIT_MODE | |
  35086. * | 1 | SPHERICAL_MODE | |
  35087. * | 2 | PLANAR_MODE | |
  35088. * | 3 | CUBIC_MODE | |
  35089. * | 4 | PROJECTION_MODE | |
  35090. * | 5 | SKYBOX_MODE | |
  35091. * | 6 | INVCUBIC_MODE | |
  35092. * | 7 | EQUIRECTANGULAR_MODE | |
  35093. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35094. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35095. */
  35096. set coordinatesMode(value: number);
  35097. get coordinatesMode(): number;
  35098. private _wrapU;
  35099. /**
  35100. * | Value | Type | Description |
  35101. * | ----- | ------------------ | ----------- |
  35102. * | 0 | CLAMP_ADDRESSMODE | |
  35103. * | 1 | WRAP_ADDRESSMODE | |
  35104. * | 2 | MIRROR_ADDRESSMODE | |
  35105. */
  35106. get wrapU(): number;
  35107. set wrapU(value: number);
  35108. private _wrapV;
  35109. /**
  35110. * | Value | Type | Description |
  35111. * | ----- | ------------------ | ----------- |
  35112. * | 0 | CLAMP_ADDRESSMODE | |
  35113. * | 1 | WRAP_ADDRESSMODE | |
  35114. * | 2 | MIRROR_ADDRESSMODE | |
  35115. */
  35116. get wrapV(): number;
  35117. set wrapV(value: number);
  35118. /**
  35119. * | Value | Type | Description |
  35120. * | ----- | ------------------ | ----------- |
  35121. * | 0 | CLAMP_ADDRESSMODE | |
  35122. * | 1 | WRAP_ADDRESSMODE | |
  35123. * | 2 | MIRROR_ADDRESSMODE | |
  35124. */
  35125. wrapR: number;
  35126. /**
  35127. * With compliant hardware and browser (supporting anisotropic filtering)
  35128. * this defines the level of anisotropic filtering in the texture.
  35129. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35130. */
  35131. anisotropicFilteringLevel: number;
  35132. /**
  35133. * Define if the texture is a cube texture or if false a 2d texture.
  35134. */
  35135. get isCube(): boolean;
  35136. set isCube(value: boolean);
  35137. /**
  35138. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35139. */
  35140. get is3D(): boolean;
  35141. set is3D(value: boolean);
  35142. /**
  35143. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35144. */
  35145. get is2DArray(): boolean;
  35146. set is2DArray(value: boolean);
  35147. /**
  35148. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35149. * HDR texture are usually stored in linear space.
  35150. * This only impacts the PBR and Background materials
  35151. */
  35152. gammaSpace: boolean;
  35153. /**
  35154. * Gets or sets whether or not the texture contains RGBD data.
  35155. */
  35156. get isRGBD(): boolean;
  35157. set isRGBD(value: boolean);
  35158. /**
  35159. * Is Z inverted in the texture (useful in a cube texture).
  35160. */
  35161. invertZ: boolean;
  35162. /**
  35163. * Are mip maps generated for this texture or not.
  35164. */
  35165. get noMipmap(): boolean;
  35166. /**
  35167. * @hidden
  35168. */
  35169. lodLevelInAlpha: boolean;
  35170. /**
  35171. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35172. */
  35173. get lodGenerationOffset(): number;
  35174. set lodGenerationOffset(value: number);
  35175. /**
  35176. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35177. */
  35178. get lodGenerationScale(): number;
  35179. set lodGenerationScale(value: number);
  35180. /**
  35181. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35182. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35183. * average roughness values.
  35184. */
  35185. get linearSpecularLOD(): boolean;
  35186. set linearSpecularLOD(value: boolean);
  35187. /**
  35188. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35189. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35190. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35191. */
  35192. get irradianceTexture(): Nullable<BaseTexture>;
  35193. set irradianceTexture(value: Nullable<BaseTexture>);
  35194. /**
  35195. * Define if the texture is a render target.
  35196. */
  35197. isRenderTarget: boolean;
  35198. /**
  35199. * Define the unique id of the texture in the scene.
  35200. */
  35201. get uid(): string;
  35202. /** @hidden */
  35203. _prefiltered: boolean;
  35204. /**
  35205. * Return a string representation of the texture.
  35206. * @returns the texture as a string
  35207. */
  35208. toString(): string;
  35209. /**
  35210. * Get the class name of the texture.
  35211. * @returns "BaseTexture"
  35212. */
  35213. getClassName(): string;
  35214. /**
  35215. * Define the list of animation attached to the texture.
  35216. */
  35217. animations: import("babylonjs/Animations/animation").Animation[];
  35218. /**
  35219. * An event triggered when the texture is disposed.
  35220. */
  35221. onDisposeObservable: Observable<BaseTexture>;
  35222. private _onDisposeObserver;
  35223. /**
  35224. * Callback triggered when the texture has been disposed.
  35225. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35226. */
  35227. set onDispose(callback: () => void);
  35228. /**
  35229. * Define the current state of the loading sequence when in delayed load mode.
  35230. */
  35231. delayLoadState: number;
  35232. protected _scene: Nullable<Scene>;
  35233. protected _engine: Nullable<ThinEngine>;
  35234. /** @hidden */
  35235. _texture: Nullable<InternalTexture>;
  35236. private _uid;
  35237. /**
  35238. * Define if the texture is preventinga material to render or not.
  35239. * If not and the texture is not ready, the engine will use a default black texture instead.
  35240. */
  35241. get isBlocking(): boolean;
  35242. /**
  35243. * Instantiates a new BaseTexture.
  35244. * Base class of all the textures in babylon.
  35245. * It groups all the common properties the materials, post process, lights... might need
  35246. * in order to make a correct use of the texture.
  35247. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35248. */
  35249. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35250. /**
  35251. * Get the scene the texture belongs to.
  35252. * @returns the scene or null if undefined
  35253. */
  35254. getScene(): Nullable<Scene>;
  35255. /** @hidden */
  35256. protected _getEngine(): Nullable<ThinEngine>;
  35257. /**
  35258. * Get the texture transform matrix used to offset tile the texture for istance.
  35259. * @returns the transformation matrix
  35260. */
  35261. getTextureMatrix(): Matrix;
  35262. /**
  35263. * Get the texture reflection matrix used to rotate/transform the reflection.
  35264. * @returns the reflection matrix
  35265. */
  35266. getReflectionTextureMatrix(): Matrix;
  35267. /**
  35268. * Get the underlying lower level texture from Babylon.
  35269. * @returns the insternal texture
  35270. */
  35271. getInternalTexture(): Nullable<InternalTexture>;
  35272. /**
  35273. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35274. * @returns true if ready or not blocking
  35275. */
  35276. isReadyOrNotBlocking(): boolean;
  35277. /**
  35278. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35279. * @returns true if fully ready
  35280. */
  35281. isReady(): boolean;
  35282. private _cachedSize;
  35283. /**
  35284. * Get the size of the texture.
  35285. * @returns the texture size.
  35286. */
  35287. getSize(): ISize;
  35288. /**
  35289. * Get the base size of the texture.
  35290. * It can be different from the size if the texture has been resized for POT for instance
  35291. * @returns the base size
  35292. */
  35293. getBaseSize(): ISize;
  35294. /**
  35295. * Update the sampling mode of the texture.
  35296. * Default is Trilinear mode.
  35297. *
  35298. * | Value | Type | Description |
  35299. * | ----- | ------------------ | ----------- |
  35300. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35301. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35302. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35303. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35304. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35305. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35306. * | 7 | NEAREST_LINEAR | |
  35307. * | 8 | NEAREST_NEAREST | |
  35308. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35309. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35310. * | 11 | LINEAR_LINEAR | |
  35311. * | 12 | LINEAR_NEAREST | |
  35312. *
  35313. * > _mag_: magnification filter (close to the viewer)
  35314. * > _min_: minification filter (far from the viewer)
  35315. * > _mip_: filter used between mip map levels
  35316. *@param samplingMode Define the new sampling mode of the texture
  35317. */
  35318. updateSamplingMode(samplingMode: number): void;
  35319. /**
  35320. * Scales the texture if is `canRescale()`
  35321. * @param ratio the resize factor we want to use to rescale
  35322. */
  35323. scale(ratio: number): void;
  35324. /**
  35325. * Get if the texture can rescale.
  35326. */
  35327. get canRescale(): boolean;
  35328. /** @hidden */
  35329. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35330. /** @hidden */
  35331. _rebuild(): void;
  35332. /**
  35333. * Triggers the load sequence in delayed load mode.
  35334. */
  35335. delayLoad(): void;
  35336. /**
  35337. * Clones the texture.
  35338. * @returns the cloned texture
  35339. */
  35340. clone(): Nullable<BaseTexture>;
  35341. /**
  35342. * Get the texture underlying type (INT, FLOAT...)
  35343. */
  35344. get textureType(): number;
  35345. /**
  35346. * Get the texture underlying format (RGB, RGBA...)
  35347. */
  35348. get textureFormat(): number;
  35349. /**
  35350. * Indicates that textures need to be re-calculated for all materials
  35351. */
  35352. protected _markAllSubMeshesAsTexturesDirty(): void;
  35353. /**
  35354. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35355. * This will returns an RGBA array buffer containing either in values (0-255) or
  35356. * float values (0-1) depending of the underlying buffer type.
  35357. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35358. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35359. * @param buffer defines a user defined buffer to fill with data (can be null)
  35360. * @returns The Array buffer containing the pixels data.
  35361. */
  35362. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35363. /**
  35364. * Release and destroy the underlying lower level texture aka internalTexture.
  35365. */
  35366. releaseInternalTexture(): void;
  35367. /** @hidden */
  35368. get _lodTextureHigh(): Nullable<BaseTexture>;
  35369. /** @hidden */
  35370. get _lodTextureMid(): Nullable<BaseTexture>;
  35371. /** @hidden */
  35372. get _lodTextureLow(): Nullable<BaseTexture>;
  35373. /**
  35374. * Dispose the texture and release its associated resources.
  35375. */
  35376. dispose(): void;
  35377. /**
  35378. * Serialize the texture into a JSON representation that can be parsed later on.
  35379. * @returns the JSON representation of the texture
  35380. */
  35381. serialize(): any;
  35382. /**
  35383. * Helper function to be called back once a list of texture contains only ready textures.
  35384. * @param textures Define the list of textures to wait for
  35385. * @param callback Define the callback triggered once the entire list will be ready
  35386. */
  35387. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35388. private static _isScene;
  35389. }
  35390. }
  35391. declare module "babylonjs/Materials/effect" {
  35392. import { Observable } from "babylonjs/Misc/observable";
  35393. import { Nullable } from "babylonjs/types";
  35394. import { IDisposable } from "babylonjs/scene";
  35395. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35396. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35397. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35398. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35399. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35400. import { Engine } from "babylonjs/Engines/engine";
  35401. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35402. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35403. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35404. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35405. /**
  35406. * Options to be used when creating an effect.
  35407. */
  35408. export interface IEffectCreationOptions {
  35409. /**
  35410. * Atrributes that will be used in the shader.
  35411. */
  35412. attributes: string[];
  35413. /**
  35414. * Uniform varible names that will be set in the shader.
  35415. */
  35416. uniformsNames: string[];
  35417. /**
  35418. * Uniform buffer variable names that will be set in the shader.
  35419. */
  35420. uniformBuffersNames: string[];
  35421. /**
  35422. * Sampler texture variable names that will be set in the shader.
  35423. */
  35424. samplers: string[];
  35425. /**
  35426. * Define statements that will be set in the shader.
  35427. */
  35428. defines: any;
  35429. /**
  35430. * Possible fallbacks for this effect to improve performance when needed.
  35431. */
  35432. fallbacks: Nullable<IEffectFallbacks>;
  35433. /**
  35434. * Callback that will be called when the shader is compiled.
  35435. */
  35436. onCompiled: Nullable<(effect: Effect) => void>;
  35437. /**
  35438. * Callback that will be called if an error occurs during shader compilation.
  35439. */
  35440. onError: Nullable<(effect: Effect, errors: string) => void>;
  35441. /**
  35442. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35443. */
  35444. indexParameters?: any;
  35445. /**
  35446. * Max number of lights that can be used in the shader.
  35447. */
  35448. maxSimultaneousLights?: number;
  35449. /**
  35450. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35451. */
  35452. transformFeedbackVaryings?: Nullable<string[]>;
  35453. /**
  35454. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  35455. */
  35456. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35457. /**
  35458. * Is this effect rendering to several color attachments ?
  35459. */
  35460. multiTarget?: boolean;
  35461. }
  35462. /**
  35463. * Effect containing vertex and fragment shader that can be executed on an object.
  35464. */
  35465. export class Effect implements IDisposable {
  35466. /**
  35467. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35468. */
  35469. static ShadersRepository: string;
  35470. /**
  35471. * Enable logging of the shader code when a compilation error occurs
  35472. */
  35473. static LogShaderCodeOnCompilationError: boolean;
  35474. /**
  35475. * Name of the effect.
  35476. */
  35477. name: any;
  35478. /**
  35479. * String container all the define statements that should be set on the shader.
  35480. */
  35481. defines: string;
  35482. /**
  35483. * Callback that will be called when the shader is compiled.
  35484. */
  35485. onCompiled: Nullable<(effect: Effect) => void>;
  35486. /**
  35487. * Callback that will be called if an error occurs during shader compilation.
  35488. */
  35489. onError: Nullable<(effect: Effect, errors: string) => void>;
  35490. /**
  35491. * Callback that will be called when effect is bound.
  35492. */
  35493. onBind: Nullable<(effect: Effect) => void>;
  35494. /**
  35495. * Unique ID of the effect.
  35496. */
  35497. uniqueId: number;
  35498. /**
  35499. * Observable that will be called when the shader is compiled.
  35500. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35501. */
  35502. onCompileObservable: Observable<Effect>;
  35503. /**
  35504. * Observable that will be called if an error occurs during shader compilation.
  35505. */
  35506. onErrorObservable: Observable<Effect>;
  35507. /** @hidden */
  35508. _onBindObservable: Nullable<Observable<Effect>>;
  35509. /**
  35510. * @hidden
  35511. * Specifies if the effect was previously ready
  35512. */
  35513. _wasPreviouslyReady: boolean;
  35514. /**
  35515. * Observable that will be called when effect is bound.
  35516. */
  35517. get onBindObservable(): Observable<Effect>;
  35518. /** @hidden */
  35519. _bonesComputationForcedToCPU: boolean;
  35520. /** @hidden */
  35521. _multiTarget: boolean;
  35522. private static _uniqueIdSeed;
  35523. private _engine;
  35524. private _uniformBuffersNames;
  35525. private _uniformBuffersNamesList;
  35526. private _uniformsNames;
  35527. private _samplerList;
  35528. private _samplers;
  35529. private _isReady;
  35530. private _compilationError;
  35531. private _allFallbacksProcessed;
  35532. private _attributesNames;
  35533. private _attributes;
  35534. private _attributeLocationByName;
  35535. private _uniforms;
  35536. /**
  35537. * Key for the effect.
  35538. * @hidden
  35539. */
  35540. _key: string;
  35541. private _indexParameters;
  35542. private _fallbacks;
  35543. private _vertexSourceCode;
  35544. private _fragmentSourceCode;
  35545. private _vertexSourceCodeOverride;
  35546. private _fragmentSourceCodeOverride;
  35547. private _transformFeedbackVaryings;
  35548. /**
  35549. * Compiled shader to webGL program.
  35550. * @hidden
  35551. */
  35552. _pipelineContext: Nullable<IPipelineContext>;
  35553. private _valueCache;
  35554. private static _baseCache;
  35555. /**
  35556. * Instantiates an effect.
  35557. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35558. * @param baseName Name of the effect.
  35559. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35560. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35561. * @param samplers List of sampler variables that will be passed to the shader.
  35562. * @param engine Engine to be used to render the effect
  35563. * @param defines Define statements to be added to the shader.
  35564. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35565. * @param onCompiled Callback that will be called when the shader is compiled.
  35566. * @param onError Callback that will be called if an error occurs during shader compilation.
  35567. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35568. */
  35569. 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);
  35570. private _useFinalCode;
  35571. /**
  35572. * Unique key for this effect
  35573. */
  35574. get key(): string;
  35575. /**
  35576. * If the effect has been compiled and prepared.
  35577. * @returns if the effect is compiled and prepared.
  35578. */
  35579. isReady(): boolean;
  35580. private _isReadyInternal;
  35581. /**
  35582. * The engine the effect was initialized with.
  35583. * @returns the engine.
  35584. */
  35585. getEngine(): Engine;
  35586. /**
  35587. * The pipeline context for this effect
  35588. * @returns the associated pipeline context
  35589. */
  35590. getPipelineContext(): Nullable<IPipelineContext>;
  35591. /**
  35592. * The set of names of attribute variables for the shader.
  35593. * @returns An array of attribute names.
  35594. */
  35595. getAttributesNames(): string[];
  35596. /**
  35597. * Returns the attribute at the given index.
  35598. * @param index The index of the attribute.
  35599. * @returns The location of the attribute.
  35600. */
  35601. getAttributeLocation(index: number): number;
  35602. /**
  35603. * Returns the attribute based on the name of the variable.
  35604. * @param name of the attribute to look up.
  35605. * @returns the attribute location.
  35606. */
  35607. getAttributeLocationByName(name: string): number;
  35608. /**
  35609. * The number of attributes.
  35610. * @returns the numnber of attributes.
  35611. */
  35612. getAttributesCount(): number;
  35613. /**
  35614. * Gets the index of a uniform variable.
  35615. * @param uniformName of the uniform to look up.
  35616. * @returns the index.
  35617. */
  35618. getUniformIndex(uniformName: string): number;
  35619. /**
  35620. * Returns the attribute based on the name of the variable.
  35621. * @param uniformName of the uniform to look up.
  35622. * @returns the location of the uniform.
  35623. */
  35624. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35625. /**
  35626. * Returns an array of sampler variable names
  35627. * @returns The array of sampler variable names.
  35628. */
  35629. getSamplers(): string[];
  35630. /**
  35631. * Returns an array of uniform variable names
  35632. * @returns The array of uniform variable names.
  35633. */
  35634. getUniformNames(): string[];
  35635. /**
  35636. * Returns an array of uniform buffer variable names
  35637. * @returns The array of uniform buffer variable names.
  35638. */
  35639. getUniformBuffersNames(): string[];
  35640. /**
  35641. * Returns the index parameters used to create the effect
  35642. * @returns The index parameters object
  35643. */
  35644. getIndexParameters(): any;
  35645. /**
  35646. * The error from the last compilation.
  35647. * @returns the error string.
  35648. */
  35649. getCompilationError(): string;
  35650. /**
  35651. * Gets a boolean indicating that all fallbacks were used during compilation
  35652. * @returns true if all fallbacks were used
  35653. */
  35654. allFallbacksProcessed(): boolean;
  35655. /**
  35656. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35657. * @param func The callback to be used.
  35658. */
  35659. executeWhenCompiled(func: (effect: Effect) => void): void;
  35660. private _checkIsReady;
  35661. private _loadShader;
  35662. /**
  35663. * Gets the vertex shader source code of this effect
  35664. */
  35665. get vertexSourceCode(): string;
  35666. /**
  35667. * Gets the fragment shader source code of this effect
  35668. */
  35669. get fragmentSourceCode(): string;
  35670. /**
  35671. * Recompiles the webGL program
  35672. * @param vertexSourceCode The source code for the vertex shader.
  35673. * @param fragmentSourceCode The source code for the fragment shader.
  35674. * @param onCompiled Callback called when completed.
  35675. * @param onError Callback called on error.
  35676. * @hidden
  35677. */
  35678. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35679. /**
  35680. * Prepares the effect
  35681. * @hidden
  35682. */
  35683. _prepareEffect(): void;
  35684. private _getShaderCodeAndErrorLine;
  35685. private _processCompilationErrors;
  35686. /**
  35687. * Checks if the effect is supported. (Must be called after compilation)
  35688. */
  35689. get isSupported(): boolean;
  35690. /**
  35691. * Binds a texture to the engine to be used as output of the shader.
  35692. * @param channel Name of the output variable.
  35693. * @param texture Texture to bind.
  35694. * @hidden
  35695. */
  35696. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35697. /**
  35698. * Sets a texture on the engine to be used in the shader.
  35699. * @param channel Name of the sampler variable.
  35700. * @param texture Texture to set.
  35701. */
  35702. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35703. /**
  35704. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35705. * @param channel Name of the sampler variable.
  35706. * @param texture Texture to set.
  35707. */
  35708. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35709. /**
  35710. * Sets an array of textures on the engine to be used in the shader.
  35711. * @param channel Name of the variable.
  35712. * @param textures Textures to set.
  35713. */
  35714. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35715. /**
  35716. * 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)
  35717. * @param channel Name of the sampler variable.
  35718. * @param postProcess Post process to get the input texture from.
  35719. */
  35720. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35721. /**
  35722. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35723. * 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)
  35724. * @param channel Name of the sampler variable.
  35725. * @param postProcess Post process to get the output texture from.
  35726. */
  35727. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35728. /** @hidden */
  35729. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35730. /** @hidden */
  35731. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35732. /** @hidden */
  35733. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35734. /** @hidden */
  35735. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35736. /**
  35737. * Binds a buffer to a uniform.
  35738. * @param buffer Buffer to bind.
  35739. * @param name Name of the uniform variable to bind to.
  35740. */
  35741. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35742. /**
  35743. * Binds block to a uniform.
  35744. * @param blockName Name of the block to bind.
  35745. * @param index Index to bind.
  35746. */
  35747. bindUniformBlock(blockName: string, index: number): void;
  35748. /**
  35749. * Sets an interger value on a uniform variable.
  35750. * @param uniformName Name of the variable.
  35751. * @param value Value to be set.
  35752. * @returns this effect.
  35753. */
  35754. setInt(uniformName: string, value: number): Effect;
  35755. /**
  35756. * Sets an int array on a uniform variable.
  35757. * @param uniformName Name of the variable.
  35758. * @param array array to be set.
  35759. * @returns this effect.
  35760. */
  35761. setIntArray(uniformName: string, array: Int32Array): Effect;
  35762. /**
  35763. * 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)
  35764. * @param uniformName Name of the variable.
  35765. * @param array array to be set.
  35766. * @returns this effect.
  35767. */
  35768. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35769. /**
  35770. * 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)
  35771. * @param uniformName Name of the variable.
  35772. * @param array array to be set.
  35773. * @returns this effect.
  35774. */
  35775. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35776. /**
  35777. * 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)
  35778. * @param uniformName Name of the variable.
  35779. * @param array array to be set.
  35780. * @returns this effect.
  35781. */
  35782. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35783. /**
  35784. * Sets an float array on a uniform variable.
  35785. * @param uniformName Name of the variable.
  35786. * @param array array to be set.
  35787. * @returns this effect.
  35788. */
  35789. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35790. /**
  35791. * 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)
  35792. * @param uniformName Name of the variable.
  35793. * @param array array to be set.
  35794. * @returns this effect.
  35795. */
  35796. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35797. /**
  35798. * 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)
  35799. * @param uniformName Name of the variable.
  35800. * @param array array to be set.
  35801. * @returns this effect.
  35802. */
  35803. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35804. /**
  35805. * 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)
  35806. * @param uniformName Name of the variable.
  35807. * @param array array to be set.
  35808. * @returns this effect.
  35809. */
  35810. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35811. /**
  35812. * Sets an array on a uniform variable.
  35813. * @param uniformName Name of the variable.
  35814. * @param array array to be set.
  35815. * @returns this effect.
  35816. */
  35817. setArray(uniformName: string, array: number[]): Effect;
  35818. /**
  35819. * 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)
  35820. * @param uniformName Name of the variable.
  35821. * @param array array to be set.
  35822. * @returns this effect.
  35823. */
  35824. setArray2(uniformName: string, array: number[]): Effect;
  35825. /**
  35826. * 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)
  35827. * @param uniformName Name of the variable.
  35828. * @param array array to be set.
  35829. * @returns this effect.
  35830. */
  35831. setArray3(uniformName: string, array: number[]): Effect;
  35832. /**
  35833. * 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)
  35834. * @param uniformName Name of the variable.
  35835. * @param array array to be set.
  35836. * @returns this effect.
  35837. */
  35838. setArray4(uniformName: string, array: number[]): Effect;
  35839. /**
  35840. * Sets matrices on a uniform variable.
  35841. * @param uniformName Name of the variable.
  35842. * @param matrices matrices to be set.
  35843. * @returns this effect.
  35844. */
  35845. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35846. /**
  35847. * Sets matrix on a uniform variable.
  35848. * @param uniformName Name of the variable.
  35849. * @param matrix matrix to be set.
  35850. * @returns this effect.
  35851. */
  35852. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35853. /**
  35854. * 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)
  35855. * @param uniformName Name of the variable.
  35856. * @param matrix matrix to be set.
  35857. * @returns this effect.
  35858. */
  35859. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35860. /**
  35861. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35862. * @param uniformName Name of the variable.
  35863. * @param matrix matrix to be set.
  35864. * @returns this effect.
  35865. */
  35866. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35867. /**
  35868. * Sets a float on a uniform variable.
  35869. * @param uniformName Name of the variable.
  35870. * @param value value to be set.
  35871. * @returns this effect.
  35872. */
  35873. setFloat(uniformName: string, value: number): Effect;
  35874. /**
  35875. * Sets a boolean on a uniform variable.
  35876. * @param uniformName Name of the variable.
  35877. * @param bool value to be set.
  35878. * @returns this effect.
  35879. */
  35880. setBool(uniformName: string, bool: boolean): Effect;
  35881. /**
  35882. * Sets a Vector2 on a uniform variable.
  35883. * @param uniformName Name of the variable.
  35884. * @param vector2 vector2 to be set.
  35885. * @returns this effect.
  35886. */
  35887. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35888. /**
  35889. * Sets a float2 on a uniform variable.
  35890. * @param uniformName Name of the variable.
  35891. * @param x First float in float2.
  35892. * @param y Second float in float2.
  35893. * @returns this effect.
  35894. */
  35895. setFloat2(uniformName: string, x: number, y: number): Effect;
  35896. /**
  35897. * Sets a Vector3 on a uniform variable.
  35898. * @param uniformName Name of the variable.
  35899. * @param vector3 Value to be set.
  35900. * @returns this effect.
  35901. */
  35902. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35903. /**
  35904. * Sets a float3 on a uniform variable.
  35905. * @param uniformName Name of the variable.
  35906. * @param x First float in float3.
  35907. * @param y Second float in float3.
  35908. * @param z Third float in float3.
  35909. * @returns this effect.
  35910. */
  35911. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35912. /**
  35913. * Sets a Vector4 on a uniform variable.
  35914. * @param uniformName Name of the variable.
  35915. * @param vector4 Value to be set.
  35916. * @returns this effect.
  35917. */
  35918. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35919. /**
  35920. * Sets a float4 on a uniform variable.
  35921. * @param uniformName Name of the variable.
  35922. * @param x First float in float4.
  35923. * @param y Second float in float4.
  35924. * @param z Third float in float4.
  35925. * @param w Fourth float in float4.
  35926. * @returns this effect.
  35927. */
  35928. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35929. /**
  35930. * Sets a Color3 on a uniform variable.
  35931. * @param uniformName Name of the variable.
  35932. * @param color3 Value to be set.
  35933. * @returns this effect.
  35934. */
  35935. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35936. /**
  35937. * Sets a Color4 on a uniform variable.
  35938. * @param uniformName Name of the variable.
  35939. * @param color3 Value to be set.
  35940. * @param alpha Alpha value to be set.
  35941. * @returns this effect.
  35942. */
  35943. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35944. /**
  35945. * Sets a Color4 on a uniform variable
  35946. * @param uniformName defines the name of the variable
  35947. * @param color4 defines the value to be set
  35948. * @returns this effect.
  35949. */
  35950. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35951. /** Release all associated resources */
  35952. dispose(): void;
  35953. /**
  35954. * This function will add a new shader to the shader store
  35955. * @param name the name of the shader
  35956. * @param pixelShader optional pixel shader content
  35957. * @param vertexShader optional vertex shader content
  35958. */
  35959. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35960. /**
  35961. * Store of each shader (The can be looked up using effect.key)
  35962. */
  35963. static ShadersStore: {
  35964. [key: string]: string;
  35965. };
  35966. /**
  35967. * Store of each included file for a shader (The can be looked up using effect.key)
  35968. */
  35969. static IncludesShadersStore: {
  35970. [key: string]: string;
  35971. };
  35972. /**
  35973. * Resets the cache of effects.
  35974. */
  35975. static ResetCache(): void;
  35976. }
  35977. }
  35978. declare module "babylonjs/Engines/engineCapabilities" {
  35979. /**
  35980. * Interface used to describe the capabilities of the engine relatively to the current browser
  35981. */
  35982. export interface EngineCapabilities {
  35983. /** Maximum textures units per fragment shader */
  35984. maxTexturesImageUnits: number;
  35985. /** Maximum texture units per vertex shader */
  35986. maxVertexTextureImageUnits: number;
  35987. /** Maximum textures units in the entire pipeline */
  35988. maxCombinedTexturesImageUnits: number;
  35989. /** Maximum texture size */
  35990. maxTextureSize: number;
  35991. /** Maximum texture samples */
  35992. maxSamples?: number;
  35993. /** Maximum cube texture size */
  35994. maxCubemapTextureSize: number;
  35995. /** Maximum render texture size */
  35996. maxRenderTextureSize: number;
  35997. /** Maximum number of vertex attributes */
  35998. maxVertexAttribs: number;
  35999. /** Maximum number of varyings */
  36000. maxVaryingVectors: number;
  36001. /** Maximum number of uniforms per vertex shader */
  36002. maxVertexUniformVectors: number;
  36003. /** Maximum number of uniforms per fragment shader */
  36004. maxFragmentUniformVectors: number;
  36005. /** Defines if standard derivates (dx/dy) are supported */
  36006. standardDerivatives: boolean;
  36007. /** Defines if s3tc texture compression is supported */
  36008. s3tc?: WEBGL_compressed_texture_s3tc;
  36009. /** Defines if pvrtc texture compression is supported */
  36010. pvrtc: any;
  36011. /** Defines if etc1 texture compression is supported */
  36012. etc1: any;
  36013. /** Defines if etc2 texture compression is supported */
  36014. etc2: any;
  36015. /** Defines if astc texture compression is supported */
  36016. astc: any;
  36017. /** Defines if float textures are supported */
  36018. textureFloat: boolean;
  36019. /** Defines if vertex array objects are supported */
  36020. vertexArrayObject: boolean;
  36021. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36022. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36023. /** Gets the maximum level of anisotropy supported */
  36024. maxAnisotropy: number;
  36025. /** Defines if instancing is supported */
  36026. instancedArrays: boolean;
  36027. /** Defines if 32 bits indices are supported */
  36028. uintIndices: boolean;
  36029. /** Defines if high precision shaders are supported */
  36030. highPrecisionShaderSupported: boolean;
  36031. /** Defines if depth reading in the fragment shader is supported */
  36032. fragmentDepthSupported: boolean;
  36033. /** Defines if float texture linear filtering is supported*/
  36034. textureFloatLinearFiltering: boolean;
  36035. /** Defines if rendering to float textures is supported */
  36036. textureFloatRender: boolean;
  36037. /** Defines if half float textures are supported*/
  36038. textureHalfFloat: boolean;
  36039. /** Defines if half float texture linear filtering is supported*/
  36040. textureHalfFloatLinearFiltering: boolean;
  36041. /** Defines if rendering to half float textures is supported */
  36042. textureHalfFloatRender: boolean;
  36043. /** Defines if textureLOD shader command is supported */
  36044. textureLOD: boolean;
  36045. /** Defines if draw buffers extension is supported */
  36046. drawBuffersExtension: boolean;
  36047. /** Defines if depth textures are supported */
  36048. depthTextureExtension: boolean;
  36049. /** Defines if float color buffer are supported */
  36050. colorBufferFloat: boolean;
  36051. /** Gets disjoint timer query extension (null if not supported) */
  36052. timerQuery?: EXT_disjoint_timer_query;
  36053. /** Defines if timestamp can be used with timer query */
  36054. canUseTimestampForTimerQuery: boolean;
  36055. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36056. multiview?: any;
  36057. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36058. oculusMultiview?: any;
  36059. /** Function used to let the system compiles shaders in background */
  36060. parallelShaderCompile?: {
  36061. COMPLETION_STATUS_KHR: number;
  36062. };
  36063. /** Max number of texture samples for MSAA */
  36064. maxMSAASamples: number;
  36065. /** Defines if the blend min max extension is supported */
  36066. blendMinMax: boolean;
  36067. }
  36068. }
  36069. declare module "babylonjs/States/depthCullingState" {
  36070. import { Nullable } from "babylonjs/types";
  36071. /**
  36072. * @hidden
  36073. **/
  36074. export class DepthCullingState {
  36075. private _isDepthTestDirty;
  36076. private _isDepthMaskDirty;
  36077. private _isDepthFuncDirty;
  36078. private _isCullFaceDirty;
  36079. private _isCullDirty;
  36080. private _isZOffsetDirty;
  36081. private _isFrontFaceDirty;
  36082. private _depthTest;
  36083. private _depthMask;
  36084. private _depthFunc;
  36085. private _cull;
  36086. private _cullFace;
  36087. private _zOffset;
  36088. private _frontFace;
  36089. /**
  36090. * Initializes the state.
  36091. */
  36092. constructor();
  36093. get isDirty(): boolean;
  36094. get zOffset(): number;
  36095. set zOffset(value: number);
  36096. get cullFace(): Nullable<number>;
  36097. set cullFace(value: Nullable<number>);
  36098. get cull(): Nullable<boolean>;
  36099. set cull(value: Nullable<boolean>);
  36100. get depthFunc(): Nullable<number>;
  36101. set depthFunc(value: Nullable<number>);
  36102. get depthMask(): boolean;
  36103. set depthMask(value: boolean);
  36104. get depthTest(): boolean;
  36105. set depthTest(value: boolean);
  36106. get frontFace(): Nullable<number>;
  36107. set frontFace(value: Nullable<number>);
  36108. reset(): void;
  36109. apply(gl: WebGLRenderingContext): void;
  36110. }
  36111. }
  36112. declare module "babylonjs/States/stencilState" {
  36113. /**
  36114. * @hidden
  36115. **/
  36116. export class StencilState {
  36117. /** 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 */
  36118. static readonly ALWAYS: number;
  36119. /** Passed to stencilOperation to specify that stencil value must be kept */
  36120. static readonly KEEP: number;
  36121. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36122. static readonly REPLACE: number;
  36123. private _isStencilTestDirty;
  36124. private _isStencilMaskDirty;
  36125. private _isStencilFuncDirty;
  36126. private _isStencilOpDirty;
  36127. private _stencilTest;
  36128. private _stencilMask;
  36129. private _stencilFunc;
  36130. private _stencilFuncRef;
  36131. private _stencilFuncMask;
  36132. private _stencilOpStencilFail;
  36133. private _stencilOpDepthFail;
  36134. private _stencilOpStencilDepthPass;
  36135. get isDirty(): boolean;
  36136. get stencilFunc(): number;
  36137. set stencilFunc(value: number);
  36138. get stencilFuncRef(): number;
  36139. set stencilFuncRef(value: number);
  36140. get stencilFuncMask(): number;
  36141. set stencilFuncMask(value: number);
  36142. get stencilOpStencilFail(): number;
  36143. set stencilOpStencilFail(value: number);
  36144. get stencilOpDepthFail(): number;
  36145. set stencilOpDepthFail(value: number);
  36146. get stencilOpStencilDepthPass(): number;
  36147. set stencilOpStencilDepthPass(value: number);
  36148. get stencilMask(): number;
  36149. set stencilMask(value: number);
  36150. get stencilTest(): boolean;
  36151. set stencilTest(value: boolean);
  36152. constructor();
  36153. reset(): void;
  36154. apply(gl: WebGLRenderingContext): void;
  36155. }
  36156. }
  36157. declare module "babylonjs/States/alphaCullingState" {
  36158. /**
  36159. * @hidden
  36160. **/
  36161. export class AlphaState {
  36162. private _isAlphaBlendDirty;
  36163. private _isBlendFunctionParametersDirty;
  36164. private _isBlendEquationParametersDirty;
  36165. private _isBlendConstantsDirty;
  36166. private _alphaBlend;
  36167. private _blendFunctionParameters;
  36168. private _blendEquationParameters;
  36169. private _blendConstants;
  36170. /**
  36171. * Initializes the state.
  36172. */
  36173. constructor();
  36174. get isDirty(): boolean;
  36175. get alphaBlend(): boolean;
  36176. set alphaBlend(value: boolean);
  36177. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36178. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36179. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36180. reset(): void;
  36181. apply(gl: WebGLRenderingContext): void;
  36182. }
  36183. }
  36184. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36185. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36186. /** @hidden */
  36187. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36188. attributeProcessor(attribute: string): string;
  36189. varyingProcessor(varying: string, isFragment: boolean): string;
  36190. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36191. }
  36192. }
  36193. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36194. /**
  36195. * Interface for attribute information associated with buffer instanciation
  36196. */
  36197. export interface InstancingAttributeInfo {
  36198. /**
  36199. * Name of the GLSL attribute
  36200. * if attribute index is not specified, this is used to retrieve the index from the effect
  36201. */
  36202. attributeName: string;
  36203. /**
  36204. * Index/offset of the attribute in the vertex shader
  36205. * if not specified, this will be computes from the name.
  36206. */
  36207. index?: number;
  36208. /**
  36209. * size of the attribute, 1, 2, 3 or 4
  36210. */
  36211. attributeSize: number;
  36212. /**
  36213. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36214. */
  36215. offset: number;
  36216. /**
  36217. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36218. * default to 1
  36219. */
  36220. divisor?: number;
  36221. /**
  36222. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36223. * default is FLOAT
  36224. */
  36225. attributeType?: number;
  36226. /**
  36227. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36228. */
  36229. normalized?: boolean;
  36230. }
  36231. }
  36232. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36233. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36234. import { Nullable } from "babylonjs/types";
  36235. module "babylonjs/Engines/thinEngine" {
  36236. interface ThinEngine {
  36237. /**
  36238. * Update a video texture
  36239. * @param texture defines the texture to update
  36240. * @param video defines the video element to use
  36241. * @param invertY defines if data must be stored with Y axis inverted
  36242. */
  36243. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36244. }
  36245. }
  36246. }
  36247. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36248. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36249. import { Nullable } from "babylonjs/types";
  36250. module "babylonjs/Engines/thinEngine" {
  36251. interface ThinEngine {
  36252. /**
  36253. * Creates a dynamic texture
  36254. * @param width defines the width of the texture
  36255. * @param height defines the height of the texture
  36256. * @param generateMipMaps defines if the engine should generate the mip levels
  36257. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36258. * @returns the dynamic texture inside an InternalTexture
  36259. */
  36260. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36261. /**
  36262. * Update the content of a dynamic texture
  36263. * @param texture defines the texture to update
  36264. * @param canvas defines the canvas containing the source
  36265. * @param invertY defines if data must be stored with Y axis inverted
  36266. * @param premulAlpha defines if alpha is stored as premultiplied
  36267. * @param format defines the format of the data
  36268. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36269. */
  36270. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36271. }
  36272. }
  36273. }
  36274. declare module "babylonjs/Materials/Textures/videoTexture" {
  36275. import { Observable } from "babylonjs/Misc/observable";
  36276. import { Nullable } from "babylonjs/types";
  36277. import { Scene } from "babylonjs/scene";
  36278. import { Texture } from "babylonjs/Materials/Textures/texture";
  36279. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36280. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36281. /**
  36282. * Settings for finer control over video usage
  36283. */
  36284. export interface VideoTextureSettings {
  36285. /**
  36286. * Applies `autoplay` to video, if specified
  36287. */
  36288. autoPlay?: boolean;
  36289. /**
  36290. * Applies `loop` to video, if specified
  36291. */
  36292. loop?: boolean;
  36293. /**
  36294. * Automatically updates internal texture from video at every frame in the render loop
  36295. */
  36296. autoUpdateTexture: boolean;
  36297. /**
  36298. * Image src displayed during the video loading or until the user interacts with the video.
  36299. */
  36300. poster?: string;
  36301. }
  36302. /**
  36303. * If you want to display a video in your scene, this is the special texture for that.
  36304. * This special texture works similar to other textures, with the exception of a few parameters.
  36305. * @see https://doc.babylonjs.com/how_to/video_texture
  36306. */
  36307. export class VideoTexture extends Texture {
  36308. /**
  36309. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36310. */
  36311. readonly autoUpdateTexture: boolean;
  36312. /**
  36313. * The video instance used by the texture internally
  36314. */
  36315. readonly video: HTMLVideoElement;
  36316. private _onUserActionRequestedObservable;
  36317. /**
  36318. * Event triggerd when a dom action is required by the user to play the video.
  36319. * This happens due to recent changes in browser policies preventing video to auto start.
  36320. */
  36321. get onUserActionRequestedObservable(): Observable<Texture>;
  36322. private _generateMipMaps;
  36323. private _stillImageCaptured;
  36324. private _displayingPosterTexture;
  36325. private _settings;
  36326. private _createInternalTextureOnEvent;
  36327. private _frameId;
  36328. private _currentSrc;
  36329. /**
  36330. * Creates a video texture.
  36331. * If you want to display a video in your scene, this is the special texture for that.
  36332. * This special texture works similar to other textures, with the exception of a few parameters.
  36333. * @see https://doc.babylonjs.com/how_to/video_texture
  36334. * @param name optional name, will detect from video source, if not defined
  36335. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36336. * @param scene is obviously the current scene.
  36337. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36338. * @param invertY is false by default but can be used to invert video on Y axis
  36339. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36340. * @param settings allows finer control over video usage
  36341. */
  36342. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36343. private _getName;
  36344. private _getVideo;
  36345. private _createInternalTexture;
  36346. private reset;
  36347. /**
  36348. * @hidden Internal method to initiate `update`.
  36349. */
  36350. _rebuild(): void;
  36351. /**
  36352. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36353. */
  36354. update(): void;
  36355. /**
  36356. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36357. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36358. */
  36359. updateTexture(isVisible: boolean): void;
  36360. protected _updateInternalTexture: () => void;
  36361. /**
  36362. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36363. * @param url New url.
  36364. */
  36365. updateURL(url: string): void;
  36366. /**
  36367. * Clones the texture.
  36368. * @returns the cloned texture
  36369. */
  36370. clone(): VideoTexture;
  36371. /**
  36372. * Dispose the texture and release its associated resources.
  36373. */
  36374. dispose(): void;
  36375. /**
  36376. * Creates a video texture straight from a stream.
  36377. * @param scene Define the scene the texture should be created in
  36378. * @param stream Define the stream the texture should be created from
  36379. * @returns The created video texture as a promise
  36380. */
  36381. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36382. /**
  36383. * Creates a video texture straight from your WebCam video feed.
  36384. * @param scene Define the scene the texture should be created in
  36385. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36386. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36387. * @returns The created video texture as a promise
  36388. */
  36389. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36390. minWidth: number;
  36391. maxWidth: number;
  36392. minHeight: number;
  36393. maxHeight: number;
  36394. deviceId: string;
  36395. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36396. /**
  36397. * Creates a video texture straight from your WebCam video feed.
  36398. * @param scene Define the scene the texture should be created in
  36399. * @param onReady Define a callback to triggered once the texture will be ready
  36400. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36401. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36402. */
  36403. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36404. minWidth: number;
  36405. maxWidth: number;
  36406. minHeight: number;
  36407. maxHeight: number;
  36408. deviceId: string;
  36409. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36410. }
  36411. }
  36412. declare module "babylonjs/Engines/thinEngine" {
  36413. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36414. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36415. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36416. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36417. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36418. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36419. import { Observable } from "babylonjs/Misc/observable";
  36420. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36421. import { StencilState } from "babylonjs/States/stencilState";
  36422. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36423. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36424. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36425. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36426. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36427. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36428. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36429. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36430. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36431. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36432. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36433. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36434. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36435. import { WebRequest } from "babylonjs/Misc/webRequest";
  36436. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36437. /**
  36438. * Defines the interface used by objects working like Scene
  36439. * @hidden
  36440. */
  36441. export interface ISceneLike {
  36442. _addPendingData(data: any): void;
  36443. _removePendingData(data: any): void;
  36444. offlineProvider: IOfflineProvider;
  36445. }
  36446. /**
  36447. * Information about the current host
  36448. */
  36449. export interface HostInformation {
  36450. /**
  36451. * Defines if the current host is a mobile
  36452. */
  36453. isMobile: boolean;
  36454. }
  36455. /** Interface defining initialization parameters for Engine class */
  36456. export interface EngineOptions extends WebGLContextAttributes {
  36457. /**
  36458. * Defines if the engine should no exceed a specified device ratio
  36459. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36460. */
  36461. limitDeviceRatio?: number;
  36462. /**
  36463. * Defines if webvr should be enabled automatically
  36464. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36465. */
  36466. autoEnableWebVR?: boolean;
  36467. /**
  36468. * Defines if webgl2 should be turned off even if supported
  36469. * @see https://doc.babylonjs.com/features/webgl2
  36470. */
  36471. disableWebGL2Support?: boolean;
  36472. /**
  36473. * Defines if webaudio should be initialized as well
  36474. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36475. */
  36476. audioEngine?: boolean;
  36477. /**
  36478. * Defines if animations should run using a deterministic lock step
  36479. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36480. */
  36481. deterministicLockstep?: boolean;
  36482. /** Defines the maximum steps to use with deterministic lock step mode */
  36483. lockstepMaxSteps?: number;
  36484. /** Defines the seconds between each deterministic lock step */
  36485. timeStep?: number;
  36486. /**
  36487. * Defines that engine should ignore context lost events
  36488. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36489. */
  36490. doNotHandleContextLost?: boolean;
  36491. /**
  36492. * Defines that engine should ignore modifying touch action attribute and style
  36493. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36494. */
  36495. doNotHandleTouchAction?: boolean;
  36496. /**
  36497. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36498. */
  36499. useHighPrecisionFloats?: boolean;
  36500. /**
  36501. * Make the canvas XR Compatible for XR sessions
  36502. */
  36503. xrCompatible?: boolean;
  36504. /**
  36505. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36506. */
  36507. useHighPrecisionMatrix?: boolean;
  36508. }
  36509. /**
  36510. * The base engine class (root of all engines)
  36511. */
  36512. export class ThinEngine {
  36513. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36514. static ExceptionList: ({
  36515. key: string;
  36516. capture: string;
  36517. captureConstraint: number;
  36518. targets: string[];
  36519. } | {
  36520. key: string;
  36521. capture: null;
  36522. captureConstraint: null;
  36523. targets: string[];
  36524. })[];
  36525. /** @hidden */
  36526. static _TextureLoaders: IInternalTextureLoader[];
  36527. /**
  36528. * Returns the current npm package of the sdk
  36529. */
  36530. static get NpmPackage(): string;
  36531. /**
  36532. * Returns the current version of the framework
  36533. */
  36534. static get Version(): string;
  36535. /**
  36536. * Returns a string describing the current engine
  36537. */
  36538. get description(): string;
  36539. /**
  36540. * Gets or sets the epsilon value used by collision engine
  36541. */
  36542. static CollisionsEpsilon: number;
  36543. /**
  36544. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36545. */
  36546. static get ShadersRepository(): string;
  36547. static set ShadersRepository(value: string);
  36548. /** @hidden */
  36549. _shaderProcessor: IShaderProcessor;
  36550. /**
  36551. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36552. */
  36553. forcePOTTextures: boolean;
  36554. /**
  36555. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36556. */
  36557. isFullscreen: boolean;
  36558. /**
  36559. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36560. */
  36561. cullBackFaces: boolean;
  36562. /**
  36563. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36564. */
  36565. renderEvenInBackground: boolean;
  36566. /**
  36567. * Gets or sets a boolean indicating that cache can be kept between frames
  36568. */
  36569. preventCacheWipeBetweenFrames: boolean;
  36570. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36571. validateShaderPrograms: boolean;
  36572. /**
  36573. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36574. * This can provide greater z depth for distant objects.
  36575. */
  36576. useReverseDepthBuffer: boolean;
  36577. /**
  36578. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36579. */
  36580. disableUniformBuffers: boolean;
  36581. /** @hidden */
  36582. _uniformBuffers: UniformBuffer[];
  36583. /**
  36584. * Gets a boolean indicating that the engine supports uniform buffers
  36585. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36586. */
  36587. get supportsUniformBuffers(): boolean;
  36588. /** @hidden */
  36589. _gl: WebGLRenderingContext;
  36590. /** @hidden */
  36591. _webGLVersion: number;
  36592. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36593. protected _windowIsBackground: boolean;
  36594. protected _creationOptions: EngineOptions;
  36595. protected _highPrecisionShadersAllowed: boolean;
  36596. /** @hidden */
  36597. get _shouldUseHighPrecisionShader(): boolean;
  36598. /**
  36599. * Gets a boolean indicating that only power of 2 textures are supported
  36600. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36601. */
  36602. get needPOTTextures(): boolean;
  36603. /** @hidden */
  36604. _badOS: boolean;
  36605. /** @hidden */
  36606. _badDesktopOS: boolean;
  36607. private _hardwareScalingLevel;
  36608. /** @hidden */
  36609. _caps: EngineCapabilities;
  36610. private _isStencilEnable;
  36611. private _glVersion;
  36612. private _glRenderer;
  36613. private _glVendor;
  36614. /** @hidden */
  36615. _videoTextureSupported: boolean;
  36616. protected _renderingQueueLaunched: boolean;
  36617. protected _activeRenderLoops: (() => void)[];
  36618. /**
  36619. * Observable signaled when a context lost event is raised
  36620. */
  36621. onContextLostObservable: Observable<ThinEngine>;
  36622. /**
  36623. * Observable signaled when a context restored event is raised
  36624. */
  36625. onContextRestoredObservable: Observable<ThinEngine>;
  36626. private _onContextLost;
  36627. private _onContextRestored;
  36628. protected _contextWasLost: boolean;
  36629. /** @hidden */
  36630. _doNotHandleContextLost: boolean;
  36631. /**
  36632. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36633. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36634. */
  36635. get doNotHandleContextLost(): boolean;
  36636. set doNotHandleContextLost(value: boolean);
  36637. /**
  36638. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36639. */
  36640. disableVertexArrayObjects: boolean;
  36641. /** @hidden */
  36642. protected _colorWrite: boolean;
  36643. /** @hidden */
  36644. protected _colorWriteChanged: boolean;
  36645. /** @hidden */
  36646. protected _depthCullingState: DepthCullingState;
  36647. /** @hidden */
  36648. protected _stencilState: StencilState;
  36649. /** @hidden */
  36650. _alphaState: AlphaState;
  36651. /** @hidden */
  36652. _alphaMode: number;
  36653. /** @hidden */
  36654. _alphaEquation: number;
  36655. /** @hidden */
  36656. _internalTexturesCache: InternalTexture[];
  36657. /** @hidden */
  36658. protected _activeChannel: number;
  36659. private _currentTextureChannel;
  36660. /** @hidden */
  36661. protected _boundTexturesCache: {
  36662. [key: string]: Nullable<InternalTexture>;
  36663. };
  36664. /** @hidden */
  36665. protected _currentEffect: Nullable<Effect>;
  36666. /** @hidden */
  36667. protected _currentProgram: Nullable<WebGLProgram>;
  36668. private _compiledEffects;
  36669. private _vertexAttribArraysEnabled;
  36670. /** @hidden */
  36671. protected _cachedViewport: Nullable<IViewportLike>;
  36672. private _cachedVertexArrayObject;
  36673. /** @hidden */
  36674. protected _cachedVertexBuffers: any;
  36675. /** @hidden */
  36676. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36677. /** @hidden */
  36678. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36679. /** @hidden */
  36680. _currentRenderTarget: Nullable<InternalTexture>;
  36681. private _uintIndicesCurrentlySet;
  36682. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36683. /** @hidden */
  36684. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36685. /** @hidden */
  36686. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36687. private _currentBufferPointers;
  36688. private _currentInstanceLocations;
  36689. private _currentInstanceBuffers;
  36690. private _textureUnits;
  36691. /** @hidden */
  36692. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36693. /** @hidden */
  36694. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36695. /** @hidden */
  36696. _boundRenderFunction: any;
  36697. private _vaoRecordInProgress;
  36698. private _mustWipeVertexAttributes;
  36699. private _emptyTexture;
  36700. private _emptyCubeTexture;
  36701. private _emptyTexture3D;
  36702. private _emptyTexture2DArray;
  36703. /** @hidden */
  36704. _frameHandler: number;
  36705. private _nextFreeTextureSlots;
  36706. private _maxSimultaneousTextures;
  36707. private _activeRequests;
  36708. /** @hidden */
  36709. _transformTextureUrl: Nullable<(url: string) => string>;
  36710. /**
  36711. * Gets information about the current host
  36712. */
  36713. hostInformation: HostInformation;
  36714. protected get _supportsHardwareTextureRescaling(): boolean;
  36715. private _framebufferDimensionsObject;
  36716. /**
  36717. * sets the object from which width and height will be taken from when getting render width and height
  36718. * Will fallback to the gl object
  36719. * @param dimensions the framebuffer width and height that will be used.
  36720. */
  36721. set framebufferDimensionsObject(dimensions: Nullable<{
  36722. framebufferWidth: number;
  36723. framebufferHeight: number;
  36724. }>);
  36725. /**
  36726. * Gets the current viewport
  36727. */
  36728. get currentViewport(): Nullable<IViewportLike>;
  36729. /**
  36730. * Gets the default empty texture
  36731. */
  36732. get emptyTexture(): InternalTexture;
  36733. /**
  36734. * Gets the default empty 3D texture
  36735. */
  36736. get emptyTexture3D(): InternalTexture;
  36737. /**
  36738. * Gets the default empty 2D array texture
  36739. */
  36740. get emptyTexture2DArray(): InternalTexture;
  36741. /**
  36742. * Gets the default empty cube texture
  36743. */
  36744. get emptyCubeTexture(): InternalTexture;
  36745. /**
  36746. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36747. */
  36748. readonly premultipliedAlpha: boolean;
  36749. /**
  36750. * Observable event triggered before each texture is initialized
  36751. */
  36752. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36753. /**
  36754. * Creates a new engine
  36755. * @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
  36756. * @param antialias defines enable antialiasing (default: false)
  36757. * @param options defines further options to be sent to the getContext() function
  36758. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36759. */
  36760. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36761. private _rebuildInternalTextures;
  36762. private _rebuildEffects;
  36763. /**
  36764. * Gets a boolean indicating if all created effects are ready
  36765. * @returns true if all effects are ready
  36766. */
  36767. areAllEffectsReady(): boolean;
  36768. protected _rebuildBuffers(): void;
  36769. protected _initGLContext(): void;
  36770. /**
  36771. * Gets version of the current webGL context
  36772. */
  36773. get webGLVersion(): number;
  36774. /**
  36775. * Gets a string identifying the name of the class
  36776. * @returns "Engine" string
  36777. */
  36778. getClassName(): string;
  36779. /**
  36780. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36781. */
  36782. get isStencilEnable(): boolean;
  36783. /** @hidden */
  36784. _prepareWorkingCanvas(): void;
  36785. /**
  36786. * Reset the texture cache to empty state
  36787. */
  36788. resetTextureCache(): void;
  36789. /**
  36790. * Gets an object containing information about the current webGL context
  36791. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36792. */
  36793. getGlInfo(): {
  36794. vendor: string;
  36795. renderer: string;
  36796. version: string;
  36797. };
  36798. /**
  36799. * Defines the hardware scaling level.
  36800. * By default the hardware scaling level is computed from the window device ratio.
  36801. * 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.
  36802. * @param level defines the level to use
  36803. */
  36804. setHardwareScalingLevel(level: number): void;
  36805. /**
  36806. * Gets the current hardware scaling level.
  36807. * By default the hardware scaling level is computed from the window device ratio.
  36808. * 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.
  36809. * @returns a number indicating the current hardware scaling level
  36810. */
  36811. getHardwareScalingLevel(): number;
  36812. /**
  36813. * Gets the list of loaded textures
  36814. * @returns an array containing all loaded textures
  36815. */
  36816. getLoadedTexturesCache(): InternalTexture[];
  36817. /**
  36818. * Gets the object containing all engine capabilities
  36819. * @returns the EngineCapabilities object
  36820. */
  36821. getCaps(): EngineCapabilities;
  36822. /**
  36823. * stop executing a render loop function and remove it from the execution array
  36824. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36825. */
  36826. stopRenderLoop(renderFunction?: () => void): void;
  36827. /** @hidden */
  36828. _renderLoop(): void;
  36829. /**
  36830. * Gets the HTML canvas attached with the current webGL context
  36831. * @returns a HTML canvas
  36832. */
  36833. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36834. /**
  36835. * Gets host window
  36836. * @returns the host window object
  36837. */
  36838. getHostWindow(): Nullable<Window>;
  36839. /**
  36840. * Gets the current render width
  36841. * @param useScreen defines if screen size must be used (or the current render target if any)
  36842. * @returns a number defining the current render width
  36843. */
  36844. getRenderWidth(useScreen?: boolean): number;
  36845. /**
  36846. * Gets the current render height
  36847. * @param useScreen defines if screen size must be used (or the current render target if any)
  36848. * @returns a number defining the current render height
  36849. */
  36850. getRenderHeight(useScreen?: boolean): number;
  36851. /**
  36852. * Can be used to override the current requestAnimationFrame requester.
  36853. * @hidden
  36854. */
  36855. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36856. /**
  36857. * Register and execute a render loop. The engine can have more than one render function
  36858. * @param renderFunction defines the function to continuously execute
  36859. */
  36860. runRenderLoop(renderFunction: () => void): void;
  36861. /**
  36862. * Clear the current render buffer or the current render target (if any is set up)
  36863. * @param color defines the color to use
  36864. * @param backBuffer defines if the back buffer must be cleared
  36865. * @param depth defines if the depth buffer must be cleared
  36866. * @param stencil defines if the stencil buffer must be cleared
  36867. */
  36868. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36869. private _viewportCached;
  36870. /** @hidden */
  36871. _viewport(x: number, y: number, width: number, height: number): void;
  36872. /**
  36873. * Set the WebGL's viewport
  36874. * @param viewport defines the viewport element to be used
  36875. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36876. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36877. */
  36878. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36879. /**
  36880. * Begin a new frame
  36881. */
  36882. beginFrame(): void;
  36883. /**
  36884. * Enf the current frame
  36885. */
  36886. endFrame(): void;
  36887. /**
  36888. * Resize the view according to the canvas' size
  36889. */
  36890. resize(): void;
  36891. /**
  36892. * Force a specific size of the canvas
  36893. * @param width defines the new canvas' width
  36894. * @param height defines the new canvas' height
  36895. * @returns true if the size was changed
  36896. */
  36897. setSize(width: number, height: number): boolean;
  36898. /**
  36899. * Binds the frame buffer to the specified texture.
  36900. * @param texture The texture to render to or null for the default canvas
  36901. * @param faceIndex The face of the texture to render to in case of cube texture
  36902. * @param requiredWidth The width of the target to render to
  36903. * @param requiredHeight The height of the target to render to
  36904. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36905. * @param lodLevel defines the lod level to bind to the frame buffer
  36906. * @param layer defines the 2d array index to bind to frame buffer to
  36907. */
  36908. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36909. /** @hidden */
  36910. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36911. /**
  36912. * Unbind the current render target texture from the webGL context
  36913. * @param texture defines the render target texture to unbind
  36914. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36915. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36916. */
  36917. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36918. /**
  36919. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36920. */
  36921. flushFramebuffer(): void;
  36922. /**
  36923. * Unbind the current render target and bind the default framebuffer
  36924. */
  36925. restoreDefaultFramebuffer(): void;
  36926. /** @hidden */
  36927. protected _resetVertexBufferBinding(): void;
  36928. /**
  36929. * Creates a vertex buffer
  36930. * @param data the data for the vertex buffer
  36931. * @returns the new WebGL static buffer
  36932. */
  36933. createVertexBuffer(data: DataArray): DataBuffer;
  36934. private _createVertexBuffer;
  36935. /**
  36936. * Creates a dynamic vertex buffer
  36937. * @param data the data for the dynamic vertex buffer
  36938. * @returns the new WebGL dynamic buffer
  36939. */
  36940. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36941. protected _resetIndexBufferBinding(): void;
  36942. /**
  36943. * Creates a new index buffer
  36944. * @param indices defines the content of the index buffer
  36945. * @param updatable defines if the index buffer must be updatable
  36946. * @returns a new webGL buffer
  36947. */
  36948. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36949. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36950. /**
  36951. * Bind a webGL buffer to the webGL context
  36952. * @param buffer defines the buffer to bind
  36953. */
  36954. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36955. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36956. private bindBuffer;
  36957. /**
  36958. * update the bound buffer with the given data
  36959. * @param data defines the data to update
  36960. */
  36961. updateArrayBuffer(data: Float32Array): void;
  36962. private _vertexAttribPointer;
  36963. /** @hidden */
  36964. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36965. private _bindVertexBuffersAttributes;
  36966. /**
  36967. * Records a vertex array object
  36968. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36969. * @param vertexBuffers defines the list of vertex buffers to store
  36970. * @param indexBuffer defines the index buffer to store
  36971. * @param effect defines the effect to store
  36972. * @returns the new vertex array object
  36973. */
  36974. recordVertexArrayObject(vertexBuffers: {
  36975. [key: string]: VertexBuffer;
  36976. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36977. /**
  36978. * Bind a specific vertex array object
  36979. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36980. * @param vertexArrayObject defines the vertex array object to bind
  36981. * @param indexBuffer defines the index buffer to bind
  36982. */
  36983. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36984. /**
  36985. * Bind webGl buffers directly to the webGL context
  36986. * @param vertexBuffer defines the vertex buffer to bind
  36987. * @param indexBuffer defines the index buffer to bind
  36988. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36989. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36990. * @param effect defines the effect associated with the vertex buffer
  36991. */
  36992. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36993. private _unbindVertexArrayObject;
  36994. /**
  36995. * Bind a list of vertex buffers to the webGL context
  36996. * @param vertexBuffers defines the list of vertex buffers to bind
  36997. * @param indexBuffer defines the index buffer to bind
  36998. * @param effect defines the effect associated with the vertex buffers
  36999. */
  37000. bindBuffers(vertexBuffers: {
  37001. [key: string]: Nullable<VertexBuffer>;
  37002. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37003. /**
  37004. * Unbind all instance attributes
  37005. */
  37006. unbindInstanceAttributes(): void;
  37007. /**
  37008. * Release and free the memory of a vertex array object
  37009. * @param vao defines the vertex array object to delete
  37010. */
  37011. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37012. /** @hidden */
  37013. _releaseBuffer(buffer: DataBuffer): boolean;
  37014. protected _deleteBuffer(buffer: DataBuffer): void;
  37015. /**
  37016. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37017. * @param instancesBuffer defines the webGL buffer to update and bind
  37018. * @param data defines the data to store in the buffer
  37019. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37020. */
  37021. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37022. /**
  37023. * Bind the content of a webGL buffer used with instantiation
  37024. * @param instancesBuffer defines the webGL buffer to bind
  37025. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37026. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37027. */
  37028. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37029. /**
  37030. * Disable the instance attribute corresponding to the name in parameter
  37031. * @param name defines the name of the attribute to disable
  37032. */
  37033. disableInstanceAttributeByName(name: string): void;
  37034. /**
  37035. * Disable the instance attribute corresponding to the location in parameter
  37036. * @param attributeLocation defines the attribute location of the attribute to disable
  37037. */
  37038. disableInstanceAttribute(attributeLocation: number): void;
  37039. /**
  37040. * Disable the attribute corresponding to the location in parameter
  37041. * @param attributeLocation defines the attribute location of the attribute to disable
  37042. */
  37043. disableAttributeByIndex(attributeLocation: number): void;
  37044. /**
  37045. * Send a draw order
  37046. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37047. * @param indexStart defines the starting index
  37048. * @param indexCount defines the number of index to draw
  37049. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37050. */
  37051. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37052. /**
  37053. * Draw a list of points
  37054. * @param verticesStart defines the index of first vertex to draw
  37055. * @param verticesCount defines the count of vertices to draw
  37056. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37057. */
  37058. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37059. /**
  37060. * Draw a list of unindexed primitives
  37061. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37062. * @param verticesStart defines the index of first vertex to draw
  37063. * @param verticesCount defines the count of vertices to draw
  37064. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37065. */
  37066. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37067. /**
  37068. * Draw a list of indexed primitives
  37069. * @param fillMode defines the primitive to use
  37070. * @param indexStart defines the starting index
  37071. * @param indexCount defines the number of index to draw
  37072. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37073. */
  37074. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37075. /**
  37076. * Draw a list of unindexed primitives
  37077. * @param fillMode defines the primitive to use
  37078. * @param verticesStart defines the index of first vertex to draw
  37079. * @param verticesCount defines the count of vertices to draw
  37080. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37081. */
  37082. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37083. private _drawMode;
  37084. /** @hidden */
  37085. protected _reportDrawCall(): void;
  37086. /** @hidden */
  37087. _releaseEffect(effect: Effect): void;
  37088. /** @hidden */
  37089. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37090. /**
  37091. * Create a new effect (used to store vertex/fragment shaders)
  37092. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37093. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37094. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37095. * @param samplers defines an array of string used to represent textures
  37096. * @param defines defines the string containing the defines to use to compile the shaders
  37097. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37098. * @param onCompiled defines a function to call when the effect creation is successful
  37099. * @param onError defines a function to call when the effect creation has failed
  37100. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37101. * @returns the new Effect
  37102. */
  37103. 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;
  37104. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37105. private _compileShader;
  37106. private _compileRawShader;
  37107. /** @hidden */
  37108. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37109. /**
  37110. * Directly creates a webGL program
  37111. * @param pipelineContext defines the pipeline context to attach to
  37112. * @param vertexCode defines the vertex shader code to use
  37113. * @param fragmentCode defines the fragment shader code to use
  37114. * @param context defines the webGL context to use (if not set, the current one will be used)
  37115. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37116. * @returns the new webGL program
  37117. */
  37118. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37119. /**
  37120. * Creates a webGL program
  37121. * @param pipelineContext defines the pipeline context to attach to
  37122. * @param vertexCode defines the vertex shader code to use
  37123. * @param fragmentCode defines the fragment shader code to use
  37124. * @param defines defines the string containing the defines to use to compile the shaders
  37125. * @param context defines the webGL context to use (if not set, the current one will be used)
  37126. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37127. * @returns the new webGL program
  37128. */
  37129. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37130. /**
  37131. * Creates a new pipeline context
  37132. * @returns the new pipeline
  37133. */
  37134. createPipelineContext(): IPipelineContext;
  37135. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37136. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37137. /** @hidden */
  37138. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37139. /** @hidden */
  37140. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37141. /** @hidden */
  37142. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37143. /**
  37144. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37145. * @param pipelineContext defines the pipeline context to use
  37146. * @param uniformsNames defines the list of uniform names
  37147. * @returns an array of webGL uniform locations
  37148. */
  37149. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37150. /**
  37151. * Gets the lsit of active attributes for a given webGL program
  37152. * @param pipelineContext defines the pipeline context to use
  37153. * @param attributesNames defines the list of attribute names to get
  37154. * @returns an array of indices indicating the offset of each attribute
  37155. */
  37156. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37157. /**
  37158. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37159. * @param effect defines the effect to activate
  37160. */
  37161. enableEffect(effect: Nullable<Effect>): void;
  37162. /**
  37163. * Set the value of an uniform to a number (int)
  37164. * @param uniform defines the webGL uniform location where to store the value
  37165. * @param value defines the int number to store
  37166. */
  37167. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37168. /**
  37169. * Set the value of an uniform to an array of int32
  37170. * @param uniform defines the webGL uniform location where to store the value
  37171. * @param array defines the array of int32 to store
  37172. */
  37173. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37174. /**
  37175. * Set the value of an uniform to an array of int32 (stored as vec2)
  37176. * @param uniform defines the webGL uniform location where to store the value
  37177. * @param array defines the array of int32 to store
  37178. */
  37179. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37180. /**
  37181. * Set the value of an uniform to an array of int32 (stored as vec3)
  37182. * @param uniform defines the webGL uniform location where to store the value
  37183. * @param array defines the array of int32 to store
  37184. */
  37185. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37186. /**
  37187. * Set the value of an uniform to an array of int32 (stored as vec4)
  37188. * @param uniform defines the webGL uniform location where to store the value
  37189. * @param array defines the array of int32 to store
  37190. */
  37191. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37192. /**
  37193. * Set the value of an uniform to an array of number
  37194. * @param uniform defines the webGL uniform location where to store the value
  37195. * @param array defines the array of number to store
  37196. */
  37197. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37198. /**
  37199. * Set the value of an uniform to an array of number (stored as vec2)
  37200. * @param uniform defines the webGL uniform location where to store the value
  37201. * @param array defines the array of number to store
  37202. */
  37203. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37204. /**
  37205. * Set the value of an uniform to an array of number (stored as vec3)
  37206. * @param uniform defines the webGL uniform location where to store the value
  37207. * @param array defines the array of number to store
  37208. */
  37209. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37210. /**
  37211. * Set the value of an uniform to an array of number (stored as vec4)
  37212. * @param uniform defines the webGL uniform location where to store the value
  37213. * @param array defines the array of number to store
  37214. */
  37215. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37216. /**
  37217. * Set the value of an uniform to an array of float32 (stored as matrices)
  37218. * @param uniform defines the webGL uniform location where to store the value
  37219. * @param matrices defines the array of float32 to store
  37220. */
  37221. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37222. /**
  37223. * Set the value of an uniform to a matrix (3x3)
  37224. * @param uniform defines the webGL uniform location where to store the value
  37225. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37226. */
  37227. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37228. /**
  37229. * Set the value of an uniform to a matrix (2x2)
  37230. * @param uniform defines the webGL uniform location where to store the value
  37231. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37232. */
  37233. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37234. /**
  37235. * Set the value of an uniform to a number (float)
  37236. * @param uniform defines the webGL uniform location where to store the value
  37237. * @param value defines the float number to store
  37238. */
  37239. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37240. /**
  37241. * Set the value of an uniform to a vec2
  37242. * @param uniform defines the webGL uniform location where to store the value
  37243. * @param x defines the 1st component of the value
  37244. * @param y defines the 2nd component of the value
  37245. */
  37246. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37247. /**
  37248. * Set the value of an uniform to a vec3
  37249. * @param uniform defines the webGL uniform location where to store the value
  37250. * @param x defines the 1st component of the value
  37251. * @param y defines the 2nd component of the value
  37252. * @param z defines the 3rd component of the value
  37253. */
  37254. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37255. /**
  37256. * Set the value of an uniform to a vec4
  37257. * @param uniform defines the webGL uniform location where to store the value
  37258. * @param x defines the 1st component of the value
  37259. * @param y defines the 2nd component of the value
  37260. * @param z defines the 3rd component of the value
  37261. * @param w defines the 4th component of the value
  37262. */
  37263. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37264. /**
  37265. * Apply all cached states (depth, culling, stencil and alpha)
  37266. */
  37267. applyStates(): void;
  37268. /**
  37269. * Enable or disable color writing
  37270. * @param enable defines the state to set
  37271. */
  37272. setColorWrite(enable: boolean): void;
  37273. /**
  37274. * Gets a boolean indicating if color writing is enabled
  37275. * @returns the current color writing state
  37276. */
  37277. getColorWrite(): boolean;
  37278. /**
  37279. * Gets the depth culling state manager
  37280. */
  37281. get depthCullingState(): DepthCullingState;
  37282. /**
  37283. * Gets the alpha state manager
  37284. */
  37285. get alphaState(): AlphaState;
  37286. /**
  37287. * Gets the stencil state manager
  37288. */
  37289. get stencilState(): StencilState;
  37290. /**
  37291. * Clears the list of texture accessible through engine.
  37292. * This can help preventing texture load conflict due to name collision.
  37293. */
  37294. clearInternalTexturesCache(): void;
  37295. /**
  37296. * Force the entire cache to be cleared
  37297. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37298. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37299. */
  37300. wipeCaches(bruteForce?: boolean): void;
  37301. /** @hidden */
  37302. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37303. min: number;
  37304. mag: number;
  37305. };
  37306. /** @hidden */
  37307. _createTexture(): WebGLTexture;
  37308. /**
  37309. * Usually called from Texture.ts.
  37310. * Passed information to create a WebGLTexture
  37311. * @param url defines a value which contains one of the following:
  37312. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37313. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37314. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37315. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37316. * @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)
  37317. * @param scene needed for loading to the correct scene
  37318. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37319. * @param onLoad optional callback to be called upon successful completion
  37320. * @param onError optional callback to be called upon failure
  37321. * @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
  37322. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37323. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37324. * @param forcedExtension defines the extension to use to pick the right loader
  37325. * @param mimeType defines an optional mime type
  37326. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37327. */
  37328. createTexture(url: 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>, mimeType?: string): InternalTexture;
  37329. /**
  37330. * Loads an image as an HTMLImageElement.
  37331. * @param input url string, ArrayBuffer, or Blob to load
  37332. * @param onLoad callback called when the image successfully loads
  37333. * @param onError callback called when the image fails to load
  37334. * @param offlineProvider offline provider for caching
  37335. * @param mimeType optional mime type
  37336. * @returns the HTMLImageElement of the loaded image
  37337. * @hidden
  37338. */
  37339. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  37340. /**
  37341. * @hidden
  37342. */
  37343. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37344. private _unpackFlipYCached;
  37345. /**
  37346. * In case you are sharing the context with other applications, it might
  37347. * be interested to not cache the unpack flip y state to ensure a consistent
  37348. * value would be set.
  37349. */
  37350. enableUnpackFlipYCached: boolean;
  37351. /** @hidden */
  37352. _unpackFlipY(value: boolean): void;
  37353. /** @hidden */
  37354. _getUnpackAlignement(): number;
  37355. private _getTextureTarget;
  37356. /**
  37357. * Update the sampling mode of a given texture
  37358. * @param samplingMode defines the required sampling mode
  37359. * @param texture defines the texture to update
  37360. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37361. */
  37362. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37363. /**
  37364. * Update the sampling mode of a given texture
  37365. * @param texture defines the texture to update
  37366. * @param wrapU defines the texture wrap mode of the u coordinates
  37367. * @param wrapV defines the texture wrap mode of the v coordinates
  37368. * @param wrapR defines the texture wrap mode of the r coordinates
  37369. */
  37370. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37371. /** @hidden */
  37372. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37373. width: number;
  37374. height: number;
  37375. layers?: number;
  37376. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37377. /** @hidden */
  37378. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37379. /** @hidden */
  37380. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37381. /**
  37382. * Update a portion of an internal texture
  37383. * @param texture defines the texture to update
  37384. * @param imageData defines the data to store into the texture
  37385. * @param xOffset defines the x coordinates of the update rectangle
  37386. * @param yOffset defines the y coordinates of the update rectangle
  37387. * @param width defines the width of the update rectangle
  37388. * @param height defines the height of the update rectangle
  37389. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37390. * @param lod defines the lod level to update (0 by default)
  37391. */
  37392. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37393. /** @hidden */
  37394. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37395. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37396. private _prepareWebGLTexture;
  37397. /** @hidden */
  37398. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37399. private _getDepthStencilBuffer;
  37400. /** @hidden */
  37401. _releaseFramebufferObjects(texture: InternalTexture): void;
  37402. /** @hidden */
  37403. _releaseTexture(texture: InternalTexture): void;
  37404. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37405. protected _setProgram(program: WebGLProgram): void;
  37406. protected _boundUniforms: {
  37407. [key: number]: WebGLUniformLocation;
  37408. };
  37409. /**
  37410. * Binds an effect to the webGL context
  37411. * @param effect defines the effect to bind
  37412. */
  37413. bindSamplers(effect: Effect): void;
  37414. private _activateCurrentTexture;
  37415. /** @hidden */
  37416. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37417. /** @hidden */
  37418. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37419. /**
  37420. * Unbind all textures from the webGL context
  37421. */
  37422. unbindAllTextures(): void;
  37423. /**
  37424. * Sets a texture to the according uniform.
  37425. * @param channel The texture channel
  37426. * @param uniform The uniform to set
  37427. * @param texture The texture to apply
  37428. */
  37429. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37430. private _bindSamplerUniformToChannel;
  37431. private _getTextureWrapMode;
  37432. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37433. /**
  37434. * Sets an array of texture to the webGL context
  37435. * @param channel defines the channel where the texture array must be set
  37436. * @param uniform defines the associated uniform location
  37437. * @param textures defines the array of textures to bind
  37438. */
  37439. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37440. /** @hidden */
  37441. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37442. private _setTextureParameterFloat;
  37443. private _setTextureParameterInteger;
  37444. /**
  37445. * Unbind all vertex attributes from the webGL context
  37446. */
  37447. unbindAllAttributes(): void;
  37448. /**
  37449. * 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
  37450. */
  37451. releaseEffects(): void;
  37452. /**
  37453. * Dispose and release all associated resources
  37454. */
  37455. dispose(): void;
  37456. /**
  37457. * Attach a new callback raised when context lost event is fired
  37458. * @param callback defines the callback to call
  37459. */
  37460. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37461. /**
  37462. * Attach a new callback raised when context restored event is fired
  37463. * @param callback defines the callback to call
  37464. */
  37465. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37466. /**
  37467. * Get the current error code of the webGL context
  37468. * @returns the error code
  37469. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37470. */
  37471. getError(): number;
  37472. private _canRenderToFloatFramebuffer;
  37473. private _canRenderToHalfFloatFramebuffer;
  37474. private _canRenderToFramebuffer;
  37475. /** @hidden */
  37476. _getWebGLTextureType(type: number): number;
  37477. /** @hidden */
  37478. _getInternalFormat(format: number): number;
  37479. /** @hidden */
  37480. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37481. /** @hidden */
  37482. _getRGBAMultiSampleBufferFormat(type: number): number;
  37483. /** @hidden */
  37484. _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;
  37485. /**
  37486. * Loads a file from a url
  37487. * @param url url to load
  37488. * @param onSuccess callback called when the file successfully loads
  37489. * @param onProgress callback called while file is loading (if the server supports this mode)
  37490. * @param offlineProvider defines the offline provider for caching
  37491. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37492. * @param onError callback called when the file fails to load
  37493. * @returns a file request object
  37494. * @hidden
  37495. */
  37496. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  37497. /**
  37498. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37499. * @param x defines the x coordinate of the rectangle where pixels must be read
  37500. * @param y defines the y coordinate of the rectangle where pixels must be read
  37501. * @param width defines the width of the rectangle where pixels must be read
  37502. * @param height defines the height of the rectangle where pixels must be read
  37503. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37504. * @returns a Uint8Array containing RGBA colors
  37505. */
  37506. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37507. private static _isSupported;
  37508. /**
  37509. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37510. * @returns true if the engine can be created
  37511. * @ignorenaming
  37512. */
  37513. static isSupported(): boolean;
  37514. /**
  37515. * Find the next highest power of two.
  37516. * @param x Number to start search from.
  37517. * @return Next highest power of two.
  37518. */
  37519. static CeilingPOT(x: number): number;
  37520. /**
  37521. * Find the next lowest power of two.
  37522. * @param x Number to start search from.
  37523. * @return Next lowest power of two.
  37524. */
  37525. static FloorPOT(x: number): number;
  37526. /**
  37527. * Find the nearest power of two.
  37528. * @param x Number to start search from.
  37529. * @return Next nearest power of two.
  37530. */
  37531. static NearestPOT(x: number): number;
  37532. /**
  37533. * Get the closest exponent of two
  37534. * @param value defines the value to approximate
  37535. * @param max defines the maximum value to return
  37536. * @param mode defines how to define the closest value
  37537. * @returns closest exponent of two of the given value
  37538. */
  37539. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37540. /**
  37541. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37542. * @param func - the function to be called
  37543. * @param requester - the object that will request the next frame. Falls back to window.
  37544. * @returns frame number
  37545. */
  37546. static QueueNewFrame(func: () => void, requester?: any): number;
  37547. /**
  37548. * Gets host document
  37549. * @returns the host document object
  37550. */
  37551. getHostDocument(): Nullable<Document>;
  37552. }
  37553. }
  37554. declare module "babylonjs/Maths/sphericalPolynomial" {
  37555. import { Vector3 } from "babylonjs/Maths/math.vector";
  37556. import { Color3 } from "babylonjs/Maths/math.color";
  37557. /**
  37558. * Class representing spherical harmonics coefficients to the 3rd degree
  37559. */
  37560. export class SphericalHarmonics {
  37561. /**
  37562. * Defines whether or not the harmonics have been prescaled for rendering.
  37563. */
  37564. preScaled: boolean;
  37565. /**
  37566. * The l0,0 coefficients of the spherical harmonics
  37567. */
  37568. l00: Vector3;
  37569. /**
  37570. * The l1,-1 coefficients of the spherical harmonics
  37571. */
  37572. l1_1: Vector3;
  37573. /**
  37574. * The l1,0 coefficients of the spherical harmonics
  37575. */
  37576. l10: Vector3;
  37577. /**
  37578. * The l1,1 coefficients of the spherical harmonics
  37579. */
  37580. l11: Vector3;
  37581. /**
  37582. * The l2,-2 coefficients of the spherical harmonics
  37583. */
  37584. l2_2: Vector3;
  37585. /**
  37586. * The l2,-1 coefficients of the spherical harmonics
  37587. */
  37588. l2_1: Vector3;
  37589. /**
  37590. * The l2,0 coefficients of the spherical harmonics
  37591. */
  37592. l20: Vector3;
  37593. /**
  37594. * The l2,1 coefficients of the spherical harmonics
  37595. */
  37596. l21: Vector3;
  37597. /**
  37598. * The l2,2 coefficients of the spherical harmonics
  37599. */
  37600. l22: Vector3;
  37601. /**
  37602. * Adds a light to the spherical harmonics
  37603. * @param direction the direction of the light
  37604. * @param color the color of the light
  37605. * @param deltaSolidAngle the delta solid angle of the light
  37606. */
  37607. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37608. /**
  37609. * Scales the spherical harmonics by the given amount
  37610. * @param scale the amount to scale
  37611. */
  37612. scaleInPlace(scale: number): void;
  37613. /**
  37614. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37615. *
  37616. * ```
  37617. * E_lm = A_l * L_lm
  37618. * ```
  37619. *
  37620. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37621. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37622. * the scaling factors are given in equation 9.
  37623. */
  37624. convertIncidentRadianceToIrradiance(): void;
  37625. /**
  37626. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37627. *
  37628. * ```
  37629. * L = (1/pi) * E * rho
  37630. * ```
  37631. *
  37632. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37633. */
  37634. convertIrradianceToLambertianRadiance(): void;
  37635. /**
  37636. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37637. * required operations at run time.
  37638. *
  37639. * This is simply done by scaling back the SH with Ylm constants parameter.
  37640. * The trigonometric part being applied by the shader at run time.
  37641. */
  37642. preScaleForRendering(): void;
  37643. /**
  37644. * Constructs a spherical harmonics from an array.
  37645. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37646. * @returns the spherical harmonics
  37647. */
  37648. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37649. /**
  37650. * Gets the spherical harmonics from polynomial
  37651. * @param polynomial the spherical polynomial
  37652. * @returns the spherical harmonics
  37653. */
  37654. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37655. }
  37656. /**
  37657. * Class representing spherical polynomial coefficients to the 3rd degree
  37658. */
  37659. export class SphericalPolynomial {
  37660. private _harmonics;
  37661. /**
  37662. * The spherical harmonics used to create the polynomials.
  37663. */
  37664. get preScaledHarmonics(): SphericalHarmonics;
  37665. /**
  37666. * The x coefficients of the spherical polynomial
  37667. */
  37668. x: Vector3;
  37669. /**
  37670. * The y coefficients of the spherical polynomial
  37671. */
  37672. y: Vector3;
  37673. /**
  37674. * The z coefficients of the spherical polynomial
  37675. */
  37676. z: Vector3;
  37677. /**
  37678. * The xx coefficients of the spherical polynomial
  37679. */
  37680. xx: Vector3;
  37681. /**
  37682. * The yy coefficients of the spherical polynomial
  37683. */
  37684. yy: Vector3;
  37685. /**
  37686. * The zz coefficients of the spherical polynomial
  37687. */
  37688. zz: Vector3;
  37689. /**
  37690. * The xy coefficients of the spherical polynomial
  37691. */
  37692. xy: Vector3;
  37693. /**
  37694. * The yz coefficients of the spherical polynomial
  37695. */
  37696. yz: Vector3;
  37697. /**
  37698. * The zx coefficients of the spherical polynomial
  37699. */
  37700. zx: Vector3;
  37701. /**
  37702. * Adds an ambient color to the spherical polynomial
  37703. * @param color the color to add
  37704. */
  37705. addAmbient(color: Color3): void;
  37706. /**
  37707. * Scales the spherical polynomial by the given amount
  37708. * @param scale the amount to scale
  37709. */
  37710. scaleInPlace(scale: number): void;
  37711. /**
  37712. * Gets the spherical polynomial from harmonics
  37713. * @param harmonics the spherical harmonics
  37714. * @returns the spherical polynomial
  37715. */
  37716. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37717. /**
  37718. * Constructs a spherical polynomial from an array.
  37719. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37720. * @returns the spherical polynomial
  37721. */
  37722. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37723. }
  37724. }
  37725. declare module "babylonjs/Materials/Textures/internalTexture" {
  37726. import { Observable } from "babylonjs/Misc/observable";
  37727. import { Nullable, int } from "babylonjs/types";
  37728. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37729. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37730. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37731. /**
  37732. * Defines the source of the internal texture
  37733. */
  37734. export enum InternalTextureSource {
  37735. /**
  37736. * The source of the texture data is unknown
  37737. */
  37738. Unknown = 0,
  37739. /**
  37740. * Texture data comes from an URL
  37741. */
  37742. Url = 1,
  37743. /**
  37744. * Texture data is only used for temporary storage
  37745. */
  37746. Temp = 2,
  37747. /**
  37748. * Texture data comes from raw data (ArrayBuffer)
  37749. */
  37750. Raw = 3,
  37751. /**
  37752. * Texture content is dynamic (video or dynamic texture)
  37753. */
  37754. Dynamic = 4,
  37755. /**
  37756. * Texture content is generated by rendering to it
  37757. */
  37758. RenderTarget = 5,
  37759. /**
  37760. * Texture content is part of a multi render target process
  37761. */
  37762. MultiRenderTarget = 6,
  37763. /**
  37764. * Texture data comes from a cube data file
  37765. */
  37766. Cube = 7,
  37767. /**
  37768. * Texture data comes from a raw cube data
  37769. */
  37770. CubeRaw = 8,
  37771. /**
  37772. * Texture data come from a prefiltered cube data file
  37773. */
  37774. CubePrefiltered = 9,
  37775. /**
  37776. * Texture content is raw 3D data
  37777. */
  37778. Raw3D = 10,
  37779. /**
  37780. * Texture content is raw 2D array data
  37781. */
  37782. Raw2DArray = 11,
  37783. /**
  37784. * Texture content is a depth texture
  37785. */
  37786. Depth = 12,
  37787. /**
  37788. * Texture data comes from a raw cube data encoded with RGBD
  37789. */
  37790. CubeRawRGBD = 13
  37791. }
  37792. /**
  37793. * Class used to store data associated with WebGL texture data for the engine
  37794. * This class should not be used directly
  37795. */
  37796. export class InternalTexture {
  37797. /** @hidden */
  37798. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37799. /**
  37800. * Defines if the texture is ready
  37801. */
  37802. isReady: boolean;
  37803. /**
  37804. * Defines if the texture is a cube texture
  37805. */
  37806. isCube: boolean;
  37807. /**
  37808. * Defines if the texture contains 3D data
  37809. */
  37810. is3D: boolean;
  37811. /**
  37812. * Defines if the texture contains 2D array data
  37813. */
  37814. is2DArray: boolean;
  37815. /**
  37816. * Defines if the texture contains multiview data
  37817. */
  37818. isMultiview: boolean;
  37819. /**
  37820. * Gets the URL used to load this texture
  37821. */
  37822. url: string;
  37823. /**
  37824. * Gets the sampling mode of the texture
  37825. */
  37826. samplingMode: number;
  37827. /**
  37828. * Gets a boolean indicating if the texture needs mipmaps generation
  37829. */
  37830. generateMipMaps: boolean;
  37831. /**
  37832. * Gets the number of samples used by the texture (WebGL2+ only)
  37833. */
  37834. samples: number;
  37835. /**
  37836. * Gets the type of the texture (int, float...)
  37837. */
  37838. type: number;
  37839. /**
  37840. * Gets the format of the texture (RGB, RGBA...)
  37841. */
  37842. format: number;
  37843. /**
  37844. * Observable called when the texture is loaded
  37845. */
  37846. onLoadedObservable: Observable<InternalTexture>;
  37847. /**
  37848. * Gets the width of the texture
  37849. */
  37850. width: number;
  37851. /**
  37852. * Gets the height of the texture
  37853. */
  37854. height: number;
  37855. /**
  37856. * Gets the depth of the texture
  37857. */
  37858. depth: number;
  37859. /**
  37860. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37861. */
  37862. baseWidth: number;
  37863. /**
  37864. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37865. */
  37866. baseHeight: number;
  37867. /**
  37868. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37869. */
  37870. baseDepth: number;
  37871. /**
  37872. * Gets a boolean indicating if the texture is inverted on Y axis
  37873. */
  37874. invertY: boolean;
  37875. /** @hidden */
  37876. _invertVScale: boolean;
  37877. /** @hidden */
  37878. _associatedChannel: number;
  37879. /** @hidden */
  37880. _source: InternalTextureSource;
  37881. /** @hidden */
  37882. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37883. /** @hidden */
  37884. _bufferView: Nullable<ArrayBufferView>;
  37885. /** @hidden */
  37886. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37887. /** @hidden */
  37888. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37889. /** @hidden */
  37890. _size: number;
  37891. /** @hidden */
  37892. _extension: string;
  37893. /** @hidden */
  37894. _files: Nullable<string[]>;
  37895. /** @hidden */
  37896. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37897. /** @hidden */
  37898. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37899. /** @hidden */
  37900. _framebuffer: Nullable<WebGLFramebuffer>;
  37901. /** @hidden */
  37902. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37903. /** @hidden */
  37904. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37905. /** @hidden */
  37906. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37907. /** @hidden */
  37908. _attachments: Nullable<number[]>;
  37909. /** @hidden */
  37910. _textureArray: Nullable<InternalTexture[]>;
  37911. /** @hidden */
  37912. _cachedCoordinatesMode: Nullable<number>;
  37913. /** @hidden */
  37914. _cachedWrapU: Nullable<number>;
  37915. /** @hidden */
  37916. _cachedWrapV: Nullable<number>;
  37917. /** @hidden */
  37918. _cachedWrapR: Nullable<number>;
  37919. /** @hidden */
  37920. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37921. /** @hidden */
  37922. _isDisabled: boolean;
  37923. /** @hidden */
  37924. _compression: Nullable<string>;
  37925. /** @hidden */
  37926. _generateStencilBuffer: boolean;
  37927. /** @hidden */
  37928. _generateDepthBuffer: boolean;
  37929. /** @hidden */
  37930. _comparisonFunction: number;
  37931. /** @hidden */
  37932. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37933. /** @hidden */
  37934. _lodGenerationScale: number;
  37935. /** @hidden */
  37936. _lodGenerationOffset: number;
  37937. /** @hidden */
  37938. _depthStencilTexture: Nullable<InternalTexture>;
  37939. /** @hidden */
  37940. _colorTextureArray: Nullable<WebGLTexture>;
  37941. /** @hidden */
  37942. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37943. /** @hidden */
  37944. _lodTextureHigh: Nullable<BaseTexture>;
  37945. /** @hidden */
  37946. _lodTextureMid: Nullable<BaseTexture>;
  37947. /** @hidden */
  37948. _lodTextureLow: Nullable<BaseTexture>;
  37949. /** @hidden */
  37950. _isRGBD: boolean;
  37951. /** @hidden */
  37952. _linearSpecularLOD: boolean;
  37953. /** @hidden */
  37954. _irradianceTexture: Nullable<BaseTexture>;
  37955. /** @hidden */
  37956. _webGLTexture: Nullable<WebGLTexture>;
  37957. /** @hidden */
  37958. _references: number;
  37959. private _engine;
  37960. /**
  37961. * Gets the Engine the texture belongs to.
  37962. * @returns The babylon engine
  37963. */
  37964. getEngine(): ThinEngine;
  37965. /**
  37966. * Gets the data source type of the texture
  37967. */
  37968. get source(): InternalTextureSource;
  37969. /**
  37970. * Creates a new InternalTexture
  37971. * @param engine defines the engine to use
  37972. * @param source defines the type of data that will be used
  37973. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37974. */
  37975. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37976. /**
  37977. * Increments the number of references (ie. the number of Texture that point to it)
  37978. */
  37979. incrementReferences(): void;
  37980. /**
  37981. * Change the size of the texture (not the size of the content)
  37982. * @param width defines the new width
  37983. * @param height defines the new height
  37984. * @param depth defines the new depth (1 by default)
  37985. */
  37986. updateSize(width: int, height: int, depth?: int): void;
  37987. /** @hidden */
  37988. _rebuild(): void;
  37989. /** @hidden */
  37990. _swapAndDie(target: InternalTexture): void;
  37991. /**
  37992. * Dispose the current allocated resources
  37993. */
  37994. dispose(): void;
  37995. }
  37996. }
  37997. declare module "babylonjs/Audio/analyser" {
  37998. import { Scene } from "babylonjs/scene";
  37999. /**
  38000. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38001. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38002. */
  38003. export class Analyser {
  38004. /**
  38005. * Gets or sets the smoothing
  38006. * @ignorenaming
  38007. */
  38008. SMOOTHING: number;
  38009. /**
  38010. * Gets or sets the FFT table size
  38011. * @ignorenaming
  38012. */
  38013. FFT_SIZE: number;
  38014. /**
  38015. * Gets or sets the bar graph amplitude
  38016. * @ignorenaming
  38017. */
  38018. BARGRAPHAMPLITUDE: number;
  38019. /**
  38020. * Gets or sets the position of the debug canvas
  38021. * @ignorenaming
  38022. */
  38023. DEBUGCANVASPOS: {
  38024. x: number;
  38025. y: number;
  38026. };
  38027. /**
  38028. * Gets or sets the debug canvas size
  38029. * @ignorenaming
  38030. */
  38031. DEBUGCANVASSIZE: {
  38032. width: number;
  38033. height: number;
  38034. };
  38035. private _byteFreqs;
  38036. private _byteTime;
  38037. private _floatFreqs;
  38038. private _webAudioAnalyser;
  38039. private _debugCanvas;
  38040. private _debugCanvasContext;
  38041. private _scene;
  38042. private _registerFunc;
  38043. private _audioEngine;
  38044. /**
  38045. * Creates a new analyser
  38046. * @param scene defines hosting scene
  38047. */
  38048. constructor(scene: Scene);
  38049. /**
  38050. * Get the number of data values you will have to play with for the visualization
  38051. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38052. * @returns a number
  38053. */
  38054. getFrequencyBinCount(): number;
  38055. /**
  38056. * Gets the current frequency data as a byte array
  38057. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38058. * @returns a Uint8Array
  38059. */
  38060. getByteFrequencyData(): Uint8Array;
  38061. /**
  38062. * Gets the current waveform as a byte array
  38063. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38064. * @returns a Uint8Array
  38065. */
  38066. getByteTimeDomainData(): Uint8Array;
  38067. /**
  38068. * Gets the current frequency data as a float array
  38069. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38070. * @returns a Float32Array
  38071. */
  38072. getFloatFrequencyData(): Float32Array;
  38073. /**
  38074. * Renders the debug canvas
  38075. */
  38076. drawDebugCanvas(): void;
  38077. /**
  38078. * Stops rendering the debug canvas and removes it
  38079. */
  38080. stopDebugCanvas(): void;
  38081. /**
  38082. * Connects two audio nodes
  38083. * @param inputAudioNode defines first node to connect
  38084. * @param outputAudioNode defines second node to connect
  38085. */
  38086. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38087. /**
  38088. * Releases all associated resources
  38089. */
  38090. dispose(): void;
  38091. }
  38092. }
  38093. declare module "babylonjs/Audio/audioEngine" {
  38094. import { IDisposable } from "babylonjs/scene";
  38095. import { Analyser } from "babylonjs/Audio/analyser";
  38096. import { Nullable } from "babylonjs/types";
  38097. import { Observable } from "babylonjs/Misc/observable";
  38098. /**
  38099. * This represents an audio engine and it is responsible
  38100. * to play, synchronize and analyse sounds throughout the application.
  38101. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38102. */
  38103. export interface IAudioEngine extends IDisposable {
  38104. /**
  38105. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38106. */
  38107. readonly canUseWebAudio: boolean;
  38108. /**
  38109. * Gets the current AudioContext if available.
  38110. */
  38111. readonly audioContext: Nullable<AudioContext>;
  38112. /**
  38113. * The master gain node defines the global audio volume of your audio engine.
  38114. */
  38115. readonly masterGain: GainNode;
  38116. /**
  38117. * Gets whether or not mp3 are supported by your browser.
  38118. */
  38119. readonly isMP3supported: boolean;
  38120. /**
  38121. * Gets whether or not ogg are supported by your browser.
  38122. */
  38123. readonly isOGGsupported: boolean;
  38124. /**
  38125. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38126. * @ignoreNaming
  38127. */
  38128. WarnedWebAudioUnsupported: boolean;
  38129. /**
  38130. * Defines if the audio engine relies on a custom unlocked button.
  38131. * In this case, the embedded button will not be displayed.
  38132. */
  38133. useCustomUnlockedButton: boolean;
  38134. /**
  38135. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38136. */
  38137. readonly unlocked: boolean;
  38138. /**
  38139. * Event raised when audio has been unlocked on the browser.
  38140. */
  38141. onAudioUnlockedObservable: Observable<AudioEngine>;
  38142. /**
  38143. * Event raised when audio has been locked on the browser.
  38144. */
  38145. onAudioLockedObservable: Observable<AudioEngine>;
  38146. /**
  38147. * Flags the audio engine in Locked state.
  38148. * This happens due to new browser policies preventing audio to autoplay.
  38149. */
  38150. lock(): void;
  38151. /**
  38152. * Unlocks the audio engine once a user action has been done on the dom.
  38153. * This is helpful to resume play once browser policies have been satisfied.
  38154. */
  38155. unlock(): void;
  38156. /**
  38157. * Gets the global volume sets on the master gain.
  38158. * @returns the global volume if set or -1 otherwise
  38159. */
  38160. getGlobalVolume(): number;
  38161. /**
  38162. * Sets the global volume of your experience (sets on the master gain).
  38163. * @param newVolume Defines the new global volume of the application
  38164. */
  38165. setGlobalVolume(newVolume: number): void;
  38166. /**
  38167. * Connect the audio engine to an audio analyser allowing some amazing
  38168. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38169. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38170. * @param analyser The analyser to connect to the engine
  38171. */
  38172. connectToAnalyser(analyser: Analyser): void;
  38173. }
  38174. /**
  38175. * This represents the default audio engine used in babylon.
  38176. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38177. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38178. */
  38179. export class AudioEngine implements IAudioEngine {
  38180. private _audioContext;
  38181. private _audioContextInitialized;
  38182. private _muteButton;
  38183. private _hostElement;
  38184. /**
  38185. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38186. */
  38187. canUseWebAudio: boolean;
  38188. /**
  38189. * The master gain node defines the global audio volume of your audio engine.
  38190. */
  38191. masterGain: GainNode;
  38192. /**
  38193. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38194. * @ignoreNaming
  38195. */
  38196. WarnedWebAudioUnsupported: boolean;
  38197. /**
  38198. * Gets whether or not mp3 are supported by your browser.
  38199. */
  38200. isMP3supported: boolean;
  38201. /**
  38202. * Gets whether or not ogg are supported by your browser.
  38203. */
  38204. isOGGsupported: boolean;
  38205. /**
  38206. * Gets whether audio has been unlocked on the device.
  38207. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38208. * a user interaction has happened.
  38209. */
  38210. unlocked: boolean;
  38211. /**
  38212. * Defines if the audio engine relies on a custom unlocked button.
  38213. * In this case, the embedded button will not be displayed.
  38214. */
  38215. useCustomUnlockedButton: boolean;
  38216. /**
  38217. * Event raised when audio has been unlocked on the browser.
  38218. */
  38219. onAudioUnlockedObservable: Observable<AudioEngine>;
  38220. /**
  38221. * Event raised when audio has been locked on the browser.
  38222. */
  38223. onAudioLockedObservable: Observable<AudioEngine>;
  38224. /**
  38225. * Gets the current AudioContext if available.
  38226. */
  38227. get audioContext(): Nullable<AudioContext>;
  38228. private _connectedAnalyser;
  38229. /**
  38230. * Instantiates a new audio engine.
  38231. *
  38232. * There should be only one per page as some browsers restrict the number
  38233. * of audio contexts you can create.
  38234. * @param hostElement defines the host element where to display the mute icon if necessary
  38235. */
  38236. constructor(hostElement?: Nullable<HTMLElement>);
  38237. /**
  38238. * Flags the audio engine in Locked state.
  38239. * This happens due to new browser policies preventing audio to autoplay.
  38240. */
  38241. lock(): void;
  38242. /**
  38243. * Unlocks the audio engine once a user action has been done on the dom.
  38244. * This is helpful to resume play once browser policies have been satisfied.
  38245. */
  38246. unlock(): void;
  38247. private _resumeAudioContext;
  38248. private _initializeAudioContext;
  38249. private _tryToRun;
  38250. private _triggerRunningState;
  38251. private _triggerSuspendedState;
  38252. private _displayMuteButton;
  38253. private _moveButtonToTopLeft;
  38254. private _onResize;
  38255. private _hideMuteButton;
  38256. /**
  38257. * Destroy and release the resources associated with the audio ccontext.
  38258. */
  38259. dispose(): void;
  38260. /**
  38261. * Gets the global volume sets on the master gain.
  38262. * @returns the global volume if set or -1 otherwise
  38263. */
  38264. getGlobalVolume(): number;
  38265. /**
  38266. * Sets the global volume of your experience (sets on the master gain).
  38267. * @param newVolume Defines the new global volume of the application
  38268. */
  38269. setGlobalVolume(newVolume: number): void;
  38270. /**
  38271. * Connect the audio engine to an audio analyser allowing some amazing
  38272. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38273. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38274. * @param analyser The analyser to connect to the engine
  38275. */
  38276. connectToAnalyser(analyser: Analyser): void;
  38277. }
  38278. }
  38279. declare module "babylonjs/Loading/loadingScreen" {
  38280. /**
  38281. * Interface used to present a loading screen while loading a scene
  38282. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38283. */
  38284. export interface ILoadingScreen {
  38285. /**
  38286. * Function called to display the loading screen
  38287. */
  38288. displayLoadingUI: () => void;
  38289. /**
  38290. * Function called to hide the loading screen
  38291. */
  38292. hideLoadingUI: () => void;
  38293. /**
  38294. * Gets or sets the color to use for the background
  38295. */
  38296. loadingUIBackgroundColor: string;
  38297. /**
  38298. * Gets or sets the text to display while loading
  38299. */
  38300. loadingUIText: string;
  38301. }
  38302. /**
  38303. * Class used for the default loading screen
  38304. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38305. */
  38306. export class DefaultLoadingScreen implements ILoadingScreen {
  38307. private _renderingCanvas;
  38308. private _loadingText;
  38309. private _loadingDivBackgroundColor;
  38310. private _loadingDiv;
  38311. private _loadingTextDiv;
  38312. /** Gets or sets the logo url to use for the default loading screen */
  38313. static DefaultLogoUrl: string;
  38314. /** Gets or sets the spinner url to use for the default loading screen */
  38315. static DefaultSpinnerUrl: string;
  38316. /**
  38317. * Creates a new default loading screen
  38318. * @param _renderingCanvas defines the canvas used to render the scene
  38319. * @param _loadingText defines the default text to display
  38320. * @param _loadingDivBackgroundColor defines the default background color
  38321. */
  38322. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38323. /**
  38324. * Function called to display the loading screen
  38325. */
  38326. displayLoadingUI(): void;
  38327. /**
  38328. * Function called to hide the loading screen
  38329. */
  38330. hideLoadingUI(): void;
  38331. /**
  38332. * Gets or sets the text to display while loading
  38333. */
  38334. set loadingUIText(text: string);
  38335. get loadingUIText(): string;
  38336. /**
  38337. * Gets or sets the color to use for the background
  38338. */
  38339. get loadingUIBackgroundColor(): string;
  38340. set loadingUIBackgroundColor(color: string);
  38341. private _resizeLoadingUI;
  38342. }
  38343. }
  38344. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38345. /**
  38346. * Interface for any object that can request an animation frame
  38347. */
  38348. export interface ICustomAnimationFrameRequester {
  38349. /**
  38350. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38351. */
  38352. renderFunction?: Function;
  38353. /**
  38354. * Called to request the next frame to render to
  38355. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38356. */
  38357. requestAnimationFrame: Function;
  38358. /**
  38359. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38360. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38361. */
  38362. requestID?: number;
  38363. }
  38364. }
  38365. declare module "babylonjs/Misc/performanceMonitor" {
  38366. /**
  38367. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38368. */
  38369. export class PerformanceMonitor {
  38370. private _enabled;
  38371. private _rollingFrameTime;
  38372. private _lastFrameTimeMs;
  38373. /**
  38374. * constructor
  38375. * @param frameSampleSize The number of samples required to saturate the sliding window
  38376. */
  38377. constructor(frameSampleSize?: number);
  38378. /**
  38379. * Samples current frame
  38380. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38381. */
  38382. sampleFrame(timeMs?: number): void;
  38383. /**
  38384. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38385. */
  38386. get averageFrameTime(): number;
  38387. /**
  38388. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38389. */
  38390. get averageFrameTimeVariance(): number;
  38391. /**
  38392. * Returns the frame time of the most recent frame
  38393. */
  38394. get instantaneousFrameTime(): number;
  38395. /**
  38396. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38397. */
  38398. get averageFPS(): number;
  38399. /**
  38400. * Returns the average framerate in frames per second using the most recent frame time
  38401. */
  38402. get instantaneousFPS(): number;
  38403. /**
  38404. * Returns true if enough samples have been taken to completely fill the sliding window
  38405. */
  38406. get isSaturated(): boolean;
  38407. /**
  38408. * Enables contributions to the sliding window sample set
  38409. */
  38410. enable(): void;
  38411. /**
  38412. * Disables contributions to the sliding window sample set
  38413. * Samples will not be interpolated over the disabled period
  38414. */
  38415. disable(): void;
  38416. /**
  38417. * Returns true if sampling is enabled
  38418. */
  38419. get isEnabled(): boolean;
  38420. /**
  38421. * Resets performance monitor
  38422. */
  38423. reset(): void;
  38424. }
  38425. /**
  38426. * RollingAverage
  38427. *
  38428. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38429. */
  38430. export class RollingAverage {
  38431. /**
  38432. * Current average
  38433. */
  38434. average: number;
  38435. /**
  38436. * Current variance
  38437. */
  38438. variance: number;
  38439. protected _samples: Array<number>;
  38440. protected _sampleCount: number;
  38441. protected _pos: number;
  38442. protected _m2: number;
  38443. /**
  38444. * constructor
  38445. * @param length The number of samples required to saturate the sliding window
  38446. */
  38447. constructor(length: number);
  38448. /**
  38449. * Adds a sample to the sample set
  38450. * @param v The sample value
  38451. */
  38452. add(v: number): void;
  38453. /**
  38454. * Returns previously added values or null if outside of history or outside the sliding window domain
  38455. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38456. * @return Value previously recorded with add() or null if outside of range
  38457. */
  38458. history(i: number): number;
  38459. /**
  38460. * Returns true if enough samples have been taken to completely fill the sliding window
  38461. * @return true if sample-set saturated
  38462. */
  38463. isSaturated(): boolean;
  38464. /**
  38465. * Resets the rolling average (equivalent to 0 samples taken so far)
  38466. */
  38467. reset(): void;
  38468. /**
  38469. * Wraps a value around the sample range boundaries
  38470. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38471. * @return Wrapped position in sample range
  38472. */
  38473. protected _wrapPosition(i: number): number;
  38474. }
  38475. }
  38476. declare module "babylonjs/Misc/perfCounter" {
  38477. /**
  38478. * This class is used to track a performance counter which is number based.
  38479. * The user has access to many properties which give statistics of different nature.
  38480. *
  38481. * The implementer can track two kinds of Performance Counter: time and count.
  38482. * 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.
  38483. * 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.
  38484. */
  38485. export class PerfCounter {
  38486. /**
  38487. * Gets or sets a global boolean to turn on and off all the counters
  38488. */
  38489. static Enabled: boolean;
  38490. /**
  38491. * Returns the smallest value ever
  38492. */
  38493. get min(): number;
  38494. /**
  38495. * Returns the biggest value ever
  38496. */
  38497. get max(): number;
  38498. /**
  38499. * Returns the average value since the performance counter is running
  38500. */
  38501. get average(): number;
  38502. /**
  38503. * Returns the average value of the last second the counter was monitored
  38504. */
  38505. get lastSecAverage(): number;
  38506. /**
  38507. * Returns the current value
  38508. */
  38509. get current(): number;
  38510. /**
  38511. * Gets the accumulated total
  38512. */
  38513. get total(): number;
  38514. /**
  38515. * Gets the total value count
  38516. */
  38517. get count(): number;
  38518. /**
  38519. * Creates a new counter
  38520. */
  38521. constructor();
  38522. /**
  38523. * Call this method to start monitoring a new frame.
  38524. * 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.
  38525. */
  38526. fetchNewFrame(): void;
  38527. /**
  38528. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38529. * @param newCount the count value to add to the monitored count
  38530. * @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.
  38531. */
  38532. addCount(newCount: number, fetchResult: boolean): void;
  38533. /**
  38534. * Start monitoring this performance counter
  38535. */
  38536. beginMonitoring(): void;
  38537. /**
  38538. * Compute the time lapsed since the previous beginMonitoring() call.
  38539. * @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
  38540. */
  38541. endMonitoring(newFrame?: boolean): void;
  38542. private _fetchResult;
  38543. private _startMonitoringTime;
  38544. private _min;
  38545. private _max;
  38546. private _average;
  38547. private _current;
  38548. private _totalValueCount;
  38549. private _totalAccumulated;
  38550. private _lastSecAverage;
  38551. private _lastSecAccumulated;
  38552. private _lastSecTime;
  38553. private _lastSecValueCount;
  38554. }
  38555. }
  38556. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38557. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38558. import { Nullable } from "babylonjs/types";
  38559. module "babylonjs/Engines/thinEngine" {
  38560. interface ThinEngine {
  38561. /** @hidden */
  38562. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38563. }
  38564. }
  38565. }
  38566. declare module "babylonjs/Engines/engine" {
  38567. import { Observable } from "babylonjs/Misc/observable";
  38568. import { Nullable } from "babylonjs/types";
  38569. import { Scene } from "babylonjs/scene";
  38570. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38571. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38572. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38573. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38574. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38575. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38576. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38577. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38578. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38579. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38580. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38581. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38582. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38583. import "babylonjs/Engines/Extensions/engine.alpha";
  38584. import "babylonjs/Engines/Extensions/engine.readTexture";
  38585. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38586. import { Material } from "babylonjs/Materials/material";
  38587. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38588. /**
  38589. * Defines the interface used by display changed events
  38590. */
  38591. export interface IDisplayChangedEventArgs {
  38592. /** Gets the vrDisplay object (if any) */
  38593. vrDisplay: Nullable<any>;
  38594. /** Gets a boolean indicating if webVR is supported */
  38595. vrSupported: boolean;
  38596. }
  38597. /**
  38598. * Defines the interface used by objects containing a viewport (like a camera)
  38599. */
  38600. interface IViewportOwnerLike {
  38601. /**
  38602. * Gets or sets the viewport
  38603. */
  38604. viewport: IViewportLike;
  38605. }
  38606. /**
  38607. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38608. */
  38609. export class Engine extends ThinEngine {
  38610. /** Defines that alpha blending is disabled */
  38611. static readonly ALPHA_DISABLE: number;
  38612. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38613. static readonly ALPHA_ADD: number;
  38614. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38615. static readonly ALPHA_COMBINE: number;
  38616. /** Defines that alpha blending to DEST - SRC * DEST */
  38617. static readonly ALPHA_SUBTRACT: number;
  38618. /** Defines that alpha blending to SRC * DEST */
  38619. static readonly ALPHA_MULTIPLY: number;
  38620. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38621. static readonly ALPHA_MAXIMIZED: number;
  38622. /** Defines that alpha blending to SRC + DEST */
  38623. static readonly ALPHA_ONEONE: number;
  38624. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38625. static readonly ALPHA_PREMULTIPLIED: number;
  38626. /**
  38627. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38628. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38629. */
  38630. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38631. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38632. static readonly ALPHA_INTERPOLATE: number;
  38633. /**
  38634. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38635. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38636. */
  38637. static readonly ALPHA_SCREENMODE: number;
  38638. /** Defines that the ressource is not delayed*/
  38639. static readonly DELAYLOADSTATE_NONE: number;
  38640. /** Defines that the ressource was successfully delay loaded */
  38641. static readonly DELAYLOADSTATE_LOADED: number;
  38642. /** Defines that the ressource is currently delay loading */
  38643. static readonly DELAYLOADSTATE_LOADING: number;
  38644. /** Defines that the ressource is delayed and has not started loading */
  38645. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38646. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38647. static readonly NEVER: number;
  38648. /** 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 */
  38649. static readonly ALWAYS: number;
  38650. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38651. static readonly LESS: number;
  38652. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38653. static readonly EQUAL: number;
  38654. /** 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 */
  38655. static readonly LEQUAL: number;
  38656. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38657. static readonly GREATER: number;
  38658. /** 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 */
  38659. static readonly GEQUAL: number;
  38660. /** 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 */
  38661. static readonly NOTEQUAL: number;
  38662. /** Passed to stencilOperation to specify that stencil value must be kept */
  38663. static readonly KEEP: number;
  38664. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38665. static readonly REPLACE: number;
  38666. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38667. static readonly INCR: number;
  38668. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38669. static readonly DECR: number;
  38670. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38671. static readonly INVERT: number;
  38672. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38673. static readonly INCR_WRAP: number;
  38674. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38675. static readonly DECR_WRAP: number;
  38676. /** Texture is not repeating outside of 0..1 UVs */
  38677. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38678. /** Texture is repeating outside of 0..1 UVs */
  38679. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38680. /** Texture is repeating and mirrored */
  38681. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38682. /** ALPHA */
  38683. static readonly TEXTUREFORMAT_ALPHA: number;
  38684. /** LUMINANCE */
  38685. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38686. /** LUMINANCE_ALPHA */
  38687. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38688. /** RGB */
  38689. static readonly TEXTUREFORMAT_RGB: number;
  38690. /** RGBA */
  38691. static readonly TEXTUREFORMAT_RGBA: number;
  38692. /** RED */
  38693. static readonly TEXTUREFORMAT_RED: number;
  38694. /** RED (2nd reference) */
  38695. static readonly TEXTUREFORMAT_R: number;
  38696. /** RG */
  38697. static readonly TEXTUREFORMAT_RG: number;
  38698. /** RED_INTEGER */
  38699. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38700. /** RED_INTEGER (2nd reference) */
  38701. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38702. /** RG_INTEGER */
  38703. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38704. /** RGB_INTEGER */
  38705. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38706. /** RGBA_INTEGER */
  38707. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38708. /** UNSIGNED_BYTE */
  38709. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38710. /** UNSIGNED_BYTE (2nd reference) */
  38711. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38712. /** FLOAT */
  38713. static readonly TEXTURETYPE_FLOAT: number;
  38714. /** HALF_FLOAT */
  38715. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38716. /** BYTE */
  38717. static readonly TEXTURETYPE_BYTE: number;
  38718. /** SHORT */
  38719. static readonly TEXTURETYPE_SHORT: number;
  38720. /** UNSIGNED_SHORT */
  38721. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38722. /** INT */
  38723. static readonly TEXTURETYPE_INT: number;
  38724. /** UNSIGNED_INT */
  38725. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38726. /** UNSIGNED_SHORT_4_4_4_4 */
  38727. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38728. /** UNSIGNED_SHORT_5_5_5_1 */
  38729. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38730. /** UNSIGNED_SHORT_5_6_5 */
  38731. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38732. /** UNSIGNED_INT_2_10_10_10_REV */
  38733. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38734. /** UNSIGNED_INT_24_8 */
  38735. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38736. /** UNSIGNED_INT_10F_11F_11F_REV */
  38737. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38738. /** UNSIGNED_INT_5_9_9_9_REV */
  38739. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38740. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38741. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38742. /** nearest is mag = nearest and min = nearest and mip = linear */
  38743. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38744. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38745. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38746. /** Trilinear is mag = linear and min = linear and mip = linear */
  38747. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38748. /** nearest is mag = nearest and min = nearest and mip = linear */
  38749. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38750. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38751. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38752. /** Trilinear is mag = linear and min = linear and mip = linear */
  38753. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38754. /** mag = nearest and min = nearest and mip = nearest */
  38755. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38756. /** mag = nearest and min = linear and mip = nearest */
  38757. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38758. /** mag = nearest and min = linear and mip = linear */
  38759. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38760. /** mag = nearest and min = linear and mip = none */
  38761. static readonly TEXTURE_NEAREST_LINEAR: number;
  38762. /** mag = nearest and min = nearest and mip = none */
  38763. static readonly TEXTURE_NEAREST_NEAREST: number;
  38764. /** mag = linear and min = nearest and mip = nearest */
  38765. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38766. /** mag = linear and min = nearest and mip = linear */
  38767. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38768. /** mag = linear and min = linear and mip = none */
  38769. static readonly TEXTURE_LINEAR_LINEAR: number;
  38770. /** mag = linear and min = nearest and mip = none */
  38771. static readonly TEXTURE_LINEAR_NEAREST: number;
  38772. /** Explicit coordinates mode */
  38773. static readonly TEXTURE_EXPLICIT_MODE: number;
  38774. /** Spherical coordinates mode */
  38775. static readonly TEXTURE_SPHERICAL_MODE: number;
  38776. /** Planar coordinates mode */
  38777. static readonly TEXTURE_PLANAR_MODE: number;
  38778. /** Cubic coordinates mode */
  38779. static readonly TEXTURE_CUBIC_MODE: number;
  38780. /** Projection coordinates mode */
  38781. static readonly TEXTURE_PROJECTION_MODE: number;
  38782. /** Skybox coordinates mode */
  38783. static readonly TEXTURE_SKYBOX_MODE: number;
  38784. /** Inverse Cubic coordinates mode */
  38785. static readonly TEXTURE_INVCUBIC_MODE: number;
  38786. /** Equirectangular coordinates mode */
  38787. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38788. /** Equirectangular Fixed coordinates mode */
  38789. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38790. /** Equirectangular Fixed Mirrored coordinates mode */
  38791. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38792. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38793. static readonly SCALEMODE_FLOOR: number;
  38794. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38795. static readonly SCALEMODE_NEAREST: number;
  38796. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38797. static readonly SCALEMODE_CEILING: number;
  38798. /**
  38799. * Returns the current npm package of the sdk
  38800. */
  38801. static get NpmPackage(): string;
  38802. /**
  38803. * Returns the current version of the framework
  38804. */
  38805. static get Version(): string;
  38806. /** Gets the list of created engines */
  38807. static get Instances(): Engine[];
  38808. /**
  38809. * Gets the latest created engine
  38810. */
  38811. static get LastCreatedEngine(): Nullable<Engine>;
  38812. /**
  38813. * Gets the latest created scene
  38814. */
  38815. static get LastCreatedScene(): Nullable<Scene>;
  38816. /**
  38817. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38818. * @param flag defines which part of the materials must be marked as dirty
  38819. * @param predicate defines a predicate used to filter which materials should be affected
  38820. */
  38821. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38822. /**
  38823. * Method called to create the default loading screen.
  38824. * This can be overriden in your own app.
  38825. * @param canvas The rendering canvas element
  38826. * @returns The loading screen
  38827. */
  38828. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38829. /**
  38830. * Method called to create the default rescale post process on each engine.
  38831. */
  38832. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38833. /**
  38834. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38835. **/
  38836. enableOfflineSupport: boolean;
  38837. /**
  38838. * 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)
  38839. **/
  38840. disableManifestCheck: boolean;
  38841. /**
  38842. * Gets the list of created scenes
  38843. */
  38844. scenes: Scene[];
  38845. /**
  38846. * Event raised when a new scene is created
  38847. */
  38848. onNewSceneAddedObservable: Observable<Scene>;
  38849. /**
  38850. * Gets the list of created postprocesses
  38851. */
  38852. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38853. /**
  38854. * Gets a boolean indicating if the pointer is currently locked
  38855. */
  38856. isPointerLock: boolean;
  38857. /**
  38858. * Observable event triggered each time the rendering canvas is resized
  38859. */
  38860. onResizeObservable: Observable<Engine>;
  38861. /**
  38862. * Observable event triggered each time the canvas loses focus
  38863. */
  38864. onCanvasBlurObservable: Observable<Engine>;
  38865. /**
  38866. * Observable event triggered each time the canvas gains focus
  38867. */
  38868. onCanvasFocusObservable: Observable<Engine>;
  38869. /**
  38870. * Observable event triggered each time the canvas receives pointerout event
  38871. */
  38872. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38873. /**
  38874. * Observable raised when the engine begins a new frame
  38875. */
  38876. onBeginFrameObservable: Observable<Engine>;
  38877. /**
  38878. * If set, will be used to request the next animation frame for the render loop
  38879. */
  38880. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38881. /**
  38882. * Observable raised when the engine ends the current frame
  38883. */
  38884. onEndFrameObservable: Observable<Engine>;
  38885. /**
  38886. * Observable raised when the engine is about to compile a shader
  38887. */
  38888. onBeforeShaderCompilationObservable: Observable<Engine>;
  38889. /**
  38890. * Observable raised when the engine has jsut compiled a shader
  38891. */
  38892. onAfterShaderCompilationObservable: Observable<Engine>;
  38893. /**
  38894. * Gets the audio engine
  38895. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38896. * @ignorenaming
  38897. */
  38898. static audioEngine: IAudioEngine;
  38899. /**
  38900. * Default AudioEngine factory responsible of creating the Audio Engine.
  38901. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38902. */
  38903. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38904. /**
  38905. * Default offline support factory responsible of creating a tool used to store data locally.
  38906. * By default, this will create a Database object if the workload has been embedded.
  38907. */
  38908. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38909. private _loadingScreen;
  38910. private _pointerLockRequested;
  38911. private _rescalePostProcess;
  38912. private _deterministicLockstep;
  38913. private _lockstepMaxSteps;
  38914. private _timeStep;
  38915. protected get _supportsHardwareTextureRescaling(): boolean;
  38916. private _fps;
  38917. private _deltaTime;
  38918. /** @hidden */
  38919. _drawCalls: PerfCounter;
  38920. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  38921. canvasTabIndex: number;
  38922. /**
  38923. * Turn this value on if you want to pause FPS computation when in background
  38924. */
  38925. disablePerformanceMonitorInBackground: boolean;
  38926. private _performanceMonitor;
  38927. /**
  38928. * Gets the performance monitor attached to this engine
  38929. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38930. */
  38931. get performanceMonitor(): PerformanceMonitor;
  38932. private _onFocus;
  38933. private _onBlur;
  38934. private _onCanvasPointerOut;
  38935. private _onCanvasBlur;
  38936. private _onCanvasFocus;
  38937. private _onFullscreenChange;
  38938. private _onPointerLockChange;
  38939. /**
  38940. * Gets the HTML element used to attach event listeners
  38941. * @returns a HTML element
  38942. */
  38943. getInputElement(): Nullable<HTMLElement>;
  38944. /**
  38945. * Creates a new engine
  38946. * @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
  38947. * @param antialias defines enable antialiasing (default: false)
  38948. * @param options defines further options to be sent to the getContext() function
  38949. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38950. */
  38951. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38952. /**
  38953. * Gets current aspect ratio
  38954. * @param viewportOwner defines the camera to use to get the aspect ratio
  38955. * @param useScreen defines if screen size must be used (or the current render target if any)
  38956. * @returns a number defining the aspect ratio
  38957. */
  38958. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38959. /**
  38960. * Gets current screen aspect ratio
  38961. * @returns a number defining the aspect ratio
  38962. */
  38963. getScreenAspectRatio(): number;
  38964. /**
  38965. * Gets the client rect of the HTML canvas attached with the current webGL context
  38966. * @returns a client rectanglee
  38967. */
  38968. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38969. /**
  38970. * Gets the client rect of the HTML element used for events
  38971. * @returns a client rectanglee
  38972. */
  38973. getInputElementClientRect(): Nullable<ClientRect>;
  38974. /**
  38975. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38976. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38977. * @returns true if engine is in deterministic lock step mode
  38978. */
  38979. isDeterministicLockStep(): boolean;
  38980. /**
  38981. * Gets the max steps when engine is running in deterministic lock step
  38982. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38983. * @returns the max steps
  38984. */
  38985. getLockstepMaxSteps(): number;
  38986. /**
  38987. * Returns the time in ms between steps when using deterministic lock step.
  38988. * @returns time step in (ms)
  38989. */
  38990. getTimeStep(): number;
  38991. /**
  38992. * Force the mipmap generation for the given render target texture
  38993. * @param texture defines the render target texture to use
  38994. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38995. */
  38996. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38997. /** States */
  38998. /**
  38999. * Set various states to the webGL context
  39000. * @param culling defines backface culling state
  39001. * @param zOffset defines the value to apply to zOffset (0 by default)
  39002. * @param force defines if states must be applied even if cache is up to date
  39003. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39004. */
  39005. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39006. /**
  39007. * Set the z offset to apply to current rendering
  39008. * @param value defines the offset to apply
  39009. */
  39010. setZOffset(value: number): void;
  39011. /**
  39012. * Gets the current value of the zOffset
  39013. * @returns the current zOffset state
  39014. */
  39015. getZOffset(): number;
  39016. /**
  39017. * Enable or disable depth buffering
  39018. * @param enable defines the state to set
  39019. */
  39020. setDepthBuffer(enable: boolean): void;
  39021. /**
  39022. * Gets a boolean indicating if depth writing is enabled
  39023. * @returns the current depth writing state
  39024. */
  39025. getDepthWrite(): boolean;
  39026. /**
  39027. * Enable or disable depth writing
  39028. * @param enable defines the state to set
  39029. */
  39030. setDepthWrite(enable: boolean): void;
  39031. /**
  39032. * Gets a boolean indicating if stencil buffer is enabled
  39033. * @returns the current stencil buffer state
  39034. */
  39035. getStencilBuffer(): boolean;
  39036. /**
  39037. * Enable or disable the stencil buffer
  39038. * @param enable defines if the stencil buffer must be enabled or disabled
  39039. */
  39040. setStencilBuffer(enable: boolean): void;
  39041. /**
  39042. * Gets the current stencil mask
  39043. * @returns a number defining the new stencil mask to use
  39044. */
  39045. getStencilMask(): number;
  39046. /**
  39047. * Sets the current stencil mask
  39048. * @param mask defines the new stencil mask to use
  39049. */
  39050. setStencilMask(mask: number): void;
  39051. /**
  39052. * Gets the current stencil function
  39053. * @returns a number defining the stencil function to use
  39054. */
  39055. getStencilFunction(): number;
  39056. /**
  39057. * Gets the current stencil reference value
  39058. * @returns a number defining the stencil reference value to use
  39059. */
  39060. getStencilFunctionReference(): number;
  39061. /**
  39062. * Gets the current stencil mask
  39063. * @returns a number defining the stencil mask to use
  39064. */
  39065. getStencilFunctionMask(): number;
  39066. /**
  39067. * Sets the current stencil function
  39068. * @param stencilFunc defines the new stencil function to use
  39069. */
  39070. setStencilFunction(stencilFunc: number): void;
  39071. /**
  39072. * Sets the current stencil reference
  39073. * @param reference defines the new stencil reference to use
  39074. */
  39075. setStencilFunctionReference(reference: number): void;
  39076. /**
  39077. * Sets the current stencil mask
  39078. * @param mask defines the new stencil mask to use
  39079. */
  39080. setStencilFunctionMask(mask: number): void;
  39081. /**
  39082. * Gets the current stencil operation when stencil fails
  39083. * @returns a number defining stencil operation to use when stencil fails
  39084. */
  39085. getStencilOperationFail(): number;
  39086. /**
  39087. * Gets the current stencil operation when depth fails
  39088. * @returns a number defining stencil operation to use when depth fails
  39089. */
  39090. getStencilOperationDepthFail(): number;
  39091. /**
  39092. * Gets the current stencil operation when stencil passes
  39093. * @returns a number defining stencil operation to use when stencil passes
  39094. */
  39095. getStencilOperationPass(): number;
  39096. /**
  39097. * Sets the stencil operation to use when stencil fails
  39098. * @param operation defines the stencil operation to use when stencil fails
  39099. */
  39100. setStencilOperationFail(operation: number): void;
  39101. /**
  39102. * Sets the stencil operation to use when depth fails
  39103. * @param operation defines the stencil operation to use when depth fails
  39104. */
  39105. setStencilOperationDepthFail(operation: number): void;
  39106. /**
  39107. * Sets the stencil operation to use when stencil passes
  39108. * @param operation defines the stencil operation to use when stencil passes
  39109. */
  39110. setStencilOperationPass(operation: number): void;
  39111. /**
  39112. * Sets a boolean indicating if the dithering state is enabled or disabled
  39113. * @param value defines the dithering state
  39114. */
  39115. setDitheringState(value: boolean): void;
  39116. /**
  39117. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39118. * @param value defines the rasterizer state
  39119. */
  39120. setRasterizerState(value: boolean): void;
  39121. /**
  39122. * Gets the current depth function
  39123. * @returns a number defining the depth function
  39124. */
  39125. getDepthFunction(): Nullable<number>;
  39126. /**
  39127. * Sets the current depth function
  39128. * @param depthFunc defines the function to use
  39129. */
  39130. setDepthFunction(depthFunc: number): void;
  39131. /**
  39132. * Sets the current depth function to GREATER
  39133. */
  39134. setDepthFunctionToGreater(): void;
  39135. /**
  39136. * Sets the current depth function to GEQUAL
  39137. */
  39138. setDepthFunctionToGreaterOrEqual(): void;
  39139. /**
  39140. * Sets the current depth function to LESS
  39141. */
  39142. setDepthFunctionToLess(): void;
  39143. /**
  39144. * Sets the current depth function to LEQUAL
  39145. */
  39146. setDepthFunctionToLessOrEqual(): void;
  39147. private _cachedStencilBuffer;
  39148. private _cachedStencilFunction;
  39149. private _cachedStencilMask;
  39150. private _cachedStencilOperationPass;
  39151. private _cachedStencilOperationFail;
  39152. private _cachedStencilOperationDepthFail;
  39153. private _cachedStencilReference;
  39154. /**
  39155. * Caches the the state of the stencil buffer
  39156. */
  39157. cacheStencilState(): void;
  39158. /**
  39159. * Restores the state of the stencil buffer
  39160. */
  39161. restoreStencilState(): void;
  39162. /**
  39163. * Directly set the WebGL Viewport
  39164. * @param x defines the x coordinate of the viewport (in screen space)
  39165. * @param y defines the y coordinate of the viewport (in screen space)
  39166. * @param width defines the width of the viewport (in screen space)
  39167. * @param height defines the height of the viewport (in screen space)
  39168. * @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
  39169. */
  39170. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39171. /**
  39172. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39173. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39174. * @param y defines the y-coordinate of the corner of the clear rectangle
  39175. * @param width defines the width of the clear rectangle
  39176. * @param height defines the height of the clear rectangle
  39177. * @param clearColor defines the clear color
  39178. */
  39179. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39180. /**
  39181. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39182. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39183. * @param y defines the y-coordinate of the corner of the clear rectangle
  39184. * @param width defines the width of the clear rectangle
  39185. * @param height defines the height of the clear rectangle
  39186. */
  39187. enableScissor(x: number, y: number, width: number, height: number): void;
  39188. /**
  39189. * Disable previously set scissor test rectangle
  39190. */
  39191. disableScissor(): void;
  39192. protected _reportDrawCall(): void;
  39193. /**
  39194. * Initializes a webVR display and starts listening to display change events
  39195. * The onVRDisplayChangedObservable will be notified upon these changes
  39196. * @returns The onVRDisplayChangedObservable
  39197. */
  39198. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39199. /** @hidden */
  39200. _prepareVRComponent(): void;
  39201. /** @hidden */
  39202. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39203. /** @hidden */
  39204. _submitVRFrame(): void;
  39205. /**
  39206. * Call this function to leave webVR mode
  39207. * Will do nothing if webVR is not supported or if there is no webVR device
  39208. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39209. */
  39210. disableVR(): void;
  39211. /**
  39212. * Gets a boolean indicating that the system is in VR mode and is presenting
  39213. * @returns true if VR mode is engaged
  39214. */
  39215. isVRPresenting(): boolean;
  39216. /** @hidden */
  39217. _requestVRFrame(): void;
  39218. /** @hidden */
  39219. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39220. /**
  39221. * Gets the source code of the vertex shader associated with a specific webGL program
  39222. * @param program defines the program to use
  39223. * @returns a string containing the source code of the vertex shader associated with the program
  39224. */
  39225. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39226. /**
  39227. * Gets the source code of the fragment shader associated with a specific webGL program
  39228. * @param program defines the program to use
  39229. * @returns a string containing the source code of the fragment shader associated with the program
  39230. */
  39231. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39232. /**
  39233. * Sets a depth stencil texture from a render target to the according uniform.
  39234. * @param channel The texture channel
  39235. * @param uniform The uniform to set
  39236. * @param texture The render target texture containing the depth stencil texture to apply
  39237. */
  39238. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39239. /**
  39240. * Sets a texture to the webGL context from a postprocess
  39241. * @param channel defines the channel to use
  39242. * @param postProcess defines the source postprocess
  39243. */
  39244. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39245. /**
  39246. * Binds the output of the passed in post process to the texture channel specified
  39247. * @param channel The channel the texture should be bound to
  39248. * @param postProcess The post process which's output should be bound
  39249. */
  39250. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39251. protected _rebuildBuffers(): void;
  39252. /** @hidden */
  39253. _renderFrame(): void;
  39254. _renderLoop(): void;
  39255. /** @hidden */
  39256. _renderViews(): boolean;
  39257. /**
  39258. * Toggle full screen mode
  39259. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39260. */
  39261. switchFullscreen(requestPointerLock: boolean): void;
  39262. /**
  39263. * Enters full screen mode
  39264. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39265. */
  39266. enterFullscreen(requestPointerLock: boolean): void;
  39267. /**
  39268. * Exits full screen mode
  39269. */
  39270. exitFullscreen(): void;
  39271. /**
  39272. * Enters Pointerlock mode
  39273. */
  39274. enterPointerlock(): void;
  39275. /**
  39276. * Exits Pointerlock mode
  39277. */
  39278. exitPointerlock(): void;
  39279. /**
  39280. * Begin a new frame
  39281. */
  39282. beginFrame(): void;
  39283. /**
  39284. * Enf the current frame
  39285. */
  39286. endFrame(): void;
  39287. resize(): void;
  39288. /**
  39289. * Force a specific size of the canvas
  39290. * @param width defines the new canvas' width
  39291. * @param height defines the new canvas' height
  39292. * @returns true if the size was changed
  39293. */
  39294. setSize(width: number, height: number): boolean;
  39295. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39296. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39297. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39298. _releaseTexture(texture: InternalTexture): void;
  39299. /**
  39300. * @hidden
  39301. * Rescales a texture
  39302. * @param source input texutre
  39303. * @param destination destination texture
  39304. * @param scene scene to use to render the resize
  39305. * @param internalFormat format to use when resizing
  39306. * @param onComplete callback to be called when resize has completed
  39307. */
  39308. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39309. /**
  39310. * Gets the current framerate
  39311. * @returns a number representing the framerate
  39312. */
  39313. getFps(): number;
  39314. /**
  39315. * Gets the time spent between current and previous frame
  39316. * @returns a number representing the delta time in ms
  39317. */
  39318. getDeltaTime(): number;
  39319. private _measureFps;
  39320. /** @hidden */
  39321. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39322. /**
  39323. * Updates the sample count of a render target texture
  39324. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39325. * @param texture defines the texture to update
  39326. * @param samples defines the sample count to set
  39327. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39328. */
  39329. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39330. /**
  39331. * Updates a depth texture Comparison Mode and Function.
  39332. * If the comparison Function is equal to 0, the mode will be set to none.
  39333. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39334. * @param texture The texture to set the comparison function for
  39335. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39336. */
  39337. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39338. /**
  39339. * Creates a webGL buffer to use with instanciation
  39340. * @param capacity defines the size of the buffer
  39341. * @returns the webGL buffer
  39342. */
  39343. createInstancesBuffer(capacity: number): DataBuffer;
  39344. /**
  39345. * Delete a webGL buffer used with instanciation
  39346. * @param buffer defines the webGL buffer to delete
  39347. */
  39348. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39349. private _clientWaitAsync;
  39350. /** @hidden */
  39351. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39352. dispose(): void;
  39353. private _disableTouchAction;
  39354. /**
  39355. * Display the loading screen
  39356. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39357. */
  39358. displayLoadingUI(): void;
  39359. /**
  39360. * Hide the loading screen
  39361. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39362. */
  39363. hideLoadingUI(): void;
  39364. /**
  39365. * Gets the current loading screen object
  39366. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39367. */
  39368. get loadingScreen(): ILoadingScreen;
  39369. /**
  39370. * Sets the current loading screen object
  39371. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39372. */
  39373. set loadingScreen(loadingScreen: ILoadingScreen);
  39374. /**
  39375. * Sets the current loading screen text
  39376. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39377. */
  39378. set loadingUIText(text: string);
  39379. /**
  39380. * Sets the current loading screen background color
  39381. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39382. */
  39383. set loadingUIBackgroundColor(color: string);
  39384. /** Pointerlock and fullscreen */
  39385. /**
  39386. * Ask the browser to promote the current element to pointerlock mode
  39387. * @param element defines the DOM element to promote
  39388. */
  39389. static _RequestPointerlock(element: HTMLElement): void;
  39390. /**
  39391. * Asks the browser to exit pointerlock mode
  39392. */
  39393. static _ExitPointerlock(): void;
  39394. /**
  39395. * Ask the browser to promote the current element to fullscreen rendering mode
  39396. * @param element defines the DOM element to promote
  39397. */
  39398. static _RequestFullscreen(element: HTMLElement): void;
  39399. /**
  39400. * Asks the browser to exit fullscreen mode
  39401. */
  39402. static _ExitFullscreen(): void;
  39403. }
  39404. }
  39405. declare module "babylonjs/Engines/engineStore" {
  39406. import { Nullable } from "babylonjs/types";
  39407. import { Engine } from "babylonjs/Engines/engine";
  39408. import { Scene } from "babylonjs/scene";
  39409. /**
  39410. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39411. * during the life time of the application.
  39412. */
  39413. export class EngineStore {
  39414. /** Gets the list of created engines */
  39415. static Instances: import("babylonjs/Engines/engine").Engine[];
  39416. /** @hidden */
  39417. static _LastCreatedScene: Nullable<Scene>;
  39418. /**
  39419. * Gets the latest created engine
  39420. */
  39421. static get LastCreatedEngine(): Nullable<Engine>;
  39422. /**
  39423. * Gets the latest created scene
  39424. */
  39425. static get LastCreatedScene(): Nullable<Scene>;
  39426. /**
  39427. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39428. * @ignorenaming
  39429. */
  39430. static UseFallbackTexture: boolean;
  39431. /**
  39432. * Texture content used if a texture cannot loaded
  39433. * @ignorenaming
  39434. */
  39435. static FallbackTexture: string;
  39436. }
  39437. }
  39438. declare module "babylonjs/Misc/promise" {
  39439. /**
  39440. * Helper class that provides a small promise polyfill
  39441. */
  39442. export class PromisePolyfill {
  39443. /**
  39444. * Static function used to check if the polyfill is required
  39445. * If this is the case then the function will inject the polyfill to window.Promise
  39446. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39447. */
  39448. static Apply(force?: boolean): void;
  39449. }
  39450. }
  39451. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39452. /**
  39453. * Interface for screenshot methods with describe argument called `size` as object with options
  39454. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39455. */
  39456. export interface IScreenshotSize {
  39457. /**
  39458. * number in pixels for canvas height
  39459. */
  39460. height?: number;
  39461. /**
  39462. * multiplier allowing render at a higher or lower resolution
  39463. * If value is defined then height and width will be ignored and taken from camera
  39464. */
  39465. precision?: number;
  39466. /**
  39467. * number in pixels for canvas width
  39468. */
  39469. width?: number;
  39470. }
  39471. }
  39472. declare module "babylonjs/Misc/tools" {
  39473. import { Nullable, float } from "babylonjs/types";
  39474. import { DomManagement } from "babylonjs/Misc/domManagement";
  39475. import { WebRequest } from "babylonjs/Misc/webRequest";
  39476. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39477. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39478. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39479. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39480. import { Camera } from "babylonjs/Cameras/camera";
  39481. import { Engine } from "babylonjs/Engines/engine";
  39482. interface IColor4Like {
  39483. r: float;
  39484. g: float;
  39485. b: float;
  39486. a: float;
  39487. }
  39488. /**
  39489. * Class containing a set of static utilities functions
  39490. */
  39491. export class Tools {
  39492. /**
  39493. * Gets or sets the base URL to use to load assets
  39494. */
  39495. static get BaseUrl(): string;
  39496. static set BaseUrl(value: string);
  39497. /**
  39498. * Enable/Disable Custom HTTP Request Headers globally.
  39499. * default = false
  39500. * @see CustomRequestHeaders
  39501. */
  39502. static UseCustomRequestHeaders: boolean;
  39503. /**
  39504. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39505. * i.e. when loading files, where the server/service expects an Authorization header
  39506. */
  39507. static CustomRequestHeaders: {
  39508. [key: string]: string;
  39509. };
  39510. /**
  39511. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39512. */
  39513. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39514. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39515. /**
  39516. * Default behaviour for cors in the application.
  39517. * It can be a string if the expected behavior is identical in the entire app.
  39518. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39519. */
  39520. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39521. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39522. /**
  39523. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39524. * @ignorenaming
  39525. */
  39526. static get UseFallbackTexture(): boolean;
  39527. static set UseFallbackTexture(value: boolean);
  39528. /**
  39529. * Use this object to register external classes like custom textures or material
  39530. * to allow the laoders to instantiate them
  39531. */
  39532. static get RegisteredExternalClasses(): {
  39533. [key: string]: Object;
  39534. };
  39535. static set RegisteredExternalClasses(classes: {
  39536. [key: string]: Object;
  39537. });
  39538. /**
  39539. * Texture content used if a texture cannot loaded
  39540. * @ignorenaming
  39541. */
  39542. static get fallbackTexture(): string;
  39543. static set fallbackTexture(value: string);
  39544. /**
  39545. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39546. * @param u defines the coordinate on X axis
  39547. * @param v defines the coordinate on Y axis
  39548. * @param width defines the width of the source data
  39549. * @param height defines the height of the source data
  39550. * @param pixels defines the source byte array
  39551. * @param color defines the output color
  39552. */
  39553. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39554. /**
  39555. * Interpolates between a and b via alpha
  39556. * @param a The lower value (returned when alpha = 0)
  39557. * @param b The upper value (returned when alpha = 1)
  39558. * @param alpha The interpolation-factor
  39559. * @return The mixed value
  39560. */
  39561. static Mix(a: number, b: number, alpha: number): number;
  39562. /**
  39563. * Tries to instantiate a new object from a given class name
  39564. * @param className defines the class name to instantiate
  39565. * @returns the new object or null if the system was not able to do the instantiation
  39566. */
  39567. static Instantiate(className: string): any;
  39568. /**
  39569. * Provides a slice function that will work even on IE
  39570. * @param data defines the array to slice
  39571. * @param start defines the start of the data (optional)
  39572. * @param end defines the end of the data (optional)
  39573. * @returns the new sliced array
  39574. */
  39575. static Slice<T>(data: T, start?: number, end?: number): T;
  39576. /**
  39577. * Polyfill for setImmediate
  39578. * @param action defines the action to execute after the current execution block
  39579. */
  39580. static SetImmediate(action: () => void): void;
  39581. /**
  39582. * Function indicating if a number is an exponent of 2
  39583. * @param value defines the value to test
  39584. * @returns true if the value is an exponent of 2
  39585. */
  39586. static IsExponentOfTwo(value: number): boolean;
  39587. private static _tmpFloatArray;
  39588. /**
  39589. * Returns the nearest 32-bit single precision float representation of a Number
  39590. * @param value A Number. If the parameter is of a different type, it will get converted
  39591. * to a number or to NaN if it cannot be converted
  39592. * @returns number
  39593. */
  39594. static FloatRound(value: number): number;
  39595. /**
  39596. * Extracts the filename from a path
  39597. * @param path defines the path to use
  39598. * @returns the filename
  39599. */
  39600. static GetFilename(path: string): string;
  39601. /**
  39602. * Extracts the "folder" part of a path (everything before the filename).
  39603. * @param uri The URI to extract the info from
  39604. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39605. * @returns The "folder" part of the path
  39606. */
  39607. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39608. /**
  39609. * Extracts text content from a DOM element hierarchy
  39610. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39611. */
  39612. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39613. /**
  39614. * Convert an angle in radians to degrees
  39615. * @param angle defines the angle to convert
  39616. * @returns the angle in degrees
  39617. */
  39618. static ToDegrees(angle: number): number;
  39619. /**
  39620. * Convert an angle in degrees to radians
  39621. * @param angle defines the angle to convert
  39622. * @returns the angle in radians
  39623. */
  39624. static ToRadians(angle: number): number;
  39625. /**
  39626. * Returns an array if obj is not an array
  39627. * @param obj defines the object to evaluate as an array
  39628. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39629. * @returns either obj directly if obj is an array or a new array containing obj
  39630. */
  39631. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39632. /**
  39633. * Gets the pointer prefix to use
  39634. * @param engine defines the engine we are finding the prefix for
  39635. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39636. */
  39637. static GetPointerPrefix(engine: Engine): string;
  39638. /**
  39639. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39640. * @param url define the url we are trying
  39641. * @param element define the dom element where to configure the cors policy
  39642. */
  39643. static SetCorsBehavior(url: string | string[], element: {
  39644. crossOrigin: string | null;
  39645. }): void;
  39646. /**
  39647. * Removes unwanted characters from an url
  39648. * @param url defines the url to clean
  39649. * @returns the cleaned url
  39650. */
  39651. static CleanUrl(url: string): string;
  39652. /**
  39653. * Gets or sets a function used to pre-process url before using them to load assets
  39654. */
  39655. static get PreprocessUrl(): (url: string) => string;
  39656. static set PreprocessUrl(processor: (url: string) => string);
  39657. /**
  39658. * Loads an image as an HTMLImageElement.
  39659. * @param input url string, ArrayBuffer, or Blob to load
  39660. * @param onLoad callback called when the image successfully loads
  39661. * @param onError callback called when the image fails to load
  39662. * @param offlineProvider offline provider for caching
  39663. * @param mimeType optional mime type
  39664. * @returns the HTMLImageElement of the loaded image
  39665. */
  39666. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39667. /**
  39668. * Loads a file from a url
  39669. * @param url url string, ArrayBuffer, or Blob to load
  39670. * @param onSuccess callback called when the file successfully loads
  39671. * @param onProgress callback called while file is loading (if the server supports this mode)
  39672. * @param offlineProvider defines the offline provider for caching
  39673. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39674. * @param onError callback called when the file fails to load
  39675. * @returns a file request object
  39676. */
  39677. 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;
  39678. /**
  39679. * Loads a file from a url
  39680. * @param url the file url to load
  39681. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39682. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39683. */
  39684. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39685. /**
  39686. * Load a script (identified by an url). When the url returns, the
  39687. * content of this file is added into a new script element, attached to the DOM (body element)
  39688. * @param scriptUrl defines the url of the script to laod
  39689. * @param onSuccess defines the callback called when the script is loaded
  39690. * @param onError defines the callback to call if an error occurs
  39691. * @param scriptId defines the id of the script element
  39692. */
  39693. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39694. /**
  39695. * Load an asynchronous script (identified by an url). When the url returns, the
  39696. * content of this file is added into a new script element, attached to the DOM (body element)
  39697. * @param scriptUrl defines the url of the script to laod
  39698. * @param scriptId defines the id of the script element
  39699. * @returns a promise request object
  39700. */
  39701. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39702. /**
  39703. * Loads a file from a blob
  39704. * @param fileToLoad defines the blob to use
  39705. * @param callback defines the callback to call when data is loaded
  39706. * @param progressCallback defines the callback to call during loading process
  39707. * @returns a file request object
  39708. */
  39709. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39710. /**
  39711. * Reads a file from a File object
  39712. * @param file defines the file to load
  39713. * @param onSuccess defines the callback to call when data is loaded
  39714. * @param onProgress defines the callback to call during loading process
  39715. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39716. * @param onError defines the callback to call when an error occurs
  39717. * @returns a file request object
  39718. */
  39719. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39720. /**
  39721. * Creates a data url from a given string content
  39722. * @param content defines the content to convert
  39723. * @returns the new data url link
  39724. */
  39725. static FileAsURL(content: string): string;
  39726. /**
  39727. * Format the given number to a specific decimal format
  39728. * @param value defines the number to format
  39729. * @param decimals defines the number of decimals to use
  39730. * @returns the formatted string
  39731. */
  39732. static Format(value: number, decimals?: number): string;
  39733. /**
  39734. * Tries to copy an object by duplicating every property
  39735. * @param source defines the source object
  39736. * @param destination defines the target object
  39737. * @param doNotCopyList defines a list of properties to avoid
  39738. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39739. */
  39740. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39741. /**
  39742. * Gets a boolean indicating if the given object has no own property
  39743. * @param obj defines the object to test
  39744. * @returns true if object has no own property
  39745. */
  39746. static IsEmpty(obj: any): boolean;
  39747. /**
  39748. * Function used to register events at window level
  39749. * @param windowElement defines the Window object to use
  39750. * @param events defines the events to register
  39751. */
  39752. static RegisterTopRootEvents(windowElement: Window, events: {
  39753. name: string;
  39754. handler: Nullable<(e: FocusEvent) => any>;
  39755. }[]): void;
  39756. /**
  39757. * Function used to unregister events from window level
  39758. * @param windowElement defines the Window object to use
  39759. * @param events defines the events to unregister
  39760. */
  39761. static UnregisterTopRootEvents(windowElement: Window, events: {
  39762. name: string;
  39763. handler: Nullable<(e: FocusEvent) => any>;
  39764. }[]): void;
  39765. /**
  39766. * @ignore
  39767. */
  39768. static _ScreenshotCanvas: HTMLCanvasElement;
  39769. /**
  39770. * Dumps the current bound framebuffer
  39771. * @param width defines the rendering width
  39772. * @param height defines the rendering height
  39773. * @param engine defines the hosting engine
  39774. * @param successCallback defines the callback triggered once the data are available
  39775. * @param mimeType defines the mime type of the result
  39776. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39777. */
  39778. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39779. /**
  39780. * Converts the canvas data to blob.
  39781. * This acts as a polyfill for browsers not supporting the to blob function.
  39782. * @param canvas Defines the canvas to extract the data from
  39783. * @param successCallback Defines the callback triggered once the data are available
  39784. * @param mimeType Defines the mime type of the result
  39785. */
  39786. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39787. /**
  39788. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39789. * @param successCallback defines the callback triggered once the data are available
  39790. * @param mimeType defines the mime type of the result
  39791. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39792. */
  39793. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39794. /**
  39795. * Downloads a blob in the browser
  39796. * @param blob defines the blob to download
  39797. * @param fileName defines the name of the downloaded file
  39798. */
  39799. static Download(blob: Blob, fileName: string): void;
  39800. /**
  39801. * Captures a screenshot of the current rendering
  39802. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39803. * @param engine defines the rendering engine
  39804. * @param camera defines the source camera
  39805. * @param size This parameter can be set to a single number or to an object with the
  39806. * following (optional) properties: precision, width, height. If a single number is passed,
  39807. * it will be used for both width and height. If an object is passed, the screenshot size
  39808. * will be derived from the parameters. The precision property is a multiplier allowing
  39809. * rendering at a higher or lower resolution
  39810. * @param successCallback defines the callback receives a single parameter which contains the
  39811. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39812. * src parameter of an <img> to display it
  39813. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39814. * Check your browser for supported MIME types
  39815. */
  39816. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39817. /**
  39818. * Captures a screenshot of the current rendering
  39819. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39820. * @param engine defines the rendering engine
  39821. * @param camera defines the source camera
  39822. * @param size This parameter can be set to a single number or to an object with the
  39823. * following (optional) properties: precision, width, height. If a single number is passed,
  39824. * it will be used for both width and height. If an object is passed, the screenshot size
  39825. * will be derived from the parameters. The precision property is a multiplier allowing
  39826. * rendering at a higher or lower resolution
  39827. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39828. * Check your browser for supported MIME types
  39829. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39830. * to the src parameter of an <img> to display it
  39831. */
  39832. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39833. /**
  39834. * Generates an image screenshot from the specified camera.
  39835. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39836. * @param engine The engine to use for rendering
  39837. * @param camera The camera to use for rendering
  39838. * @param size This parameter can be set to a single number or to an object with the
  39839. * following (optional) properties: precision, width, height. If a single number is passed,
  39840. * it will be used for both width and height. If an object is passed, the screenshot size
  39841. * will be derived from the parameters. The precision property is a multiplier allowing
  39842. * rendering at a higher or lower resolution
  39843. * @param successCallback The callback receives a single parameter which contains the
  39844. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39845. * src parameter of an <img> to display it
  39846. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39847. * Check your browser for supported MIME types
  39848. * @param samples Texture samples (default: 1)
  39849. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39850. * @param fileName A name for for the downloaded file.
  39851. */
  39852. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39853. /**
  39854. * Generates an image screenshot from the specified camera.
  39855. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39856. * @param engine The engine to use for rendering
  39857. * @param camera The camera to use for rendering
  39858. * @param size This parameter can be set to a single number or to an object with the
  39859. * following (optional) properties: precision, width, height. If a single number is passed,
  39860. * it will be used for both width and height. If an object is passed, the screenshot size
  39861. * will be derived from the parameters. The precision property is a multiplier allowing
  39862. * rendering at a higher or lower resolution
  39863. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39864. * Check your browser for supported MIME types
  39865. * @param samples Texture samples (default: 1)
  39866. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39867. * @param fileName A name for for the downloaded file.
  39868. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39869. * to the src parameter of an <img> to display it
  39870. */
  39871. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39872. /**
  39873. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39874. * Be aware Math.random() could cause collisions, but:
  39875. * "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"
  39876. * @returns a pseudo random id
  39877. */
  39878. static RandomId(): string;
  39879. /**
  39880. * Test if the given uri is a base64 string
  39881. * @param uri The uri to test
  39882. * @return True if the uri is a base64 string or false otherwise
  39883. */
  39884. static IsBase64(uri: string): boolean;
  39885. /**
  39886. * Decode the given base64 uri.
  39887. * @param uri The uri to decode
  39888. * @return The decoded base64 data.
  39889. */
  39890. static DecodeBase64(uri: string): ArrayBuffer;
  39891. /**
  39892. * Gets the absolute url.
  39893. * @param url the input url
  39894. * @return the absolute url
  39895. */
  39896. static GetAbsoluteUrl(url: string): string;
  39897. /**
  39898. * No log
  39899. */
  39900. static readonly NoneLogLevel: number;
  39901. /**
  39902. * Only message logs
  39903. */
  39904. static readonly MessageLogLevel: number;
  39905. /**
  39906. * Only warning logs
  39907. */
  39908. static readonly WarningLogLevel: number;
  39909. /**
  39910. * Only error logs
  39911. */
  39912. static readonly ErrorLogLevel: number;
  39913. /**
  39914. * All logs
  39915. */
  39916. static readonly AllLogLevel: number;
  39917. /**
  39918. * Gets a value indicating the number of loading errors
  39919. * @ignorenaming
  39920. */
  39921. static get errorsCount(): number;
  39922. /**
  39923. * Callback called when a new log is added
  39924. */
  39925. static OnNewCacheEntry: (entry: string) => void;
  39926. /**
  39927. * Log a message to the console
  39928. * @param message defines the message to log
  39929. */
  39930. static Log(message: string): void;
  39931. /**
  39932. * Write a warning message to the console
  39933. * @param message defines the message to log
  39934. */
  39935. static Warn(message: string): void;
  39936. /**
  39937. * Write an error message to the console
  39938. * @param message defines the message to log
  39939. */
  39940. static Error(message: string): void;
  39941. /**
  39942. * Gets current log cache (list of logs)
  39943. */
  39944. static get LogCache(): string;
  39945. /**
  39946. * Clears the log cache
  39947. */
  39948. static ClearLogCache(): void;
  39949. /**
  39950. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39951. */
  39952. static set LogLevels(level: number);
  39953. /**
  39954. * Checks if the window object exists
  39955. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39956. */
  39957. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39958. /**
  39959. * No performance log
  39960. */
  39961. static readonly PerformanceNoneLogLevel: number;
  39962. /**
  39963. * Use user marks to log performance
  39964. */
  39965. static readonly PerformanceUserMarkLogLevel: number;
  39966. /**
  39967. * Log performance to the console
  39968. */
  39969. static readonly PerformanceConsoleLogLevel: number;
  39970. private static _performance;
  39971. /**
  39972. * Sets the current performance log level
  39973. */
  39974. static set PerformanceLogLevel(level: number);
  39975. private static _StartPerformanceCounterDisabled;
  39976. private static _EndPerformanceCounterDisabled;
  39977. private static _StartUserMark;
  39978. private static _EndUserMark;
  39979. private static _StartPerformanceConsole;
  39980. private static _EndPerformanceConsole;
  39981. /**
  39982. * Starts a performance counter
  39983. */
  39984. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39985. /**
  39986. * Ends a specific performance coutner
  39987. */
  39988. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39989. /**
  39990. * Gets either window.performance.now() if supported or Date.now() else
  39991. */
  39992. static get Now(): number;
  39993. /**
  39994. * This method will return the name of the class used to create the instance of the given object.
  39995. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39996. * @param object the object to get the class name from
  39997. * @param isType defines if the object is actually a type
  39998. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39999. */
  40000. static GetClassName(object: any, isType?: boolean): string;
  40001. /**
  40002. * Gets the first element of an array satisfying a given predicate
  40003. * @param array defines the array to browse
  40004. * @param predicate defines the predicate to use
  40005. * @returns null if not found or the element
  40006. */
  40007. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40008. /**
  40009. * This method will return the name of the full name of the class, including its owning module (if any).
  40010. * 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).
  40011. * @param object the object to get the class name from
  40012. * @param isType defines if the object is actually a type
  40013. * @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.
  40014. * @ignorenaming
  40015. */
  40016. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40017. /**
  40018. * Returns a promise that resolves after the given amount of time.
  40019. * @param delay Number of milliseconds to delay
  40020. * @returns Promise that resolves after the given amount of time
  40021. */
  40022. static DelayAsync(delay: number): Promise<void>;
  40023. /**
  40024. * Utility function to detect if the current user agent is Safari
  40025. * @returns whether or not the current user agent is safari
  40026. */
  40027. static IsSafari(): boolean;
  40028. }
  40029. /**
  40030. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40031. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40032. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40033. * @param name The name of the class, case should be preserved
  40034. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40035. */
  40036. export function className(name: string, module?: string): (target: Object) => void;
  40037. /**
  40038. * An implementation of a loop for asynchronous functions.
  40039. */
  40040. export class AsyncLoop {
  40041. /**
  40042. * Defines the number of iterations for the loop
  40043. */
  40044. iterations: number;
  40045. /**
  40046. * Defines the current index of the loop.
  40047. */
  40048. index: number;
  40049. private _done;
  40050. private _fn;
  40051. private _successCallback;
  40052. /**
  40053. * Constructor.
  40054. * @param iterations the number of iterations.
  40055. * @param func the function to run each iteration
  40056. * @param successCallback the callback that will be called upon succesful execution
  40057. * @param offset starting offset.
  40058. */
  40059. constructor(
  40060. /**
  40061. * Defines the number of iterations for the loop
  40062. */
  40063. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40064. /**
  40065. * Execute the next iteration. Must be called after the last iteration was finished.
  40066. */
  40067. executeNext(): void;
  40068. /**
  40069. * Break the loop and run the success callback.
  40070. */
  40071. breakLoop(): void;
  40072. /**
  40073. * Create and run an async loop.
  40074. * @param iterations the number of iterations.
  40075. * @param fn the function to run each iteration
  40076. * @param successCallback the callback that will be called upon succesful execution
  40077. * @param offset starting offset.
  40078. * @returns the created async loop object
  40079. */
  40080. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40081. /**
  40082. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40083. * @param iterations total number of iterations
  40084. * @param syncedIterations number of synchronous iterations in each async iteration.
  40085. * @param fn the function to call each iteration.
  40086. * @param callback a success call back that will be called when iterating stops.
  40087. * @param breakFunction a break condition (optional)
  40088. * @param timeout timeout settings for the setTimeout function. default - 0.
  40089. * @returns the created async loop object
  40090. */
  40091. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40092. }
  40093. }
  40094. declare module "babylonjs/Misc/stringDictionary" {
  40095. import { Nullable } from "babylonjs/types";
  40096. /**
  40097. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40098. * The underlying implementation relies on an associative array to ensure the best performances.
  40099. * The value can be anything including 'null' but except 'undefined'
  40100. */
  40101. export class StringDictionary<T> {
  40102. /**
  40103. * This will clear this dictionary and copy the content from the 'source' one.
  40104. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40105. * @param source the dictionary to take the content from and copy to this dictionary
  40106. */
  40107. copyFrom(source: StringDictionary<T>): void;
  40108. /**
  40109. * Get a value based from its key
  40110. * @param key the given key to get the matching value from
  40111. * @return the value if found, otherwise undefined is returned
  40112. */
  40113. get(key: string): T | undefined;
  40114. /**
  40115. * Get a value from its key or add it if it doesn't exist.
  40116. * This method will ensure you that a given key/data will be present in the dictionary.
  40117. * @param key the given key to get the matching value from
  40118. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40119. * The factory will only be invoked if there's no data for the given key.
  40120. * @return the value corresponding to the key.
  40121. */
  40122. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40123. /**
  40124. * Get a value from its key if present in the dictionary otherwise add it
  40125. * @param key the key to get the value from
  40126. * @param val if there's no such key/value pair in the dictionary add it with this value
  40127. * @return the value corresponding to the key
  40128. */
  40129. getOrAdd(key: string, val: T): T;
  40130. /**
  40131. * Check if there's a given key in the dictionary
  40132. * @param key the key to check for
  40133. * @return true if the key is present, false otherwise
  40134. */
  40135. contains(key: string): boolean;
  40136. /**
  40137. * Add a new key and its corresponding value
  40138. * @param key the key to add
  40139. * @param value the value corresponding to the key
  40140. * @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
  40141. */
  40142. add(key: string, value: T): boolean;
  40143. /**
  40144. * Update a specific value associated to a key
  40145. * @param key defines the key to use
  40146. * @param value defines the value to store
  40147. * @returns true if the value was updated (or false if the key was not found)
  40148. */
  40149. set(key: string, value: T): boolean;
  40150. /**
  40151. * Get the element of the given key and remove it from the dictionary
  40152. * @param key defines the key to search
  40153. * @returns the value associated with the key or null if not found
  40154. */
  40155. getAndRemove(key: string): Nullable<T>;
  40156. /**
  40157. * Remove a key/value from the dictionary.
  40158. * @param key the key to remove
  40159. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40160. */
  40161. remove(key: string): boolean;
  40162. /**
  40163. * Clear the whole content of the dictionary
  40164. */
  40165. clear(): void;
  40166. /**
  40167. * Gets the current count
  40168. */
  40169. get count(): number;
  40170. /**
  40171. * Execute a callback on each key/val of the dictionary.
  40172. * Note that you can remove any element in this dictionary in the callback implementation
  40173. * @param callback the callback to execute on a given key/value pair
  40174. */
  40175. forEach(callback: (key: string, val: T) => void): void;
  40176. /**
  40177. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40178. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40179. * Note that you can remove any element in this dictionary in the callback implementation
  40180. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40181. * @returns the first item
  40182. */
  40183. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40184. private _count;
  40185. private _data;
  40186. }
  40187. }
  40188. declare module "babylonjs/Collisions/collisionCoordinator" {
  40189. import { Nullable } from "babylonjs/types";
  40190. import { Scene } from "babylonjs/scene";
  40191. import { Vector3 } from "babylonjs/Maths/math.vector";
  40192. import { Collider } from "babylonjs/Collisions/collider";
  40193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40194. /** @hidden */
  40195. export interface ICollisionCoordinator {
  40196. createCollider(): Collider;
  40197. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40198. init(scene: Scene): void;
  40199. }
  40200. /** @hidden */
  40201. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40202. private _scene;
  40203. private _scaledPosition;
  40204. private _scaledVelocity;
  40205. private _finalPosition;
  40206. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40207. createCollider(): Collider;
  40208. init(scene: Scene): void;
  40209. private _collideWithWorld;
  40210. }
  40211. }
  40212. declare module "babylonjs/Inputs/scene.inputManager" {
  40213. import { Nullable } from "babylonjs/types";
  40214. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40215. import { Vector2 } from "babylonjs/Maths/math.vector";
  40216. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40217. import { Scene } from "babylonjs/scene";
  40218. /**
  40219. * Class used to manage all inputs for the scene.
  40220. */
  40221. export class InputManager {
  40222. /** The distance in pixel that you have to move to prevent some events */
  40223. static DragMovementThreshold: number;
  40224. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40225. static LongPressDelay: number;
  40226. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40227. static DoubleClickDelay: number;
  40228. /** If you need to check double click without raising a single click at first click, enable this flag */
  40229. static ExclusiveDoubleClickMode: boolean;
  40230. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  40231. private _alreadyAttached;
  40232. private _wheelEventName;
  40233. private _onPointerMove;
  40234. private _onPointerDown;
  40235. private _onPointerUp;
  40236. private _initClickEvent;
  40237. private _initActionManager;
  40238. private _delayedSimpleClick;
  40239. private _delayedSimpleClickTimeout;
  40240. private _previousDelayedSimpleClickTimeout;
  40241. private _meshPickProceed;
  40242. private _previousButtonPressed;
  40243. private _currentPickResult;
  40244. private _previousPickResult;
  40245. private _totalPointersPressed;
  40246. private _doubleClickOccured;
  40247. private _pointerOverMesh;
  40248. private _pickedDownMesh;
  40249. private _pickedUpMesh;
  40250. private _pointerX;
  40251. private _pointerY;
  40252. private _unTranslatedPointerX;
  40253. private _unTranslatedPointerY;
  40254. private _startingPointerPosition;
  40255. private _previousStartingPointerPosition;
  40256. private _startingPointerTime;
  40257. private _previousStartingPointerTime;
  40258. private _pointerCaptures;
  40259. private _meshUnderPointerId;
  40260. private _onKeyDown;
  40261. private _onKeyUp;
  40262. private _onCanvasFocusObserver;
  40263. private _onCanvasBlurObserver;
  40264. private _scene;
  40265. /**
  40266. * Creates a new InputManager
  40267. * @param scene defines the hosting scene
  40268. */
  40269. constructor(scene: Scene);
  40270. /**
  40271. * Gets the mesh that is currently under the pointer
  40272. */
  40273. get meshUnderPointer(): Nullable<AbstractMesh>;
  40274. /**
  40275. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40276. * @param pointerId the pointer id to use
  40277. * @returns The mesh under this pointer id or null if not found
  40278. */
  40279. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40280. /**
  40281. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40282. */
  40283. get unTranslatedPointer(): Vector2;
  40284. /**
  40285. * Gets or sets the current on-screen X position of the pointer
  40286. */
  40287. get pointerX(): number;
  40288. set pointerX(value: number);
  40289. /**
  40290. * Gets or sets the current on-screen Y position of the pointer
  40291. */
  40292. get pointerY(): number;
  40293. set pointerY(value: number);
  40294. private _updatePointerPosition;
  40295. private _processPointerMove;
  40296. private _setRayOnPointerInfo;
  40297. private _checkPrePointerObservable;
  40298. /**
  40299. * Use this method to simulate a pointer move on a mesh
  40300. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40301. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40302. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40303. */
  40304. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40305. /**
  40306. * Use this method to simulate a pointer down on a mesh
  40307. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40308. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40309. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40310. */
  40311. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40312. private _processPointerDown;
  40313. /** @hidden */
  40314. _isPointerSwiping(): boolean;
  40315. /**
  40316. * Use this method to simulate a pointer up on a mesh
  40317. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40318. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40319. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40320. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40321. */
  40322. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40323. private _processPointerUp;
  40324. /**
  40325. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40326. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40327. * @returns true if the pointer was captured
  40328. */
  40329. isPointerCaptured(pointerId?: number): boolean;
  40330. /**
  40331. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40332. * @param attachUp defines if you want to attach events to pointerup
  40333. * @param attachDown defines if you want to attach events to pointerdown
  40334. * @param attachMove defines if you want to attach events to pointermove
  40335. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40336. */
  40337. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40338. /**
  40339. * Detaches all event handlers
  40340. */
  40341. detachControl(): void;
  40342. /**
  40343. * Force the value of meshUnderPointer
  40344. * @param mesh defines the mesh to use
  40345. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40346. */
  40347. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40348. /**
  40349. * Gets the mesh under the pointer
  40350. * @returns a Mesh or null if no mesh is under the pointer
  40351. */
  40352. getPointerOverMesh(): Nullable<AbstractMesh>;
  40353. }
  40354. }
  40355. declare module "babylonjs/Animations/animationGroup" {
  40356. import { Animatable } from "babylonjs/Animations/animatable";
  40357. import { Animation } from "babylonjs/Animations/animation";
  40358. import { Scene, IDisposable } from "babylonjs/scene";
  40359. import { Observable } from "babylonjs/Misc/observable";
  40360. import { Nullable } from "babylonjs/types";
  40361. import "babylonjs/Animations/animatable";
  40362. /**
  40363. * This class defines the direct association between an animation and a target
  40364. */
  40365. export class TargetedAnimation {
  40366. /**
  40367. * Animation to perform
  40368. */
  40369. animation: Animation;
  40370. /**
  40371. * Target to animate
  40372. */
  40373. target: any;
  40374. /**
  40375. * Returns the string "TargetedAnimation"
  40376. * @returns "TargetedAnimation"
  40377. */
  40378. getClassName(): string;
  40379. /**
  40380. * Serialize the object
  40381. * @returns the JSON object representing the current entity
  40382. */
  40383. serialize(): any;
  40384. }
  40385. /**
  40386. * Use this class to create coordinated animations on multiple targets
  40387. */
  40388. export class AnimationGroup implements IDisposable {
  40389. /** The name of the animation group */
  40390. name: string;
  40391. private _scene;
  40392. private _targetedAnimations;
  40393. private _animatables;
  40394. private _from;
  40395. private _to;
  40396. private _isStarted;
  40397. private _isPaused;
  40398. private _speedRatio;
  40399. private _loopAnimation;
  40400. private _isAdditive;
  40401. /**
  40402. * Gets or sets the unique id of the node
  40403. */
  40404. uniqueId: number;
  40405. /**
  40406. * This observable will notify when one animation have ended
  40407. */
  40408. onAnimationEndObservable: Observable<TargetedAnimation>;
  40409. /**
  40410. * Observer raised when one animation loops
  40411. */
  40412. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40413. /**
  40414. * Observer raised when all animations have looped
  40415. */
  40416. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40417. /**
  40418. * This observable will notify when all animations have ended.
  40419. */
  40420. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40421. /**
  40422. * This observable will notify when all animations have paused.
  40423. */
  40424. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40425. /**
  40426. * This observable will notify when all animations are playing.
  40427. */
  40428. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40429. /**
  40430. * Gets the first frame
  40431. */
  40432. get from(): number;
  40433. /**
  40434. * Gets the last frame
  40435. */
  40436. get to(): number;
  40437. /**
  40438. * Define if the animations are started
  40439. */
  40440. get isStarted(): boolean;
  40441. /**
  40442. * Gets a value indicating that the current group is playing
  40443. */
  40444. get isPlaying(): boolean;
  40445. /**
  40446. * Gets or sets the speed ratio to use for all animations
  40447. */
  40448. get speedRatio(): number;
  40449. /**
  40450. * Gets or sets the speed ratio to use for all animations
  40451. */
  40452. set speedRatio(value: number);
  40453. /**
  40454. * Gets or sets if all animations should loop or not
  40455. */
  40456. get loopAnimation(): boolean;
  40457. set loopAnimation(value: boolean);
  40458. /**
  40459. * Gets or sets if all animations should be evaluated additively
  40460. */
  40461. get isAdditive(): boolean;
  40462. set isAdditive(value: boolean);
  40463. /**
  40464. * Gets the targeted animations for this animation group
  40465. */
  40466. get targetedAnimations(): Array<TargetedAnimation>;
  40467. /**
  40468. * returning the list of animatables controlled by this animation group.
  40469. */
  40470. get animatables(): Array<Animatable>;
  40471. /**
  40472. * Gets the list of target animations
  40473. */
  40474. get children(): TargetedAnimation[];
  40475. /**
  40476. * Instantiates a new Animation Group.
  40477. * This helps managing several animations at once.
  40478. * @see https://doc.babylonjs.com/how_to/group
  40479. * @param name Defines the name of the group
  40480. * @param scene Defines the scene the group belongs to
  40481. */
  40482. constructor(
  40483. /** The name of the animation group */
  40484. name: string, scene?: Nullable<Scene>);
  40485. /**
  40486. * Add an animation (with its target) in the group
  40487. * @param animation defines the animation we want to add
  40488. * @param target defines the target of the animation
  40489. * @returns the TargetedAnimation object
  40490. */
  40491. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40492. /**
  40493. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40494. * It can add constant keys at begin or end
  40495. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40496. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40497. * @returns the animation group
  40498. */
  40499. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40500. private _animationLoopCount;
  40501. private _animationLoopFlags;
  40502. private _processLoop;
  40503. /**
  40504. * Start all animations on given targets
  40505. * @param loop defines if animations must loop
  40506. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40507. * @param from defines the from key (optional)
  40508. * @param to defines the to key (optional)
  40509. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40510. * @returns the current animation group
  40511. */
  40512. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40513. /**
  40514. * Pause all animations
  40515. * @returns the animation group
  40516. */
  40517. pause(): AnimationGroup;
  40518. /**
  40519. * Play all animations to initial state
  40520. * This function will start() the animations if they were not started or will restart() them if they were paused
  40521. * @param loop defines if animations must loop
  40522. * @returns the animation group
  40523. */
  40524. play(loop?: boolean): AnimationGroup;
  40525. /**
  40526. * Reset all animations to initial state
  40527. * @returns the animation group
  40528. */
  40529. reset(): AnimationGroup;
  40530. /**
  40531. * Restart animations from key 0
  40532. * @returns the animation group
  40533. */
  40534. restart(): AnimationGroup;
  40535. /**
  40536. * Stop all animations
  40537. * @returns the animation group
  40538. */
  40539. stop(): AnimationGroup;
  40540. /**
  40541. * Set animation weight for all animatables
  40542. * @param weight defines the weight to use
  40543. * @return the animationGroup
  40544. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40545. */
  40546. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40547. /**
  40548. * Synchronize and normalize all animatables with a source animatable
  40549. * @param root defines the root animatable to synchronize with
  40550. * @return the animationGroup
  40551. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40552. */
  40553. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40554. /**
  40555. * Goes to a specific frame in this animation group
  40556. * @param frame the frame number to go to
  40557. * @return the animationGroup
  40558. */
  40559. goToFrame(frame: number): AnimationGroup;
  40560. /**
  40561. * Dispose all associated resources
  40562. */
  40563. dispose(): void;
  40564. private _checkAnimationGroupEnded;
  40565. /**
  40566. * Clone the current animation group and returns a copy
  40567. * @param newName defines the name of the new group
  40568. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40569. * @returns the new aniamtion group
  40570. */
  40571. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40572. /**
  40573. * Serializes the animationGroup to an object
  40574. * @returns Serialized object
  40575. */
  40576. serialize(): any;
  40577. /**
  40578. * Returns a new AnimationGroup object parsed from the source provided.
  40579. * @param parsedAnimationGroup defines the source
  40580. * @param scene defines the scene that will receive the animationGroup
  40581. * @returns a new AnimationGroup
  40582. */
  40583. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40584. /**
  40585. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40586. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40587. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40588. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40589. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40590. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40591. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40592. */
  40593. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40594. /**
  40595. * Returns the string "AnimationGroup"
  40596. * @returns "AnimationGroup"
  40597. */
  40598. getClassName(): string;
  40599. /**
  40600. * Creates a detailled string about the object
  40601. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40602. * @returns a string representing the object
  40603. */
  40604. toString(fullDetails?: boolean): string;
  40605. }
  40606. }
  40607. declare module "babylonjs/scene" {
  40608. import { Nullable } from "babylonjs/types";
  40609. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40610. import { Observable } from "babylonjs/Misc/observable";
  40611. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40612. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40613. import { Geometry } from "babylonjs/Meshes/geometry";
  40614. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40615. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40617. import { Mesh } from "babylonjs/Meshes/mesh";
  40618. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40619. import { Bone } from "babylonjs/Bones/bone";
  40620. import { Skeleton } from "babylonjs/Bones/skeleton";
  40621. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40622. import { Camera } from "babylonjs/Cameras/camera";
  40623. import { AbstractScene } from "babylonjs/abstractScene";
  40624. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40625. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40626. import { Material } from "babylonjs/Materials/material";
  40627. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40628. import { Effect } from "babylonjs/Materials/effect";
  40629. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40630. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40631. import { Light } from "babylonjs/Lights/light";
  40632. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40633. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40634. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40635. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40636. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40637. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40638. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40639. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40640. import { Engine } from "babylonjs/Engines/engine";
  40641. import { Node } from "babylonjs/node";
  40642. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40643. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40644. import { WebRequest } from "babylonjs/Misc/webRequest";
  40645. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40646. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40647. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40648. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40649. import { Plane } from "babylonjs/Maths/math.plane";
  40650. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40651. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40652. import { Ray } from "babylonjs/Culling/ray";
  40653. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40654. import { Animation } from "babylonjs/Animations/animation";
  40655. import { Animatable } from "babylonjs/Animations/animatable";
  40656. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40657. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40658. import { Collider } from "babylonjs/Collisions/collider";
  40659. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40660. /**
  40661. * Define an interface for all classes that will hold resources
  40662. */
  40663. export interface IDisposable {
  40664. /**
  40665. * Releases all held resources
  40666. */
  40667. dispose(): void;
  40668. }
  40669. /** Interface defining initialization parameters for Scene class */
  40670. export interface SceneOptions {
  40671. /**
  40672. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40673. * It will improve performance when the number of geometries becomes important.
  40674. */
  40675. useGeometryUniqueIdsMap?: boolean;
  40676. /**
  40677. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40678. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40679. */
  40680. useMaterialMeshMap?: boolean;
  40681. /**
  40682. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40683. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40684. */
  40685. useClonedMeshMap?: boolean;
  40686. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40687. virtual?: boolean;
  40688. }
  40689. /**
  40690. * Represents a scene to be rendered by the engine.
  40691. * @see https://doc.babylonjs.com/features/scene
  40692. */
  40693. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40694. /** The fog is deactivated */
  40695. static readonly FOGMODE_NONE: number;
  40696. /** The fog density is following an exponential function */
  40697. static readonly FOGMODE_EXP: number;
  40698. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40699. static readonly FOGMODE_EXP2: number;
  40700. /** The fog density is following a linear function. */
  40701. static readonly FOGMODE_LINEAR: number;
  40702. /**
  40703. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40704. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40705. */
  40706. static MinDeltaTime: number;
  40707. /**
  40708. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40709. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40710. */
  40711. static MaxDeltaTime: number;
  40712. /**
  40713. * Factory used to create the default material.
  40714. * @param name The name of the material to create
  40715. * @param scene The scene to create the material for
  40716. * @returns The default material
  40717. */
  40718. static DefaultMaterialFactory(scene: Scene): Material;
  40719. /**
  40720. * Factory used to create the a collision coordinator.
  40721. * @returns The collision coordinator
  40722. */
  40723. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40724. /** @hidden */
  40725. _inputManager: InputManager;
  40726. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40727. cameraToUseForPointers: Nullable<Camera>;
  40728. /** @hidden */
  40729. readonly _isScene: boolean;
  40730. /** @hidden */
  40731. _blockEntityCollection: boolean;
  40732. /**
  40733. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40734. */
  40735. autoClear: boolean;
  40736. /**
  40737. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40738. */
  40739. autoClearDepthAndStencil: boolean;
  40740. /**
  40741. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40742. */
  40743. clearColor: Color4;
  40744. /**
  40745. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40746. */
  40747. ambientColor: Color3;
  40748. /**
  40749. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40750. * It should only be one of the following (if not the default embedded one):
  40751. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40752. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40753. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40754. * The material properties need to be setup according to the type of texture in use.
  40755. */
  40756. environmentBRDFTexture: BaseTexture;
  40757. /**
  40758. * Texture used in all pbr material as the reflection texture.
  40759. * As in the majority of the scene they are the same (exception for multi room and so on),
  40760. * this is easier to reference from here than from all the materials.
  40761. */
  40762. get environmentTexture(): Nullable<BaseTexture>;
  40763. /**
  40764. * Texture used in all pbr material as the reflection texture.
  40765. * As in the majority of the scene they are the same (exception for multi room and so on),
  40766. * this is easier to set here than in all the materials.
  40767. */
  40768. set environmentTexture(value: Nullable<BaseTexture>);
  40769. /** @hidden */
  40770. protected _environmentIntensity: number;
  40771. /**
  40772. * Intensity of the environment in all pbr material.
  40773. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40774. * As in the majority of the scene they are the same (exception for multi room and so on),
  40775. * this is easier to reference from here than from all the materials.
  40776. */
  40777. get environmentIntensity(): number;
  40778. /**
  40779. * Intensity of the environment in all pbr material.
  40780. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40781. * As in the majority of the scene they are the same (exception for multi room and so on),
  40782. * this is easier to set here than in all the materials.
  40783. */
  40784. set environmentIntensity(value: number);
  40785. /** @hidden */
  40786. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40787. /**
  40788. * Default image processing configuration used either in the rendering
  40789. * Forward main pass or through the imageProcessingPostProcess if present.
  40790. * As in the majority of the scene they are the same (exception for multi camera),
  40791. * this is easier to reference from here than from all the materials and post process.
  40792. *
  40793. * No setter as we it is a shared configuration, you can set the values instead.
  40794. */
  40795. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40796. private _forceWireframe;
  40797. /**
  40798. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40799. */
  40800. set forceWireframe(value: boolean);
  40801. get forceWireframe(): boolean;
  40802. private _skipFrustumClipping;
  40803. /**
  40804. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40805. */
  40806. set skipFrustumClipping(value: boolean);
  40807. get skipFrustumClipping(): boolean;
  40808. private _forcePointsCloud;
  40809. /**
  40810. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40811. */
  40812. set forcePointsCloud(value: boolean);
  40813. get forcePointsCloud(): boolean;
  40814. /**
  40815. * Gets or sets the active clipplane 1
  40816. */
  40817. clipPlane: Nullable<Plane>;
  40818. /**
  40819. * Gets or sets the active clipplane 2
  40820. */
  40821. clipPlane2: Nullable<Plane>;
  40822. /**
  40823. * Gets or sets the active clipplane 3
  40824. */
  40825. clipPlane3: Nullable<Plane>;
  40826. /**
  40827. * Gets or sets the active clipplane 4
  40828. */
  40829. clipPlane4: Nullable<Plane>;
  40830. /**
  40831. * Gets or sets the active clipplane 5
  40832. */
  40833. clipPlane5: Nullable<Plane>;
  40834. /**
  40835. * Gets or sets the active clipplane 6
  40836. */
  40837. clipPlane6: Nullable<Plane>;
  40838. /**
  40839. * Gets or sets a boolean indicating if animations are enabled
  40840. */
  40841. animationsEnabled: boolean;
  40842. private _animationPropertiesOverride;
  40843. /**
  40844. * Gets or sets the animation properties override
  40845. */
  40846. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40847. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40848. /**
  40849. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40850. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40851. */
  40852. useConstantAnimationDeltaTime: boolean;
  40853. /**
  40854. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40855. * Please note that it requires to run a ray cast through the scene on every frame
  40856. */
  40857. constantlyUpdateMeshUnderPointer: boolean;
  40858. /**
  40859. * Defines the HTML cursor to use when hovering over interactive elements
  40860. */
  40861. hoverCursor: string;
  40862. /**
  40863. * Defines the HTML default cursor to use (empty by default)
  40864. */
  40865. defaultCursor: string;
  40866. /**
  40867. * Defines whether cursors are handled by the scene.
  40868. */
  40869. doNotHandleCursors: boolean;
  40870. /**
  40871. * This is used to call preventDefault() on pointer down
  40872. * in order to block unwanted artifacts like system double clicks
  40873. */
  40874. preventDefaultOnPointerDown: boolean;
  40875. /**
  40876. * This is used to call preventDefault() on pointer up
  40877. * in order to block unwanted artifacts like system double clicks
  40878. */
  40879. preventDefaultOnPointerUp: boolean;
  40880. /**
  40881. * Gets or sets user defined metadata
  40882. */
  40883. metadata: any;
  40884. /**
  40885. * For internal use only. Please do not use.
  40886. */
  40887. reservedDataStore: any;
  40888. /**
  40889. * Gets the name of the plugin used to load this scene (null by default)
  40890. */
  40891. loadingPluginName: string;
  40892. /**
  40893. * Use this array to add regular expressions used to disable offline support for specific urls
  40894. */
  40895. disableOfflineSupportExceptionRules: RegExp[];
  40896. /**
  40897. * An event triggered when the scene is disposed.
  40898. */
  40899. onDisposeObservable: Observable<Scene>;
  40900. private _onDisposeObserver;
  40901. /** Sets a function to be executed when this scene is disposed. */
  40902. set onDispose(callback: () => void);
  40903. /**
  40904. * An event triggered before rendering the scene (right after animations and physics)
  40905. */
  40906. onBeforeRenderObservable: Observable<Scene>;
  40907. private _onBeforeRenderObserver;
  40908. /** Sets a function to be executed before rendering this scene */
  40909. set beforeRender(callback: Nullable<() => void>);
  40910. /**
  40911. * An event triggered after rendering the scene
  40912. */
  40913. onAfterRenderObservable: Observable<Scene>;
  40914. /**
  40915. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40916. */
  40917. onAfterRenderCameraObservable: Observable<Camera>;
  40918. private _onAfterRenderObserver;
  40919. /** Sets a function to be executed after rendering this scene */
  40920. set afterRender(callback: Nullable<() => void>);
  40921. /**
  40922. * An event triggered before animating the scene
  40923. */
  40924. onBeforeAnimationsObservable: Observable<Scene>;
  40925. /**
  40926. * An event triggered after animations processing
  40927. */
  40928. onAfterAnimationsObservable: Observable<Scene>;
  40929. /**
  40930. * An event triggered before draw calls are ready to be sent
  40931. */
  40932. onBeforeDrawPhaseObservable: Observable<Scene>;
  40933. /**
  40934. * An event triggered after draw calls have been sent
  40935. */
  40936. onAfterDrawPhaseObservable: Observable<Scene>;
  40937. /**
  40938. * An event triggered when the scene is ready
  40939. */
  40940. onReadyObservable: Observable<Scene>;
  40941. /**
  40942. * An event triggered before rendering a camera
  40943. */
  40944. onBeforeCameraRenderObservable: Observable<Camera>;
  40945. private _onBeforeCameraRenderObserver;
  40946. /** Sets a function to be executed before rendering a camera*/
  40947. set beforeCameraRender(callback: () => void);
  40948. /**
  40949. * An event triggered after rendering a camera
  40950. */
  40951. onAfterCameraRenderObservable: Observable<Camera>;
  40952. private _onAfterCameraRenderObserver;
  40953. /** Sets a function to be executed after rendering a camera*/
  40954. set afterCameraRender(callback: () => void);
  40955. /**
  40956. * An event triggered when active meshes evaluation is about to start
  40957. */
  40958. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40959. /**
  40960. * An event triggered when active meshes evaluation is done
  40961. */
  40962. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40963. /**
  40964. * An event triggered when particles rendering is about to start
  40965. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40966. */
  40967. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40968. /**
  40969. * An event triggered when particles rendering is done
  40970. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40971. */
  40972. onAfterParticlesRenderingObservable: Observable<Scene>;
  40973. /**
  40974. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40975. */
  40976. onDataLoadedObservable: Observable<Scene>;
  40977. /**
  40978. * An event triggered when a camera is created
  40979. */
  40980. onNewCameraAddedObservable: Observable<Camera>;
  40981. /**
  40982. * An event triggered when a camera is removed
  40983. */
  40984. onCameraRemovedObservable: Observable<Camera>;
  40985. /**
  40986. * An event triggered when a light is created
  40987. */
  40988. onNewLightAddedObservable: Observable<Light>;
  40989. /**
  40990. * An event triggered when a light is removed
  40991. */
  40992. onLightRemovedObservable: Observable<Light>;
  40993. /**
  40994. * An event triggered when a geometry is created
  40995. */
  40996. onNewGeometryAddedObservable: Observable<Geometry>;
  40997. /**
  40998. * An event triggered when a geometry is removed
  40999. */
  41000. onGeometryRemovedObservable: Observable<Geometry>;
  41001. /**
  41002. * An event triggered when a transform node is created
  41003. */
  41004. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41005. /**
  41006. * An event triggered when a transform node is removed
  41007. */
  41008. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41009. /**
  41010. * An event triggered when a mesh is created
  41011. */
  41012. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41013. /**
  41014. * An event triggered when a mesh is removed
  41015. */
  41016. onMeshRemovedObservable: Observable<AbstractMesh>;
  41017. /**
  41018. * An event triggered when a skeleton is created
  41019. */
  41020. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41021. /**
  41022. * An event triggered when a skeleton is removed
  41023. */
  41024. onSkeletonRemovedObservable: Observable<Skeleton>;
  41025. /**
  41026. * An event triggered when a material is created
  41027. */
  41028. onNewMaterialAddedObservable: Observable<Material>;
  41029. /**
  41030. * An event triggered when a material is removed
  41031. */
  41032. onMaterialRemovedObservable: Observable<Material>;
  41033. /**
  41034. * An event triggered when a texture is created
  41035. */
  41036. onNewTextureAddedObservable: Observable<BaseTexture>;
  41037. /**
  41038. * An event triggered when a texture is removed
  41039. */
  41040. onTextureRemovedObservable: Observable<BaseTexture>;
  41041. /**
  41042. * An event triggered when render targets are about to be rendered
  41043. * Can happen multiple times per frame.
  41044. */
  41045. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41046. /**
  41047. * An event triggered when render targets were rendered.
  41048. * Can happen multiple times per frame.
  41049. */
  41050. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41051. /**
  41052. * An event triggered before calculating deterministic simulation step
  41053. */
  41054. onBeforeStepObservable: Observable<Scene>;
  41055. /**
  41056. * An event triggered after calculating deterministic simulation step
  41057. */
  41058. onAfterStepObservable: Observable<Scene>;
  41059. /**
  41060. * An event triggered when the activeCamera property is updated
  41061. */
  41062. onActiveCameraChanged: Observable<Scene>;
  41063. /**
  41064. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41065. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41066. * 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)
  41067. */
  41068. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41069. /**
  41070. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41071. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41072. * 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)
  41073. */
  41074. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41075. /**
  41076. * This Observable will when a mesh has been imported into the scene.
  41077. */
  41078. onMeshImportedObservable: Observable<AbstractMesh>;
  41079. /**
  41080. * This Observable will when an animation file has been imported into the scene.
  41081. */
  41082. onAnimationFileImportedObservable: Observable<Scene>;
  41083. /**
  41084. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41085. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41086. */
  41087. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41088. /** @hidden */
  41089. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41090. /**
  41091. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41092. */
  41093. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41094. /**
  41095. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41096. */
  41097. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41098. /**
  41099. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41100. */
  41101. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41102. /** Callback called when a pointer move is detected */
  41103. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41104. /** Callback called when a pointer down is detected */
  41105. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41106. /** Callback called when a pointer up is detected */
  41107. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41108. /** Callback called when a pointer pick is detected */
  41109. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41110. /**
  41111. * 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).
  41112. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41113. */
  41114. onPrePointerObservable: Observable<PointerInfoPre>;
  41115. /**
  41116. * Observable event triggered each time an input event is received from the rendering canvas
  41117. */
  41118. onPointerObservable: Observable<PointerInfo>;
  41119. /**
  41120. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41121. */
  41122. get unTranslatedPointer(): Vector2;
  41123. /**
  41124. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41125. */
  41126. static get DragMovementThreshold(): number;
  41127. static set DragMovementThreshold(value: number);
  41128. /**
  41129. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41130. */
  41131. static get LongPressDelay(): number;
  41132. static set LongPressDelay(value: number);
  41133. /**
  41134. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41135. */
  41136. static get DoubleClickDelay(): number;
  41137. static set DoubleClickDelay(value: number);
  41138. /** If you need to check double click without raising a single click at first click, enable this flag */
  41139. static get ExclusiveDoubleClickMode(): boolean;
  41140. static set ExclusiveDoubleClickMode(value: boolean);
  41141. /** @hidden */
  41142. _mirroredCameraPosition: Nullable<Vector3>;
  41143. /**
  41144. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41145. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41146. */
  41147. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41148. /**
  41149. * Observable event triggered each time an keyboard event is received from the hosting window
  41150. */
  41151. onKeyboardObservable: Observable<KeyboardInfo>;
  41152. private _useRightHandedSystem;
  41153. /**
  41154. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41155. */
  41156. set useRightHandedSystem(value: boolean);
  41157. get useRightHandedSystem(): boolean;
  41158. private _timeAccumulator;
  41159. private _currentStepId;
  41160. private _currentInternalStep;
  41161. /**
  41162. * Sets the step Id used by deterministic lock step
  41163. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41164. * @param newStepId defines the step Id
  41165. */
  41166. setStepId(newStepId: number): void;
  41167. /**
  41168. * Gets the step Id used by deterministic lock step
  41169. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41170. * @returns the step Id
  41171. */
  41172. getStepId(): number;
  41173. /**
  41174. * Gets the internal step used by deterministic lock step
  41175. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41176. * @returns the internal step
  41177. */
  41178. getInternalStep(): number;
  41179. private _fogEnabled;
  41180. /**
  41181. * Gets or sets a boolean indicating if fog is enabled on this scene
  41182. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41183. * (Default is true)
  41184. */
  41185. set fogEnabled(value: boolean);
  41186. get fogEnabled(): boolean;
  41187. private _fogMode;
  41188. /**
  41189. * Gets or sets the fog mode to use
  41190. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41191. * | mode | value |
  41192. * | --- | --- |
  41193. * | FOGMODE_NONE | 0 |
  41194. * | FOGMODE_EXP | 1 |
  41195. * | FOGMODE_EXP2 | 2 |
  41196. * | FOGMODE_LINEAR | 3 |
  41197. */
  41198. set fogMode(value: number);
  41199. get fogMode(): number;
  41200. /**
  41201. * Gets or sets the fog color to use
  41202. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41203. * (Default is Color3(0.2, 0.2, 0.3))
  41204. */
  41205. fogColor: Color3;
  41206. /**
  41207. * Gets or sets the fog density to use
  41208. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41209. * (Default is 0.1)
  41210. */
  41211. fogDensity: number;
  41212. /**
  41213. * Gets or sets the fog start distance to use
  41214. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41215. * (Default is 0)
  41216. */
  41217. fogStart: number;
  41218. /**
  41219. * Gets or sets the fog end distance to use
  41220. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41221. * (Default is 1000)
  41222. */
  41223. fogEnd: number;
  41224. /**
  41225. * Flag indicating that the frame buffer binding is handled by another component
  41226. */
  41227. prePass: boolean;
  41228. private _shadowsEnabled;
  41229. /**
  41230. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41231. */
  41232. set shadowsEnabled(value: boolean);
  41233. get shadowsEnabled(): boolean;
  41234. private _lightsEnabled;
  41235. /**
  41236. * Gets or sets a boolean indicating if lights are enabled on this scene
  41237. */
  41238. set lightsEnabled(value: boolean);
  41239. get lightsEnabled(): boolean;
  41240. /** All of the active cameras added to this scene. */
  41241. activeCameras: Camera[];
  41242. /** @hidden */
  41243. _activeCamera: Nullable<Camera>;
  41244. /** Gets or sets the current active camera */
  41245. get activeCamera(): Nullable<Camera>;
  41246. set activeCamera(value: Nullable<Camera>);
  41247. private _defaultMaterial;
  41248. /** The default material used on meshes when no material is affected */
  41249. get defaultMaterial(): Material;
  41250. /** The default material used on meshes when no material is affected */
  41251. set defaultMaterial(value: Material);
  41252. private _texturesEnabled;
  41253. /**
  41254. * Gets or sets a boolean indicating if textures are enabled on this scene
  41255. */
  41256. set texturesEnabled(value: boolean);
  41257. get texturesEnabled(): boolean;
  41258. /**
  41259. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41260. */
  41261. physicsEnabled: boolean;
  41262. /**
  41263. * Gets or sets a boolean indicating if particles are enabled on this scene
  41264. */
  41265. particlesEnabled: boolean;
  41266. /**
  41267. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41268. */
  41269. spritesEnabled: boolean;
  41270. private _skeletonsEnabled;
  41271. /**
  41272. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41273. */
  41274. set skeletonsEnabled(value: boolean);
  41275. get skeletonsEnabled(): boolean;
  41276. /**
  41277. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41278. */
  41279. lensFlaresEnabled: boolean;
  41280. /**
  41281. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41282. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41283. */
  41284. collisionsEnabled: boolean;
  41285. private _collisionCoordinator;
  41286. /** @hidden */
  41287. get collisionCoordinator(): ICollisionCoordinator;
  41288. /**
  41289. * Defines the gravity applied to this scene (used only for collisions)
  41290. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41291. */
  41292. gravity: Vector3;
  41293. /**
  41294. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41295. */
  41296. postProcessesEnabled: boolean;
  41297. /**
  41298. * Gets the current postprocess manager
  41299. */
  41300. postProcessManager: PostProcessManager;
  41301. /**
  41302. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41303. */
  41304. renderTargetsEnabled: boolean;
  41305. /**
  41306. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41307. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41308. */
  41309. dumpNextRenderTargets: boolean;
  41310. /**
  41311. * The list of user defined render targets added to the scene
  41312. */
  41313. customRenderTargets: RenderTargetTexture[];
  41314. /**
  41315. * Defines if texture loading must be delayed
  41316. * If true, textures will only be loaded when they need to be rendered
  41317. */
  41318. useDelayedTextureLoading: boolean;
  41319. /**
  41320. * Gets the list of meshes imported to the scene through SceneLoader
  41321. */
  41322. importedMeshesFiles: String[];
  41323. /**
  41324. * Gets or sets a boolean indicating if probes are enabled on this scene
  41325. */
  41326. probesEnabled: boolean;
  41327. /**
  41328. * Gets or sets the current offline provider to use to store scene data
  41329. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41330. */
  41331. offlineProvider: IOfflineProvider;
  41332. /**
  41333. * Gets or sets the action manager associated with the scene
  41334. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41335. */
  41336. actionManager: AbstractActionManager;
  41337. private _meshesForIntersections;
  41338. /**
  41339. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41340. */
  41341. proceduralTexturesEnabled: boolean;
  41342. private _engine;
  41343. private _totalVertices;
  41344. /** @hidden */
  41345. _activeIndices: PerfCounter;
  41346. /** @hidden */
  41347. _activeParticles: PerfCounter;
  41348. /** @hidden */
  41349. _activeBones: PerfCounter;
  41350. private _animationRatio;
  41351. /** @hidden */
  41352. _animationTimeLast: number;
  41353. /** @hidden */
  41354. _animationTime: number;
  41355. /**
  41356. * Gets or sets a general scale for animation speed
  41357. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41358. */
  41359. animationTimeScale: number;
  41360. /** @hidden */
  41361. _cachedMaterial: Nullable<Material>;
  41362. /** @hidden */
  41363. _cachedEffect: Nullable<Effect>;
  41364. /** @hidden */
  41365. _cachedVisibility: Nullable<number>;
  41366. private _renderId;
  41367. private _frameId;
  41368. private _executeWhenReadyTimeoutId;
  41369. private _intermediateRendering;
  41370. private _viewUpdateFlag;
  41371. private _projectionUpdateFlag;
  41372. /** @hidden */
  41373. _toBeDisposed: Nullable<IDisposable>[];
  41374. private _activeRequests;
  41375. /** @hidden */
  41376. _pendingData: any[];
  41377. private _isDisposed;
  41378. /**
  41379. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41380. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41381. */
  41382. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41383. private _activeMeshes;
  41384. private _processedMaterials;
  41385. private _renderTargets;
  41386. /** @hidden */
  41387. _activeParticleSystems: SmartArray<IParticleSystem>;
  41388. private _activeSkeletons;
  41389. private _softwareSkinnedMeshes;
  41390. private _renderingManager;
  41391. /** @hidden */
  41392. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41393. private _transformMatrix;
  41394. private _sceneUbo;
  41395. /** @hidden */
  41396. _viewMatrix: Matrix;
  41397. private _projectionMatrix;
  41398. /** @hidden */
  41399. _forcedViewPosition: Nullable<Vector3>;
  41400. /** @hidden */
  41401. _frustumPlanes: Plane[];
  41402. /**
  41403. * Gets the list of frustum planes (built from the active camera)
  41404. */
  41405. get frustumPlanes(): Plane[];
  41406. /**
  41407. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41408. * This is useful if there are more lights that the maximum simulteanous authorized
  41409. */
  41410. requireLightSorting: boolean;
  41411. /** @hidden */
  41412. readonly useMaterialMeshMap: boolean;
  41413. /** @hidden */
  41414. readonly useClonedMeshMap: boolean;
  41415. private _externalData;
  41416. private _uid;
  41417. /**
  41418. * @hidden
  41419. * Backing store of defined scene components.
  41420. */
  41421. _components: ISceneComponent[];
  41422. /**
  41423. * @hidden
  41424. * Backing store of defined scene components.
  41425. */
  41426. _serializableComponents: ISceneSerializableComponent[];
  41427. /**
  41428. * List of components to register on the next registration step.
  41429. */
  41430. private _transientComponents;
  41431. /**
  41432. * Registers the transient components if needed.
  41433. */
  41434. private _registerTransientComponents;
  41435. /**
  41436. * @hidden
  41437. * Add a component to the scene.
  41438. * Note that the ccomponent could be registered on th next frame if this is called after
  41439. * the register component stage.
  41440. * @param component Defines the component to add to the scene
  41441. */
  41442. _addComponent(component: ISceneComponent): void;
  41443. /**
  41444. * @hidden
  41445. * Gets a component from the scene.
  41446. * @param name defines the name of the component to retrieve
  41447. * @returns the component or null if not present
  41448. */
  41449. _getComponent(name: string): Nullable<ISceneComponent>;
  41450. /**
  41451. * @hidden
  41452. * Defines the actions happening before camera updates.
  41453. */
  41454. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41455. /**
  41456. * @hidden
  41457. * Defines the actions happening before clear the canvas.
  41458. */
  41459. _beforeClearStage: Stage<SimpleStageAction>;
  41460. /**
  41461. * @hidden
  41462. * Defines the actions when collecting render targets for the frame.
  41463. */
  41464. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41465. /**
  41466. * @hidden
  41467. * Defines the actions happening for one camera in the frame.
  41468. */
  41469. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41470. /**
  41471. * @hidden
  41472. * Defines the actions happening during the per mesh ready checks.
  41473. */
  41474. _isReadyForMeshStage: Stage<MeshStageAction>;
  41475. /**
  41476. * @hidden
  41477. * Defines the actions happening before evaluate active mesh checks.
  41478. */
  41479. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41480. /**
  41481. * @hidden
  41482. * Defines the actions happening during the evaluate sub mesh checks.
  41483. */
  41484. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41485. /**
  41486. * @hidden
  41487. * Defines the actions happening during the active mesh stage.
  41488. */
  41489. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41490. /**
  41491. * @hidden
  41492. * Defines the actions happening during the per camera render target step.
  41493. */
  41494. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41495. /**
  41496. * @hidden
  41497. * Defines the actions happening just before the active camera is drawing.
  41498. */
  41499. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41500. /**
  41501. * @hidden
  41502. * Defines the actions happening just before a render target is drawing.
  41503. */
  41504. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41505. /**
  41506. * @hidden
  41507. * Defines the actions happening just before a rendering group is drawing.
  41508. */
  41509. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41510. /**
  41511. * @hidden
  41512. * Defines the actions happening just before a mesh is drawing.
  41513. */
  41514. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41515. /**
  41516. * @hidden
  41517. * Defines the actions happening just after a mesh has been drawn.
  41518. */
  41519. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41520. /**
  41521. * @hidden
  41522. * Defines the actions happening just after a rendering group has been drawn.
  41523. */
  41524. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41525. /**
  41526. * @hidden
  41527. * Defines the actions happening just after the active camera has been drawn.
  41528. */
  41529. _afterCameraDrawStage: Stage<CameraStageAction>;
  41530. /**
  41531. * @hidden
  41532. * Defines the actions happening just after a render target has been drawn.
  41533. */
  41534. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41535. /**
  41536. * @hidden
  41537. * Defines the actions happening just after rendering all cameras and computing intersections.
  41538. */
  41539. _afterRenderStage: Stage<SimpleStageAction>;
  41540. /**
  41541. * @hidden
  41542. * Defines the actions happening when a pointer move event happens.
  41543. */
  41544. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41545. /**
  41546. * @hidden
  41547. * Defines the actions happening when a pointer down event happens.
  41548. */
  41549. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41550. /**
  41551. * @hidden
  41552. * Defines the actions happening when a pointer up event happens.
  41553. */
  41554. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41555. /**
  41556. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41557. */
  41558. private geometriesByUniqueId;
  41559. /**
  41560. * Creates a new Scene
  41561. * @param engine defines the engine to use to render this scene
  41562. * @param options defines the scene options
  41563. */
  41564. constructor(engine: Engine, options?: SceneOptions);
  41565. /**
  41566. * Gets a string identifying the name of the class
  41567. * @returns "Scene" string
  41568. */
  41569. getClassName(): string;
  41570. private _defaultMeshCandidates;
  41571. /**
  41572. * @hidden
  41573. */
  41574. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41575. private _defaultSubMeshCandidates;
  41576. /**
  41577. * @hidden
  41578. */
  41579. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41580. /**
  41581. * Sets the default candidate providers for the scene.
  41582. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41583. * and getCollidingSubMeshCandidates to their default function
  41584. */
  41585. setDefaultCandidateProviders(): void;
  41586. /**
  41587. * Gets the mesh that is currently under the pointer
  41588. */
  41589. get meshUnderPointer(): Nullable<AbstractMesh>;
  41590. /**
  41591. * Gets or sets the current on-screen X position of the pointer
  41592. */
  41593. get pointerX(): number;
  41594. set pointerX(value: number);
  41595. /**
  41596. * Gets or sets the current on-screen Y position of the pointer
  41597. */
  41598. get pointerY(): number;
  41599. set pointerY(value: number);
  41600. /**
  41601. * Gets the cached material (ie. the latest rendered one)
  41602. * @returns the cached material
  41603. */
  41604. getCachedMaterial(): Nullable<Material>;
  41605. /**
  41606. * Gets the cached effect (ie. the latest rendered one)
  41607. * @returns the cached effect
  41608. */
  41609. getCachedEffect(): Nullable<Effect>;
  41610. /**
  41611. * Gets the cached visibility state (ie. the latest rendered one)
  41612. * @returns the cached visibility state
  41613. */
  41614. getCachedVisibility(): Nullable<number>;
  41615. /**
  41616. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41617. * @param material defines the current material
  41618. * @param effect defines the current effect
  41619. * @param visibility defines the current visibility state
  41620. * @returns true if one parameter is not cached
  41621. */
  41622. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41623. /**
  41624. * Gets the engine associated with the scene
  41625. * @returns an Engine
  41626. */
  41627. getEngine(): Engine;
  41628. /**
  41629. * Gets the total number of vertices rendered per frame
  41630. * @returns the total number of vertices rendered per frame
  41631. */
  41632. getTotalVertices(): number;
  41633. /**
  41634. * Gets the performance counter for total vertices
  41635. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41636. */
  41637. get totalVerticesPerfCounter(): PerfCounter;
  41638. /**
  41639. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41640. * @returns the total number of active indices rendered per frame
  41641. */
  41642. getActiveIndices(): number;
  41643. /**
  41644. * Gets the performance counter for active indices
  41645. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41646. */
  41647. get totalActiveIndicesPerfCounter(): PerfCounter;
  41648. /**
  41649. * Gets the total number of active particles rendered per frame
  41650. * @returns the total number of active particles rendered per frame
  41651. */
  41652. getActiveParticles(): number;
  41653. /**
  41654. * Gets the performance counter for active particles
  41655. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41656. */
  41657. get activeParticlesPerfCounter(): PerfCounter;
  41658. /**
  41659. * Gets the total number of active bones rendered per frame
  41660. * @returns the total number of active bones rendered per frame
  41661. */
  41662. getActiveBones(): number;
  41663. /**
  41664. * Gets the performance counter for active bones
  41665. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41666. */
  41667. get activeBonesPerfCounter(): PerfCounter;
  41668. /**
  41669. * Gets the array of active meshes
  41670. * @returns an array of AbstractMesh
  41671. */
  41672. getActiveMeshes(): SmartArray<AbstractMesh>;
  41673. /**
  41674. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41675. * @returns a number
  41676. */
  41677. getAnimationRatio(): number;
  41678. /**
  41679. * Gets an unique Id for the current render phase
  41680. * @returns a number
  41681. */
  41682. getRenderId(): number;
  41683. /**
  41684. * Gets an unique Id for the current frame
  41685. * @returns a number
  41686. */
  41687. getFrameId(): number;
  41688. /** Call this function if you want to manually increment the render Id*/
  41689. incrementRenderId(): void;
  41690. private _createUbo;
  41691. /**
  41692. * Use this method to simulate a pointer move on a mesh
  41693. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41694. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41695. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41696. * @returns the current scene
  41697. */
  41698. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41699. /**
  41700. * Use this method to simulate a pointer down on a mesh
  41701. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41702. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41703. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41704. * @returns the current scene
  41705. */
  41706. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41707. /**
  41708. * Use this method to simulate a pointer up on a mesh
  41709. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41710. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41711. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41712. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41713. * @returns the current scene
  41714. */
  41715. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41716. /**
  41717. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41718. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41719. * @returns true if the pointer was captured
  41720. */
  41721. isPointerCaptured(pointerId?: number): boolean;
  41722. /**
  41723. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41724. * @param attachUp defines if you want to attach events to pointerup
  41725. * @param attachDown defines if you want to attach events to pointerdown
  41726. * @param attachMove defines if you want to attach events to pointermove
  41727. */
  41728. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41729. /** Detaches all event handlers*/
  41730. detachControl(): void;
  41731. /**
  41732. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41733. * Delay loaded resources are not taking in account
  41734. * @return true if all required resources are ready
  41735. */
  41736. isReady(): boolean;
  41737. /** Resets all cached information relative to material (including effect and visibility) */
  41738. resetCachedMaterial(): void;
  41739. /**
  41740. * Registers a function to be called before every frame render
  41741. * @param func defines the function to register
  41742. */
  41743. registerBeforeRender(func: () => void): void;
  41744. /**
  41745. * Unregisters a function called before every frame render
  41746. * @param func defines the function to unregister
  41747. */
  41748. unregisterBeforeRender(func: () => void): void;
  41749. /**
  41750. * Registers a function to be called after every frame render
  41751. * @param func defines the function to register
  41752. */
  41753. registerAfterRender(func: () => void): void;
  41754. /**
  41755. * Unregisters a function called after every frame render
  41756. * @param func defines the function to unregister
  41757. */
  41758. unregisterAfterRender(func: () => void): void;
  41759. private _executeOnceBeforeRender;
  41760. /**
  41761. * The provided function will run before render once and will be disposed afterwards.
  41762. * A timeout delay can be provided so that the function will be executed in N ms.
  41763. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41764. * @param func The function to be executed.
  41765. * @param timeout optional delay in ms
  41766. */
  41767. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41768. /** @hidden */
  41769. _addPendingData(data: any): void;
  41770. /** @hidden */
  41771. _removePendingData(data: any): void;
  41772. /**
  41773. * Returns the number of items waiting to be loaded
  41774. * @returns the number of items waiting to be loaded
  41775. */
  41776. getWaitingItemsCount(): number;
  41777. /**
  41778. * Returns a boolean indicating if the scene is still loading data
  41779. */
  41780. get isLoading(): boolean;
  41781. /**
  41782. * Registers a function to be executed when the scene is ready
  41783. * @param {Function} func - the function to be executed
  41784. */
  41785. executeWhenReady(func: () => void): void;
  41786. /**
  41787. * Returns a promise that resolves when the scene is ready
  41788. * @returns A promise that resolves when the scene is ready
  41789. */
  41790. whenReadyAsync(): Promise<void>;
  41791. /** @hidden */
  41792. _checkIsReady(): void;
  41793. /**
  41794. * Gets all animatable attached to the scene
  41795. */
  41796. get animatables(): Animatable[];
  41797. /**
  41798. * Resets the last animation time frame.
  41799. * Useful to override when animations start running when loading a scene for the first time.
  41800. */
  41801. resetLastAnimationTimeFrame(): void;
  41802. /**
  41803. * Gets the current view matrix
  41804. * @returns a Matrix
  41805. */
  41806. getViewMatrix(): Matrix;
  41807. /**
  41808. * Gets the current projection matrix
  41809. * @returns a Matrix
  41810. */
  41811. getProjectionMatrix(): Matrix;
  41812. /**
  41813. * Gets the current transform matrix
  41814. * @returns a Matrix made of View * Projection
  41815. */
  41816. getTransformMatrix(): Matrix;
  41817. /**
  41818. * Sets the current transform matrix
  41819. * @param viewL defines the View matrix to use
  41820. * @param projectionL defines the Projection matrix to use
  41821. * @param viewR defines the right View matrix to use (if provided)
  41822. * @param projectionR defines the right Projection matrix to use (if provided)
  41823. */
  41824. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41825. /**
  41826. * Gets the uniform buffer used to store scene data
  41827. * @returns a UniformBuffer
  41828. */
  41829. getSceneUniformBuffer(): UniformBuffer;
  41830. /**
  41831. * Gets an unique (relatively to the current scene) Id
  41832. * @returns an unique number for the scene
  41833. */
  41834. getUniqueId(): number;
  41835. /**
  41836. * Add a mesh to the list of scene's meshes
  41837. * @param newMesh defines the mesh to add
  41838. * @param recursive if all child meshes should also be added to the scene
  41839. */
  41840. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41841. /**
  41842. * Remove a mesh for the list of scene's meshes
  41843. * @param toRemove defines the mesh to remove
  41844. * @param recursive if all child meshes should also be removed from the scene
  41845. * @returns the index where the mesh was in the mesh list
  41846. */
  41847. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41848. /**
  41849. * Add a transform node to the list of scene's transform nodes
  41850. * @param newTransformNode defines the transform node to add
  41851. */
  41852. addTransformNode(newTransformNode: TransformNode): void;
  41853. /**
  41854. * Remove a transform node for the list of scene's transform nodes
  41855. * @param toRemove defines the transform node to remove
  41856. * @returns the index where the transform node was in the transform node list
  41857. */
  41858. removeTransformNode(toRemove: TransformNode): number;
  41859. /**
  41860. * Remove a skeleton for the list of scene's skeletons
  41861. * @param toRemove defines the skeleton to remove
  41862. * @returns the index where the skeleton was in the skeleton list
  41863. */
  41864. removeSkeleton(toRemove: Skeleton): number;
  41865. /**
  41866. * Remove a morph target for the list of scene's morph targets
  41867. * @param toRemove defines the morph target to remove
  41868. * @returns the index where the morph target was in the morph target list
  41869. */
  41870. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41871. /**
  41872. * Remove a light for the list of scene's lights
  41873. * @param toRemove defines the light to remove
  41874. * @returns the index where the light was in the light list
  41875. */
  41876. removeLight(toRemove: Light): number;
  41877. /**
  41878. * Remove a camera for the list of scene's cameras
  41879. * @param toRemove defines the camera to remove
  41880. * @returns the index where the camera was in the camera list
  41881. */
  41882. removeCamera(toRemove: Camera): number;
  41883. /**
  41884. * Remove a particle system for the list of scene's particle systems
  41885. * @param toRemove defines the particle system to remove
  41886. * @returns the index where the particle system was in the particle system list
  41887. */
  41888. removeParticleSystem(toRemove: IParticleSystem): number;
  41889. /**
  41890. * Remove a animation for the list of scene's animations
  41891. * @param toRemove defines the animation to remove
  41892. * @returns the index where the animation was in the animation list
  41893. */
  41894. removeAnimation(toRemove: Animation): number;
  41895. /**
  41896. * Will stop the animation of the given target
  41897. * @param target - the target
  41898. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41899. * @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)
  41900. */
  41901. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41902. /**
  41903. * Removes the given animation group from this scene.
  41904. * @param toRemove The animation group to remove
  41905. * @returns The index of the removed animation group
  41906. */
  41907. removeAnimationGroup(toRemove: AnimationGroup): number;
  41908. /**
  41909. * Removes the given multi-material from this scene.
  41910. * @param toRemove The multi-material to remove
  41911. * @returns The index of the removed multi-material
  41912. */
  41913. removeMultiMaterial(toRemove: MultiMaterial): number;
  41914. /**
  41915. * Removes the given material from this scene.
  41916. * @param toRemove The material to remove
  41917. * @returns The index of the removed material
  41918. */
  41919. removeMaterial(toRemove: Material): number;
  41920. /**
  41921. * Removes the given action manager from this scene.
  41922. * @param toRemove The action manager to remove
  41923. * @returns The index of the removed action manager
  41924. */
  41925. removeActionManager(toRemove: AbstractActionManager): number;
  41926. /**
  41927. * Removes the given texture from this scene.
  41928. * @param toRemove The texture to remove
  41929. * @returns The index of the removed texture
  41930. */
  41931. removeTexture(toRemove: BaseTexture): number;
  41932. /**
  41933. * Adds the given light to this scene
  41934. * @param newLight The light to add
  41935. */
  41936. addLight(newLight: Light): void;
  41937. /**
  41938. * Sorts the list list based on light priorities
  41939. */
  41940. sortLightsByPriority(): void;
  41941. /**
  41942. * Adds the given camera to this scene
  41943. * @param newCamera The camera to add
  41944. */
  41945. addCamera(newCamera: Camera): void;
  41946. /**
  41947. * Adds the given skeleton to this scene
  41948. * @param newSkeleton The skeleton to add
  41949. */
  41950. addSkeleton(newSkeleton: Skeleton): void;
  41951. /**
  41952. * Adds the given particle system to this scene
  41953. * @param newParticleSystem The particle system to add
  41954. */
  41955. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41956. /**
  41957. * Adds the given animation to this scene
  41958. * @param newAnimation The animation to add
  41959. */
  41960. addAnimation(newAnimation: Animation): void;
  41961. /**
  41962. * Adds the given animation group to this scene.
  41963. * @param newAnimationGroup The animation group to add
  41964. */
  41965. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41966. /**
  41967. * Adds the given multi-material to this scene
  41968. * @param newMultiMaterial The multi-material to add
  41969. */
  41970. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41971. /**
  41972. * Adds the given material to this scene
  41973. * @param newMaterial The material to add
  41974. */
  41975. addMaterial(newMaterial: Material): void;
  41976. /**
  41977. * Adds the given morph target to this scene
  41978. * @param newMorphTargetManager The morph target to add
  41979. */
  41980. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41981. /**
  41982. * Adds the given geometry to this scene
  41983. * @param newGeometry The geometry to add
  41984. */
  41985. addGeometry(newGeometry: Geometry): void;
  41986. /**
  41987. * Adds the given action manager to this scene
  41988. * @param newActionManager The action manager to add
  41989. */
  41990. addActionManager(newActionManager: AbstractActionManager): void;
  41991. /**
  41992. * Adds the given texture to this scene.
  41993. * @param newTexture The texture to add
  41994. */
  41995. addTexture(newTexture: BaseTexture): void;
  41996. /**
  41997. * Switch active camera
  41998. * @param newCamera defines the new active camera
  41999. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  42000. */
  42001. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42002. /**
  42003. * sets the active camera of the scene using its ID
  42004. * @param id defines the camera's ID
  42005. * @return the new active camera or null if none found.
  42006. */
  42007. setActiveCameraByID(id: string): Nullable<Camera>;
  42008. /**
  42009. * sets the active camera of the scene using its name
  42010. * @param name defines the camera's name
  42011. * @returns the new active camera or null if none found.
  42012. */
  42013. setActiveCameraByName(name: string): Nullable<Camera>;
  42014. /**
  42015. * get an animation group using its name
  42016. * @param name defines the material's name
  42017. * @return the animation group or null if none found.
  42018. */
  42019. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42020. /**
  42021. * Get a material using its unique id
  42022. * @param uniqueId defines the material's unique id
  42023. * @return the material or null if none found.
  42024. */
  42025. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42026. /**
  42027. * get a material using its id
  42028. * @param id defines the material's ID
  42029. * @return the material or null if none found.
  42030. */
  42031. getMaterialByID(id: string): Nullable<Material>;
  42032. /**
  42033. * Gets a the last added material using a given id
  42034. * @param id defines the material's ID
  42035. * @return the last material with the given id or null if none found.
  42036. */
  42037. getLastMaterialByID(id: string): Nullable<Material>;
  42038. /**
  42039. * Gets a material using its name
  42040. * @param name defines the material's name
  42041. * @return the material or null if none found.
  42042. */
  42043. getMaterialByName(name: string): Nullable<Material>;
  42044. /**
  42045. * Get a texture using its unique id
  42046. * @param uniqueId defines the texture's unique id
  42047. * @return the texture or null if none found.
  42048. */
  42049. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42050. /**
  42051. * Gets a camera using its id
  42052. * @param id defines the id to look for
  42053. * @returns the camera or null if not found
  42054. */
  42055. getCameraByID(id: string): Nullable<Camera>;
  42056. /**
  42057. * Gets a camera using its unique id
  42058. * @param uniqueId defines the unique id to look for
  42059. * @returns the camera or null if not found
  42060. */
  42061. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42062. /**
  42063. * Gets a camera using its name
  42064. * @param name defines the camera's name
  42065. * @return the camera or null if none found.
  42066. */
  42067. getCameraByName(name: string): Nullable<Camera>;
  42068. /**
  42069. * Gets a bone using its id
  42070. * @param id defines the bone's id
  42071. * @return the bone or null if not found
  42072. */
  42073. getBoneByID(id: string): Nullable<Bone>;
  42074. /**
  42075. * Gets a bone using its id
  42076. * @param name defines the bone's name
  42077. * @return the bone or null if not found
  42078. */
  42079. getBoneByName(name: string): Nullable<Bone>;
  42080. /**
  42081. * Gets a light node using its name
  42082. * @param name defines the the light's name
  42083. * @return the light or null if none found.
  42084. */
  42085. getLightByName(name: string): Nullable<Light>;
  42086. /**
  42087. * Gets a light node using its id
  42088. * @param id defines the light's id
  42089. * @return the light or null if none found.
  42090. */
  42091. getLightByID(id: string): Nullable<Light>;
  42092. /**
  42093. * Gets a light node using its scene-generated unique ID
  42094. * @param uniqueId defines the light's unique id
  42095. * @return the light or null if none found.
  42096. */
  42097. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42098. /**
  42099. * Gets a particle system by id
  42100. * @param id defines the particle system id
  42101. * @return the corresponding system or null if none found
  42102. */
  42103. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42104. /**
  42105. * Gets a geometry using its ID
  42106. * @param id defines the geometry's id
  42107. * @return the geometry or null if none found.
  42108. */
  42109. getGeometryByID(id: string): Nullable<Geometry>;
  42110. private _getGeometryByUniqueID;
  42111. /**
  42112. * Add a new geometry to this scene
  42113. * @param geometry defines the geometry to be added to the scene.
  42114. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42115. * @return a boolean defining if the geometry was added or not
  42116. */
  42117. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42118. /**
  42119. * Removes an existing geometry
  42120. * @param geometry defines the geometry to be removed from the scene
  42121. * @return a boolean defining if the geometry was removed or not
  42122. */
  42123. removeGeometry(geometry: Geometry): boolean;
  42124. /**
  42125. * Gets the list of geometries attached to the scene
  42126. * @returns an array of Geometry
  42127. */
  42128. getGeometries(): Geometry[];
  42129. /**
  42130. * Gets the first added mesh found of a given ID
  42131. * @param id defines the id to search for
  42132. * @return the mesh found or null if not found at all
  42133. */
  42134. getMeshByID(id: string): Nullable<AbstractMesh>;
  42135. /**
  42136. * Gets a list of meshes using their id
  42137. * @param id defines the id to search for
  42138. * @returns a list of meshes
  42139. */
  42140. getMeshesByID(id: string): Array<AbstractMesh>;
  42141. /**
  42142. * Gets the first added transform node found of a given ID
  42143. * @param id defines the id to search for
  42144. * @return the found transform node or null if not found at all.
  42145. */
  42146. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42147. /**
  42148. * Gets a transform node with its auto-generated unique id
  42149. * @param uniqueId efines the unique id to search for
  42150. * @return the found transform node or null if not found at all.
  42151. */
  42152. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42153. /**
  42154. * Gets a list of transform nodes using their id
  42155. * @param id defines the id to search for
  42156. * @returns a list of transform nodes
  42157. */
  42158. getTransformNodesByID(id: string): Array<TransformNode>;
  42159. /**
  42160. * Gets a mesh with its auto-generated unique id
  42161. * @param uniqueId defines the unique id to search for
  42162. * @return the found mesh or null if not found at all.
  42163. */
  42164. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42165. /**
  42166. * Gets a the last added mesh using a given id
  42167. * @param id defines the id to search for
  42168. * @return the found mesh or null if not found at all.
  42169. */
  42170. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42171. /**
  42172. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42173. * @param id defines the id to search for
  42174. * @return the found node or null if not found at all
  42175. */
  42176. getLastEntryByID(id: string): Nullable<Node>;
  42177. /**
  42178. * Gets a node (Mesh, Camera, Light) using a given id
  42179. * @param id defines the id to search for
  42180. * @return the found node or null if not found at all
  42181. */
  42182. getNodeByID(id: string): Nullable<Node>;
  42183. /**
  42184. * Gets a node (Mesh, Camera, Light) using a given name
  42185. * @param name defines the name to search for
  42186. * @return the found node or null if not found at all.
  42187. */
  42188. getNodeByName(name: string): Nullable<Node>;
  42189. /**
  42190. * Gets a mesh using a given name
  42191. * @param name defines the name to search for
  42192. * @return the found mesh or null if not found at all.
  42193. */
  42194. getMeshByName(name: string): Nullable<AbstractMesh>;
  42195. /**
  42196. * Gets a transform node using a given name
  42197. * @param name defines the name to search for
  42198. * @return the found transform node or null if not found at all.
  42199. */
  42200. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42201. /**
  42202. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42203. * @param id defines the id to search for
  42204. * @return the found skeleton or null if not found at all.
  42205. */
  42206. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42207. /**
  42208. * Gets a skeleton using a given auto generated unique id
  42209. * @param uniqueId defines the unique id to search for
  42210. * @return the found skeleton or null if not found at all.
  42211. */
  42212. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42213. /**
  42214. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42215. * @param id defines the id to search for
  42216. * @return the found skeleton or null if not found at all.
  42217. */
  42218. getSkeletonById(id: string): Nullable<Skeleton>;
  42219. /**
  42220. * Gets a skeleton using a given name
  42221. * @param name defines the name to search for
  42222. * @return the found skeleton or null if not found at all.
  42223. */
  42224. getSkeletonByName(name: string): Nullable<Skeleton>;
  42225. /**
  42226. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42227. * @param id defines the id to search for
  42228. * @return the found morph target manager or null if not found at all.
  42229. */
  42230. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42231. /**
  42232. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42233. * @param id defines the id to search for
  42234. * @return the found morph target or null if not found at all.
  42235. */
  42236. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42237. /**
  42238. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42239. * @param name defines the name to search for
  42240. * @return the found morph target or null if not found at all.
  42241. */
  42242. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42243. /**
  42244. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42245. * @param name defines the name to search for
  42246. * @return the found post process or null if not found at all.
  42247. */
  42248. getPostProcessByName(name: string): Nullable<PostProcess>;
  42249. /**
  42250. * Gets a boolean indicating if the given mesh is active
  42251. * @param mesh defines the mesh to look for
  42252. * @returns true if the mesh is in the active list
  42253. */
  42254. isActiveMesh(mesh: AbstractMesh): boolean;
  42255. /**
  42256. * Return a unique id as a string which can serve as an identifier for the scene
  42257. */
  42258. get uid(): string;
  42259. /**
  42260. * Add an externaly attached data from its key.
  42261. * This method call will fail and return false, if such key already exists.
  42262. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42263. * @param key the unique key that identifies the data
  42264. * @param data the data object to associate to the key for this Engine instance
  42265. * @return true if no such key were already present and the data was added successfully, false otherwise
  42266. */
  42267. addExternalData<T>(key: string, data: T): boolean;
  42268. /**
  42269. * Get an externaly attached data from its key
  42270. * @param key the unique key that identifies the data
  42271. * @return the associated data, if present (can be null), or undefined if not present
  42272. */
  42273. getExternalData<T>(key: string): Nullable<T>;
  42274. /**
  42275. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42276. * @param key the unique key that identifies the data
  42277. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42278. * @return the associated data, can be null if the factory returned null.
  42279. */
  42280. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42281. /**
  42282. * Remove an externaly attached data from the Engine instance
  42283. * @param key the unique key that identifies the data
  42284. * @return true if the data was successfully removed, false if it doesn't exist
  42285. */
  42286. removeExternalData(key: string): boolean;
  42287. private _evaluateSubMesh;
  42288. /**
  42289. * Clear the processed materials smart array preventing retention point in material dispose.
  42290. */
  42291. freeProcessedMaterials(): void;
  42292. private _preventFreeActiveMeshesAndRenderingGroups;
  42293. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42294. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42295. * when disposing several meshes in a row or a hierarchy of meshes.
  42296. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42297. */
  42298. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42299. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42300. /**
  42301. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42302. */
  42303. freeActiveMeshes(): void;
  42304. /**
  42305. * Clear the info related to rendering groups preventing retention points during dispose.
  42306. */
  42307. freeRenderingGroups(): void;
  42308. /** @hidden */
  42309. _isInIntermediateRendering(): boolean;
  42310. /**
  42311. * Lambda returning the list of potentially active meshes.
  42312. */
  42313. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42314. /**
  42315. * Lambda returning the list of potentially active sub meshes.
  42316. */
  42317. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42318. /**
  42319. * Lambda returning the list of potentially intersecting sub meshes.
  42320. */
  42321. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42322. /**
  42323. * Lambda returning the list of potentially colliding sub meshes.
  42324. */
  42325. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42326. private _activeMeshesFrozen;
  42327. private _skipEvaluateActiveMeshesCompletely;
  42328. /**
  42329. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42330. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42331. * @returns the current scene
  42332. */
  42333. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42334. /**
  42335. * Use this function to restart evaluating active meshes on every frame
  42336. * @returns the current scene
  42337. */
  42338. unfreezeActiveMeshes(): Scene;
  42339. private _evaluateActiveMeshes;
  42340. private _activeMesh;
  42341. /**
  42342. * Update the transform matrix to update from the current active camera
  42343. * @param force defines a boolean used to force the update even if cache is up to date
  42344. */
  42345. updateTransformMatrix(force?: boolean): void;
  42346. private _bindFrameBuffer;
  42347. /** @hidden */
  42348. _allowPostProcessClearColor: boolean;
  42349. /** @hidden */
  42350. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42351. private _processSubCameras;
  42352. private _checkIntersections;
  42353. /** @hidden */
  42354. _advancePhysicsEngineStep(step: number): void;
  42355. /**
  42356. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42357. */
  42358. getDeterministicFrameTime: () => number;
  42359. /** @hidden */
  42360. _animate(): void;
  42361. /** Execute all animations (for a frame) */
  42362. animate(): void;
  42363. /**
  42364. * Render the scene
  42365. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42366. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42367. */
  42368. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42369. /**
  42370. * Freeze all materials
  42371. * A frozen material will not be updatable but should be faster to render
  42372. */
  42373. freezeMaterials(): void;
  42374. /**
  42375. * Unfreeze all materials
  42376. * A frozen material will not be updatable but should be faster to render
  42377. */
  42378. unfreezeMaterials(): void;
  42379. /**
  42380. * Releases all held ressources
  42381. */
  42382. dispose(): void;
  42383. /**
  42384. * Gets if the scene is already disposed
  42385. */
  42386. get isDisposed(): boolean;
  42387. /**
  42388. * Call this function to reduce memory footprint of the scene.
  42389. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42390. */
  42391. clearCachedVertexData(): void;
  42392. /**
  42393. * This function will remove the local cached buffer data from texture.
  42394. * It will save memory but will prevent the texture from being rebuilt
  42395. */
  42396. cleanCachedTextureBuffer(): void;
  42397. /**
  42398. * Get the world extend vectors with an optional filter
  42399. *
  42400. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42401. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42402. */
  42403. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42404. min: Vector3;
  42405. max: Vector3;
  42406. };
  42407. /**
  42408. * Creates a ray that can be used to pick in the scene
  42409. * @param x defines the x coordinate of the origin (on-screen)
  42410. * @param y defines the y coordinate of the origin (on-screen)
  42411. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42412. * @param camera defines the camera to use for the picking
  42413. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42414. * @returns a Ray
  42415. */
  42416. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42417. /**
  42418. * Creates a ray that can be used to pick in the scene
  42419. * @param x defines the x coordinate of the origin (on-screen)
  42420. * @param y defines the y coordinate of the origin (on-screen)
  42421. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42422. * @param result defines the ray where to store the picking ray
  42423. * @param camera defines the camera to use for the picking
  42424. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42425. * @returns the current scene
  42426. */
  42427. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42428. /**
  42429. * Creates a ray that can be used to pick in the scene
  42430. * @param x defines the x coordinate of the origin (on-screen)
  42431. * @param y defines the y coordinate of the origin (on-screen)
  42432. * @param camera defines the camera to use for the picking
  42433. * @returns a Ray
  42434. */
  42435. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42436. /**
  42437. * Creates a ray that can be used to pick in the scene
  42438. * @param x defines the x coordinate of the origin (on-screen)
  42439. * @param y defines the y coordinate of the origin (on-screen)
  42440. * @param result defines the ray where to store the picking ray
  42441. * @param camera defines the camera to use for the picking
  42442. * @returns the current scene
  42443. */
  42444. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42445. /** Launch a ray to try to pick a mesh in the scene
  42446. * @param x position on screen
  42447. * @param y position on screen
  42448. * @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
  42449. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42450. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42451. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42452. * @returns a PickingInfo
  42453. */
  42454. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42455. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42456. * @param x position on screen
  42457. * @param y position on screen
  42458. * @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
  42459. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42460. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42461. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  42462. */
  42463. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42464. /** Use the given ray to pick a mesh in the scene
  42465. * @param ray The ray to use to pick meshes
  42466. * @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
  42467. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42468. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42469. * @returns a PickingInfo
  42470. */
  42471. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42472. /**
  42473. * Launch a ray to try to pick a mesh in the scene
  42474. * @param x X position on screen
  42475. * @param y Y position on screen
  42476. * @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
  42477. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42478. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42479. * @returns an array of PickingInfo
  42480. */
  42481. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42482. /**
  42483. * Launch a ray to try to pick a mesh in the scene
  42484. * @param ray Ray to use
  42485. * @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
  42486. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42487. * @returns an array of PickingInfo
  42488. */
  42489. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42490. /**
  42491. * Force the value of meshUnderPointer
  42492. * @param mesh defines the mesh to use
  42493. * @param pointerId optional pointer id when using more than one pointer
  42494. */
  42495. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42496. /**
  42497. * Gets the mesh under the pointer
  42498. * @returns a Mesh or null if no mesh is under the pointer
  42499. */
  42500. getPointerOverMesh(): Nullable<AbstractMesh>;
  42501. /** @hidden */
  42502. _rebuildGeometries(): void;
  42503. /** @hidden */
  42504. _rebuildTextures(): void;
  42505. private _getByTags;
  42506. /**
  42507. * Get a list of meshes by tags
  42508. * @param tagsQuery defines the tags query to use
  42509. * @param forEach defines a predicate used to filter results
  42510. * @returns an array of Mesh
  42511. */
  42512. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42513. /**
  42514. * Get a list of cameras by tags
  42515. * @param tagsQuery defines the tags query to use
  42516. * @param forEach defines a predicate used to filter results
  42517. * @returns an array of Camera
  42518. */
  42519. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42520. /**
  42521. * Get a list of lights by tags
  42522. * @param tagsQuery defines the tags query to use
  42523. * @param forEach defines a predicate used to filter results
  42524. * @returns an array of Light
  42525. */
  42526. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42527. /**
  42528. * Get a list of materials by tags
  42529. * @param tagsQuery defines the tags query to use
  42530. * @param forEach defines a predicate used to filter results
  42531. * @returns an array of Material
  42532. */
  42533. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42534. /**
  42535. * Get a list of transform nodes by tags
  42536. * @param tagsQuery defines the tags query to use
  42537. * @param forEach defines a predicate used to filter results
  42538. * @returns an array of TransformNode
  42539. */
  42540. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42541. /**
  42542. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42543. * This allowed control for front to back rendering or reversly depending of the special needs.
  42544. *
  42545. * @param renderingGroupId The rendering group id corresponding to its index
  42546. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42547. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42548. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42549. */
  42550. 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;
  42551. /**
  42552. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42553. *
  42554. * @param renderingGroupId The rendering group id corresponding to its index
  42555. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42556. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42557. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42558. */
  42559. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42560. /**
  42561. * Gets the current auto clear configuration for one rendering group of the rendering
  42562. * manager.
  42563. * @param index the rendering group index to get the information for
  42564. * @returns The auto clear setup for the requested rendering group
  42565. */
  42566. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42567. private _blockMaterialDirtyMechanism;
  42568. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42569. get blockMaterialDirtyMechanism(): boolean;
  42570. set blockMaterialDirtyMechanism(value: boolean);
  42571. /**
  42572. * Will flag all materials as dirty to trigger new shader compilation
  42573. * @param flag defines the flag used to specify which material part must be marked as dirty
  42574. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42575. */
  42576. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42577. /** @hidden */
  42578. _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;
  42579. /** @hidden */
  42580. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42581. /** @hidden */
  42582. _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;
  42583. /** @hidden */
  42584. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42585. /** @hidden */
  42586. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42587. /** @hidden */
  42588. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42589. }
  42590. }
  42591. declare module "babylonjs/assetContainer" {
  42592. import { AbstractScene } from "babylonjs/abstractScene";
  42593. import { Scene } from "babylonjs/scene";
  42594. import { Mesh } from "babylonjs/Meshes/mesh";
  42595. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42596. import { Skeleton } from "babylonjs/Bones/skeleton";
  42597. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42598. import { Animatable } from "babylonjs/Animations/animatable";
  42599. import { Nullable } from "babylonjs/types";
  42600. import { Node } from "babylonjs/node";
  42601. /**
  42602. * Set of assets to keep when moving a scene into an asset container.
  42603. */
  42604. export class KeepAssets extends AbstractScene {
  42605. }
  42606. /**
  42607. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42608. */
  42609. export class InstantiatedEntries {
  42610. /**
  42611. * List of new root nodes (eg. nodes with no parent)
  42612. */
  42613. rootNodes: TransformNode[];
  42614. /**
  42615. * List of new skeletons
  42616. */
  42617. skeletons: Skeleton[];
  42618. /**
  42619. * List of new animation groups
  42620. */
  42621. animationGroups: AnimationGroup[];
  42622. }
  42623. /**
  42624. * Container with a set of assets that can be added or removed from a scene.
  42625. */
  42626. export class AssetContainer extends AbstractScene {
  42627. private _wasAddedToScene;
  42628. /**
  42629. * The scene the AssetContainer belongs to.
  42630. */
  42631. scene: Scene;
  42632. /**
  42633. * Instantiates an AssetContainer.
  42634. * @param scene The scene the AssetContainer belongs to.
  42635. */
  42636. constructor(scene: Scene);
  42637. /**
  42638. * Instantiate or clone all meshes and add the new ones to the scene.
  42639. * Skeletons and animation groups will all be cloned
  42640. * @param nameFunction defines an optional function used to get new names for clones
  42641. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42642. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42643. */
  42644. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42645. /**
  42646. * Adds all the assets from the container to the scene.
  42647. */
  42648. addAllToScene(): void;
  42649. /**
  42650. * Removes all the assets in the container from the scene
  42651. */
  42652. removeAllFromScene(): void;
  42653. /**
  42654. * Disposes all the assets in the container
  42655. */
  42656. dispose(): void;
  42657. private _moveAssets;
  42658. /**
  42659. * Removes all the assets contained in the scene and adds them to the container.
  42660. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42661. */
  42662. moveAllFromScene(keepAssets?: KeepAssets): void;
  42663. /**
  42664. * 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.
  42665. * @returns the root mesh
  42666. */
  42667. createRootMesh(): Mesh;
  42668. /**
  42669. * Merge animations (direct and animation groups) from this asset container into a scene
  42670. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42671. * @param animatables set of animatables to retarget to a node from the scene
  42672. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42673. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42674. */
  42675. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42676. }
  42677. }
  42678. declare module "babylonjs/abstractScene" {
  42679. import { Scene } from "babylonjs/scene";
  42680. import { Nullable } from "babylonjs/types";
  42681. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42682. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42683. import { Geometry } from "babylonjs/Meshes/geometry";
  42684. import { Skeleton } from "babylonjs/Bones/skeleton";
  42685. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42686. import { AssetContainer } from "babylonjs/assetContainer";
  42687. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42688. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42689. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42690. import { Material } from "babylonjs/Materials/material";
  42691. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42692. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42693. import { Camera } from "babylonjs/Cameras/camera";
  42694. import { Light } from "babylonjs/Lights/light";
  42695. import { Node } from "babylonjs/node";
  42696. import { Animation } from "babylonjs/Animations/animation";
  42697. /**
  42698. * Defines how the parser contract is defined.
  42699. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42700. */
  42701. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42702. /**
  42703. * Defines how the individual parser contract is defined.
  42704. * These parser can parse an individual asset
  42705. */
  42706. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42707. /**
  42708. * Base class of the scene acting as a container for the different elements composing a scene.
  42709. * This class is dynamically extended by the different components of the scene increasing
  42710. * flexibility and reducing coupling
  42711. */
  42712. export abstract class AbstractScene {
  42713. /**
  42714. * Stores the list of available parsers in the application.
  42715. */
  42716. private static _BabylonFileParsers;
  42717. /**
  42718. * Stores the list of available individual parsers in the application.
  42719. */
  42720. private static _IndividualBabylonFileParsers;
  42721. /**
  42722. * Adds a parser in the list of available ones
  42723. * @param name Defines the name of the parser
  42724. * @param parser Defines the parser to add
  42725. */
  42726. static AddParser(name: string, parser: BabylonFileParser): void;
  42727. /**
  42728. * Gets a general parser from the list of avaialble ones
  42729. * @param name Defines the name of the parser
  42730. * @returns the requested parser or null
  42731. */
  42732. static GetParser(name: string): Nullable<BabylonFileParser>;
  42733. /**
  42734. * Adds n individual parser in the list of available ones
  42735. * @param name Defines the name of the parser
  42736. * @param parser Defines the parser to add
  42737. */
  42738. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42739. /**
  42740. * Gets an individual parser from the list of avaialble ones
  42741. * @param name Defines the name of the parser
  42742. * @returns the requested parser or null
  42743. */
  42744. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42745. /**
  42746. * Parser json data and populate both a scene and its associated container object
  42747. * @param jsonData Defines the data to parse
  42748. * @param scene Defines the scene to parse the data for
  42749. * @param container Defines the container attached to the parsing sequence
  42750. * @param rootUrl Defines the root url of the data
  42751. */
  42752. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42753. /**
  42754. * Gets the list of root nodes (ie. nodes with no parent)
  42755. */
  42756. rootNodes: Node[];
  42757. /** All of the cameras added to this scene
  42758. * @see https://doc.babylonjs.com/babylon101/cameras
  42759. */
  42760. cameras: Camera[];
  42761. /**
  42762. * All of the lights added to this scene
  42763. * @see https://doc.babylonjs.com/babylon101/lights
  42764. */
  42765. lights: Light[];
  42766. /**
  42767. * All of the (abstract) meshes added to this scene
  42768. */
  42769. meshes: AbstractMesh[];
  42770. /**
  42771. * The list of skeletons added to the scene
  42772. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42773. */
  42774. skeletons: Skeleton[];
  42775. /**
  42776. * All of the particle systems added to this scene
  42777. * @see https://doc.babylonjs.com/babylon101/particles
  42778. */
  42779. particleSystems: IParticleSystem[];
  42780. /**
  42781. * Gets a list of Animations associated with the scene
  42782. */
  42783. animations: Animation[];
  42784. /**
  42785. * All of the animation groups added to this scene
  42786. * @see https://doc.babylonjs.com/how_to/group
  42787. */
  42788. animationGroups: AnimationGroup[];
  42789. /**
  42790. * All of the multi-materials added to this scene
  42791. * @see https://doc.babylonjs.com/how_to/multi_materials
  42792. */
  42793. multiMaterials: MultiMaterial[];
  42794. /**
  42795. * All of the materials added to this scene
  42796. * In the context of a Scene, it is not supposed to be modified manually.
  42797. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42798. * Note also that the order of the Material within the array is not significant and might change.
  42799. * @see https://doc.babylonjs.com/babylon101/materials
  42800. */
  42801. materials: Material[];
  42802. /**
  42803. * The list of morph target managers added to the scene
  42804. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42805. */
  42806. morphTargetManagers: MorphTargetManager[];
  42807. /**
  42808. * The list of geometries used in the scene.
  42809. */
  42810. geometries: Geometry[];
  42811. /**
  42812. * All of the tranform nodes added to this scene
  42813. * In the context of a Scene, it is not supposed to be modified manually.
  42814. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42815. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42816. * @see https://doc.babylonjs.com/how_to/transformnode
  42817. */
  42818. transformNodes: TransformNode[];
  42819. /**
  42820. * ActionManagers available on the scene.
  42821. */
  42822. actionManagers: AbstractActionManager[];
  42823. /**
  42824. * Textures to keep.
  42825. */
  42826. textures: BaseTexture[];
  42827. /** @hidden */
  42828. protected _environmentTexture: Nullable<BaseTexture>;
  42829. /**
  42830. * Texture used in all pbr material as the reflection texture.
  42831. * As in the majority of the scene they are the same (exception for multi room and so on),
  42832. * this is easier to reference from here than from all the materials.
  42833. */
  42834. get environmentTexture(): Nullable<BaseTexture>;
  42835. set environmentTexture(value: Nullable<BaseTexture>);
  42836. /**
  42837. * The list of postprocesses added to the scene
  42838. */
  42839. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42840. /**
  42841. * @returns all meshes, lights, cameras, transformNodes and bones
  42842. */
  42843. getNodes(): Array<Node>;
  42844. }
  42845. }
  42846. declare module "babylonjs/Audio/sound" {
  42847. import { Observable } from "babylonjs/Misc/observable";
  42848. import { Vector3 } from "babylonjs/Maths/math.vector";
  42849. import { Nullable } from "babylonjs/types";
  42850. import { Scene } from "babylonjs/scene";
  42851. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42852. /**
  42853. * Interface used to define options for Sound class
  42854. */
  42855. export interface ISoundOptions {
  42856. /**
  42857. * Does the sound autoplay once loaded.
  42858. */
  42859. autoplay?: boolean;
  42860. /**
  42861. * Does the sound loop after it finishes playing once.
  42862. */
  42863. loop?: boolean;
  42864. /**
  42865. * Sound's volume
  42866. */
  42867. volume?: number;
  42868. /**
  42869. * Is it a spatial sound?
  42870. */
  42871. spatialSound?: boolean;
  42872. /**
  42873. * Maximum distance to hear that sound
  42874. */
  42875. maxDistance?: number;
  42876. /**
  42877. * Uses user defined attenuation function
  42878. */
  42879. useCustomAttenuation?: boolean;
  42880. /**
  42881. * Define the roll off factor of spatial sounds.
  42882. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42883. */
  42884. rolloffFactor?: number;
  42885. /**
  42886. * Define the reference distance the sound should be heard perfectly.
  42887. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42888. */
  42889. refDistance?: number;
  42890. /**
  42891. * Define the distance attenuation model the sound will follow.
  42892. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42893. */
  42894. distanceModel?: string;
  42895. /**
  42896. * Defines the playback speed (1 by default)
  42897. */
  42898. playbackRate?: number;
  42899. /**
  42900. * Defines if the sound is from a streaming source
  42901. */
  42902. streaming?: boolean;
  42903. /**
  42904. * Defines an optional length (in seconds) inside the sound file
  42905. */
  42906. length?: number;
  42907. /**
  42908. * Defines an optional offset (in seconds) inside the sound file
  42909. */
  42910. offset?: number;
  42911. /**
  42912. * If true, URLs will not be required to state the audio file codec to use.
  42913. */
  42914. skipCodecCheck?: boolean;
  42915. }
  42916. /**
  42917. * Defines a sound that can be played in the application.
  42918. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42919. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42920. */
  42921. export class Sound {
  42922. /**
  42923. * The name of the sound in the scene.
  42924. */
  42925. name: string;
  42926. /**
  42927. * Does the sound autoplay once loaded.
  42928. */
  42929. autoplay: boolean;
  42930. /**
  42931. * Does the sound loop after it finishes playing once.
  42932. */
  42933. loop: boolean;
  42934. /**
  42935. * Does the sound use a custom attenuation curve to simulate the falloff
  42936. * happening when the source gets further away from the camera.
  42937. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42938. */
  42939. useCustomAttenuation: boolean;
  42940. /**
  42941. * The sound track id this sound belongs to.
  42942. */
  42943. soundTrackId: number;
  42944. /**
  42945. * Is this sound currently played.
  42946. */
  42947. isPlaying: boolean;
  42948. /**
  42949. * Is this sound currently paused.
  42950. */
  42951. isPaused: boolean;
  42952. /**
  42953. * Does this sound enables spatial sound.
  42954. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42955. */
  42956. spatialSound: boolean;
  42957. /**
  42958. * Define the reference distance the sound should be heard perfectly.
  42959. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42960. */
  42961. refDistance: number;
  42962. /**
  42963. * Define the roll off factor of spatial sounds.
  42964. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42965. */
  42966. rolloffFactor: number;
  42967. /**
  42968. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42969. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42970. */
  42971. maxDistance: number;
  42972. /**
  42973. * Define the distance attenuation model the sound will follow.
  42974. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42975. */
  42976. distanceModel: string;
  42977. /**
  42978. * @hidden
  42979. * Back Compat
  42980. **/
  42981. onended: () => any;
  42982. /**
  42983. * Gets or sets an object used to store user defined information for the sound.
  42984. */
  42985. metadata: any;
  42986. /**
  42987. * Observable event when the current playing sound finishes.
  42988. */
  42989. onEndedObservable: Observable<Sound>;
  42990. private _panningModel;
  42991. private _playbackRate;
  42992. private _streaming;
  42993. private _startTime;
  42994. private _startOffset;
  42995. private _position;
  42996. /** @hidden */
  42997. _positionInEmitterSpace: boolean;
  42998. private _localDirection;
  42999. private _volume;
  43000. private _isReadyToPlay;
  43001. private _isDirectional;
  43002. private _readyToPlayCallback;
  43003. private _audioBuffer;
  43004. private _soundSource;
  43005. private _streamingSource;
  43006. private _soundPanner;
  43007. private _soundGain;
  43008. private _inputAudioNode;
  43009. private _outputAudioNode;
  43010. private _coneInnerAngle;
  43011. private _coneOuterAngle;
  43012. private _coneOuterGain;
  43013. private _scene;
  43014. private _connectedTransformNode;
  43015. private _customAttenuationFunction;
  43016. private _registerFunc;
  43017. private _isOutputConnected;
  43018. private _htmlAudioElement;
  43019. private _urlType;
  43020. private _length?;
  43021. private _offset?;
  43022. /** @hidden */
  43023. static _SceneComponentInitialization: (scene: Scene) => void;
  43024. /**
  43025. * Create a sound and attach it to a scene
  43026. * @param name Name of your sound
  43027. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43028. * @param scene defines the scene the sound belongs to
  43029. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43030. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43031. */
  43032. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43033. /**
  43034. * Release the sound and its associated resources
  43035. */
  43036. dispose(): void;
  43037. /**
  43038. * Gets if the sounds is ready to be played or not.
  43039. * @returns true if ready, otherwise false
  43040. */
  43041. isReady(): boolean;
  43042. private _soundLoaded;
  43043. /**
  43044. * Sets the data of the sound from an audiobuffer
  43045. * @param audioBuffer The audioBuffer containing the data
  43046. */
  43047. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43048. /**
  43049. * Updates the current sounds options such as maxdistance, loop...
  43050. * @param options A JSON object containing values named as the object properties
  43051. */
  43052. updateOptions(options: ISoundOptions): void;
  43053. private _createSpatialParameters;
  43054. private _updateSpatialParameters;
  43055. /**
  43056. * Switch the panning model to HRTF:
  43057. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43058. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43059. */
  43060. switchPanningModelToHRTF(): void;
  43061. /**
  43062. * Switch the panning model to Equal Power:
  43063. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43064. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43065. */
  43066. switchPanningModelToEqualPower(): void;
  43067. private _switchPanningModel;
  43068. /**
  43069. * Connect this sound to a sound track audio node like gain...
  43070. * @param soundTrackAudioNode the sound track audio node to connect to
  43071. */
  43072. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43073. /**
  43074. * Transform this sound into a directional source
  43075. * @param coneInnerAngle Size of the inner cone in degree
  43076. * @param coneOuterAngle Size of the outer cone in degree
  43077. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43078. */
  43079. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43080. /**
  43081. * Gets or sets the inner angle for the directional cone.
  43082. */
  43083. get directionalConeInnerAngle(): number;
  43084. /**
  43085. * Gets or sets the inner angle for the directional cone.
  43086. */
  43087. set directionalConeInnerAngle(value: number);
  43088. /**
  43089. * Gets or sets the outer angle for the directional cone.
  43090. */
  43091. get directionalConeOuterAngle(): number;
  43092. /**
  43093. * Gets or sets the outer angle for the directional cone.
  43094. */
  43095. set directionalConeOuterAngle(value: number);
  43096. /**
  43097. * Sets the position of the emitter if spatial sound is enabled
  43098. * @param newPosition Defines the new posisiton
  43099. */
  43100. setPosition(newPosition: Vector3): void;
  43101. /**
  43102. * Sets the local direction of the emitter if spatial sound is enabled
  43103. * @param newLocalDirection Defines the new local direction
  43104. */
  43105. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43106. private _updateDirection;
  43107. /** @hidden */
  43108. updateDistanceFromListener(): void;
  43109. /**
  43110. * Sets a new custom attenuation function for the sound.
  43111. * @param callback Defines the function used for the attenuation
  43112. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43113. */
  43114. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43115. /**
  43116. * Play the sound
  43117. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43118. * @param offset (optional) Start the sound at a specific time in seconds
  43119. * @param length (optional) Sound duration (in seconds)
  43120. */
  43121. play(time?: number, offset?: number, length?: number): void;
  43122. private _onended;
  43123. /**
  43124. * Stop the sound
  43125. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43126. */
  43127. stop(time?: number): void;
  43128. /**
  43129. * Put the sound in pause
  43130. */
  43131. pause(): void;
  43132. /**
  43133. * Sets a dedicated volume for this sounds
  43134. * @param newVolume Define the new volume of the sound
  43135. * @param time Define time for gradual change to new volume
  43136. */
  43137. setVolume(newVolume: number, time?: number): void;
  43138. /**
  43139. * Set the sound play back rate
  43140. * @param newPlaybackRate Define the playback rate the sound should be played at
  43141. */
  43142. setPlaybackRate(newPlaybackRate: number): void;
  43143. /**
  43144. * Gets the volume of the sound.
  43145. * @returns the volume of the sound
  43146. */
  43147. getVolume(): number;
  43148. /**
  43149. * Attach the sound to a dedicated mesh
  43150. * @param transformNode The transform node to connect the sound with
  43151. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43152. */
  43153. attachToMesh(transformNode: TransformNode): void;
  43154. /**
  43155. * Detach the sound from the previously attached mesh
  43156. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43157. */
  43158. detachFromMesh(): void;
  43159. private _onRegisterAfterWorldMatrixUpdate;
  43160. /**
  43161. * Clone the current sound in the scene.
  43162. * @returns the new sound clone
  43163. */
  43164. clone(): Nullable<Sound>;
  43165. /**
  43166. * Gets the current underlying audio buffer containing the data
  43167. * @returns the audio buffer
  43168. */
  43169. getAudioBuffer(): Nullable<AudioBuffer>;
  43170. /**
  43171. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43172. * @returns the source node
  43173. */
  43174. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43175. /**
  43176. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43177. * @returns the gain node
  43178. */
  43179. getSoundGain(): Nullable<GainNode>;
  43180. /**
  43181. * Serializes the Sound in a JSON representation
  43182. * @returns the JSON representation of the sound
  43183. */
  43184. serialize(): any;
  43185. /**
  43186. * Parse a JSON representation of a sound to innstantiate in a given scene
  43187. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43188. * @param scene Define the scene the new parsed sound should be created in
  43189. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43190. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43191. * @returns the newly parsed sound
  43192. */
  43193. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43194. }
  43195. }
  43196. declare module "babylonjs/Actions/directAudioActions" {
  43197. import { Action } from "babylonjs/Actions/action";
  43198. import { Condition } from "babylonjs/Actions/condition";
  43199. import { Sound } from "babylonjs/Audio/sound";
  43200. /**
  43201. * This defines an action helpful to play a defined sound on a triggered action.
  43202. */
  43203. export class PlaySoundAction extends Action {
  43204. private _sound;
  43205. /**
  43206. * Instantiate the action
  43207. * @param triggerOptions defines the trigger options
  43208. * @param sound defines the sound to play
  43209. * @param condition defines the trigger related conditions
  43210. */
  43211. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43212. /** @hidden */
  43213. _prepare(): void;
  43214. /**
  43215. * Execute the action and play the sound.
  43216. */
  43217. execute(): void;
  43218. /**
  43219. * Serializes the actions and its related information.
  43220. * @param parent defines the object to serialize in
  43221. * @returns the serialized object
  43222. */
  43223. serialize(parent: any): any;
  43224. }
  43225. /**
  43226. * This defines an action helpful to stop a defined sound on a triggered action.
  43227. */
  43228. export class StopSoundAction extends Action {
  43229. private _sound;
  43230. /**
  43231. * Instantiate the action
  43232. * @param triggerOptions defines the trigger options
  43233. * @param sound defines the sound to stop
  43234. * @param condition defines the trigger related conditions
  43235. */
  43236. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43237. /** @hidden */
  43238. _prepare(): void;
  43239. /**
  43240. * Execute the action and stop the sound.
  43241. */
  43242. execute(): void;
  43243. /**
  43244. * Serializes the actions and its related information.
  43245. * @param parent defines the object to serialize in
  43246. * @returns the serialized object
  43247. */
  43248. serialize(parent: any): any;
  43249. }
  43250. }
  43251. declare module "babylonjs/Actions/interpolateValueAction" {
  43252. import { Action } from "babylonjs/Actions/action";
  43253. import { Condition } from "babylonjs/Actions/condition";
  43254. import { Observable } from "babylonjs/Misc/observable";
  43255. /**
  43256. * This defines an action responsible to change the value of a property
  43257. * by interpolating between its current value and the newly set one once triggered.
  43258. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43259. */
  43260. export class InterpolateValueAction extends Action {
  43261. /**
  43262. * Defines the path of the property where the value should be interpolated
  43263. */
  43264. propertyPath: string;
  43265. /**
  43266. * Defines the target value at the end of the interpolation.
  43267. */
  43268. value: any;
  43269. /**
  43270. * Defines the time it will take for the property to interpolate to the value.
  43271. */
  43272. duration: number;
  43273. /**
  43274. * Defines if the other scene animations should be stopped when the action has been triggered
  43275. */
  43276. stopOtherAnimations?: boolean;
  43277. /**
  43278. * Defines a callback raised once the interpolation animation has been done.
  43279. */
  43280. onInterpolationDone?: () => void;
  43281. /**
  43282. * Observable triggered once the interpolation animation has been done.
  43283. */
  43284. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43285. private _target;
  43286. private _effectiveTarget;
  43287. private _property;
  43288. /**
  43289. * Instantiate the action
  43290. * @param triggerOptions defines the trigger options
  43291. * @param target defines the object containing the value to interpolate
  43292. * @param propertyPath defines the path to the property in the target object
  43293. * @param value defines the target value at the end of the interpolation
  43294. * @param duration deines the time it will take for the property to interpolate to the value.
  43295. * @param condition defines the trigger related conditions
  43296. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43297. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43298. */
  43299. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43300. /** @hidden */
  43301. _prepare(): void;
  43302. /**
  43303. * Execute the action starts the value interpolation.
  43304. */
  43305. execute(): void;
  43306. /**
  43307. * Serializes the actions and its related information.
  43308. * @param parent defines the object to serialize in
  43309. * @returns the serialized object
  43310. */
  43311. serialize(parent: any): any;
  43312. }
  43313. }
  43314. declare module "babylonjs/Actions/index" {
  43315. export * from "babylonjs/Actions/abstractActionManager";
  43316. export * from "babylonjs/Actions/action";
  43317. export * from "babylonjs/Actions/actionEvent";
  43318. export * from "babylonjs/Actions/actionManager";
  43319. export * from "babylonjs/Actions/condition";
  43320. export * from "babylonjs/Actions/directActions";
  43321. export * from "babylonjs/Actions/directAudioActions";
  43322. export * from "babylonjs/Actions/interpolateValueAction";
  43323. }
  43324. declare module "babylonjs/Animations/index" {
  43325. export * from "babylonjs/Animations/animatable";
  43326. export * from "babylonjs/Animations/animation";
  43327. export * from "babylonjs/Animations/animationGroup";
  43328. export * from "babylonjs/Animations/animationPropertiesOverride";
  43329. export * from "babylonjs/Animations/easing";
  43330. export * from "babylonjs/Animations/runtimeAnimation";
  43331. export * from "babylonjs/Animations/animationEvent";
  43332. export * from "babylonjs/Animations/animationGroup";
  43333. export * from "babylonjs/Animations/animationKey";
  43334. export * from "babylonjs/Animations/animationRange";
  43335. export * from "babylonjs/Animations/animatable.interface";
  43336. }
  43337. declare module "babylonjs/Audio/soundTrack" {
  43338. import { Sound } from "babylonjs/Audio/sound";
  43339. import { Analyser } from "babylonjs/Audio/analyser";
  43340. import { Scene } from "babylonjs/scene";
  43341. /**
  43342. * Options allowed during the creation of a sound track.
  43343. */
  43344. export interface ISoundTrackOptions {
  43345. /**
  43346. * The volume the sound track should take during creation
  43347. */
  43348. volume?: number;
  43349. /**
  43350. * Define if the sound track is the main sound track of the scene
  43351. */
  43352. mainTrack?: boolean;
  43353. }
  43354. /**
  43355. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43356. * It will be also used in a future release to apply effects on a specific track.
  43357. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43358. */
  43359. export class SoundTrack {
  43360. /**
  43361. * The unique identifier of the sound track in the scene.
  43362. */
  43363. id: number;
  43364. /**
  43365. * The list of sounds included in the sound track.
  43366. */
  43367. soundCollection: Array<Sound>;
  43368. private _outputAudioNode;
  43369. private _scene;
  43370. private _connectedAnalyser;
  43371. private _options;
  43372. private _isInitialized;
  43373. /**
  43374. * Creates a new sound track.
  43375. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43376. * @param scene Define the scene the sound track belongs to
  43377. * @param options
  43378. */
  43379. constructor(scene: Scene, options?: ISoundTrackOptions);
  43380. private _initializeSoundTrackAudioGraph;
  43381. /**
  43382. * Release the sound track and its associated resources
  43383. */
  43384. dispose(): void;
  43385. /**
  43386. * Adds a sound to this sound track
  43387. * @param sound define the cound to add
  43388. * @ignoreNaming
  43389. */
  43390. AddSound(sound: Sound): void;
  43391. /**
  43392. * Removes a sound to this sound track
  43393. * @param sound define the cound to remove
  43394. * @ignoreNaming
  43395. */
  43396. RemoveSound(sound: Sound): void;
  43397. /**
  43398. * Set a global volume for the full sound track.
  43399. * @param newVolume Define the new volume of the sound track
  43400. */
  43401. setVolume(newVolume: number): void;
  43402. /**
  43403. * Switch the panning model to HRTF:
  43404. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43405. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43406. */
  43407. switchPanningModelToHRTF(): void;
  43408. /**
  43409. * Switch the panning model to Equal Power:
  43410. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43411. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43412. */
  43413. switchPanningModelToEqualPower(): void;
  43414. /**
  43415. * Connect the sound track to an audio analyser allowing some amazing
  43416. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43417. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43418. * @param analyser The analyser to connect to the engine
  43419. */
  43420. connectToAnalyser(analyser: Analyser): void;
  43421. }
  43422. }
  43423. declare module "babylonjs/Audio/audioSceneComponent" {
  43424. import { Sound } from "babylonjs/Audio/sound";
  43425. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43426. import { Nullable } from "babylonjs/types";
  43427. import { Vector3 } from "babylonjs/Maths/math.vector";
  43428. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43429. import { Scene } from "babylonjs/scene";
  43430. import { AbstractScene } from "babylonjs/abstractScene";
  43431. import "babylonjs/Audio/audioEngine";
  43432. module "babylonjs/abstractScene" {
  43433. interface AbstractScene {
  43434. /**
  43435. * The list of sounds used in the scene.
  43436. */
  43437. sounds: Nullable<Array<Sound>>;
  43438. }
  43439. }
  43440. module "babylonjs/scene" {
  43441. interface Scene {
  43442. /**
  43443. * @hidden
  43444. * Backing field
  43445. */
  43446. _mainSoundTrack: SoundTrack;
  43447. /**
  43448. * The main sound track played by the scene.
  43449. * It cotains your primary collection of sounds.
  43450. */
  43451. mainSoundTrack: SoundTrack;
  43452. /**
  43453. * The list of sound tracks added to the scene
  43454. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43455. */
  43456. soundTracks: Nullable<Array<SoundTrack>>;
  43457. /**
  43458. * Gets a sound using a given name
  43459. * @param name defines the name to search for
  43460. * @return the found sound or null if not found at all.
  43461. */
  43462. getSoundByName(name: string): Nullable<Sound>;
  43463. /**
  43464. * Gets or sets if audio support is enabled
  43465. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43466. */
  43467. audioEnabled: boolean;
  43468. /**
  43469. * Gets or sets if audio will be output to headphones
  43470. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43471. */
  43472. headphone: boolean;
  43473. /**
  43474. * Gets or sets custom audio listener position provider
  43475. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43476. */
  43477. audioListenerPositionProvider: Nullable<() => Vector3>;
  43478. /**
  43479. * Gets or sets a refresh rate when using 3D audio positioning
  43480. */
  43481. audioPositioningRefreshRate: number;
  43482. }
  43483. }
  43484. /**
  43485. * Defines the sound scene component responsible to manage any sounds
  43486. * in a given scene.
  43487. */
  43488. export class AudioSceneComponent implements ISceneSerializableComponent {
  43489. private static _CameraDirectionLH;
  43490. private static _CameraDirectionRH;
  43491. /**
  43492. * The component name helpfull to identify the component in the list of scene components.
  43493. */
  43494. readonly name: string;
  43495. /**
  43496. * The scene the component belongs to.
  43497. */
  43498. scene: Scene;
  43499. private _audioEnabled;
  43500. /**
  43501. * Gets whether audio is enabled or not.
  43502. * Please use related enable/disable method to switch state.
  43503. */
  43504. get audioEnabled(): boolean;
  43505. private _headphone;
  43506. /**
  43507. * Gets whether audio is outputing to headphone or not.
  43508. * Please use the according Switch methods to change output.
  43509. */
  43510. get headphone(): boolean;
  43511. /**
  43512. * Gets or sets a refresh rate when using 3D audio positioning
  43513. */
  43514. audioPositioningRefreshRate: number;
  43515. private _audioListenerPositionProvider;
  43516. /**
  43517. * Gets the current audio listener position provider
  43518. */
  43519. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43520. /**
  43521. * Sets a custom listener position for all sounds in the scene
  43522. * By default, this is the position of the first active camera
  43523. */
  43524. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43525. /**
  43526. * Creates a new instance of the component for the given scene
  43527. * @param scene Defines the scene to register the component in
  43528. */
  43529. constructor(scene: Scene);
  43530. /**
  43531. * Registers the component in a given scene
  43532. */
  43533. register(): void;
  43534. /**
  43535. * Rebuilds the elements related to this component in case of
  43536. * context lost for instance.
  43537. */
  43538. rebuild(): void;
  43539. /**
  43540. * Serializes the component data to the specified json object
  43541. * @param serializationObject The object to serialize to
  43542. */
  43543. serialize(serializationObject: any): void;
  43544. /**
  43545. * Adds all the elements from the container to the scene
  43546. * @param container the container holding the elements
  43547. */
  43548. addFromContainer(container: AbstractScene): void;
  43549. /**
  43550. * Removes all the elements in the container from the scene
  43551. * @param container contains the elements to remove
  43552. * @param dispose if the removed element should be disposed (default: false)
  43553. */
  43554. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43555. /**
  43556. * Disposes the component and the associated ressources.
  43557. */
  43558. dispose(): void;
  43559. /**
  43560. * Disables audio in the associated scene.
  43561. */
  43562. disableAudio(): void;
  43563. /**
  43564. * Enables audio in the associated scene.
  43565. */
  43566. enableAudio(): void;
  43567. /**
  43568. * Switch audio to headphone output.
  43569. */
  43570. switchAudioModeForHeadphones(): void;
  43571. /**
  43572. * Switch audio to normal speakers.
  43573. */
  43574. switchAudioModeForNormalSpeakers(): void;
  43575. private _cachedCameraDirection;
  43576. private _cachedCameraPosition;
  43577. private _lastCheck;
  43578. private _afterRender;
  43579. }
  43580. }
  43581. declare module "babylonjs/Audio/weightedsound" {
  43582. import { Sound } from "babylonjs/Audio/sound";
  43583. /**
  43584. * Wraps one or more Sound objects and selects one with random weight for playback.
  43585. */
  43586. export class WeightedSound {
  43587. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43588. loop: boolean;
  43589. private _coneInnerAngle;
  43590. private _coneOuterAngle;
  43591. private _volume;
  43592. /** A Sound is currently playing. */
  43593. isPlaying: boolean;
  43594. /** A Sound is currently paused. */
  43595. isPaused: boolean;
  43596. private _sounds;
  43597. private _weights;
  43598. private _currentIndex?;
  43599. /**
  43600. * Creates a new WeightedSound from the list of sounds given.
  43601. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43602. * @param sounds Array of Sounds that will be selected from.
  43603. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43604. */
  43605. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43606. /**
  43607. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43608. */
  43609. get directionalConeInnerAngle(): number;
  43610. /**
  43611. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43612. */
  43613. set directionalConeInnerAngle(value: number);
  43614. /**
  43615. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43616. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43617. */
  43618. get directionalConeOuterAngle(): number;
  43619. /**
  43620. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43621. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43622. */
  43623. set directionalConeOuterAngle(value: number);
  43624. /**
  43625. * Playback volume.
  43626. */
  43627. get volume(): number;
  43628. /**
  43629. * Playback volume.
  43630. */
  43631. set volume(value: number);
  43632. private _onended;
  43633. /**
  43634. * Suspend playback
  43635. */
  43636. pause(): void;
  43637. /**
  43638. * Stop playback
  43639. */
  43640. stop(): void;
  43641. /**
  43642. * Start playback.
  43643. * @param startOffset Position the clip head at a specific time in seconds.
  43644. */
  43645. play(startOffset?: number): void;
  43646. }
  43647. }
  43648. declare module "babylonjs/Audio/index" {
  43649. export * from "babylonjs/Audio/analyser";
  43650. export * from "babylonjs/Audio/audioEngine";
  43651. export * from "babylonjs/Audio/audioSceneComponent";
  43652. export * from "babylonjs/Audio/sound";
  43653. export * from "babylonjs/Audio/soundTrack";
  43654. export * from "babylonjs/Audio/weightedsound";
  43655. }
  43656. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43657. import { Behavior } from "babylonjs/Behaviors/behavior";
  43658. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43659. import { BackEase } from "babylonjs/Animations/easing";
  43660. /**
  43661. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43662. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43663. */
  43664. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43665. /**
  43666. * Gets the name of the behavior.
  43667. */
  43668. get name(): string;
  43669. /**
  43670. * The easing function used by animations
  43671. */
  43672. static EasingFunction: BackEase;
  43673. /**
  43674. * The easing mode used by animations
  43675. */
  43676. static EasingMode: number;
  43677. /**
  43678. * The duration of the animation, in milliseconds
  43679. */
  43680. transitionDuration: number;
  43681. /**
  43682. * Length of the distance animated by the transition when lower radius is reached
  43683. */
  43684. lowerRadiusTransitionRange: number;
  43685. /**
  43686. * Length of the distance animated by the transition when upper radius is reached
  43687. */
  43688. upperRadiusTransitionRange: number;
  43689. private _autoTransitionRange;
  43690. /**
  43691. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43692. */
  43693. get autoTransitionRange(): boolean;
  43694. /**
  43695. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43696. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43697. */
  43698. set autoTransitionRange(value: boolean);
  43699. private _attachedCamera;
  43700. private _onAfterCheckInputsObserver;
  43701. private _onMeshTargetChangedObserver;
  43702. /**
  43703. * Initializes the behavior.
  43704. */
  43705. init(): void;
  43706. /**
  43707. * Attaches the behavior to its arc rotate camera.
  43708. * @param camera Defines the camera to attach the behavior to
  43709. */
  43710. attach(camera: ArcRotateCamera): void;
  43711. /**
  43712. * Detaches the behavior from its current arc rotate camera.
  43713. */
  43714. detach(): void;
  43715. private _radiusIsAnimating;
  43716. private _radiusBounceTransition;
  43717. private _animatables;
  43718. private _cachedWheelPrecision;
  43719. /**
  43720. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43721. * @param radiusLimit The limit to check against.
  43722. * @return Bool to indicate if at limit.
  43723. */
  43724. private _isRadiusAtLimit;
  43725. /**
  43726. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43727. * @param radiusDelta The delta by which to animate to. Can be negative.
  43728. */
  43729. private _applyBoundRadiusAnimation;
  43730. /**
  43731. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43732. */
  43733. protected _clearAnimationLocks(): void;
  43734. /**
  43735. * Stops and removes all animations that have been applied to the camera
  43736. */
  43737. stopAllAnimations(): void;
  43738. }
  43739. }
  43740. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43741. import { Behavior } from "babylonjs/Behaviors/behavior";
  43742. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43743. import { ExponentialEase } from "babylonjs/Animations/easing";
  43744. import { Nullable } from "babylonjs/types";
  43745. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43746. import { Vector3 } from "babylonjs/Maths/math.vector";
  43747. /**
  43748. * 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.
  43749. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43750. */
  43751. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43752. /**
  43753. * Gets the name of the behavior.
  43754. */
  43755. get name(): string;
  43756. private _mode;
  43757. private _radiusScale;
  43758. private _positionScale;
  43759. private _defaultElevation;
  43760. private _elevationReturnTime;
  43761. private _elevationReturnWaitTime;
  43762. private _zoomStopsAnimation;
  43763. private _framingTime;
  43764. /**
  43765. * The easing function used by animations
  43766. */
  43767. static EasingFunction: ExponentialEase;
  43768. /**
  43769. * The easing mode used by animations
  43770. */
  43771. static EasingMode: number;
  43772. /**
  43773. * Sets the current mode used by the behavior
  43774. */
  43775. set mode(mode: number);
  43776. /**
  43777. * Gets current mode used by the behavior.
  43778. */
  43779. get mode(): number;
  43780. /**
  43781. * Sets the scale applied to the radius (1 by default)
  43782. */
  43783. set radiusScale(radius: number);
  43784. /**
  43785. * Gets the scale applied to the radius
  43786. */
  43787. get radiusScale(): number;
  43788. /**
  43789. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43790. */
  43791. set positionScale(scale: number);
  43792. /**
  43793. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43794. */
  43795. get positionScale(): number;
  43796. /**
  43797. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43798. * behaviour is triggered, in radians.
  43799. */
  43800. set defaultElevation(elevation: number);
  43801. /**
  43802. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43803. * behaviour is triggered, in radians.
  43804. */
  43805. get defaultElevation(): number;
  43806. /**
  43807. * Sets the time (in milliseconds) taken to return to the default beta position.
  43808. * Negative value indicates camera should not return to default.
  43809. */
  43810. set elevationReturnTime(speed: number);
  43811. /**
  43812. * Gets the time (in milliseconds) taken to return to the default beta position.
  43813. * Negative value indicates camera should not return to default.
  43814. */
  43815. get elevationReturnTime(): number;
  43816. /**
  43817. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43818. */
  43819. set elevationReturnWaitTime(time: number);
  43820. /**
  43821. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43822. */
  43823. get elevationReturnWaitTime(): number;
  43824. /**
  43825. * Sets the flag that indicates if user zooming should stop animation.
  43826. */
  43827. set zoomStopsAnimation(flag: boolean);
  43828. /**
  43829. * Gets the flag that indicates if user zooming should stop animation.
  43830. */
  43831. get zoomStopsAnimation(): boolean;
  43832. /**
  43833. * Sets the transition time when framing the mesh, in milliseconds
  43834. */
  43835. set framingTime(time: number);
  43836. /**
  43837. * Gets the transition time when framing the mesh, in milliseconds
  43838. */
  43839. get framingTime(): number;
  43840. /**
  43841. * Define if the behavior should automatically change the configured
  43842. * camera limits and sensibilities.
  43843. */
  43844. autoCorrectCameraLimitsAndSensibility: boolean;
  43845. private _onPrePointerObservableObserver;
  43846. private _onAfterCheckInputsObserver;
  43847. private _onMeshTargetChangedObserver;
  43848. private _attachedCamera;
  43849. private _isPointerDown;
  43850. private _lastInteractionTime;
  43851. /**
  43852. * Initializes the behavior.
  43853. */
  43854. init(): void;
  43855. /**
  43856. * Attaches the behavior to its arc rotate camera.
  43857. * @param camera Defines the camera to attach the behavior to
  43858. */
  43859. attach(camera: ArcRotateCamera): void;
  43860. /**
  43861. * Detaches the behavior from its current arc rotate camera.
  43862. */
  43863. detach(): void;
  43864. private _animatables;
  43865. private _betaIsAnimating;
  43866. private _betaTransition;
  43867. private _radiusTransition;
  43868. private _vectorTransition;
  43869. /**
  43870. * Targets the given mesh and updates zoom level accordingly.
  43871. * @param mesh The mesh to target.
  43872. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43873. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43874. */
  43875. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43876. /**
  43877. * Targets the given mesh with its children and updates zoom level accordingly.
  43878. * @param mesh The mesh to target.
  43879. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43880. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43881. */
  43882. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43883. /**
  43884. * Targets the given meshes with their children and updates zoom level accordingly.
  43885. * @param meshes The mesh to target.
  43886. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43887. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43888. */
  43889. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43890. /**
  43891. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43892. * @param minimumWorld Determines the smaller position of the bounding box extend
  43893. * @param maximumWorld Determines the bigger position of the bounding box extend
  43894. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43895. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43896. */
  43897. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43898. /**
  43899. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43900. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43901. * frustum width.
  43902. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43903. * to fully enclose the mesh in the viewing frustum.
  43904. */
  43905. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43906. /**
  43907. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43908. * is automatically returned to its default position (expected to be above ground plane).
  43909. */
  43910. private _maintainCameraAboveGround;
  43911. /**
  43912. * Returns the frustum slope based on the canvas ratio and camera FOV
  43913. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43914. */
  43915. private _getFrustumSlope;
  43916. /**
  43917. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43918. */
  43919. private _clearAnimationLocks;
  43920. /**
  43921. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43922. */
  43923. private _applyUserInteraction;
  43924. /**
  43925. * Stops and removes all animations that have been applied to the camera
  43926. */
  43927. stopAllAnimations(): void;
  43928. /**
  43929. * Gets a value indicating if the user is moving the camera
  43930. */
  43931. get isUserIsMoving(): boolean;
  43932. /**
  43933. * The camera can move all the way towards the mesh.
  43934. */
  43935. static IgnoreBoundsSizeMode: number;
  43936. /**
  43937. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43938. */
  43939. static FitFrustumSidesMode: number;
  43940. }
  43941. }
  43942. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43943. import { Nullable } from "babylonjs/types";
  43944. import { Camera } from "babylonjs/Cameras/camera";
  43945. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43946. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43947. /**
  43948. * Base class for Camera Pointer Inputs.
  43949. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43950. * for example usage.
  43951. */
  43952. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43953. /**
  43954. * Defines the camera the input is attached to.
  43955. */
  43956. abstract camera: Camera;
  43957. /**
  43958. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43959. */
  43960. protected _altKey: boolean;
  43961. protected _ctrlKey: boolean;
  43962. protected _metaKey: boolean;
  43963. protected _shiftKey: boolean;
  43964. /**
  43965. * Which mouse buttons were pressed at time of last mouse event.
  43966. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43967. */
  43968. protected _buttonsPressed: number;
  43969. /**
  43970. * Defines the buttons associated with the input to handle camera move.
  43971. */
  43972. buttons: number[];
  43973. /**
  43974. * Attach the input controls to a specific dom element to get the input from.
  43975. * @param element Defines the element the controls should be listened from
  43976. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43977. */
  43978. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43979. /**
  43980. * Detach the current controls from the specified dom element.
  43981. * @param element Defines the element to stop listening the inputs from
  43982. */
  43983. detachControl(element: Nullable<HTMLElement>): void;
  43984. /**
  43985. * Gets the class name of the current input.
  43986. * @returns the class name
  43987. */
  43988. getClassName(): string;
  43989. /**
  43990. * Get the friendly name associated with the input class.
  43991. * @returns the input friendly name
  43992. */
  43993. getSimpleName(): string;
  43994. /**
  43995. * Called on pointer POINTERDOUBLETAP event.
  43996. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43997. */
  43998. protected onDoubleTap(type: string): void;
  43999. /**
  44000. * Called on pointer POINTERMOVE event if only a single touch is active.
  44001. * Override this method to provide functionality.
  44002. */
  44003. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44004. /**
  44005. * Called on pointer POINTERMOVE event if multiple touches are active.
  44006. * Override this method to provide functionality.
  44007. */
  44008. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44009. /**
  44010. * Called on JS contextmenu event.
  44011. * Override this method to provide functionality.
  44012. */
  44013. protected onContextMenu(evt: PointerEvent): void;
  44014. /**
  44015. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44016. * press.
  44017. * Override this method to provide functionality.
  44018. */
  44019. protected onButtonDown(evt: PointerEvent): void;
  44020. /**
  44021. * Called each time a new POINTERUP event occurs. Ie, for each button
  44022. * release.
  44023. * Override this method to provide functionality.
  44024. */
  44025. protected onButtonUp(evt: PointerEvent): void;
  44026. /**
  44027. * Called when window becomes inactive.
  44028. * Override this method to provide functionality.
  44029. */
  44030. protected onLostFocus(): void;
  44031. private _pointerInput;
  44032. private _observer;
  44033. private _onLostFocus;
  44034. private pointA;
  44035. private pointB;
  44036. }
  44037. }
  44038. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44039. import { Nullable } from "babylonjs/types";
  44040. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44041. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44042. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44043. /**
  44044. * Manage the pointers inputs to control an arc rotate camera.
  44045. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44046. */
  44047. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44048. /**
  44049. * Defines the camera the input is attached to.
  44050. */
  44051. camera: ArcRotateCamera;
  44052. /**
  44053. * Gets the class name of the current input.
  44054. * @returns the class name
  44055. */
  44056. getClassName(): string;
  44057. /**
  44058. * Defines the buttons associated with the input to handle camera move.
  44059. */
  44060. buttons: number[];
  44061. /**
  44062. * Defines the pointer angular sensibility along the X axis or how fast is
  44063. * the camera rotating.
  44064. */
  44065. angularSensibilityX: number;
  44066. /**
  44067. * Defines the pointer angular sensibility along the Y axis or how fast is
  44068. * the camera rotating.
  44069. */
  44070. angularSensibilityY: number;
  44071. /**
  44072. * Defines the pointer pinch precision or how fast is the camera zooming.
  44073. */
  44074. pinchPrecision: number;
  44075. /**
  44076. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44077. * from 0.
  44078. * It defines the percentage of current camera.radius to use as delta when
  44079. * pinch zoom is used.
  44080. */
  44081. pinchDeltaPercentage: number;
  44082. /**
  44083. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44084. * that any object in the plane at the camera's target point will scale
  44085. * perfectly with finger motion.
  44086. * Overrides pinchDeltaPercentage and pinchPrecision.
  44087. */
  44088. useNaturalPinchZoom: boolean;
  44089. /**
  44090. * Defines the pointer panning sensibility or how fast is the camera moving.
  44091. */
  44092. panningSensibility: number;
  44093. /**
  44094. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44095. */
  44096. multiTouchPanning: boolean;
  44097. /**
  44098. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44099. * zoom (pinch) through multitouch.
  44100. */
  44101. multiTouchPanAndZoom: boolean;
  44102. /**
  44103. * Revers pinch action direction.
  44104. */
  44105. pinchInwards: boolean;
  44106. private _isPanClick;
  44107. private _twoFingerActivityCount;
  44108. private _isPinching;
  44109. /**
  44110. * Called on pointer POINTERMOVE event if only a single touch is active.
  44111. */
  44112. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44113. /**
  44114. * Called on pointer POINTERDOUBLETAP event.
  44115. */
  44116. protected onDoubleTap(type: string): void;
  44117. /**
  44118. * Called on pointer POINTERMOVE event if multiple touches are active.
  44119. */
  44120. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44121. /**
  44122. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44123. * press.
  44124. */
  44125. protected onButtonDown(evt: PointerEvent): void;
  44126. /**
  44127. * Called each time a new POINTERUP event occurs. Ie, for each button
  44128. * release.
  44129. */
  44130. protected onButtonUp(evt: PointerEvent): void;
  44131. /**
  44132. * Called when window becomes inactive.
  44133. */
  44134. protected onLostFocus(): void;
  44135. }
  44136. }
  44137. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44138. import { Nullable } from "babylonjs/types";
  44139. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44140. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44141. /**
  44142. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44143. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44144. */
  44145. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44146. /**
  44147. * Defines the camera the input is attached to.
  44148. */
  44149. camera: ArcRotateCamera;
  44150. /**
  44151. * Defines the list of key codes associated with the up action (increase alpha)
  44152. */
  44153. keysUp: number[];
  44154. /**
  44155. * Defines the list of key codes associated with the down action (decrease alpha)
  44156. */
  44157. keysDown: number[];
  44158. /**
  44159. * Defines the list of key codes associated with the left action (increase beta)
  44160. */
  44161. keysLeft: number[];
  44162. /**
  44163. * Defines the list of key codes associated with the right action (decrease beta)
  44164. */
  44165. keysRight: number[];
  44166. /**
  44167. * Defines the list of key codes associated with the reset action.
  44168. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44169. */
  44170. keysReset: number[];
  44171. /**
  44172. * Defines the panning sensibility of the inputs.
  44173. * (How fast is the camera panning)
  44174. */
  44175. panningSensibility: number;
  44176. /**
  44177. * Defines the zooming sensibility of the inputs.
  44178. * (How fast is the camera zooming)
  44179. */
  44180. zoomingSensibility: number;
  44181. /**
  44182. * Defines whether maintaining the alt key down switch the movement mode from
  44183. * orientation to zoom.
  44184. */
  44185. useAltToZoom: boolean;
  44186. /**
  44187. * Rotation speed of the camera
  44188. */
  44189. angularSpeed: number;
  44190. private _keys;
  44191. private _ctrlPressed;
  44192. private _altPressed;
  44193. private _onCanvasBlurObserver;
  44194. private _onKeyboardObserver;
  44195. private _engine;
  44196. private _scene;
  44197. /**
  44198. * Attach the input controls to a specific dom element to get the input from.
  44199. * @param element Defines the element the controls should be listened from
  44200. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44201. */
  44202. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44203. /**
  44204. * Detach the current controls from the specified dom element.
  44205. * @param element Defines the element to stop listening the inputs from
  44206. */
  44207. detachControl(element: Nullable<HTMLElement>): void;
  44208. /**
  44209. * Update the current camera state depending on the inputs that have been used this frame.
  44210. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44211. */
  44212. checkInputs(): void;
  44213. /**
  44214. * Gets the class name of the current intput.
  44215. * @returns the class name
  44216. */
  44217. getClassName(): string;
  44218. /**
  44219. * Get the friendly name associated with the input class.
  44220. * @returns the input friendly name
  44221. */
  44222. getSimpleName(): string;
  44223. }
  44224. }
  44225. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44226. import { Nullable } from "babylonjs/types";
  44227. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44228. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44229. /**
  44230. * Manage the mouse wheel inputs to control an arc rotate camera.
  44231. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44232. */
  44233. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44234. /**
  44235. * Defines the camera the input is attached to.
  44236. */
  44237. camera: ArcRotateCamera;
  44238. /**
  44239. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44240. */
  44241. wheelPrecision: number;
  44242. /**
  44243. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44244. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44245. */
  44246. wheelDeltaPercentage: number;
  44247. private _wheel;
  44248. private _observer;
  44249. private computeDeltaFromMouseWheelLegacyEvent;
  44250. /**
  44251. * Attach the input controls to a specific dom element to get the input from.
  44252. * @param element Defines the element the controls should be listened from
  44253. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44254. */
  44255. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44256. /**
  44257. * Detach the current controls from the specified dom element.
  44258. * @param element Defines the element to stop listening the inputs from
  44259. */
  44260. detachControl(element: Nullable<HTMLElement>): void;
  44261. /**
  44262. * Gets the class name of the current intput.
  44263. * @returns the class name
  44264. */
  44265. getClassName(): string;
  44266. /**
  44267. * Get the friendly name associated with the input class.
  44268. * @returns the input friendly name
  44269. */
  44270. getSimpleName(): string;
  44271. }
  44272. }
  44273. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44274. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44275. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44276. /**
  44277. * Default Inputs manager for the ArcRotateCamera.
  44278. * It groups all the default supported inputs for ease of use.
  44279. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44280. */
  44281. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44282. /**
  44283. * Instantiates a new ArcRotateCameraInputsManager.
  44284. * @param camera Defines the camera the inputs belong to
  44285. */
  44286. constructor(camera: ArcRotateCamera);
  44287. /**
  44288. * Add mouse wheel input support to the input manager.
  44289. * @returns the current input manager
  44290. */
  44291. addMouseWheel(): ArcRotateCameraInputsManager;
  44292. /**
  44293. * Add pointers input support to the input manager.
  44294. * @returns the current input manager
  44295. */
  44296. addPointers(): ArcRotateCameraInputsManager;
  44297. /**
  44298. * Add keyboard input support to the input manager.
  44299. * @returns the current input manager
  44300. */
  44301. addKeyboard(): ArcRotateCameraInputsManager;
  44302. }
  44303. }
  44304. declare module "babylonjs/Cameras/arcRotateCamera" {
  44305. import { Observable } from "babylonjs/Misc/observable";
  44306. import { Nullable } from "babylonjs/types";
  44307. import { Scene } from "babylonjs/scene";
  44308. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44309. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44310. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44311. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44312. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44313. import { Camera } from "babylonjs/Cameras/camera";
  44314. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44315. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44316. import { Collider } from "babylonjs/Collisions/collider";
  44317. /**
  44318. * This represents an orbital type of camera.
  44319. *
  44320. * 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.
  44321. * 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.
  44322. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44323. */
  44324. export class ArcRotateCamera extends TargetCamera {
  44325. /**
  44326. * Defines the rotation angle of the camera along the longitudinal axis.
  44327. */
  44328. alpha: number;
  44329. /**
  44330. * Defines the rotation angle of the camera along the latitudinal axis.
  44331. */
  44332. beta: number;
  44333. /**
  44334. * Defines the radius of the camera from it s target point.
  44335. */
  44336. radius: number;
  44337. protected _target: Vector3;
  44338. protected _targetHost: Nullable<AbstractMesh>;
  44339. /**
  44340. * Defines the target point of the camera.
  44341. * The camera looks towards it form the radius distance.
  44342. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44343. */
  44344. get target(): Vector3;
  44345. set target(value: Vector3);
  44346. /**
  44347. * Define the current local position of the camera in the scene
  44348. */
  44349. get position(): Vector3;
  44350. set position(newPosition: Vector3);
  44351. protected _upToYMatrix: Matrix;
  44352. protected _YToUpMatrix: Matrix;
  44353. /**
  44354. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44355. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44356. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44357. */
  44358. set upVector(vec: Vector3);
  44359. get upVector(): Vector3;
  44360. /**
  44361. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44362. */
  44363. setMatUp(): void;
  44364. /**
  44365. * Current inertia value on the longitudinal axis.
  44366. * The bigger this number the longer it will take for the camera to stop.
  44367. */
  44368. inertialAlphaOffset: number;
  44369. /**
  44370. * Current inertia value on the latitudinal axis.
  44371. * The bigger this number the longer it will take for the camera to stop.
  44372. */
  44373. inertialBetaOffset: number;
  44374. /**
  44375. * Current inertia value on the radius axis.
  44376. * The bigger this number the longer it will take for the camera to stop.
  44377. */
  44378. inertialRadiusOffset: number;
  44379. /**
  44380. * Minimum allowed angle on the longitudinal axis.
  44381. * This can help limiting how the Camera is able to move in the scene.
  44382. */
  44383. lowerAlphaLimit: Nullable<number>;
  44384. /**
  44385. * Maximum allowed angle on the longitudinal axis.
  44386. * This can help limiting how the Camera is able to move in the scene.
  44387. */
  44388. upperAlphaLimit: Nullable<number>;
  44389. /**
  44390. * Minimum allowed angle on the latitudinal axis.
  44391. * This can help limiting how the Camera is able to move in the scene.
  44392. */
  44393. lowerBetaLimit: number;
  44394. /**
  44395. * Maximum allowed angle on the latitudinal axis.
  44396. * This can help limiting how the Camera is able to move in the scene.
  44397. */
  44398. upperBetaLimit: number;
  44399. /**
  44400. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44401. * This can help limiting how the Camera is able to move in the scene.
  44402. */
  44403. lowerRadiusLimit: Nullable<number>;
  44404. /**
  44405. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44406. * This can help limiting how the Camera is able to move in the scene.
  44407. */
  44408. upperRadiusLimit: Nullable<number>;
  44409. /**
  44410. * Defines the current inertia value used during panning of the camera along the X axis.
  44411. */
  44412. inertialPanningX: number;
  44413. /**
  44414. * Defines the current inertia value used during panning of the camera along the Y axis.
  44415. */
  44416. inertialPanningY: number;
  44417. /**
  44418. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44419. * Basically if your fingers moves away from more than this distance you will be considered
  44420. * in pinch mode.
  44421. */
  44422. pinchToPanMaxDistance: number;
  44423. /**
  44424. * Defines the maximum distance the camera can pan.
  44425. * This could help keeping the cammera always in your scene.
  44426. */
  44427. panningDistanceLimit: Nullable<number>;
  44428. /**
  44429. * Defines the target of the camera before paning.
  44430. */
  44431. panningOriginTarget: Vector3;
  44432. /**
  44433. * Defines the value of the inertia used during panning.
  44434. * 0 would mean stop inertia and one would mean no decelleration at all.
  44435. */
  44436. panningInertia: number;
  44437. /**
  44438. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44439. */
  44440. get angularSensibilityX(): number;
  44441. set angularSensibilityX(value: number);
  44442. /**
  44443. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44444. */
  44445. get angularSensibilityY(): number;
  44446. set angularSensibilityY(value: number);
  44447. /**
  44448. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44449. */
  44450. get pinchPrecision(): number;
  44451. set pinchPrecision(value: number);
  44452. /**
  44453. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44454. * It will be used instead of pinchDeltaPrecision if different from 0.
  44455. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44456. */
  44457. get pinchDeltaPercentage(): number;
  44458. set pinchDeltaPercentage(value: number);
  44459. /**
  44460. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44461. * and pinch delta percentage.
  44462. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44463. * that any object in the plane at the camera's target point will scale
  44464. * perfectly with finger motion.
  44465. */
  44466. get useNaturalPinchZoom(): boolean;
  44467. set useNaturalPinchZoom(value: boolean);
  44468. /**
  44469. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44470. */
  44471. get panningSensibility(): number;
  44472. set panningSensibility(value: number);
  44473. /**
  44474. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44475. */
  44476. get keysUp(): number[];
  44477. set keysUp(value: number[]);
  44478. /**
  44479. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44480. */
  44481. get keysDown(): number[];
  44482. set keysDown(value: number[]);
  44483. /**
  44484. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44485. */
  44486. get keysLeft(): number[];
  44487. set keysLeft(value: number[]);
  44488. /**
  44489. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44490. */
  44491. get keysRight(): number[];
  44492. set keysRight(value: number[]);
  44493. /**
  44494. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44495. */
  44496. get wheelPrecision(): number;
  44497. set wheelPrecision(value: number);
  44498. /**
  44499. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44500. * It will be used instead of pinchDeltaPrecision if different from 0.
  44501. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44502. */
  44503. get wheelDeltaPercentage(): number;
  44504. set wheelDeltaPercentage(value: number);
  44505. /**
  44506. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44507. */
  44508. zoomOnFactor: number;
  44509. /**
  44510. * Defines a screen offset for the camera position.
  44511. */
  44512. targetScreenOffset: Vector2;
  44513. /**
  44514. * Allows the camera to be completely reversed.
  44515. * If false the camera can not arrive upside down.
  44516. */
  44517. allowUpsideDown: boolean;
  44518. /**
  44519. * Define if double tap/click is used to restore the previously saved state of the camera.
  44520. */
  44521. useInputToRestoreState: boolean;
  44522. /** @hidden */
  44523. _viewMatrix: Matrix;
  44524. /** @hidden */
  44525. _useCtrlForPanning: boolean;
  44526. /** @hidden */
  44527. _panningMouseButton: number;
  44528. /**
  44529. * Defines the input associated to the camera.
  44530. */
  44531. inputs: ArcRotateCameraInputsManager;
  44532. /** @hidden */
  44533. _reset: () => void;
  44534. /**
  44535. * Defines the allowed panning axis.
  44536. */
  44537. panningAxis: Vector3;
  44538. protected _localDirection: Vector3;
  44539. protected _transformedDirection: Vector3;
  44540. private _bouncingBehavior;
  44541. /**
  44542. * Gets the bouncing behavior of the camera if it has been enabled.
  44543. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44544. */
  44545. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44546. /**
  44547. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44548. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44549. */
  44550. get useBouncingBehavior(): boolean;
  44551. set useBouncingBehavior(value: boolean);
  44552. private _framingBehavior;
  44553. /**
  44554. * Gets the framing behavior of the camera if it has been enabled.
  44555. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44556. */
  44557. get framingBehavior(): Nullable<FramingBehavior>;
  44558. /**
  44559. * Defines if the framing behavior of the camera is enabled on the camera.
  44560. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44561. */
  44562. get useFramingBehavior(): boolean;
  44563. set useFramingBehavior(value: boolean);
  44564. private _autoRotationBehavior;
  44565. /**
  44566. * Gets the auto rotation behavior of the camera if it has been enabled.
  44567. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44568. */
  44569. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44570. /**
  44571. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44572. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44573. */
  44574. get useAutoRotationBehavior(): boolean;
  44575. set useAutoRotationBehavior(value: boolean);
  44576. /**
  44577. * Observable triggered when the mesh target has been changed on the camera.
  44578. */
  44579. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44580. /**
  44581. * Event raised when the camera is colliding with a mesh.
  44582. */
  44583. onCollide: (collidedMesh: AbstractMesh) => void;
  44584. /**
  44585. * Defines whether the camera should check collision with the objects oh the scene.
  44586. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44587. */
  44588. checkCollisions: boolean;
  44589. /**
  44590. * Defines the collision radius of the camera.
  44591. * This simulates a sphere around the camera.
  44592. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44593. */
  44594. collisionRadius: Vector3;
  44595. protected _collider: Collider;
  44596. protected _previousPosition: Vector3;
  44597. protected _collisionVelocity: Vector3;
  44598. protected _newPosition: Vector3;
  44599. protected _previousAlpha: number;
  44600. protected _previousBeta: number;
  44601. protected _previousRadius: number;
  44602. protected _collisionTriggered: boolean;
  44603. protected _targetBoundingCenter: Nullable<Vector3>;
  44604. private _computationVector;
  44605. /**
  44606. * Instantiates a new ArcRotateCamera in a given scene
  44607. * @param name Defines the name of the camera
  44608. * @param alpha Defines the camera rotation along the logitudinal axis
  44609. * @param beta Defines the camera rotation along the latitudinal axis
  44610. * @param radius Defines the camera distance from its target
  44611. * @param target Defines the camera target
  44612. * @param scene Defines the scene the camera belongs to
  44613. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44614. */
  44615. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44616. /** @hidden */
  44617. _initCache(): void;
  44618. /** @hidden */
  44619. _updateCache(ignoreParentClass?: boolean): void;
  44620. protected _getTargetPosition(): Vector3;
  44621. private _storedAlpha;
  44622. private _storedBeta;
  44623. private _storedRadius;
  44624. private _storedTarget;
  44625. private _storedTargetScreenOffset;
  44626. /**
  44627. * Stores the current state of the camera (alpha, beta, radius and target)
  44628. * @returns the camera itself
  44629. */
  44630. storeState(): Camera;
  44631. /**
  44632. * @hidden
  44633. * Restored camera state. You must call storeState() first
  44634. */
  44635. _restoreStateValues(): boolean;
  44636. /** @hidden */
  44637. _isSynchronizedViewMatrix(): boolean;
  44638. /**
  44639. * Attached controls to the current camera.
  44640. * @param element Defines the element the controls should be listened from
  44641. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44642. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44643. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44644. */
  44645. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44646. /**
  44647. * Detach the current controls from the camera.
  44648. * The camera will stop reacting to inputs.
  44649. * @param element Defines the element to stop listening the inputs from
  44650. */
  44651. detachControl(element: HTMLElement): void;
  44652. /** @hidden */
  44653. _checkInputs(): void;
  44654. protected _checkLimits(): void;
  44655. /**
  44656. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44657. */
  44658. rebuildAnglesAndRadius(): void;
  44659. /**
  44660. * Use a position to define the current camera related information like alpha, beta and radius
  44661. * @param position Defines the position to set the camera at
  44662. */
  44663. setPosition(position: Vector3): void;
  44664. /**
  44665. * Defines the target the camera should look at.
  44666. * This will automatically adapt alpha beta and radius to fit within the new target.
  44667. * @param target Defines the new target as a Vector or a mesh
  44668. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44669. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44670. */
  44671. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44672. /** @hidden */
  44673. _getViewMatrix(): Matrix;
  44674. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44675. /**
  44676. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44677. * @param meshes Defines the mesh to zoom on
  44678. * @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)
  44679. */
  44680. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44681. /**
  44682. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44683. * The target will be changed but the radius
  44684. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44685. * @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)
  44686. */
  44687. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44688. min: Vector3;
  44689. max: Vector3;
  44690. distance: number;
  44691. }, doNotUpdateMaxZ?: boolean): void;
  44692. /**
  44693. * @override
  44694. * Override Camera.createRigCamera
  44695. */
  44696. createRigCamera(name: string, cameraIndex: number): Camera;
  44697. /**
  44698. * @hidden
  44699. * @override
  44700. * Override Camera._updateRigCameras
  44701. */
  44702. _updateRigCameras(): void;
  44703. /**
  44704. * Destroy the camera and release the current resources hold by it.
  44705. */
  44706. dispose(): void;
  44707. /**
  44708. * Gets the current object class name.
  44709. * @return the class name
  44710. */
  44711. getClassName(): string;
  44712. }
  44713. }
  44714. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44715. import { Behavior } from "babylonjs/Behaviors/behavior";
  44716. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44717. /**
  44718. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44719. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44720. */
  44721. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44722. /**
  44723. * Gets the name of the behavior.
  44724. */
  44725. get name(): string;
  44726. private _zoomStopsAnimation;
  44727. private _idleRotationSpeed;
  44728. private _idleRotationWaitTime;
  44729. private _idleRotationSpinupTime;
  44730. /**
  44731. * Sets the flag that indicates if user zooming should stop animation.
  44732. */
  44733. set zoomStopsAnimation(flag: boolean);
  44734. /**
  44735. * Gets the flag that indicates if user zooming should stop animation.
  44736. */
  44737. get zoomStopsAnimation(): boolean;
  44738. /**
  44739. * Sets the default speed at which the camera rotates around the model.
  44740. */
  44741. set idleRotationSpeed(speed: number);
  44742. /**
  44743. * Gets the default speed at which the camera rotates around the model.
  44744. */
  44745. get idleRotationSpeed(): number;
  44746. /**
  44747. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44748. */
  44749. set idleRotationWaitTime(time: number);
  44750. /**
  44751. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44752. */
  44753. get idleRotationWaitTime(): number;
  44754. /**
  44755. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44756. */
  44757. set idleRotationSpinupTime(time: number);
  44758. /**
  44759. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44760. */
  44761. get idleRotationSpinupTime(): number;
  44762. /**
  44763. * Gets a value indicating if the camera is currently rotating because of this behavior
  44764. */
  44765. get rotationInProgress(): boolean;
  44766. private _onPrePointerObservableObserver;
  44767. private _onAfterCheckInputsObserver;
  44768. private _attachedCamera;
  44769. private _isPointerDown;
  44770. private _lastFrameTime;
  44771. private _lastInteractionTime;
  44772. private _cameraRotationSpeed;
  44773. /**
  44774. * Initializes the behavior.
  44775. */
  44776. init(): void;
  44777. /**
  44778. * Attaches the behavior to its arc rotate camera.
  44779. * @param camera Defines the camera to attach the behavior to
  44780. */
  44781. attach(camera: ArcRotateCamera): void;
  44782. /**
  44783. * Detaches the behavior from its current arc rotate camera.
  44784. */
  44785. detach(): void;
  44786. /**
  44787. * Returns true if user is scrolling.
  44788. * @return true if user is scrolling.
  44789. */
  44790. private _userIsZooming;
  44791. private _lastFrameRadius;
  44792. private _shouldAnimationStopForInteraction;
  44793. /**
  44794. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44795. */
  44796. private _applyUserInteraction;
  44797. private _userIsMoving;
  44798. }
  44799. }
  44800. declare module "babylonjs/Behaviors/Cameras/index" {
  44801. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44802. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44803. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44804. }
  44805. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44806. import { Mesh } from "babylonjs/Meshes/mesh";
  44807. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44808. import { Behavior } from "babylonjs/Behaviors/behavior";
  44809. /**
  44810. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44811. */
  44812. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44813. private ui;
  44814. /**
  44815. * The name of the behavior
  44816. */
  44817. name: string;
  44818. /**
  44819. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44820. */
  44821. distanceAwayFromFace: number;
  44822. /**
  44823. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44824. */
  44825. distanceAwayFromBottomOfFace: number;
  44826. private _faceVectors;
  44827. private _target;
  44828. private _scene;
  44829. private _onRenderObserver;
  44830. private _tmpMatrix;
  44831. private _tmpVector;
  44832. /**
  44833. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44834. * @param ui The transform node that should be attched to the mesh
  44835. */
  44836. constructor(ui: TransformNode);
  44837. /**
  44838. * Initializes the behavior
  44839. */
  44840. init(): void;
  44841. private _closestFace;
  44842. private _zeroVector;
  44843. private _lookAtTmpMatrix;
  44844. private _lookAtToRef;
  44845. /**
  44846. * Attaches the AttachToBoxBehavior to the passed in mesh
  44847. * @param target The mesh that the specified node will be attached to
  44848. */
  44849. attach(target: Mesh): void;
  44850. /**
  44851. * Detaches the behavior from the mesh
  44852. */
  44853. detach(): void;
  44854. }
  44855. }
  44856. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44857. import { Behavior } from "babylonjs/Behaviors/behavior";
  44858. import { Mesh } from "babylonjs/Meshes/mesh";
  44859. /**
  44860. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44861. */
  44862. export class FadeInOutBehavior implements Behavior<Mesh> {
  44863. /**
  44864. * Time in milliseconds to delay before fading in (Default: 0)
  44865. */
  44866. delay: number;
  44867. /**
  44868. * Time in milliseconds for the mesh to fade in (Default: 300)
  44869. */
  44870. fadeInTime: number;
  44871. private _millisecondsPerFrame;
  44872. private _hovered;
  44873. private _hoverValue;
  44874. private _ownerNode;
  44875. /**
  44876. * Instatiates the FadeInOutBehavior
  44877. */
  44878. constructor();
  44879. /**
  44880. * The name of the behavior
  44881. */
  44882. get name(): string;
  44883. /**
  44884. * Initializes the behavior
  44885. */
  44886. init(): void;
  44887. /**
  44888. * Attaches the fade behavior on the passed in mesh
  44889. * @param ownerNode The mesh that will be faded in/out once attached
  44890. */
  44891. attach(ownerNode: Mesh): void;
  44892. /**
  44893. * Detaches the behavior from the mesh
  44894. */
  44895. detach(): void;
  44896. /**
  44897. * Triggers the mesh to begin fading in or out
  44898. * @param value if the object should fade in or out (true to fade in)
  44899. */
  44900. fadeIn(value: boolean): void;
  44901. private _update;
  44902. private _setAllVisibility;
  44903. }
  44904. }
  44905. declare module "babylonjs/Misc/pivotTools" {
  44906. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44907. /**
  44908. * Class containing a set of static utilities functions for managing Pivots
  44909. * @hidden
  44910. */
  44911. export class PivotTools {
  44912. private static _PivotCached;
  44913. private static _OldPivotPoint;
  44914. private static _PivotTranslation;
  44915. private static _PivotTmpVector;
  44916. private static _PivotPostMultiplyPivotMatrix;
  44917. /** @hidden */
  44918. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44919. /** @hidden */
  44920. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44921. }
  44922. }
  44923. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44924. import { Scene } from "babylonjs/scene";
  44925. import { Vector4 } from "babylonjs/Maths/math.vector";
  44926. import { Mesh } from "babylonjs/Meshes/mesh";
  44927. import { Nullable } from "babylonjs/types";
  44928. import { Plane } from "babylonjs/Maths/math.plane";
  44929. /**
  44930. * Class containing static functions to help procedurally build meshes
  44931. */
  44932. export class PlaneBuilder {
  44933. /**
  44934. * Creates a plane mesh
  44935. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44936. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44937. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44938. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44939. * * 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
  44940. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44941. * @param name defines the name of the mesh
  44942. * @param options defines the options used to create the mesh
  44943. * @param scene defines the hosting scene
  44944. * @returns the plane mesh
  44945. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44946. */
  44947. static CreatePlane(name: string, options: {
  44948. size?: number;
  44949. width?: number;
  44950. height?: number;
  44951. sideOrientation?: number;
  44952. frontUVs?: Vector4;
  44953. backUVs?: Vector4;
  44954. updatable?: boolean;
  44955. sourcePlane?: Plane;
  44956. }, scene?: Nullable<Scene>): Mesh;
  44957. }
  44958. }
  44959. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44960. import { Behavior } from "babylonjs/Behaviors/behavior";
  44961. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44962. import { Observable } from "babylonjs/Misc/observable";
  44963. import { Vector3 } from "babylonjs/Maths/math.vector";
  44964. import { Ray } from "babylonjs/Culling/ray";
  44965. import "babylonjs/Meshes/Builders/planeBuilder";
  44966. /**
  44967. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44968. */
  44969. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44970. private static _AnyMouseID;
  44971. /**
  44972. * Abstract mesh the behavior is set on
  44973. */
  44974. attachedNode: AbstractMesh;
  44975. private _dragPlane;
  44976. private _scene;
  44977. private _pointerObserver;
  44978. private _beforeRenderObserver;
  44979. private static _planeScene;
  44980. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44981. /**
  44982. * 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)
  44983. */
  44984. maxDragAngle: number;
  44985. /**
  44986. * @hidden
  44987. */
  44988. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44989. /**
  44990. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44991. */
  44992. currentDraggingPointerID: number;
  44993. /**
  44994. * The last position where the pointer hit the drag plane in world space
  44995. */
  44996. lastDragPosition: Vector3;
  44997. /**
  44998. * If the behavior is currently in a dragging state
  44999. */
  45000. dragging: boolean;
  45001. /**
  45002. * 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)
  45003. */
  45004. dragDeltaRatio: number;
  45005. /**
  45006. * If the drag plane orientation should be updated during the dragging (Default: true)
  45007. */
  45008. updateDragPlane: boolean;
  45009. private _debugMode;
  45010. private _moving;
  45011. /**
  45012. * Fires each time the attached mesh is dragged with the pointer
  45013. * * delta between last drag position and current drag position in world space
  45014. * * dragDistance along the drag axis
  45015. * * dragPlaneNormal normal of the current drag plane used during the drag
  45016. * * dragPlanePoint in world space where the drag intersects the drag plane
  45017. */
  45018. onDragObservable: Observable<{
  45019. delta: Vector3;
  45020. dragPlanePoint: Vector3;
  45021. dragPlaneNormal: Vector3;
  45022. dragDistance: number;
  45023. pointerId: number;
  45024. }>;
  45025. /**
  45026. * Fires each time a drag begins (eg. mouse down on mesh)
  45027. */
  45028. onDragStartObservable: Observable<{
  45029. dragPlanePoint: Vector3;
  45030. pointerId: number;
  45031. }>;
  45032. /**
  45033. * Fires each time a drag ends (eg. mouse release after drag)
  45034. */
  45035. onDragEndObservable: Observable<{
  45036. dragPlanePoint: Vector3;
  45037. pointerId: number;
  45038. }>;
  45039. /**
  45040. * If the attached mesh should be moved when dragged
  45041. */
  45042. moveAttached: boolean;
  45043. /**
  45044. * If the drag behavior will react to drag events (Default: true)
  45045. */
  45046. enabled: boolean;
  45047. /**
  45048. * If pointer events should start and release the drag (Default: true)
  45049. */
  45050. startAndReleaseDragOnPointerEvents: boolean;
  45051. /**
  45052. * If camera controls should be detached during the drag
  45053. */
  45054. detachCameraControls: boolean;
  45055. /**
  45056. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45057. */
  45058. useObjectOrientationForDragging: boolean;
  45059. private _options;
  45060. /**
  45061. * Gets the options used by the behavior
  45062. */
  45063. get options(): {
  45064. dragAxis?: Vector3;
  45065. dragPlaneNormal?: Vector3;
  45066. };
  45067. /**
  45068. * Sets the options used by the behavior
  45069. */
  45070. set options(options: {
  45071. dragAxis?: Vector3;
  45072. dragPlaneNormal?: Vector3;
  45073. });
  45074. /**
  45075. * Creates a pointer drag behavior that can be attached to a mesh
  45076. * @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)
  45077. */
  45078. constructor(options?: {
  45079. dragAxis?: Vector3;
  45080. dragPlaneNormal?: Vector3;
  45081. });
  45082. /**
  45083. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45084. */
  45085. validateDrag: (targetPosition: Vector3) => boolean;
  45086. /**
  45087. * The name of the behavior
  45088. */
  45089. get name(): string;
  45090. /**
  45091. * Initializes the behavior
  45092. */
  45093. init(): void;
  45094. private _tmpVector;
  45095. private _alternatePickedPoint;
  45096. private _worldDragAxis;
  45097. private _targetPosition;
  45098. private _attachedElement;
  45099. /**
  45100. * Attaches the drag behavior the passed in mesh
  45101. * @param ownerNode The mesh that will be dragged around once attached
  45102. * @param predicate Predicate to use for pick filtering
  45103. */
  45104. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45105. /**
  45106. * Force relase the drag action by code.
  45107. */
  45108. releaseDrag(): void;
  45109. private _startDragRay;
  45110. private _lastPointerRay;
  45111. /**
  45112. * Simulates the start of a pointer drag event on the behavior
  45113. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45114. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45115. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45116. */
  45117. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45118. private _startDrag;
  45119. private _dragDelta;
  45120. private _moveDrag;
  45121. private _pickWithRayOnDragPlane;
  45122. private _pointA;
  45123. private _pointC;
  45124. private _localAxis;
  45125. private _lookAt;
  45126. private _updateDragPlanePosition;
  45127. /**
  45128. * Detaches the behavior from the mesh
  45129. */
  45130. detach(): void;
  45131. }
  45132. }
  45133. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45134. import { Mesh } from "babylonjs/Meshes/mesh";
  45135. import { Behavior } from "babylonjs/Behaviors/behavior";
  45136. /**
  45137. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45138. */
  45139. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45140. private _dragBehaviorA;
  45141. private _dragBehaviorB;
  45142. private _startDistance;
  45143. private _initialScale;
  45144. private _targetScale;
  45145. private _ownerNode;
  45146. private _sceneRenderObserver;
  45147. /**
  45148. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45149. */
  45150. constructor();
  45151. /**
  45152. * The name of the behavior
  45153. */
  45154. get name(): string;
  45155. /**
  45156. * Initializes the behavior
  45157. */
  45158. init(): void;
  45159. private _getCurrentDistance;
  45160. /**
  45161. * Attaches the scale behavior the passed in mesh
  45162. * @param ownerNode The mesh that will be scaled around once attached
  45163. */
  45164. attach(ownerNode: Mesh): void;
  45165. /**
  45166. * Detaches the behavior from the mesh
  45167. */
  45168. detach(): void;
  45169. }
  45170. }
  45171. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45172. import { Behavior } from "babylonjs/Behaviors/behavior";
  45173. import { Mesh } from "babylonjs/Meshes/mesh";
  45174. import { Observable } from "babylonjs/Misc/observable";
  45175. /**
  45176. * 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
  45177. */
  45178. export class SixDofDragBehavior implements Behavior<Mesh> {
  45179. private static _virtualScene;
  45180. private _ownerNode;
  45181. private _sceneRenderObserver;
  45182. private _scene;
  45183. private _targetPosition;
  45184. private _virtualOriginMesh;
  45185. private _virtualDragMesh;
  45186. private _pointerObserver;
  45187. private _moving;
  45188. private _startingOrientation;
  45189. private _attachedElement;
  45190. /**
  45191. * 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)
  45192. */
  45193. private zDragFactor;
  45194. /**
  45195. * If the object should rotate to face the drag origin
  45196. */
  45197. rotateDraggedObject: boolean;
  45198. /**
  45199. * If the behavior is currently in a dragging state
  45200. */
  45201. dragging: boolean;
  45202. /**
  45203. * 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)
  45204. */
  45205. dragDeltaRatio: number;
  45206. /**
  45207. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45208. */
  45209. currentDraggingPointerID: number;
  45210. /**
  45211. * If camera controls should be detached during the drag
  45212. */
  45213. detachCameraControls: boolean;
  45214. /**
  45215. * Fires each time a drag starts
  45216. */
  45217. onDragStartObservable: Observable<{}>;
  45218. /**
  45219. * Fires each time a drag ends (eg. mouse release after drag)
  45220. */
  45221. onDragEndObservable: Observable<{}>;
  45222. /**
  45223. * 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
  45224. */
  45225. constructor();
  45226. /**
  45227. * The name of the behavior
  45228. */
  45229. get name(): string;
  45230. /**
  45231. * Initializes the behavior
  45232. */
  45233. init(): void;
  45234. /**
  45235. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45236. */
  45237. private get _pointerCamera();
  45238. /**
  45239. * Attaches the scale behavior the passed in mesh
  45240. * @param ownerNode The mesh that will be scaled around once attached
  45241. */
  45242. attach(ownerNode: Mesh): void;
  45243. /**
  45244. * Detaches the behavior from the mesh
  45245. */
  45246. detach(): void;
  45247. }
  45248. }
  45249. declare module "babylonjs/Behaviors/Meshes/index" {
  45250. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45251. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45252. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45253. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45254. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45255. }
  45256. declare module "babylonjs/Behaviors/index" {
  45257. export * from "babylonjs/Behaviors/behavior";
  45258. export * from "babylonjs/Behaviors/Cameras/index";
  45259. export * from "babylonjs/Behaviors/Meshes/index";
  45260. }
  45261. declare module "babylonjs/Bones/boneIKController" {
  45262. import { Bone } from "babylonjs/Bones/bone";
  45263. import { Vector3 } from "babylonjs/Maths/math.vector";
  45264. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45265. import { Nullable } from "babylonjs/types";
  45266. /**
  45267. * Class used to apply inverse kinematics to bones
  45268. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45269. */
  45270. export class BoneIKController {
  45271. private static _tmpVecs;
  45272. private static _tmpQuat;
  45273. private static _tmpMats;
  45274. /**
  45275. * Gets or sets the target mesh
  45276. */
  45277. targetMesh: AbstractMesh;
  45278. /** Gets or sets the mesh used as pole */
  45279. poleTargetMesh: AbstractMesh;
  45280. /**
  45281. * Gets or sets the bone used as pole
  45282. */
  45283. poleTargetBone: Nullable<Bone>;
  45284. /**
  45285. * Gets or sets the target position
  45286. */
  45287. targetPosition: Vector3;
  45288. /**
  45289. * Gets or sets the pole target position
  45290. */
  45291. poleTargetPosition: Vector3;
  45292. /**
  45293. * Gets or sets the pole target local offset
  45294. */
  45295. poleTargetLocalOffset: Vector3;
  45296. /**
  45297. * Gets or sets the pole angle
  45298. */
  45299. poleAngle: number;
  45300. /**
  45301. * Gets or sets the mesh associated with the controller
  45302. */
  45303. mesh: AbstractMesh;
  45304. /**
  45305. * 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)
  45306. */
  45307. slerpAmount: number;
  45308. private _bone1Quat;
  45309. private _bone1Mat;
  45310. private _bone2Ang;
  45311. private _bone1;
  45312. private _bone2;
  45313. private _bone1Length;
  45314. private _bone2Length;
  45315. private _maxAngle;
  45316. private _maxReach;
  45317. private _rightHandedSystem;
  45318. private _bendAxis;
  45319. private _slerping;
  45320. private _adjustRoll;
  45321. /**
  45322. * Gets or sets maximum allowed angle
  45323. */
  45324. get maxAngle(): number;
  45325. set maxAngle(value: number);
  45326. /**
  45327. * Creates a new BoneIKController
  45328. * @param mesh defines the mesh to control
  45329. * @param bone defines the bone to control
  45330. * @param options defines options to set up the controller
  45331. */
  45332. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45333. targetMesh?: AbstractMesh;
  45334. poleTargetMesh?: AbstractMesh;
  45335. poleTargetBone?: Bone;
  45336. poleTargetLocalOffset?: Vector3;
  45337. poleAngle?: number;
  45338. bendAxis?: Vector3;
  45339. maxAngle?: number;
  45340. slerpAmount?: number;
  45341. });
  45342. private _setMaxAngle;
  45343. /**
  45344. * Force the controller to update the bones
  45345. */
  45346. update(): void;
  45347. }
  45348. }
  45349. declare module "babylonjs/Bones/boneLookController" {
  45350. import { Vector3 } from "babylonjs/Maths/math.vector";
  45351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45352. import { Bone } from "babylonjs/Bones/bone";
  45353. import { Space } from "babylonjs/Maths/math.axis";
  45354. /**
  45355. * Class used to make a bone look toward a point in space
  45356. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45357. */
  45358. export class BoneLookController {
  45359. private static _tmpVecs;
  45360. private static _tmpQuat;
  45361. private static _tmpMats;
  45362. /**
  45363. * The target Vector3 that the bone will look at
  45364. */
  45365. target: Vector3;
  45366. /**
  45367. * The mesh that the bone is attached to
  45368. */
  45369. mesh: AbstractMesh;
  45370. /**
  45371. * The bone that will be looking to the target
  45372. */
  45373. bone: Bone;
  45374. /**
  45375. * The up axis of the coordinate system that is used when the bone is rotated
  45376. */
  45377. upAxis: Vector3;
  45378. /**
  45379. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45380. */
  45381. upAxisSpace: Space;
  45382. /**
  45383. * Used to make an adjustment to the yaw of the bone
  45384. */
  45385. adjustYaw: number;
  45386. /**
  45387. * Used to make an adjustment to the pitch of the bone
  45388. */
  45389. adjustPitch: number;
  45390. /**
  45391. * Used to make an adjustment to the roll of the bone
  45392. */
  45393. adjustRoll: number;
  45394. /**
  45395. * 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)
  45396. */
  45397. slerpAmount: number;
  45398. private _minYaw;
  45399. private _maxYaw;
  45400. private _minPitch;
  45401. private _maxPitch;
  45402. private _minYawSin;
  45403. private _minYawCos;
  45404. private _maxYawSin;
  45405. private _maxYawCos;
  45406. private _midYawConstraint;
  45407. private _minPitchTan;
  45408. private _maxPitchTan;
  45409. private _boneQuat;
  45410. private _slerping;
  45411. private _transformYawPitch;
  45412. private _transformYawPitchInv;
  45413. private _firstFrameSkipped;
  45414. private _yawRange;
  45415. private _fowardAxis;
  45416. /**
  45417. * Gets or sets the minimum yaw angle that the bone can look to
  45418. */
  45419. get minYaw(): number;
  45420. set minYaw(value: number);
  45421. /**
  45422. * Gets or sets the maximum yaw angle that the bone can look to
  45423. */
  45424. get maxYaw(): number;
  45425. set maxYaw(value: number);
  45426. /**
  45427. * Gets or sets the minimum pitch angle that the bone can look to
  45428. */
  45429. get minPitch(): number;
  45430. set minPitch(value: number);
  45431. /**
  45432. * Gets or sets the maximum pitch angle that the bone can look to
  45433. */
  45434. get maxPitch(): number;
  45435. set maxPitch(value: number);
  45436. /**
  45437. * Create a BoneLookController
  45438. * @param mesh the mesh that the bone belongs to
  45439. * @param bone the bone that will be looking to the target
  45440. * @param target the target Vector3 to look at
  45441. * @param options optional settings:
  45442. * * maxYaw: the maximum angle the bone will yaw to
  45443. * * minYaw: the minimum angle the bone will yaw to
  45444. * * maxPitch: the maximum angle the bone will pitch to
  45445. * * minPitch: the minimum angle the bone will yaw to
  45446. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45447. * * upAxis: the up axis of the coordinate system
  45448. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45449. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45450. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45451. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45452. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45453. * * adjustRoll: used to make an adjustment to the roll of the bone
  45454. **/
  45455. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45456. maxYaw?: number;
  45457. minYaw?: number;
  45458. maxPitch?: number;
  45459. minPitch?: number;
  45460. slerpAmount?: number;
  45461. upAxis?: Vector3;
  45462. upAxisSpace?: Space;
  45463. yawAxis?: Vector3;
  45464. pitchAxis?: Vector3;
  45465. adjustYaw?: number;
  45466. adjustPitch?: number;
  45467. adjustRoll?: number;
  45468. });
  45469. /**
  45470. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45471. */
  45472. update(): void;
  45473. private _getAngleDiff;
  45474. private _getAngleBetween;
  45475. private _isAngleBetween;
  45476. }
  45477. }
  45478. declare module "babylonjs/Bones/index" {
  45479. export * from "babylonjs/Bones/bone";
  45480. export * from "babylonjs/Bones/boneIKController";
  45481. export * from "babylonjs/Bones/boneLookController";
  45482. export * from "babylonjs/Bones/skeleton";
  45483. }
  45484. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45485. import { Nullable } from "babylonjs/types";
  45486. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45487. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45488. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45489. /**
  45490. * Manage the gamepad inputs to control an arc rotate camera.
  45491. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45492. */
  45493. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45494. /**
  45495. * Defines the camera the input is attached to.
  45496. */
  45497. camera: ArcRotateCamera;
  45498. /**
  45499. * Defines the gamepad the input is gathering event from.
  45500. */
  45501. gamepad: Nullable<Gamepad>;
  45502. /**
  45503. * Defines the gamepad rotation sensiblity.
  45504. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45505. */
  45506. gamepadRotationSensibility: number;
  45507. /**
  45508. * Defines the gamepad move sensiblity.
  45509. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45510. */
  45511. gamepadMoveSensibility: number;
  45512. private _yAxisScale;
  45513. /**
  45514. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45515. */
  45516. get invertYAxis(): boolean;
  45517. set invertYAxis(value: boolean);
  45518. private _onGamepadConnectedObserver;
  45519. private _onGamepadDisconnectedObserver;
  45520. /**
  45521. * Attach the input controls to a specific dom element to get the input from.
  45522. * @param element Defines the element the controls should be listened from
  45523. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45524. */
  45525. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45526. /**
  45527. * Detach the current controls from the specified dom element.
  45528. * @param element Defines the element to stop listening the inputs from
  45529. */
  45530. detachControl(element: Nullable<HTMLElement>): void;
  45531. /**
  45532. * Update the current camera state depending on the inputs that have been used this frame.
  45533. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45534. */
  45535. checkInputs(): void;
  45536. /**
  45537. * Gets the class name of the current intput.
  45538. * @returns the class name
  45539. */
  45540. getClassName(): string;
  45541. /**
  45542. * Get the friendly name associated with the input class.
  45543. * @returns the input friendly name
  45544. */
  45545. getSimpleName(): string;
  45546. }
  45547. }
  45548. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45549. import { Nullable } from "babylonjs/types";
  45550. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45551. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45552. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45553. interface ArcRotateCameraInputsManager {
  45554. /**
  45555. * Add orientation input support to the input manager.
  45556. * @returns the current input manager
  45557. */
  45558. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45559. }
  45560. }
  45561. /**
  45562. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45563. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45564. */
  45565. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45566. /**
  45567. * Defines the camera the input is attached to.
  45568. */
  45569. camera: ArcRotateCamera;
  45570. /**
  45571. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45572. */
  45573. alphaCorrection: number;
  45574. /**
  45575. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45576. */
  45577. gammaCorrection: number;
  45578. private _alpha;
  45579. private _gamma;
  45580. private _dirty;
  45581. private _deviceOrientationHandler;
  45582. /**
  45583. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45584. */
  45585. constructor();
  45586. /**
  45587. * Attach the input controls to a specific dom element to get the input from.
  45588. * @param element Defines the element the controls should be listened from
  45589. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45590. */
  45591. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45592. /** @hidden */
  45593. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45594. /**
  45595. * Update the current camera state depending on the inputs that have been used this frame.
  45596. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45597. */
  45598. checkInputs(): void;
  45599. /**
  45600. * Detach the current controls from the specified dom element.
  45601. * @param element Defines the element to stop listening the inputs from
  45602. */
  45603. detachControl(element: Nullable<HTMLElement>): void;
  45604. /**
  45605. * Gets the class name of the current intput.
  45606. * @returns the class name
  45607. */
  45608. getClassName(): string;
  45609. /**
  45610. * Get the friendly name associated with the input class.
  45611. * @returns the input friendly name
  45612. */
  45613. getSimpleName(): string;
  45614. }
  45615. }
  45616. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45617. import { Nullable } from "babylonjs/types";
  45618. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45619. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45620. /**
  45621. * Listen to mouse events to control the camera.
  45622. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45623. */
  45624. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45625. /**
  45626. * Defines the camera the input is attached to.
  45627. */
  45628. camera: FlyCamera;
  45629. /**
  45630. * Defines if touch is enabled. (Default is true.)
  45631. */
  45632. touchEnabled: boolean;
  45633. /**
  45634. * Defines the buttons associated with the input to handle camera rotation.
  45635. */
  45636. buttons: number[];
  45637. /**
  45638. * Assign buttons for Yaw control.
  45639. */
  45640. buttonsYaw: number[];
  45641. /**
  45642. * Assign buttons for Pitch control.
  45643. */
  45644. buttonsPitch: number[];
  45645. /**
  45646. * Assign buttons for Roll control.
  45647. */
  45648. buttonsRoll: number[];
  45649. /**
  45650. * Detect if any button is being pressed while mouse is moved.
  45651. * -1 = Mouse locked.
  45652. * 0 = Left button.
  45653. * 1 = Middle Button.
  45654. * 2 = Right Button.
  45655. */
  45656. activeButton: number;
  45657. /**
  45658. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45659. * Higher values reduce its sensitivity.
  45660. */
  45661. angularSensibility: number;
  45662. private _mousemoveCallback;
  45663. private _observer;
  45664. private _rollObserver;
  45665. private previousPosition;
  45666. private noPreventDefault;
  45667. private element;
  45668. /**
  45669. * Listen to mouse events to control the camera.
  45670. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45671. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45672. */
  45673. constructor(touchEnabled?: boolean);
  45674. /**
  45675. * Attach the mouse control to the HTML DOM element.
  45676. * @param element Defines the element that listens to the input events.
  45677. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45678. */
  45679. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45680. /**
  45681. * Detach the current controls from the specified dom element.
  45682. * @param element Defines the element to stop listening the inputs from
  45683. */
  45684. detachControl(element: Nullable<HTMLElement>): void;
  45685. /**
  45686. * Gets the class name of the current input.
  45687. * @returns the class name.
  45688. */
  45689. getClassName(): string;
  45690. /**
  45691. * Get the friendly name associated with the input class.
  45692. * @returns the input's friendly name.
  45693. */
  45694. getSimpleName(): string;
  45695. private _pointerInput;
  45696. private _onMouseMove;
  45697. /**
  45698. * Rotate camera by mouse offset.
  45699. */
  45700. private rotateCamera;
  45701. }
  45702. }
  45703. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45704. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45705. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45706. /**
  45707. * Default Inputs manager for the FlyCamera.
  45708. * It groups all the default supported inputs for ease of use.
  45709. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45710. */
  45711. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45712. /**
  45713. * Instantiates a new FlyCameraInputsManager.
  45714. * @param camera Defines the camera the inputs belong to.
  45715. */
  45716. constructor(camera: FlyCamera);
  45717. /**
  45718. * Add keyboard input support to the input manager.
  45719. * @returns the new FlyCameraKeyboardMoveInput().
  45720. */
  45721. addKeyboard(): FlyCameraInputsManager;
  45722. /**
  45723. * Add mouse input support to the input manager.
  45724. * @param touchEnabled Enable touch screen support.
  45725. * @returns the new FlyCameraMouseInput().
  45726. */
  45727. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45728. }
  45729. }
  45730. declare module "babylonjs/Cameras/flyCamera" {
  45731. import { Scene } from "babylonjs/scene";
  45732. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45734. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45735. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45736. /**
  45737. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45738. * such as in a 3D Space Shooter or a Flight Simulator.
  45739. */
  45740. export class FlyCamera extends TargetCamera {
  45741. /**
  45742. * Define the collision ellipsoid of the camera.
  45743. * This is helpful for simulating a camera body, like a player's body.
  45744. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45745. */
  45746. ellipsoid: Vector3;
  45747. /**
  45748. * Define an offset for the position of the ellipsoid around the camera.
  45749. * This can be helpful if the camera is attached away from the player's body center,
  45750. * such as at its head.
  45751. */
  45752. ellipsoidOffset: Vector3;
  45753. /**
  45754. * Enable or disable collisions of the camera with the rest of the scene objects.
  45755. */
  45756. checkCollisions: boolean;
  45757. /**
  45758. * Enable or disable gravity on the camera.
  45759. */
  45760. applyGravity: boolean;
  45761. /**
  45762. * Define the current direction the camera is moving to.
  45763. */
  45764. cameraDirection: Vector3;
  45765. /**
  45766. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45767. * This overrides and empties cameraRotation.
  45768. */
  45769. rotationQuaternion: Quaternion;
  45770. /**
  45771. * Track Roll to maintain the wanted Rolling when looking around.
  45772. */
  45773. _trackRoll: number;
  45774. /**
  45775. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45776. */
  45777. rollCorrect: number;
  45778. /**
  45779. * Mimic a banked turn, Rolling the camera when Yawing.
  45780. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45781. */
  45782. bankedTurn: boolean;
  45783. /**
  45784. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45785. */
  45786. bankedTurnLimit: number;
  45787. /**
  45788. * Value of 0 disables the banked Roll.
  45789. * Value of 1 is equal to the Yaw angle in radians.
  45790. */
  45791. bankedTurnMultiplier: number;
  45792. /**
  45793. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45794. */
  45795. inputs: FlyCameraInputsManager;
  45796. /**
  45797. * Gets the input sensibility for mouse input.
  45798. * Higher values reduce sensitivity.
  45799. */
  45800. get angularSensibility(): number;
  45801. /**
  45802. * Sets the input sensibility for a mouse input.
  45803. * Higher values reduce sensitivity.
  45804. */
  45805. set angularSensibility(value: number);
  45806. /**
  45807. * Get the keys for camera movement forward.
  45808. */
  45809. get keysForward(): number[];
  45810. /**
  45811. * Set the keys for camera movement forward.
  45812. */
  45813. set keysForward(value: number[]);
  45814. /**
  45815. * Get the keys for camera movement backward.
  45816. */
  45817. get keysBackward(): number[];
  45818. set keysBackward(value: number[]);
  45819. /**
  45820. * Get the keys for camera movement up.
  45821. */
  45822. get keysUp(): number[];
  45823. /**
  45824. * Set the keys for camera movement up.
  45825. */
  45826. set keysUp(value: number[]);
  45827. /**
  45828. * Get the keys for camera movement down.
  45829. */
  45830. get keysDown(): number[];
  45831. /**
  45832. * Set the keys for camera movement down.
  45833. */
  45834. set keysDown(value: number[]);
  45835. /**
  45836. * Get the keys for camera movement left.
  45837. */
  45838. get keysLeft(): number[];
  45839. /**
  45840. * Set the keys for camera movement left.
  45841. */
  45842. set keysLeft(value: number[]);
  45843. /**
  45844. * Set the keys for camera movement right.
  45845. */
  45846. get keysRight(): number[];
  45847. /**
  45848. * Set the keys for camera movement right.
  45849. */
  45850. set keysRight(value: number[]);
  45851. /**
  45852. * Event raised when the camera collides with a mesh in the scene.
  45853. */
  45854. onCollide: (collidedMesh: AbstractMesh) => void;
  45855. private _collider;
  45856. private _needMoveForGravity;
  45857. private _oldPosition;
  45858. private _diffPosition;
  45859. private _newPosition;
  45860. /** @hidden */
  45861. _localDirection: Vector3;
  45862. /** @hidden */
  45863. _transformedDirection: Vector3;
  45864. /**
  45865. * Instantiates a FlyCamera.
  45866. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45867. * such as in a 3D Space Shooter or a Flight Simulator.
  45868. * @param name Define the name of the camera in the scene.
  45869. * @param position Define the starting position of the camera in the scene.
  45870. * @param scene Define the scene the camera belongs to.
  45871. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45872. */
  45873. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45874. /**
  45875. * Attach a control to the HTML DOM element.
  45876. * @param element Defines the element that listens to the input events.
  45877. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45878. */
  45879. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45880. /**
  45881. * Detach a control from the HTML DOM element.
  45882. * The camera will stop reacting to that input.
  45883. * @param element Defines the element that listens to the input events.
  45884. */
  45885. detachControl(element: HTMLElement): void;
  45886. private _collisionMask;
  45887. /**
  45888. * Get the mask that the camera ignores in collision events.
  45889. */
  45890. get collisionMask(): number;
  45891. /**
  45892. * Set the mask that the camera ignores in collision events.
  45893. */
  45894. set collisionMask(mask: number);
  45895. /** @hidden */
  45896. _collideWithWorld(displacement: Vector3): void;
  45897. /** @hidden */
  45898. private _onCollisionPositionChange;
  45899. /** @hidden */
  45900. _checkInputs(): void;
  45901. /** @hidden */
  45902. _decideIfNeedsToMove(): boolean;
  45903. /** @hidden */
  45904. _updatePosition(): void;
  45905. /**
  45906. * Restore the Roll to its target value at the rate specified.
  45907. * @param rate - Higher means slower restoring.
  45908. * @hidden
  45909. */
  45910. restoreRoll(rate: number): void;
  45911. /**
  45912. * Destroy the camera and release the current resources held by it.
  45913. */
  45914. dispose(): void;
  45915. /**
  45916. * Get the current object class name.
  45917. * @returns the class name.
  45918. */
  45919. getClassName(): string;
  45920. }
  45921. }
  45922. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45923. import { Nullable } from "babylonjs/types";
  45924. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45925. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45926. /**
  45927. * Listen to keyboard events to control the camera.
  45928. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45929. */
  45930. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45931. /**
  45932. * Defines the camera the input is attached to.
  45933. */
  45934. camera: FlyCamera;
  45935. /**
  45936. * The list of keyboard keys used to control the forward move of the camera.
  45937. */
  45938. keysForward: number[];
  45939. /**
  45940. * The list of keyboard keys used to control the backward move of the camera.
  45941. */
  45942. keysBackward: number[];
  45943. /**
  45944. * The list of keyboard keys used to control the forward move of the camera.
  45945. */
  45946. keysUp: number[];
  45947. /**
  45948. * The list of keyboard keys used to control the backward move of the camera.
  45949. */
  45950. keysDown: number[];
  45951. /**
  45952. * The list of keyboard keys used to control the right strafe move of the camera.
  45953. */
  45954. keysRight: number[];
  45955. /**
  45956. * The list of keyboard keys used to control the left strafe move of the camera.
  45957. */
  45958. keysLeft: number[];
  45959. private _keys;
  45960. private _onCanvasBlurObserver;
  45961. private _onKeyboardObserver;
  45962. private _engine;
  45963. private _scene;
  45964. /**
  45965. * Attach the input controls to a specific dom element to get the input from.
  45966. * @param element Defines the element the controls should be listened from
  45967. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45968. */
  45969. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45970. /**
  45971. * Detach the current controls from the specified dom element.
  45972. * @param element Defines the element to stop listening the inputs from
  45973. */
  45974. detachControl(element: Nullable<HTMLElement>): void;
  45975. /**
  45976. * Gets the class name of the current intput.
  45977. * @returns the class name
  45978. */
  45979. getClassName(): string;
  45980. /** @hidden */
  45981. _onLostFocus(e: FocusEvent): void;
  45982. /**
  45983. * Get the friendly name associated with the input class.
  45984. * @returns the input friendly name
  45985. */
  45986. getSimpleName(): string;
  45987. /**
  45988. * Update the current camera state depending on the inputs that have been used this frame.
  45989. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45990. */
  45991. checkInputs(): void;
  45992. }
  45993. }
  45994. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45995. import { Nullable } from "babylonjs/types";
  45996. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45997. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45998. /**
  45999. * Manage the mouse wheel inputs to control a follow camera.
  46000. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46001. */
  46002. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  46003. /**
  46004. * Defines the camera the input is attached to.
  46005. */
  46006. camera: FollowCamera;
  46007. /**
  46008. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46009. */
  46010. axisControlRadius: boolean;
  46011. /**
  46012. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46013. */
  46014. axisControlHeight: boolean;
  46015. /**
  46016. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46017. */
  46018. axisControlRotation: boolean;
  46019. /**
  46020. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46021. * relation to mouseWheel events.
  46022. */
  46023. wheelPrecision: number;
  46024. /**
  46025. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46026. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46027. */
  46028. wheelDeltaPercentage: number;
  46029. private _wheel;
  46030. private _observer;
  46031. /**
  46032. * Attach the input controls to a specific dom element to get the input from.
  46033. * @param element Defines the element the controls should be listened from
  46034. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46035. */
  46036. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46037. /**
  46038. * Detach the current controls from the specified dom element.
  46039. * @param element Defines the element to stop listening the inputs from
  46040. */
  46041. detachControl(element: Nullable<HTMLElement>): void;
  46042. /**
  46043. * Gets the class name of the current intput.
  46044. * @returns the class name
  46045. */
  46046. getClassName(): string;
  46047. /**
  46048. * Get the friendly name associated with the input class.
  46049. * @returns the input friendly name
  46050. */
  46051. getSimpleName(): string;
  46052. }
  46053. }
  46054. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46055. import { Nullable } from "babylonjs/types";
  46056. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46057. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46058. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46059. /**
  46060. * Manage the pointers inputs to control an follow camera.
  46061. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46062. */
  46063. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46064. /**
  46065. * Defines the camera the input is attached to.
  46066. */
  46067. camera: FollowCamera;
  46068. /**
  46069. * Gets the class name of the current input.
  46070. * @returns the class name
  46071. */
  46072. getClassName(): string;
  46073. /**
  46074. * Defines the pointer angular sensibility along the X axis or how fast is
  46075. * the camera rotating.
  46076. * A negative number will reverse the axis direction.
  46077. */
  46078. angularSensibilityX: number;
  46079. /**
  46080. * Defines the pointer angular sensibility along the Y axis or how fast is
  46081. * the camera rotating.
  46082. * A negative number will reverse the axis direction.
  46083. */
  46084. angularSensibilityY: number;
  46085. /**
  46086. * Defines the pointer pinch precision or how fast is the camera zooming.
  46087. * A negative number will reverse the axis direction.
  46088. */
  46089. pinchPrecision: number;
  46090. /**
  46091. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46092. * from 0.
  46093. * It defines the percentage of current camera.radius to use as delta when
  46094. * pinch zoom is used.
  46095. */
  46096. pinchDeltaPercentage: number;
  46097. /**
  46098. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46099. */
  46100. axisXControlRadius: boolean;
  46101. /**
  46102. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46103. */
  46104. axisXControlHeight: boolean;
  46105. /**
  46106. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46107. */
  46108. axisXControlRotation: boolean;
  46109. /**
  46110. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46111. */
  46112. axisYControlRadius: boolean;
  46113. /**
  46114. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46115. */
  46116. axisYControlHeight: boolean;
  46117. /**
  46118. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46119. */
  46120. axisYControlRotation: boolean;
  46121. /**
  46122. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46123. */
  46124. axisPinchControlRadius: boolean;
  46125. /**
  46126. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46127. */
  46128. axisPinchControlHeight: boolean;
  46129. /**
  46130. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46131. */
  46132. axisPinchControlRotation: boolean;
  46133. /**
  46134. * Log error messages if basic misconfiguration has occurred.
  46135. */
  46136. warningEnable: boolean;
  46137. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46138. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46139. private _warningCounter;
  46140. private _warning;
  46141. }
  46142. }
  46143. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46144. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46145. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46146. /**
  46147. * Default Inputs manager for the FollowCamera.
  46148. * It groups all the default supported inputs for ease of use.
  46149. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46150. */
  46151. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46152. /**
  46153. * Instantiates a new FollowCameraInputsManager.
  46154. * @param camera Defines the camera the inputs belong to
  46155. */
  46156. constructor(camera: FollowCamera);
  46157. /**
  46158. * Add keyboard input support to the input manager.
  46159. * @returns the current input manager
  46160. */
  46161. addKeyboard(): FollowCameraInputsManager;
  46162. /**
  46163. * Add mouse wheel input support to the input manager.
  46164. * @returns the current input manager
  46165. */
  46166. addMouseWheel(): FollowCameraInputsManager;
  46167. /**
  46168. * Add pointers input support to the input manager.
  46169. * @returns the current input manager
  46170. */
  46171. addPointers(): FollowCameraInputsManager;
  46172. /**
  46173. * Add orientation input support to the input manager.
  46174. * @returns the current input manager
  46175. */
  46176. addVRDeviceOrientation(): FollowCameraInputsManager;
  46177. }
  46178. }
  46179. declare module "babylonjs/Cameras/followCamera" {
  46180. import { Nullable } from "babylonjs/types";
  46181. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46182. import { Scene } from "babylonjs/scene";
  46183. import { Vector3 } from "babylonjs/Maths/math.vector";
  46184. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46185. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46186. /**
  46187. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46188. * an arc rotate version arcFollowCamera are available.
  46189. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46190. */
  46191. export class FollowCamera extends TargetCamera {
  46192. /**
  46193. * Distance the follow camera should follow an object at
  46194. */
  46195. radius: number;
  46196. /**
  46197. * Minimum allowed distance of the camera to the axis of rotation
  46198. * (The camera can not get closer).
  46199. * This can help limiting how the Camera is able to move in the scene.
  46200. */
  46201. lowerRadiusLimit: Nullable<number>;
  46202. /**
  46203. * Maximum allowed distance of the camera to the axis of rotation
  46204. * (The camera can not get further).
  46205. * This can help limiting how the Camera is able to move in the scene.
  46206. */
  46207. upperRadiusLimit: Nullable<number>;
  46208. /**
  46209. * Define a rotation offset between the camera and the object it follows
  46210. */
  46211. rotationOffset: number;
  46212. /**
  46213. * Minimum allowed angle to camera position relative to target object.
  46214. * This can help limiting how the Camera is able to move in the scene.
  46215. */
  46216. lowerRotationOffsetLimit: Nullable<number>;
  46217. /**
  46218. * Maximum allowed angle to camera position relative to target object.
  46219. * This can help limiting how the Camera is able to move in the scene.
  46220. */
  46221. upperRotationOffsetLimit: Nullable<number>;
  46222. /**
  46223. * Define a height offset between the camera and the object it follows.
  46224. * It can help following an object from the top (like a car chaing a plane)
  46225. */
  46226. heightOffset: number;
  46227. /**
  46228. * Minimum allowed height of camera position relative to target object.
  46229. * This can help limiting how the Camera is able to move in the scene.
  46230. */
  46231. lowerHeightOffsetLimit: Nullable<number>;
  46232. /**
  46233. * Maximum allowed height of camera position relative to target object.
  46234. * This can help limiting how the Camera is able to move in the scene.
  46235. */
  46236. upperHeightOffsetLimit: Nullable<number>;
  46237. /**
  46238. * Define how fast the camera can accelerate to follow it s target.
  46239. */
  46240. cameraAcceleration: number;
  46241. /**
  46242. * Define the speed limit of the camera following an object.
  46243. */
  46244. maxCameraSpeed: number;
  46245. /**
  46246. * Define the target of the camera.
  46247. */
  46248. lockedTarget: Nullable<AbstractMesh>;
  46249. /**
  46250. * Defines the input associated with the camera.
  46251. */
  46252. inputs: FollowCameraInputsManager;
  46253. /**
  46254. * Instantiates the follow camera.
  46255. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46256. * @param name Define the name of the camera in the scene
  46257. * @param position Define the position of the camera
  46258. * @param scene Define the scene the camera belong to
  46259. * @param lockedTarget Define the target of the camera
  46260. */
  46261. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46262. private _follow;
  46263. /**
  46264. * Attached controls to the current camera.
  46265. * @param element Defines the element the controls should be listened from
  46266. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46267. */
  46268. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46269. /**
  46270. * Detach the current controls from the camera.
  46271. * The camera will stop reacting to inputs.
  46272. * @param element Defines the element to stop listening the inputs from
  46273. */
  46274. detachControl(element: HTMLElement): void;
  46275. /** @hidden */
  46276. _checkInputs(): void;
  46277. private _checkLimits;
  46278. /**
  46279. * Gets the camera class name.
  46280. * @returns the class name
  46281. */
  46282. getClassName(): string;
  46283. }
  46284. /**
  46285. * Arc Rotate version of the follow camera.
  46286. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46287. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46288. */
  46289. export class ArcFollowCamera extends TargetCamera {
  46290. /** The longitudinal angle of the camera */
  46291. alpha: number;
  46292. /** The latitudinal angle of the camera */
  46293. beta: number;
  46294. /** The radius of the camera from its target */
  46295. radius: number;
  46296. private _cartesianCoordinates;
  46297. /** Define the camera target (the mesh it should follow) */
  46298. private _meshTarget;
  46299. /**
  46300. * Instantiates a new ArcFollowCamera
  46301. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46302. * @param name Define the name of the camera
  46303. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46304. * @param beta Define the rotation angle of the camera around the elevation axis
  46305. * @param radius Define the radius of the camera from its target point
  46306. * @param target Define the target of the camera
  46307. * @param scene Define the scene the camera belongs to
  46308. */
  46309. constructor(name: string,
  46310. /** The longitudinal angle of the camera */
  46311. alpha: number,
  46312. /** The latitudinal angle of the camera */
  46313. beta: number,
  46314. /** The radius of the camera from its target */
  46315. radius: number,
  46316. /** Define the camera target (the mesh it should follow) */
  46317. target: Nullable<AbstractMesh>, scene: Scene);
  46318. private _follow;
  46319. /** @hidden */
  46320. _checkInputs(): void;
  46321. /**
  46322. * Returns the class name of the object.
  46323. * It is mostly used internally for serialization purposes.
  46324. */
  46325. getClassName(): string;
  46326. }
  46327. }
  46328. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46329. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46330. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46331. import { Nullable } from "babylonjs/types";
  46332. /**
  46333. * Manage the keyboard inputs to control the movement of a follow camera.
  46334. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46335. */
  46336. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46337. /**
  46338. * Defines the camera the input is attached to.
  46339. */
  46340. camera: FollowCamera;
  46341. /**
  46342. * Defines the list of key codes associated with the up action (increase heightOffset)
  46343. */
  46344. keysHeightOffsetIncr: number[];
  46345. /**
  46346. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46347. */
  46348. keysHeightOffsetDecr: number[];
  46349. /**
  46350. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46351. */
  46352. keysHeightOffsetModifierAlt: boolean;
  46353. /**
  46354. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46355. */
  46356. keysHeightOffsetModifierCtrl: boolean;
  46357. /**
  46358. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46359. */
  46360. keysHeightOffsetModifierShift: boolean;
  46361. /**
  46362. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46363. */
  46364. keysRotationOffsetIncr: number[];
  46365. /**
  46366. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46367. */
  46368. keysRotationOffsetDecr: number[];
  46369. /**
  46370. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46371. */
  46372. keysRotationOffsetModifierAlt: boolean;
  46373. /**
  46374. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46375. */
  46376. keysRotationOffsetModifierCtrl: boolean;
  46377. /**
  46378. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46379. */
  46380. keysRotationOffsetModifierShift: boolean;
  46381. /**
  46382. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46383. */
  46384. keysRadiusIncr: number[];
  46385. /**
  46386. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46387. */
  46388. keysRadiusDecr: number[];
  46389. /**
  46390. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46391. */
  46392. keysRadiusModifierAlt: boolean;
  46393. /**
  46394. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46395. */
  46396. keysRadiusModifierCtrl: boolean;
  46397. /**
  46398. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46399. */
  46400. keysRadiusModifierShift: boolean;
  46401. /**
  46402. * Defines the rate of change of heightOffset.
  46403. */
  46404. heightSensibility: number;
  46405. /**
  46406. * Defines the rate of change of rotationOffset.
  46407. */
  46408. rotationSensibility: number;
  46409. /**
  46410. * Defines the rate of change of radius.
  46411. */
  46412. radiusSensibility: number;
  46413. private _keys;
  46414. private _ctrlPressed;
  46415. private _altPressed;
  46416. private _shiftPressed;
  46417. private _onCanvasBlurObserver;
  46418. private _onKeyboardObserver;
  46419. private _engine;
  46420. private _scene;
  46421. /**
  46422. * Attach the input controls to a specific dom element to get the input from.
  46423. * @param element Defines the element the controls should be listened from
  46424. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46425. */
  46426. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46427. /**
  46428. * Detach the current controls from the specified dom element.
  46429. * @param element Defines the element to stop listening the inputs from
  46430. */
  46431. detachControl(element: Nullable<HTMLElement>): void;
  46432. /**
  46433. * Update the current camera state depending on the inputs that have been used this frame.
  46434. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46435. */
  46436. checkInputs(): void;
  46437. /**
  46438. * Gets the class name of the current input.
  46439. * @returns the class name
  46440. */
  46441. getClassName(): string;
  46442. /**
  46443. * Get the friendly name associated with the input class.
  46444. * @returns the input friendly name
  46445. */
  46446. getSimpleName(): string;
  46447. /**
  46448. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46449. * allow modification of the heightOffset value.
  46450. */
  46451. private _modifierHeightOffset;
  46452. /**
  46453. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46454. * allow modification of the rotationOffset value.
  46455. */
  46456. private _modifierRotationOffset;
  46457. /**
  46458. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46459. * allow modification of the radius value.
  46460. */
  46461. private _modifierRadius;
  46462. }
  46463. }
  46464. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46465. import { Nullable } from "babylonjs/types";
  46466. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46467. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46468. import { Observable } from "babylonjs/Misc/observable";
  46469. module "babylonjs/Cameras/freeCameraInputsManager" {
  46470. interface FreeCameraInputsManager {
  46471. /**
  46472. * @hidden
  46473. */
  46474. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46475. /**
  46476. * Add orientation input support to the input manager.
  46477. * @returns the current input manager
  46478. */
  46479. addDeviceOrientation(): FreeCameraInputsManager;
  46480. }
  46481. }
  46482. /**
  46483. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46484. * Screen rotation is taken into account.
  46485. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46486. */
  46487. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46488. private _camera;
  46489. private _screenOrientationAngle;
  46490. private _constantTranform;
  46491. private _screenQuaternion;
  46492. private _alpha;
  46493. private _beta;
  46494. private _gamma;
  46495. /**
  46496. * Can be used to detect if a device orientation sensor is available on a device
  46497. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46498. * @returns a promise that will resolve on orientation change
  46499. */
  46500. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46501. /**
  46502. * @hidden
  46503. */
  46504. _onDeviceOrientationChangedObservable: Observable<void>;
  46505. /**
  46506. * Instantiates a new input
  46507. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46508. */
  46509. constructor();
  46510. /**
  46511. * Define the camera controlled by the input.
  46512. */
  46513. get camera(): FreeCamera;
  46514. set camera(camera: FreeCamera);
  46515. /**
  46516. * Attach the input controls to a specific dom element to get the input from.
  46517. * @param element Defines the element the controls should be listened from
  46518. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46519. */
  46520. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46521. private _orientationChanged;
  46522. private _deviceOrientation;
  46523. /**
  46524. * Detach the current controls from the specified dom element.
  46525. * @param element Defines the element to stop listening the inputs from
  46526. */
  46527. detachControl(element: Nullable<HTMLElement>): void;
  46528. /**
  46529. * Update the current camera state depending on the inputs that have been used this frame.
  46530. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46531. */
  46532. checkInputs(): void;
  46533. /**
  46534. * Gets the class name of the current intput.
  46535. * @returns the class name
  46536. */
  46537. getClassName(): string;
  46538. /**
  46539. * Get the friendly name associated with the input class.
  46540. * @returns the input friendly name
  46541. */
  46542. getSimpleName(): string;
  46543. }
  46544. }
  46545. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46546. import { Nullable } from "babylonjs/types";
  46547. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46548. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46549. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46550. /**
  46551. * Manage the gamepad inputs to control a free camera.
  46552. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46553. */
  46554. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46555. /**
  46556. * Define the camera the input is attached to.
  46557. */
  46558. camera: FreeCamera;
  46559. /**
  46560. * Define the Gamepad controlling the input
  46561. */
  46562. gamepad: Nullable<Gamepad>;
  46563. /**
  46564. * Defines the gamepad rotation sensiblity.
  46565. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46566. */
  46567. gamepadAngularSensibility: number;
  46568. /**
  46569. * Defines the gamepad move sensiblity.
  46570. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46571. */
  46572. gamepadMoveSensibility: number;
  46573. private _yAxisScale;
  46574. /**
  46575. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46576. */
  46577. get invertYAxis(): boolean;
  46578. set invertYAxis(value: boolean);
  46579. private _onGamepadConnectedObserver;
  46580. private _onGamepadDisconnectedObserver;
  46581. private _cameraTransform;
  46582. private _deltaTransform;
  46583. private _vector3;
  46584. private _vector2;
  46585. /**
  46586. * Attach the input controls to a specific dom element to get the input from.
  46587. * @param element Defines the element the controls should be listened from
  46588. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46589. */
  46590. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46591. /**
  46592. * Detach the current controls from the specified dom element.
  46593. * @param element Defines the element to stop listening the inputs from
  46594. */
  46595. detachControl(element: Nullable<HTMLElement>): void;
  46596. /**
  46597. * Update the current camera state depending on the inputs that have been used this frame.
  46598. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46599. */
  46600. checkInputs(): void;
  46601. /**
  46602. * Gets the class name of the current intput.
  46603. * @returns the class name
  46604. */
  46605. getClassName(): string;
  46606. /**
  46607. * Get the friendly name associated with the input class.
  46608. * @returns the input friendly name
  46609. */
  46610. getSimpleName(): string;
  46611. }
  46612. }
  46613. declare module "babylonjs/Misc/virtualJoystick" {
  46614. import { Nullable } from "babylonjs/types";
  46615. import { Vector3 } from "babylonjs/Maths/math.vector";
  46616. /**
  46617. * Defines the potential axis of a Joystick
  46618. */
  46619. export enum JoystickAxis {
  46620. /** X axis */
  46621. X = 0,
  46622. /** Y axis */
  46623. Y = 1,
  46624. /** Z axis */
  46625. Z = 2
  46626. }
  46627. /**
  46628. * Represents the different customization options available
  46629. * for VirtualJoystick
  46630. */
  46631. interface VirtualJoystickCustomizations {
  46632. /**
  46633. * Size of the joystick's puck
  46634. */
  46635. puckSize: number;
  46636. /**
  46637. * Size of the joystick's container
  46638. */
  46639. containerSize: number;
  46640. /**
  46641. * Color of the joystick && puck
  46642. */
  46643. color: string;
  46644. /**
  46645. * Image URL for the joystick's puck
  46646. */
  46647. puckImage?: string;
  46648. /**
  46649. * Image URL for the joystick's container
  46650. */
  46651. containerImage?: string;
  46652. /**
  46653. * Defines the unmoving position of the joystick container
  46654. */
  46655. position?: {
  46656. x: number;
  46657. y: number;
  46658. };
  46659. /**
  46660. * Defines whether or not the joystick container is always visible
  46661. */
  46662. alwaysVisible: boolean;
  46663. /**
  46664. * Defines whether or not to limit the movement of the puck to the joystick's container
  46665. */
  46666. limitToContainer: boolean;
  46667. }
  46668. /**
  46669. * Class used to define virtual joystick (used in touch mode)
  46670. */
  46671. export class VirtualJoystick {
  46672. /**
  46673. * Gets or sets a boolean indicating that left and right values must be inverted
  46674. */
  46675. reverseLeftRight: boolean;
  46676. /**
  46677. * Gets or sets a boolean indicating that up and down values must be inverted
  46678. */
  46679. reverseUpDown: boolean;
  46680. /**
  46681. * Gets the offset value for the position (ie. the change of the position value)
  46682. */
  46683. deltaPosition: Vector3;
  46684. /**
  46685. * Gets a boolean indicating if the virtual joystick was pressed
  46686. */
  46687. pressed: boolean;
  46688. /**
  46689. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46690. */
  46691. static Canvas: Nullable<HTMLCanvasElement>;
  46692. /**
  46693. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46694. */
  46695. limitToContainer: boolean;
  46696. private static _globalJoystickIndex;
  46697. private static _alwaysVisibleSticks;
  46698. private static vjCanvasContext;
  46699. private static vjCanvasWidth;
  46700. private static vjCanvasHeight;
  46701. private static halfWidth;
  46702. private static _GetDefaultOptions;
  46703. private _action;
  46704. private _axisTargetedByLeftAndRight;
  46705. private _axisTargetedByUpAndDown;
  46706. private _joystickSensibility;
  46707. private _inversedSensibility;
  46708. private _joystickPointerID;
  46709. private _joystickColor;
  46710. private _joystickPointerPos;
  46711. private _joystickPreviousPointerPos;
  46712. private _joystickPointerStartPos;
  46713. private _deltaJoystickVector;
  46714. private _leftJoystick;
  46715. private _touches;
  46716. private _joystickPosition;
  46717. private _alwaysVisible;
  46718. private _puckImage;
  46719. private _containerImage;
  46720. private _joystickPuckSize;
  46721. private _joystickContainerSize;
  46722. private _clearPuckSize;
  46723. private _clearContainerSize;
  46724. private _clearPuckSizeOffset;
  46725. private _clearContainerSizeOffset;
  46726. private _onPointerDownHandlerRef;
  46727. private _onPointerMoveHandlerRef;
  46728. private _onPointerUpHandlerRef;
  46729. private _onResize;
  46730. /**
  46731. * Creates a new virtual joystick
  46732. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46733. * @param customizations Defines the options we want to customize the VirtualJoystick
  46734. */
  46735. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46736. /**
  46737. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46738. * @param newJoystickSensibility defines the new sensibility
  46739. */
  46740. setJoystickSensibility(newJoystickSensibility: number): void;
  46741. private _onPointerDown;
  46742. private _onPointerMove;
  46743. private _onPointerUp;
  46744. /**
  46745. * Change the color of the virtual joystick
  46746. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46747. */
  46748. setJoystickColor(newColor: string): void;
  46749. /**
  46750. * Size of the joystick's container
  46751. */
  46752. set containerSize(newSize: number);
  46753. get containerSize(): number;
  46754. /**
  46755. * Size of the joystick's puck
  46756. */
  46757. set puckSize(newSize: number);
  46758. get puckSize(): number;
  46759. /**
  46760. * Clears the set position of the joystick
  46761. */
  46762. clearPosition(): void;
  46763. /**
  46764. * Defines whether or not the joystick container is always visible
  46765. */
  46766. set alwaysVisible(value: boolean);
  46767. get alwaysVisible(): boolean;
  46768. /**
  46769. * Sets the constant position of the Joystick container
  46770. * @param x X axis coordinate
  46771. * @param y Y axis coordinate
  46772. */
  46773. setPosition(x: number, y: number): void;
  46774. /**
  46775. * Defines a callback to call when the joystick is touched
  46776. * @param action defines the callback
  46777. */
  46778. setActionOnTouch(action: () => any): void;
  46779. /**
  46780. * Defines which axis you'd like to control for left & right
  46781. * @param axis defines the axis to use
  46782. */
  46783. setAxisForLeftRight(axis: JoystickAxis): void;
  46784. /**
  46785. * Defines which axis you'd like to control for up & down
  46786. * @param axis defines the axis to use
  46787. */
  46788. setAxisForUpDown(axis: JoystickAxis): void;
  46789. /**
  46790. * Clears the canvas from the previous puck / container draw
  46791. */
  46792. private _clearPreviousDraw;
  46793. /**
  46794. * Loads `urlPath` to be used for the container's image
  46795. * @param urlPath defines the urlPath of an image to use
  46796. */
  46797. setContainerImage(urlPath: string): void;
  46798. /**
  46799. * Loads `urlPath` to be used for the puck's image
  46800. * @param urlPath defines the urlPath of an image to use
  46801. */
  46802. setPuckImage(urlPath: string): void;
  46803. /**
  46804. * Draws the Virtual Joystick's container
  46805. */
  46806. private _drawContainer;
  46807. /**
  46808. * Draws the Virtual Joystick's puck
  46809. */
  46810. private _drawPuck;
  46811. private _drawVirtualJoystick;
  46812. /**
  46813. * Release internal HTML canvas
  46814. */
  46815. releaseCanvas(): void;
  46816. }
  46817. }
  46818. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46819. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46820. import { Nullable } from "babylonjs/types";
  46821. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46822. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46823. module "babylonjs/Cameras/freeCameraInputsManager" {
  46824. interface FreeCameraInputsManager {
  46825. /**
  46826. * Add virtual joystick input support to the input manager.
  46827. * @returns the current input manager
  46828. */
  46829. addVirtualJoystick(): FreeCameraInputsManager;
  46830. }
  46831. }
  46832. /**
  46833. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46834. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46835. */
  46836. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46837. /**
  46838. * Defines the camera the input is attached to.
  46839. */
  46840. camera: FreeCamera;
  46841. private _leftjoystick;
  46842. private _rightjoystick;
  46843. /**
  46844. * Gets the left stick of the virtual joystick.
  46845. * @returns The virtual Joystick
  46846. */
  46847. getLeftJoystick(): VirtualJoystick;
  46848. /**
  46849. * Gets the right stick of the virtual joystick.
  46850. * @returns The virtual Joystick
  46851. */
  46852. getRightJoystick(): VirtualJoystick;
  46853. /**
  46854. * Update the current camera state depending on the inputs that have been used this frame.
  46855. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46856. */
  46857. checkInputs(): void;
  46858. /**
  46859. * Attach the input controls to a specific dom element to get the input from.
  46860. * @param element Defines the element the controls should be listened from
  46861. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46862. */
  46863. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46864. /**
  46865. * Detach the current controls from the specified dom element.
  46866. * @param element Defines the element to stop listening the inputs from
  46867. */
  46868. detachControl(element: Nullable<HTMLElement>): void;
  46869. /**
  46870. * Gets the class name of the current intput.
  46871. * @returns the class name
  46872. */
  46873. getClassName(): string;
  46874. /**
  46875. * Get the friendly name associated with the input class.
  46876. * @returns the input friendly name
  46877. */
  46878. getSimpleName(): string;
  46879. }
  46880. }
  46881. declare module "babylonjs/Cameras/Inputs/index" {
  46882. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46883. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46884. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46885. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46886. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46887. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46888. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46889. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46890. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46891. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46892. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46893. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46894. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46895. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46896. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46897. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46898. }
  46899. declare module "babylonjs/Cameras/touchCamera" {
  46900. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46901. import { Scene } from "babylonjs/scene";
  46902. import { Vector3 } from "babylonjs/Maths/math.vector";
  46903. /**
  46904. * This represents a FPS type of camera controlled by touch.
  46905. * This is like a universal camera minus the Gamepad controls.
  46906. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46907. */
  46908. export class TouchCamera extends FreeCamera {
  46909. /**
  46910. * Defines the touch sensibility for rotation.
  46911. * The higher the faster.
  46912. */
  46913. get touchAngularSensibility(): number;
  46914. set touchAngularSensibility(value: number);
  46915. /**
  46916. * Defines the touch sensibility for move.
  46917. * The higher the faster.
  46918. */
  46919. get touchMoveSensibility(): number;
  46920. set touchMoveSensibility(value: number);
  46921. /**
  46922. * Instantiates a new touch camera.
  46923. * This represents a FPS type of camera controlled by touch.
  46924. * This is like a universal camera minus the Gamepad controls.
  46925. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46926. * @param name Define the name of the camera in the scene
  46927. * @param position Define the start position of the camera in the scene
  46928. * @param scene Define the scene the camera belongs to
  46929. */
  46930. constructor(name: string, position: Vector3, scene: Scene);
  46931. /**
  46932. * Gets the current object class name.
  46933. * @return the class name
  46934. */
  46935. getClassName(): string;
  46936. /** @hidden */
  46937. _setupInputs(): void;
  46938. }
  46939. }
  46940. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46941. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46942. import { Scene } from "babylonjs/scene";
  46943. import { Vector3 } from "babylonjs/Maths/math.vector";
  46944. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46945. import { Axis } from "babylonjs/Maths/math.axis";
  46946. /**
  46947. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46948. * being tilted forward or back and left or right.
  46949. */
  46950. export class DeviceOrientationCamera extends FreeCamera {
  46951. private _initialQuaternion;
  46952. private _quaternionCache;
  46953. private _tmpDragQuaternion;
  46954. private _disablePointerInputWhenUsingDeviceOrientation;
  46955. /**
  46956. * Creates a new device orientation camera
  46957. * @param name The name of the camera
  46958. * @param position The start position camera
  46959. * @param scene The scene the camera belongs to
  46960. */
  46961. constructor(name: string, position: Vector3, scene: Scene);
  46962. /**
  46963. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46964. */
  46965. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46966. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46967. private _dragFactor;
  46968. /**
  46969. * Enabled turning on the y axis when the orientation sensor is active
  46970. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46971. */
  46972. enableHorizontalDragging(dragFactor?: number): void;
  46973. /**
  46974. * Gets the current instance class name ("DeviceOrientationCamera").
  46975. * This helps avoiding instanceof at run time.
  46976. * @returns the class name
  46977. */
  46978. getClassName(): string;
  46979. /**
  46980. * @hidden
  46981. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46982. */
  46983. _checkInputs(): void;
  46984. /**
  46985. * Reset the camera to its default orientation on the specified axis only.
  46986. * @param axis The axis to reset
  46987. */
  46988. resetToCurrentRotation(axis?: Axis): void;
  46989. }
  46990. }
  46991. declare module "babylonjs/Gamepads/xboxGamepad" {
  46992. import { Observable } from "babylonjs/Misc/observable";
  46993. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46994. /**
  46995. * Defines supported buttons for XBox360 compatible gamepads
  46996. */
  46997. export enum Xbox360Button {
  46998. /** A */
  46999. A = 0,
  47000. /** B */
  47001. B = 1,
  47002. /** X */
  47003. X = 2,
  47004. /** Y */
  47005. Y = 3,
  47006. /** Left button */
  47007. LB = 4,
  47008. /** Right button */
  47009. RB = 5,
  47010. /** Back */
  47011. Back = 8,
  47012. /** Start */
  47013. Start = 9,
  47014. /** Left stick */
  47015. LeftStick = 10,
  47016. /** Right stick */
  47017. RightStick = 11
  47018. }
  47019. /** Defines values for XBox360 DPad */
  47020. export enum Xbox360Dpad {
  47021. /** Up */
  47022. Up = 12,
  47023. /** Down */
  47024. Down = 13,
  47025. /** Left */
  47026. Left = 14,
  47027. /** Right */
  47028. Right = 15
  47029. }
  47030. /**
  47031. * Defines a XBox360 gamepad
  47032. */
  47033. export class Xbox360Pad extends Gamepad {
  47034. private _leftTrigger;
  47035. private _rightTrigger;
  47036. private _onlefttriggerchanged;
  47037. private _onrighttriggerchanged;
  47038. private _onbuttondown;
  47039. private _onbuttonup;
  47040. private _ondpaddown;
  47041. private _ondpadup;
  47042. /** Observable raised when a button is pressed */
  47043. onButtonDownObservable: Observable<Xbox360Button>;
  47044. /** Observable raised when a button is released */
  47045. onButtonUpObservable: Observable<Xbox360Button>;
  47046. /** Observable raised when a pad is pressed */
  47047. onPadDownObservable: Observable<Xbox360Dpad>;
  47048. /** Observable raised when a pad is released */
  47049. onPadUpObservable: Observable<Xbox360Dpad>;
  47050. private _buttonA;
  47051. private _buttonB;
  47052. private _buttonX;
  47053. private _buttonY;
  47054. private _buttonBack;
  47055. private _buttonStart;
  47056. private _buttonLB;
  47057. private _buttonRB;
  47058. private _buttonLeftStick;
  47059. private _buttonRightStick;
  47060. private _dPadUp;
  47061. private _dPadDown;
  47062. private _dPadLeft;
  47063. private _dPadRight;
  47064. private _isXboxOnePad;
  47065. /**
  47066. * Creates a new XBox360 gamepad object
  47067. * @param id defines the id of this gamepad
  47068. * @param index defines its index
  47069. * @param gamepad defines the internal HTML gamepad object
  47070. * @param xboxOne defines if it is a XBox One gamepad
  47071. */
  47072. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47073. /**
  47074. * Defines the callback to call when left trigger is pressed
  47075. * @param callback defines the callback to use
  47076. */
  47077. onlefttriggerchanged(callback: (value: number) => void): void;
  47078. /**
  47079. * Defines the callback to call when right trigger is pressed
  47080. * @param callback defines the callback to use
  47081. */
  47082. onrighttriggerchanged(callback: (value: number) => void): void;
  47083. /**
  47084. * Gets the left trigger value
  47085. */
  47086. get leftTrigger(): number;
  47087. /**
  47088. * Sets the left trigger value
  47089. */
  47090. set leftTrigger(newValue: number);
  47091. /**
  47092. * Gets the right trigger value
  47093. */
  47094. get rightTrigger(): number;
  47095. /**
  47096. * Sets the right trigger value
  47097. */
  47098. set rightTrigger(newValue: number);
  47099. /**
  47100. * Defines the callback to call when a button is pressed
  47101. * @param callback defines the callback to use
  47102. */
  47103. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47104. /**
  47105. * Defines the callback to call when a button is released
  47106. * @param callback defines the callback to use
  47107. */
  47108. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47109. /**
  47110. * Defines the callback to call when a pad is pressed
  47111. * @param callback defines the callback to use
  47112. */
  47113. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47114. /**
  47115. * Defines the callback to call when a pad is released
  47116. * @param callback defines the callback to use
  47117. */
  47118. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47119. private _setButtonValue;
  47120. private _setDPadValue;
  47121. /**
  47122. * Gets the value of the `A` button
  47123. */
  47124. get buttonA(): number;
  47125. /**
  47126. * Sets the value of the `A` button
  47127. */
  47128. set buttonA(value: number);
  47129. /**
  47130. * Gets the value of the `B` button
  47131. */
  47132. get buttonB(): number;
  47133. /**
  47134. * Sets the value of the `B` button
  47135. */
  47136. set buttonB(value: number);
  47137. /**
  47138. * Gets the value of the `X` button
  47139. */
  47140. get buttonX(): number;
  47141. /**
  47142. * Sets the value of the `X` button
  47143. */
  47144. set buttonX(value: number);
  47145. /**
  47146. * Gets the value of the `Y` button
  47147. */
  47148. get buttonY(): number;
  47149. /**
  47150. * Sets the value of the `Y` button
  47151. */
  47152. set buttonY(value: number);
  47153. /**
  47154. * Gets the value of the `Start` button
  47155. */
  47156. get buttonStart(): number;
  47157. /**
  47158. * Sets the value of the `Start` button
  47159. */
  47160. set buttonStart(value: number);
  47161. /**
  47162. * Gets the value of the `Back` button
  47163. */
  47164. get buttonBack(): number;
  47165. /**
  47166. * Sets the value of the `Back` button
  47167. */
  47168. set buttonBack(value: number);
  47169. /**
  47170. * Gets the value of the `Left` button
  47171. */
  47172. get buttonLB(): number;
  47173. /**
  47174. * Sets the value of the `Left` button
  47175. */
  47176. set buttonLB(value: number);
  47177. /**
  47178. * Gets the value of the `Right` button
  47179. */
  47180. get buttonRB(): number;
  47181. /**
  47182. * Sets the value of the `Right` button
  47183. */
  47184. set buttonRB(value: number);
  47185. /**
  47186. * Gets the value of the Left joystick
  47187. */
  47188. get buttonLeftStick(): number;
  47189. /**
  47190. * Sets the value of the Left joystick
  47191. */
  47192. set buttonLeftStick(value: number);
  47193. /**
  47194. * Gets the value of the Right joystick
  47195. */
  47196. get buttonRightStick(): number;
  47197. /**
  47198. * Sets the value of the Right joystick
  47199. */
  47200. set buttonRightStick(value: number);
  47201. /**
  47202. * Gets the value of D-pad up
  47203. */
  47204. get dPadUp(): number;
  47205. /**
  47206. * Sets the value of D-pad up
  47207. */
  47208. set dPadUp(value: number);
  47209. /**
  47210. * Gets the value of D-pad down
  47211. */
  47212. get dPadDown(): number;
  47213. /**
  47214. * Sets the value of D-pad down
  47215. */
  47216. set dPadDown(value: number);
  47217. /**
  47218. * Gets the value of D-pad left
  47219. */
  47220. get dPadLeft(): number;
  47221. /**
  47222. * Sets the value of D-pad left
  47223. */
  47224. set dPadLeft(value: number);
  47225. /**
  47226. * Gets the value of D-pad right
  47227. */
  47228. get dPadRight(): number;
  47229. /**
  47230. * Sets the value of D-pad right
  47231. */
  47232. set dPadRight(value: number);
  47233. /**
  47234. * Force the gamepad to synchronize with device values
  47235. */
  47236. update(): void;
  47237. /**
  47238. * Disposes the gamepad
  47239. */
  47240. dispose(): void;
  47241. }
  47242. }
  47243. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47244. import { Observable } from "babylonjs/Misc/observable";
  47245. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47246. /**
  47247. * Defines supported buttons for DualShock compatible gamepads
  47248. */
  47249. export enum DualShockButton {
  47250. /** Cross */
  47251. Cross = 0,
  47252. /** Circle */
  47253. Circle = 1,
  47254. /** Square */
  47255. Square = 2,
  47256. /** Triangle */
  47257. Triangle = 3,
  47258. /** L1 */
  47259. L1 = 4,
  47260. /** R1 */
  47261. R1 = 5,
  47262. /** Share */
  47263. Share = 8,
  47264. /** Options */
  47265. Options = 9,
  47266. /** Left stick */
  47267. LeftStick = 10,
  47268. /** Right stick */
  47269. RightStick = 11
  47270. }
  47271. /** Defines values for DualShock DPad */
  47272. export enum DualShockDpad {
  47273. /** Up */
  47274. Up = 12,
  47275. /** Down */
  47276. Down = 13,
  47277. /** Left */
  47278. Left = 14,
  47279. /** Right */
  47280. Right = 15
  47281. }
  47282. /**
  47283. * Defines a DualShock gamepad
  47284. */
  47285. export class DualShockPad extends Gamepad {
  47286. private _leftTrigger;
  47287. private _rightTrigger;
  47288. private _onlefttriggerchanged;
  47289. private _onrighttriggerchanged;
  47290. private _onbuttondown;
  47291. private _onbuttonup;
  47292. private _ondpaddown;
  47293. private _ondpadup;
  47294. /** Observable raised when a button is pressed */
  47295. onButtonDownObservable: Observable<DualShockButton>;
  47296. /** Observable raised when a button is released */
  47297. onButtonUpObservable: Observable<DualShockButton>;
  47298. /** Observable raised when a pad is pressed */
  47299. onPadDownObservable: Observable<DualShockDpad>;
  47300. /** Observable raised when a pad is released */
  47301. onPadUpObservable: Observable<DualShockDpad>;
  47302. private _buttonCross;
  47303. private _buttonCircle;
  47304. private _buttonSquare;
  47305. private _buttonTriangle;
  47306. private _buttonShare;
  47307. private _buttonOptions;
  47308. private _buttonL1;
  47309. private _buttonR1;
  47310. private _buttonLeftStick;
  47311. private _buttonRightStick;
  47312. private _dPadUp;
  47313. private _dPadDown;
  47314. private _dPadLeft;
  47315. private _dPadRight;
  47316. /**
  47317. * Creates a new DualShock gamepad object
  47318. * @param id defines the id of this gamepad
  47319. * @param index defines its index
  47320. * @param gamepad defines the internal HTML gamepad object
  47321. */
  47322. constructor(id: string, index: number, gamepad: any);
  47323. /**
  47324. * Defines the callback to call when left trigger is pressed
  47325. * @param callback defines the callback to use
  47326. */
  47327. onlefttriggerchanged(callback: (value: number) => void): void;
  47328. /**
  47329. * Defines the callback to call when right trigger is pressed
  47330. * @param callback defines the callback to use
  47331. */
  47332. onrighttriggerchanged(callback: (value: number) => void): void;
  47333. /**
  47334. * Gets the left trigger value
  47335. */
  47336. get leftTrigger(): number;
  47337. /**
  47338. * Sets the left trigger value
  47339. */
  47340. set leftTrigger(newValue: number);
  47341. /**
  47342. * Gets the right trigger value
  47343. */
  47344. get rightTrigger(): number;
  47345. /**
  47346. * Sets the right trigger value
  47347. */
  47348. set rightTrigger(newValue: number);
  47349. /**
  47350. * Defines the callback to call when a button is pressed
  47351. * @param callback defines the callback to use
  47352. */
  47353. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47354. /**
  47355. * Defines the callback to call when a button is released
  47356. * @param callback defines the callback to use
  47357. */
  47358. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47359. /**
  47360. * Defines the callback to call when a pad is pressed
  47361. * @param callback defines the callback to use
  47362. */
  47363. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47364. /**
  47365. * Defines the callback to call when a pad is released
  47366. * @param callback defines the callback to use
  47367. */
  47368. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47369. private _setButtonValue;
  47370. private _setDPadValue;
  47371. /**
  47372. * Gets the value of the `Cross` button
  47373. */
  47374. get buttonCross(): number;
  47375. /**
  47376. * Sets the value of the `Cross` button
  47377. */
  47378. set buttonCross(value: number);
  47379. /**
  47380. * Gets the value of the `Circle` button
  47381. */
  47382. get buttonCircle(): number;
  47383. /**
  47384. * Sets the value of the `Circle` button
  47385. */
  47386. set buttonCircle(value: number);
  47387. /**
  47388. * Gets the value of the `Square` button
  47389. */
  47390. get buttonSquare(): number;
  47391. /**
  47392. * Sets the value of the `Square` button
  47393. */
  47394. set buttonSquare(value: number);
  47395. /**
  47396. * Gets the value of the `Triangle` button
  47397. */
  47398. get buttonTriangle(): number;
  47399. /**
  47400. * Sets the value of the `Triangle` button
  47401. */
  47402. set buttonTriangle(value: number);
  47403. /**
  47404. * Gets the value of the `Options` button
  47405. */
  47406. get buttonOptions(): number;
  47407. /**
  47408. * Sets the value of the `Options` button
  47409. */
  47410. set buttonOptions(value: number);
  47411. /**
  47412. * Gets the value of the `Share` button
  47413. */
  47414. get buttonShare(): number;
  47415. /**
  47416. * Sets the value of the `Share` button
  47417. */
  47418. set buttonShare(value: number);
  47419. /**
  47420. * Gets the value of the `L1` button
  47421. */
  47422. get buttonL1(): number;
  47423. /**
  47424. * Sets the value of the `L1` button
  47425. */
  47426. set buttonL1(value: number);
  47427. /**
  47428. * Gets the value of the `R1` button
  47429. */
  47430. get buttonR1(): number;
  47431. /**
  47432. * Sets the value of the `R1` button
  47433. */
  47434. set buttonR1(value: number);
  47435. /**
  47436. * Gets the value of the Left joystick
  47437. */
  47438. get buttonLeftStick(): number;
  47439. /**
  47440. * Sets the value of the Left joystick
  47441. */
  47442. set buttonLeftStick(value: number);
  47443. /**
  47444. * Gets the value of the Right joystick
  47445. */
  47446. get buttonRightStick(): number;
  47447. /**
  47448. * Sets the value of the Right joystick
  47449. */
  47450. set buttonRightStick(value: number);
  47451. /**
  47452. * Gets the value of D-pad up
  47453. */
  47454. get dPadUp(): number;
  47455. /**
  47456. * Sets the value of D-pad up
  47457. */
  47458. set dPadUp(value: number);
  47459. /**
  47460. * Gets the value of D-pad down
  47461. */
  47462. get dPadDown(): number;
  47463. /**
  47464. * Sets the value of D-pad down
  47465. */
  47466. set dPadDown(value: number);
  47467. /**
  47468. * Gets the value of D-pad left
  47469. */
  47470. get dPadLeft(): number;
  47471. /**
  47472. * Sets the value of D-pad left
  47473. */
  47474. set dPadLeft(value: number);
  47475. /**
  47476. * Gets the value of D-pad right
  47477. */
  47478. get dPadRight(): number;
  47479. /**
  47480. * Sets the value of D-pad right
  47481. */
  47482. set dPadRight(value: number);
  47483. /**
  47484. * Force the gamepad to synchronize with device values
  47485. */
  47486. update(): void;
  47487. /**
  47488. * Disposes the gamepad
  47489. */
  47490. dispose(): void;
  47491. }
  47492. }
  47493. declare module "babylonjs/Gamepads/gamepadManager" {
  47494. import { Observable } from "babylonjs/Misc/observable";
  47495. import { Nullable } from "babylonjs/types";
  47496. import { Scene } from "babylonjs/scene";
  47497. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47498. /**
  47499. * Manager for handling gamepads
  47500. */
  47501. export class GamepadManager {
  47502. private _scene?;
  47503. private _babylonGamepads;
  47504. private _oneGamepadConnected;
  47505. /** @hidden */
  47506. _isMonitoring: boolean;
  47507. private _gamepadEventSupported;
  47508. private _gamepadSupport?;
  47509. /**
  47510. * observable to be triggered when the gamepad controller has been connected
  47511. */
  47512. onGamepadConnectedObservable: Observable<Gamepad>;
  47513. /**
  47514. * observable to be triggered when the gamepad controller has been disconnected
  47515. */
  47516. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47517. private _onGamepadConnectedEvent;
  47518. private _onGamepadDisconnectedEvent;
  47519. /**
  47520. * Initializes the gamepad manager
  47521. * @param _scene BabylonJS scene
  47522. */
  47523. constructor(_scene?: Scene | undefined);
  47524. /**
  47525. * The gamepads in the game pad manager
  47526. */
  47527. get gamepads(): Gamepad[];
  47528. /**
  47529. * Get the gamepad controllers based on type
  47530. * @param type The type of gamepad controller
  47531. * @returns Nullable gamepad
  47532. */
  47533. getGamepadByType(type?: number): Nullable<Gamepad>;
  47534. /**
  47535. * Disposes the gamepad manager
  47536. */
  47537. dispose(): void;
  47538. private _addNewGamepad;
  47539. private _startMonitoringGamepads;
  47540. private _stopMonitoringGamepads;
  47541. /** @hidden */
  47542. _checkGamepadsStatus(): void;
  47543. private _updateGamepadObjects;
  47544. }
  47545. }
  47546. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47547. import { Nullable } from "babylonjs/types";
  47548. import { Scene } from "babylonjs/scene";
  47549. import { ISceneComponent } from "babylonjs/sceneComponent";
  47550. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47551. module "babylonjs/scene" {
  47552. interface Scene {
  47553. /** @hidden */
  47554. _gamepadManager: Nullable<GamepadManager>;
  47555. /**
  47556. * Gets the gamepad manager associated with the scene
  47557. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47558. */
  47559. gamepadManager: GamepadManager;
  47560. }
  47561. }
  47562. module "babylonjs/Cameras/freeCameraInputsManager" {
  47563. /**
  47564. * Interface representing a free camera inputs manager
  47565. */
  47566. interface FreeCameraInputsManager {
  47567. /**
  47568. * Adds gamepad input support to the FreeCameraInputsManager.
  47569. * @returns the FreeCameraInputsManager
  47570. */
  47571. addGamepad(): FreeCameraInputsManager;
  47572. }
  47573. }
  47574. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47575. /**
  47576. * Interface representing an arc rotate camera inputs manager
  47577. */
  47578. interface ArcRotateCameraInputsManager {
  47579. /**
  47580. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47581. * @returns the camera inputs manager
  47582. */
  47583. addGamepad(): ArcRotateCameraInputsManager;
  47584. }
  47585. }
  47586. /**
  47587. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47588. */
  47589. export class GamepadSystemSceneComponent implements ISceneComponent {
  47590. /**
  47591. * The component name helpfull to identify the component in the list of scene components.
  47592. */
  47593. readonly name: string;
  47594. /**
  47595. * The scene the component belongs to.
  47596. */
  47597. scene: Scene;
  47598. /**
  47599. * Creates a new instance of the component for the given scene
  47600. * @param scene Defines the scene to register the component in
  47601. */
  47602. constructor(scene: Scene);
  47603. /**
  47604. * Registers the component in a given scene
  47605. */
  47606. register(): void;
  47607. /**
  47608. * Rebuilds the elements related to this component in case of
  47609. * context lost for instance.
  47610. */
  47611. rebuild(): void;
  47612. /**
  47613. * Disposes the component and the associated ressources
  47614. */
  47615. dispose(): void;
  47616. private _beforeCameraUpdate;
  47617. }
  47618. }
  47619. declare module "babylonjs/Cameras/universalCamera" {
  47620. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47621. import { Scene } from "babylonjs/scene";
  47622. import { Vector3 } from "babylonjs/Maths/math.vector";
  47623. import "babylonjs/Gamepads/gamepadSceneComponent";
  47624. /**
  47625. * 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,
  47626. * which still works and will still be found in many Playgrounds.
  47627. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47628. */
  47629. export class UniversalCamera extends TouchCamera {
  47630. /**
  47631. * Defines the gamepad rotation sensiblity.
  47632. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47633. */
  47634. get gamepadAngularSensibility(): number;
  47635. set gamepadAngularSensibility(value: number);
  47636. /**
  47637. * Defines the gamepad move sensiblity.
  47638. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47639. */
  47640. get gamepadMoveSensibility(): number;
  47641. set gamepadMoveSensibility(value: number);
  47642. /**
  47643. * 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,
  47644. * which still works and will still be found in many Playgrounds.
  47645. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47646. * @param name Define the name of the camera in the scene
  47647. * @param position Define the start position of the camera in the scene
  47648. * @param scene Define the scene the camera belongs to
  47649. */
  47650. constructor(name: string, position: Vector3, scene: Scene);
  47651. /**
  47652. * Gets the current object class name.
  47653. * @return the class name
  47654. */
  47655. getClassName(): string;
  47656. }
  47657. }
  47658. declare module "babylonjs/Cameras/gamepadCamera" {
  47659. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47660. import { Scene } from "babylonjs/scene";
  47661. import { Vector3 } from "babylonjs/Maths/math.vector";
  47662. /**
  47663. * This represents a FPS type of camera. This is only here for back compat purpose.
  47664. * Please use the UniversalCamera instead as both are identical.
  47665. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47666. */
  47667. export class GamepadCamera extends UniversalCamera {
  47668. /**
  47669. * Instantiates a new Gamepad Camera
  47670. * This represents a FPS type of camera. This is only here for back compat purpose.
  47671. * Please use the UniversalCamera instead as both are identical.
  47672. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47673. * @param name Define the name of the camera in the scene
  47674. * @param position Define the start position of the camera in the scene
  47675. * @param scene Define the scene the camera belongs to
  47676. */
  47677. constructor(name: string, position: Vector3, scene: Scene);
  47678. /**
  47679. * Gets the current object class name.
  47680. * @return the class name
  47681. */
  47682. getClassName(): string;
  47683. }
  47684. }
  47685. declare module "babylonjs/Shaders/pass.fragment" {
  47686. /** @hidden */
  47687. export var passPixelShader: {
  47688. name: string;
  47689. shader: string;
  47690. };
  47691. }
  47692. declare module "babylonjs/Shaders/passCube.fragment" {
  47693. /** @hidden */
  47694. export var passCubePixelShader: {
  47695. name: string;
  47696. shader: string;
  47697. };
  47698. }
  47699. declare module "babylonjs/PostProcesses/passPostProcess" {
  47700. import { Nullable } from "babylonjs/types";
  47701. import { Camera } from "babylonjs/Cameras/camera";
  47702. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47703. import { Engine } from "babylonjs/Engines/engine";
  47704. import "babylonjs/Shaders/pass.fragment";
  47705. import "babylonjs/Shaders/passCube.fragment";
  47706. import { Scene } from "babylonjs/scene";
  47707. /**
  47708. * PassPostProcess which produces an output the same as it's input
  47709. */
  47710. export class PassPostProcess extends PostProcess {
  47711. /**
  47712. * Gets a string identifying the name of the class
  47713. * @returns "PassPostProcess" string
  47714. */
  47715. getClassName(): string;
  47716. /**
  47717. * Creates the PassPostProcess
  47718. * @param name The name of the effect.
  47719. * @param options The required width/height ratio to downsize to before computing the render pass.
  47720. * @param camera The camera to apply the render pass to.
  47721. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47722. * @param engine The engine which the post process will be applied. (default: current engine)
  47723. * @param reusable If the post process can be reused on the same frame. (default: false)
  47724. * @param textureType The type of texture to be used when performing the post processing.
  47725. * @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)
  47726. */
  47727. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47728. /** @hidden */
  47729. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47730. }
  47731. /**
  47732. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47733. */
  47734. export class PassCubePostProcess extends PostProcess {
  47735. private _face;
  47736. /**
  47737. * Gets or sets the cube face to display.
  47738. * * 0 is +X
  47739. * * 1 is -X
  47740. * * 2 is +Y
  47741. * * 3 is -Y
  47742. * * 4 is +Z
  47743. * * 5 is -Z
  47744. */
  47745. get face(): number;
  47746. set face(value: number);
  47747. /**
  47748. * Gets a string identifying the name of the class
  47749. * @returns "PassCubePostProcess" string
  47750. */
  47751. getClassName(): string;
  47752. /**
  47753. * Creates the PassCubePostProcess
  47754. * @param name The name of the effect.
  47755. * @param options The required width/height ratio to downsize to before computing the render pass.
  47756. * @param camera The camera to apply the render pass to.
  47757. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47758. * @param engine The engine which the post process will be applied. (default: current engine)
  47759. * @param reusable If the post process can be reused on the same frame. (default: false)
  47760. * @param textureType The type of texture to be used when performing the post processing.
  47761. * @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)
  47762. */
  47763. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47764. /** @hidden */
  47765. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47766. }
  47767. }
  47768. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47769. /** @hidden */
  47770. export var anaglyphPixelShader: {
  47771. name: string;
  47772. shader: string;
  47773. };
  47774. }
  47775. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47776. import { Engine } from "babylonjs/Engines/engine";
  47777. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47778. import { Camera } from "babylonjs/Cameras/camera";
  47779. import "babylonjs/Shaders/anaglyph.fragment";
  47780. /**
  47781. * Postprocess used to generate anaglyphic rendering
  47782. */
  47783. export class AnaglyphPostProcess extends PostProcess {
  47784. private _passedProcess;
  47785. /**
  47786. * Gets a string identifying the name of the class
  47787. * @returns "AnaglyphPostProcess" string
  47788. */
  47789. getClassName(): string;
  47790. /**
  47791. * Creates a new AnaglyphPostProcess
  47792. * @param name defines postprocess name
  47793. * @param options defines creation options or target ratio scale
  47794. * @param rigCameras defines cameras using this postprocess
  47795. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47796. * @param engine defines hosting engine
  47797. * @param reusable defines if the postprocess will be reused multiple times per frame
  47798. */
  47799. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47800. }
  47801. }
  47802. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47803. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47804. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47805. import { Scene } from "babylonjs/scene";
  47806. import { Vector3 } from "babylonjs/Maths/math.vector";
  47807. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47808. /**
  47809. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47810. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47811. */
  47812. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47813. /**
  47814. * Creates a new AnaglyphArcRotateCamera
  47815. * @param name defines camera name
  47816. * @param alpha defines alpha angle (in radians)
  47817. * @param beta defines beta angle (in radians)
  47818. * @param radius defines radius
  47819. * @param target defines camera target
  47820. * @param interaxialDistance defines distance between each color axis
  47821. * @param scene defines the hosting scene
  47822. */
  47823. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47824. /**
  47825. * Gets camera class name
  47826. * @returns AnaglyphArcRotateCamera
  47827. */
  47828. getClassName(): string;
  47829. }
  47830. }
  47831. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47832. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47833. import { Scene } from "babylonjs/scene";
  47834. import { Vector3 } from "babylonjs/Maths/math.vector";
  47835. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47836. /**
  47837. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47838. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47839. */
  47840. export class AnaglyphFreeCamera extends FreeCamera {
  47841. /**
  47842. * Creates a new AnaglyphFreeCamera
  47843. * @param name defines camera name
  47844. * @param position defines initial position
  47845. * @param interaxialDistance defines distance between each color axis
  47846. * @param scene defines the hosting scene
  47847. */
  47848. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47849. /**
  47850. * Gets camera class name
  47851. * @returns AnaglyphFreeCamera
  47852. */
  47853. getClassName(): string;
  47854. }
  47855. }
  47856. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47857. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47858. import { Scene } from "babylonjs/scene";
  47859. import { Vector3 } from "babylonjs/Maths/math.vector";
  47860. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47861. /**
  47862. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47863. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47864. */
  47865. export class AnaglyphGamepadCamera extends GamepadCamera {
  47866. /**
  47867. * Creates a new AnaglyphGamepadCamera
  47868. * @param name defines camera name
  47869. * @param position defines initial position
  47870. * @param interaxialDistance defines distance between each color axis
  47871. * @param scene defines the hosting scene
  47872. */
  47873. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47874. /**
  47875. * Gets camera class name
  47876. * @returns AnaglyphGamepadCamera
  47877. */
  47878. getClassName(): string;
  47879. }
  47880. }
  47881. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47882. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47883. import { Scene } from "babylonjs/scene";
  47884. import { Vector3 } from "babylonjs/Maths/math.vector";
  47885. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47886. /**
  47887. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47888. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47889. */
  47890. export class AnaglyphUniversalCamera extends UniversalCamera {
  47891. /**
  47892. * Creates a new AnaglyphUniversalCamera
  47893. * @param name defines camera name
  47894. * @param position defines initial position
  47895. * @param interaxialDistance defines distance between each color axis
  47896. * @param scene defines the hosting scene
  47897. */
  47898. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47899. /**
  47900. * Gets camera class name
  47901. * @returns AnaglyphUniversalCamera
  47902. */
  47903. getClassName(): string;
  47904. }
  47905. }
  47906. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47907. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47908. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47909. import { Scene } from "babylonjs/scene";
  47910. import { Vector3 } from "babylonjs/Maths/math.vector";
  47911. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47912. /**
  47913. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47914. * @see https://doc.babylonjs.com/features/cameras
  47915. */
  47916. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47917. /**
  47918. * Creates a new StereoscopicArcRotateCamera
  47919. * @param name defines camera name
  47920. * @param alpha defines alpha angle (in radians)
  47921. * @param beta defines beta angle (in radians)
  47922. * @param radius defines radius
  47923. * @param target defines camera target
  47924. * @param interaxialDistance defines distance between each color axis
  47925. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47926. * @param scene defines the hosting scene
  47927. */
  47928. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47929. /**
  47930. * Gets camera class name
  47931. * @returns StereoscopicArcRotateCamera
  47932. */
  47933. getClassName(): string;
  47934. }
  47935. }
  47936. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47937. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47938. import { Scene } from "babylonjs/scene";
  47939. import { Vector3 } from "babylonjs/Maths/math.vector";
  47940. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47941. /**
  47942. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47943. * @see https://doc.babylonjs.com/features/cameras
  47944. */
  47945. export class StereoscopicFreeCamera extends FreeCamera {
  47946. /**
  47947. * Creates a new StereoscopicFreeCamera
  47948. * @param name defines camera name
  47949. * @param position defines initial position
  47950. * @param interaxialDistance defines distance between each color axis
  47951. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47952. * @param scene defines the hosting scene
  47953. */
  47954. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47955. /**
  47956. * Gets camera class name
  47957. * @returns StereoscopicFreeCamera
  47958. */
  47959. getClassName(): string;
  47960. }
  47961. }
  47962. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47963. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47964. import { Scene } from "babylonjs/scene";
  47965. import { Vector3 } from "babylonjs/Maths/math.vector";
  47966. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47967. /**
  47968. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47969. * @see https://doc.babylonjs.com/features/cameras
  47970. */
  47971. export class StereoscopicGamepadCamera extends GamepadCamera {
  47972. /**
  47973. * Creates a new StereoscopicGamepadCamera
  47974. * @param name defines camera name
  47975. * @param position defines initial position
  47976. * @param interaxialDistance defines distance between each color axis
  47977. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47978. * @param scene defines the hosting scene
  47979. */
  47980. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47981. /**
  47982. * Gets camera class name
  47983. * @returns StereoscopicGamepadCamera
  47984. */
  47985. getClassName(): string;
  47986. }
  47987. }
  47988. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47989. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47990. import { Scene } from "babylonjs/scene";
  47991. import { Vector3 } from "babylonjs/Maths/math.vector";
  47992. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47993. /**
  47994. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47995. * @see https://doc.babylonjs.com/features/cameras
  47996. */
  47997. export class StereoscopicUniversalCamera extends UniversalCamera {
  47998. /**
  47999. * Creates a new StereoscopicUniversalCamera
  48000. * @param name defines camera name
  48001. * @param position defines initial position
  48002. * @param interaxialDistance defines distance between each color axis
  48003. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48004. * @param scene defines the hosting scene
  48005. */
  48006. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48007. /**
  48008. * Gets camera class name
  48009. * @returns StereoscopicUniversalCamera
  48010. */
  48011. getClassName(): string;
  48012. }
  48013. }
  48014. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48015. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48016. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48017. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48018. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48019. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48020. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48021. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48022. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48023. }
  48024. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48025. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48026. import { Scene } from "babylonjs/scene";
  48027. import { Vector3 } from "babylonjs/Maths/math.vector";
  48028. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48029. /**
  48030. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48031. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48032. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48033. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48034. */
  48035. export class VirtualJoysticksCamera extends FreeCamera {
  48036. /**
  48037. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48038. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48039. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48040. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48041. * @param name Define the name of the camera in the scene
  48042. * @param position Define the start position of the camera in the scene
  48043. * @param scene Define the scene the camera belongs to
  48044. */
  48045. constructor(name: string, position: Vector3, scene: Scene);
  48046. /**
  48047. * Gets the current object class name.
  48048. * @return the class name
  48049. */
  48050. getClassName(): string;
  48051. }
  48052. }
  48053. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48054. import { Matrix } from "babylonjs/Maths/math.vector";
  48055. /**
  48056. * This represents all the required metrics to create a VR camera.
  48057. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48058. */
  48059. export class VRCameraMetrics {
  48060. /**
  48061. * Define the horizontal resolution off the screen.
  48062. */
  48063. hResolution: number;
  48064. /**
  48065. * Define the vertical resolution off the screen.
  48066. */
  48067. vResolution: number;
  48068. /**
  48069. * Define the horizontal screen size.
  48070. */
  48071. hScreenSize: number;
  48072. /**
  48073. * Define the vertical screen size.
  48074. */
  48075. vScreenSize: number;
  48076. /**
  48077. * Define the vertical screen center position.
  48078. */
  48079. vScreenCenter: number;
  48080. /**
  48081. * Define the distance of the eyes to the screen.
  48082. */
  48083. eyeToScreenDistance: number;
  48084. /**
  48085. * Define the distance between both lenses
  48086. */
  48087. lensSeparationDistance: number;
  48088. /**
  48089. * Define the distance between both viewer's eyes.
  48090. */
  48091. interpupillaryDistance: number;
  48092. /**
  48093. * Define the distortion factor of the VR postprocess.
  48094. * Please, touch with care.
  48095. */
  48096. distortionK: number[];
  48097. /**
  48098. * Define the chromatic aberration correction factors for the VR post process.
  48099. */
  48100. chromaAbCorrection: number[];
  48101. /**
  48102. * Define the scale factor of the post process.
  48103. * The smaller the better but the slower.
  48104. */
  48105. postProcessScaleFactor: number;
  48106. /**
  48107. * Define an offset for the lens center.
  48108. */
  48109. lensCenterOffset: number;
  48110. /**
  48111. * Define if the current vr camera should compensate the distortion of the lense or not.
  48112. */
  48113. compensateDistortion: boolean;
  48114. /**
  48115. * Defines if multiview should be enabled when rendering (Default: false)
  48116. */
  48117. multiviewEnabled: boolean;
  48118. /**
  48119. * Gets the rendering aspect ratio based on the provided resolutions.
  48120. */
  48121. get aspectRatio(): number;
  48122. /**
  48123. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48124. */
  48125. get aspectRatioFov(): number;
  48126. /**
  48127. * @hidden
  48128. */
  48129. get leftHMatrix(): Matrix;
  48130. /**
  48131. * @hidden
  48132. */
  48133. get rightHMatrix(): Matrix;
  48134. /**
  48135. * @hidden
  48136. */
  48137. get leftPreViewMatrix(): Matrix;
  48138. /**
  48139. * @hidden
  48140. */
  48141. get rightPreViewMatrix(): Matrix;
  48142. /**
  48143. * Get the default VRMetrics based on the most generic setup.
  48144. * @returns the default vr metrics
  48145. */
  48146. static GetDefault(): VRCameraMetrics;
  48147. }
  48148. }
  48149. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48150. /** @hidden */
  48151. export var vrDistortionCorrectionPixelShader: {
  48152. name: string;
  48153. shader: string;
  48154. };
  48155. }
  48156. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48157. import { Camera } from "babylonjs/Cameras/camera";
  48158. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48159. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48160. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48161. /**
  48162. * VRDistortionCorrectionPostProcess used for mobile VR
  48163. */
  48164. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48165. private _isRightEye;
  48166. private _distortionFactors;
  48167. private _postProcessScaleFactor;
  48168. private _lensCenterOffset;
  48169. private _scaleIn;
  48170. private _scaleFactor;
  48171. private _lensCenter;
  48172. /**
  48173. * Gets a string identifying the name of the class
  48174. * @returns "VRDistortionCorrectionPostProcess" string
  48175. */
  48176. getClassName(): string;
  48177. /**
  48178. * Initializes the VRDistortionCorrectionPostProcess
  48179. * @param name The name of the effect.
  48180. * @param camera The camera to apply the render pass to.
  48181. * @param isRightEye If this is for the right eye distortion
  48182. * @param vrMetrics All the required metrics for the VR camera
  48183. */
  48184. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48185. }
  48186. }
  48187. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48188. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48189. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48190. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48191. import { Scene } from "babylonjs/scene";
  48192. import { Vector3 } from "babylonjs/Maths/math.vector";
  48193. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48194. import "babylonjs/Cameras/RigModes/vrRigMode";
  48195. /**
  48196. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48197. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48198. */
  48199. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48200. /**
  48201. * Creates a new VRDeviceOrientationArcRotateCamera
  48202. * @param name defines camera name
  48203. * @param alpha defines the camera rotation along the logitudinal axis
  48204. * @param beta defines the camera rotation along the latitudinal axis
  48205. * @param radius defines the camera distance from its target
  48206. * @param target defines the camera target
  48207. * @param scene defines the scene the camera belongs to
  48208. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48209. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48210. */
  48211. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48212. /**
  48213. * Gets camera class name
  48214. * @returns VRDeviceOrientationArcRotateCamera
  48215. */
  48216. getClassName(): string;
  48217. }
  48218. }
  48219. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48220. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48221. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48222. import { Scene } from "babylonjs/scene";
  48223. import { Vector3 } from "babylonjs/Maths/math.vector";
  48224. import "babylonjs/Cameras/RigModes/vrRigMode";
  48225. /**
  48226. * Camera used to simulate VR rendering (based on FreeCamera)
  48227. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48228. */
  48229. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48230. /**
  48231. * Creates a new VRDeviceOrientationFreeCamera
  48232. * @param name defines camera name
  48233. * @param position defines the start position of the camera
  48234. * @param scene defines the scene the camera belongs to
  48235. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48236. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48237. */
  48238. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48239. /**
  48240. * Gets camera class name
  48241. * @returns VRDeviceOrientationFreeCamera
  48242. */
  48243. getClassName(): string;
  48244. }
  48245. }
  48246. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48247. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48248. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48249. import { Scene } from "babylonjs/scene";
  48250. import { Vector3 } from "babylonjs/Maths/math.vector";
  48251. import "babylonjs/Gamepads/gamepadSceneComponent";
  48252. /**
  48253. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48254. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48255. */
  48256. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48257. /**
  48258. * Creates a new VRDeviceOrientationGamepadCamera
  48259. * @param name defines camera name
  48260. * @param position defines the start position of the camera
  48261. * @param scene defines the scene the camera belongs to
  48262. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48263. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48264. */
  48265. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48266. /**
  48267. * Gets camera class name
  48268. * @returns VRDeviceOrientationGamepadCamera
  48269. */
  48270. getClassName(): string;
  48271. }
  48272. }
  48273. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48274. import { Scene } from "babylonjs/scene";
  48275. import { Texture } from "babylonjs/Materials/Textures/texture";
  48276. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48277. /**
  48278. * A class extending Texture allowing drawing on a texture
  48279. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48280. */
  48281. export class DynamicTexture extends Texture {
  48282. private _generateMipMaps;
  48283. private _canvas;
  48284. private _context;
  48285. /**
  48286. * Creates a DynamicTexture
  48287. * @param name defines the name of the texture
  48288. * @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
  48289. * @param scene defines the scene where you want the texture
  48290. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48291. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48292. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48293. */
  48294. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48295. /**
  48296. * Get the current class name of the texture useful for serialization or dynamic coding.
  48297. * @returns "DynamicTexture"
  48298. */
  48299. getClassName(): string;
  48300. /**
  48301. * Gets the current state of canRescale
  48302. */
  48303. get canRescale(): boolean;
  48304. private _recreate;
  48305. /**
  48306. * Scales the texture
  48307. * @param ratio the scale factor to apply to both width and height
  48308. */
  48309. scale(ratio: number): void;
  48310. /**
  48311. * Resizes the texture
  48312. * @param width the new width
  48313. * @param height the new height
  48314. */
  48315. scaleTo(width: number, height: number): void;
  48316. /**
  48317. * Gets the context of the canvas used by the texture
  48318. * @returns the canvas context of the dynamic texture
  48319. */
  48320. getContext(): CanvasRenderingContext2D;
  48321. /**
  48322. * Clears the texture
  48323. */
  48324. clear(): void;
  48325. /**
  48326. * Updates the texture
  48327. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48328. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48329. */
  48330. update(invertY?: boolean, premulAlpha?: boolean): void;
  48331. /**
  48332. * Draws text onto the texture
  48333. * @param text defines the text to be drawn
  48334. * @param x defines the placement of the text from the left
  48335. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48336. * @param font defines the font to be used with font-style, font-size, font-name
  48337. * @param color defines the color used for the text
  48338. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48339. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48340. * @param update defines whether texture is immediately update (default is true)
  48341. */
  48342. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48343. /**
  48344. * Clones the texture
  48345. * @returns the clone of the texture.
  48346. */
  48347. clone(): DynamicTexture;
  48348. /**
  48349. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48350. * @returns a serialized dynamic texture object
  48351. */
  48352. serialize(): any;
  48353. private _IsCanvasElement;
  48354. /** @hidden */
  48355. _rebuild(): void;
  48356. }
  48357. }
  48358. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48359. import { Scene } from "babylonjs/scene";
  48360. import { Color3 } from "babylonjs/Maths/math.color";
  48361. import { Mesh } from "babylonjs/Meshes/mesh";
  48362. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48363. import { Nullable } from "babylonjs/types";
  48364. /**
  48365. * Class containing static functions to help procedurally build meshes
  48366. */
  48367. export class GroundBuilder {
  48368. /**
  48369. * Creates a ground mesh
  48370. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48371. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48372. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48373. * @param name defines the name of the mesh
  48374. * @param options defines the options used to create the mesh
  48375. * @param scene defines the hosting scene
  48376. * @returns the ground mesh
  48377. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48378. */
  48379. static CreateGround(name: string, options: {
  48380. width?: number;
  48381. height?: number;
  48382. subdivisions?: number;
  48383. subdivisionsX?: number;
  48384. subdivisionsY?: number;
  48385. updatable?: boolean;
  48386. }, scene: any): Mesh;
  48387. /**
  48388. * Creates a tiled ground mesh
  48389. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48390. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48391. * * 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
  48392. * * 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
  48393. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48394. * @param name defines the name of the mesh
  48395. * @param options defines the options used to create the mesh
  48396. * @param scene defines the hosting scene
  48397. * @returns the tiled ground mesh
  48398. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48399. */
  48400. static CreateTiledGround(name: string, options: {
  48401. xmin: number;
  48402. zmin: number;
  48403. xmax: number;
  48404. zmax: number;
  48405. subdivisions?: {
  48406. w: number;
  48407. h: number;
  48408. };
  48409. precision?: {
  48410. w: number;
  48411. h: number;
  48412. };
  48413. updatable?: boolean;
  48414. }, scene?: Nullable<Scene>): Mesh;
  48415. /**
  48416. * Creates a ground mesh from a height map
  48417. * * The parameter `url` sets the URL of the height map image resource.
  48418. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48419. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48420. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48421. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48422. * * 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.
  48423. * * 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).
  48424. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48425. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48426. * @param name defines the name of the mesh
  48427. * @param url defines the url to the height map
  48428. * @param options defines the options used to create the mesh
  48429. * @param scene defines the hosting scene
  48430. * @returns the ground mesh
  48431. * @see https://doc.babylonjs.com/babylon101/height_map
  48432. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48433. */
  48434. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48435. width?: number;
  48436. height?: number;
  48437. subdivisions?: number;
  48438. minHeight?: number;
  48439. maxHeight?: number;
  48440. colorFilter?: Color3;
  48441. alphaFilter?: number;
  48442. updatable?: boolean;
  48443. onReady?: (mesh: GroundMesh) => void;
  48444. }, scene?: Nullable<Scene>): GroundMesh;
  48445. }
  48446. }
  48447. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48448. import { Vector4 } from "babylonjs/Maths/math.vector";
  48449. import { Mesh } from "babylonjs/Meshes/mesh";
  48450. /**
  48451. * Class containing static functions to help procedurally build meshes
  48452. */
  48453. export class TorusBuilder {
  48454. /**
  48455. * Creates a torus mesh
  48456. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48457. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48458. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48459. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48460. * * 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
  48461. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48462. * @param name defines the name of the mesh
  48463. * @param options defines the options used to create the mesh
  48464. * @param scene defines the hosting scene
  48465. * @returns the torus mesh
  48466. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48467. */
  48468. static CreateTorus(name: string, options: {
  48469. diameter?: number;
  48470. thickness?: number;
  48471. tessellation?: number;
  48472. updatable?: boolean;
  48473. sideOrientation?: number;
  48474. frontUVs?: Vector4;
  48475. backUVs?: Vector4;
  48476. }, scene: any): Mesh;
  48477. }
  48478. }
  48479. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48480. import { Vector4 } from "babylonjs/Maths/math.vector";
  48481. import { Color4 } from "babylonjs/Maths/math.color";
  48482. import { Mesh } from "babylonjs/Meshes/mesh";
  48483. /**
  48484. * Class containing static functions to help procedurally build meshes
  48485. */
  48486. export class CylinderBuilder {
  48487. /**
  48488. * Creates a cylinder or a cone mesh
  48489. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48490. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48491. * * 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.
  48492. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48493. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48494. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48495. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48496. * * 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).
  48497. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48498. * * 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).
  48499. * * 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
  48500. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48501. * * 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
  48502. * * 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.
  48503. * * If `enclose` is false, a ring surface is one element.
  48504. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48505. * * 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
  48506. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48507. * * 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
  48508. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48509. * @param name defines the name of the mesh
  48510. * @param options defines the options used to create the mesh
  48511. * @param scene defines the hosting scene
  48512. * @returns the cylinder mesh
  48513. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48514. */
  48515. static CreateCylinder(name: string, options: {
  48516. height?: number;
  48517. diameterTop?: number;
  48518. diameterBottom?: number;
  48519. diameter?: number;
  48520. tessellation?: number;
  48521. subdivisions?: number;
  48522. arc?: number;
  48523. faceColors?: Color4[];
  48524. faceUV?: Vector4[];
  48525. updatable?: boolean;
  48526. hasRings?: boolean;
  48527. enclose?: boolean;
  48528. cap?: number;
  48529. sideOrientation?: number;
  48530. frontUVs?: Vector4;
  48531. backUVs?: Vector4;
  48532. }, scene: any): Mesh;
  48533. }
  48534. }
  48535. declare module "babylonjs/XR/webXRTypes" {
  48536. import { Nullable } from "babylonjs/types";
  48537. import { IDisposable } from "babylonjs/scene";
  48538. /**
  48539. * States of the webXR experience
  48540. */
  48541. export enum WebXRState {
  48542. /**
  48543. * Transitioning to being in XR mode
  48544. */
  48545. ENTERING_XR = 0,
  48546. /**
  48547. * Transitioning to non XR mode
  48548. */
  48549. EXITING_XR = 1,
  48550. /**
  48551. * In XR mode and presenting
  48552. */
  48553. IN_XR = 2,
  48554. /**
  48555. * Not entered XR mode
  48556. */
  48557. NOT_IN_XR = 3
  48558. }
  48559. /**
  48560. * Abstraction of the XR render target
  48561. */
  48562. export interface WebXRRenderTarget extends IDisposable {
  48563. /**
  48564. * xrpresent context of the canvas which can be used to display/mirror xr content
  48565. */
  48566. canvasContext: WebGLRenderingContext;
  48567. /**
  48568. * xr layer for the canvas
  48569. */
  48570. xrLayer: Nullable<XRWebGLLayer>;
  48571. /**
  48572. * Initializes the xr layer for the session
  48573. * @param xrSession xr session
  48574. * @returns a promise that will resolve once the XR Layer has been created
  48575. */
  48576. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48577. }
  48578. }
  48579. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48580. import { Nullable } from "babylonjs/types";
  48581. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48582. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48583. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48584. import { Observable } from "babylonjs/Misc/observable";
  48585. /**
  48586. * COnfiguration object for WebXR output canvas
  48587. */
  48588. export class WebXRManagedOutputCanvasOptions {
  48589. /**
  48590. * An optional canvas in case you wish to create it yourself and provide it here.
  48591. * If not provided, a new canvas will be created
  48592. */
  48593. canvasElement?: HTMLCanvasElement;
  48594. /**
  48595. * Options for this XR Layer output
  48596. */
  48597. canvasOptions?: XRWebGLLayerOptions;
  48598. /**
  48599. * CSS styling for a newly created canvas (if not provided)
  48600. */
  48601. newCanvasCssStyle?: string;
  48602. /**
  48603. * Get the default values of the configuration object
  48604. * @param engine defines the engine to use (can be null)
  48605. * @returns default values of this configuration object
  48606. */
  48607. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48608. }
  48609. /**
  48610. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48611. */
  48612. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48613. private _options;
  48614. private _canvas;
  48615. private _engine;
  48616. private _originalCanvasSize;
  48617. /**
  48618. * Rendering context of the canvas which can be used to display/mirror xr content
  48619. */
  48620. canvasContext: WebGLRenderingContext;
  48621. /**
  48622. * xr layer for the canvas
  48623. */
  48624. xrLayer: Nullable<XRWebGLLayer>;
  48625. /**
  48626. * Obseervers registered here will be triggered when the xr layer was initialized
  48627. */
  48628. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48629. /**
  48630. * Initializes the canvas to be added/removed upon entering/exiting xr
  48631. * @param _xrSessionManager The XR Session manager
  48632. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48633. */
  48634. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48635. /**
  48636. * Disposes of the object
  48637. */
  48638. dispose(): void;
  48639. /**
  48640. * Initializes the xr layer for the session
  48641. * @param xrSession xr session
  48642. * @returns a promise that will resolve once the XR Layer has been created
  48643. */
  48644. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48645. private _addCanvas;
  48646. private _removeCanvas;
  48647. private _setCanvasSize;
  48648. private _setManagedOutputCanvas;
  48649. }
  48650. }
  48651. declare module "babylonjs/XR/webXRSessionManager" {
  48652. import { Observable } from "babylonjs/Misc/observable";
  48653. import { Nullable } from "babylonjs/types";
  48654. import { IDisposable, Scene } from "babylonjs/scene";
  48655. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48656. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48657. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48658. /**
  48659. * Manages an XRSession to work with Babylon's engine
  48660. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48661. */
  48662. export class WebXRSessionManager implements IDisposable {
  48663. /** The scene which the session should be created for */
  48664. scene: Scene;
  48665. private _referenceSpace;
  48666. private _rttProvider;
  48667. private _sessionEnded;
  48668. private _xrNavigator;
  48669. private baseLayer;
  48670. /**
  48671. * The base reference space from which the session started. good if you want to reset your
  48672. * reference space
  48673. */
  48674. baseReferenceSpace: XRReferenceSpace;
  48675. /**
  48676. * Current XR frame
  48677. */
  48678. currentFrame: Nullable<XRFrame>;
  48679. /** WebXR timestamp updated every frame */
  48680. currentTimestamp: number;
  48681. /**
  48682. * Used just in case of a failure to initialize an immersive session.
  48683. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48684. */
  48685. defaultHeightCompensation: number;
  48686. /**
  48687. * Fires every time a new xrFrame arrives which can be used to update the camera
  48688. */
  48689. onXRFrameObservable: Observable<XRFrame>;
  48690. /**
  48691. * Fires when the reference space changed
  48692. */
  48693. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48694. /**
  48695. * Fires when the xr session is ended either by the device or manually done
  48696. */
  48697. onXRSessionEnded: Observable<any>;
  48698. /**
  48699. * Fires when the xr session is ended either by the device or manually done
  48700. */
  48701. onXRSessionInit: Observable<XRSession>;
  48702. /**
  48703. * Underlying xr session
  48704. */
  48705. session: XRSession;
  48706. /**
  48707. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48708. * or get the offset the player is currently at.
  48709. */
  48710. viewerReferenceSpace: XRReferenceSpace;
  48711. /**
  48712. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48713. * @param scene The scene which the session should be created for
  48714. */
  48715. constructor(
  48716. /** The scene which the session should be created for */
  48717. scene: Scene);
  48718. /**
  48719. * The current reference space used in this session. This reference space can constantly change!
  48720. * It is mainly used to offset the camera's position.
  48721. */
  48722. get referenceSpace(): XRReferenceSpace;
  48723. /**
  48724. * Set a new reference space and triggers the observable
  48725. */
  48726. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48727. /**
  48728. * Disposes of the session manager
  48729. */
  48730. dispose(): void;
  48731. /**
  48732. * Stops the xrSession and restores the render loop
  48733. * @returns Promise which resolves after it exits XR
  48734. */
  48735. exitXRAsync(): Promise<void>;
  48736. /**
  48737. * Gets the correct render target texture to be rendered this frame for this eye
  48738. * @param eye the eye for which to get the render target
  48739. * @returns the render target for the specified eye
  48740. */
  48741. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48742. /**
  48743. * Creates a WebXRRenderTarget object for the XR session
  48744. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48745. * @param options optional options to provide when creating a new render target
  48746. * @returns a WebXR render target to which the session can render
  48747. */
  48748. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48749. /**
  48750. * Initializes the manager
  48751. * After initialization enterXR can be called to start an XR session
  48752. * @returns Promise which resolves after it is initialized
  48753. */
  48754. initializeAsync(): Promise<void>;
  48755. /**
  48756. * Initializes an xr session
  48757. * @param xrSessionMode mode to initialize
  48758. * @param xrSessionInit defines optional and required values to pass to the session builder
  48759. * @returns a promise which will resolve once the session has been initialized
  48760. */
  48761. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48762. /**
  48763. * Checks if a session would be supported for the creation options specified
  48764. * @param sessionMode session mode to check if supported eg. immersive-vr
  48765. * @returns A Promise that resolves to true if supported and false if not
  48766. */
  48767. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48768. /**
  48769. * Resets the reference space to the one started the session
  48770. */
  48771. resetReferenceSpace(): void;
  48772. /**
  48773. * Starts rendering to the xr layer
  48774. */
  48775. runXRRenderLoop(): void;
  48776. /**
  48777. * Sets the reference space on the xr session
  48778. * @param referenceSpaceType space to set
  48779. * @returns a promise that will resolve once the reference space has been set
  48780. */
  48781. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48782. /**
  48783. * Updates the render state of the session
  48784. * @param state state to set
  48785. * @returns a promise that resolves once the render state has been updated
  48786. */
  48787. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48788. /**
  48789. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48790. * @param sessionMode defines the session to test
  48791. * @returns a promise with boolean as final value
  48792. */
  48793. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48794. private _createRenderTargetTexture;
  48795. }
  48796. }
  48797. declare module "babylonjs/XR/webXRCamera" {
  48798. import { Vector3 } from "babylonjs/Maths/math.vector";
  48799. import { Scene } from "babylonjs/scene";
  48800. import { Camera } from "babylonjs/Cameras/camera";
  48801. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48802. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48803. import { Observable } from "babylonjs/Misc/observable";
  48804. /**
  48805. * WebXR Camera which holds the views for the xrSession
  48806. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48807. */
  48808. export class WebXRCamera extends FreeCamera {
  48809. private _xrSessionManager;
  48810. private _firstFrame;
  48811. private _referenceQuaternion;
  48812. private _referencedPosition;
  48813. private _xrInvPositionCache;
  48814. private _xrInvQuaternionCache;
  48815. /**
  48816. * Observable raised before camera teleportation
  48817. */
  48818. onBeforeCameraTeleport: Observable<Vector3>;
  48819. /**
  48820. * Observable raised after camera teleportation
  48821. */
  48822. onAfterCameraTeleport: Observable<Vector3>;
  48823. /**
  48824. * Should position compensation execute on first frame.
  48825. * This is used when copying the position from a native (non XR) camera
  48826. */
  48827. compensateOnFirstFrame: boolean;
  48828. /**
  48829. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48830. * @param name the name of the camera
  48831. * @param scene the scene to add the camera to
  48832. * @param _xrSessionManager a constructed xr session manager
  48833. */
  48834. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48835. /**
  48836. * Return the user's height, unrelated to the current ground.
  48837. * This will be the y position of this camera, when ground level is 0.
  48838. */
  48839. get realWorldHeight(): number;
  48840. /** @hidden */
  48841. _updateForDualEyeDebugging(): void;
  48842. /**
  48843. * Sets this camera's transformation based on a non-vr camera
  48844. * @param otherCamera the non-vr camera to copy the transformation from
  48845. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48846. */
  48847. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48848. /**
  48849. * Gets the current instance class name ("WebXRCamera").
  48850. * @returns the class name
  48851. */
  48852. getClassName(): string;
  48853. private _rotate180;
  48854. private _updateFromXRSession;
  48855. private _updateNumberOfRigCameras;
  48856. private _updateReferenceSpace;
  48857. private _updateReferenceSpaceOffset;
  48858. }
  48859. }
  48860. declare module "babylonjs/XR/webXRFeaturesManager" {
  48861. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48862. import { IDisposable } from "babylonjs/scene";
  48863. /**
  48864. * Defining the interface required for a (webxr) feature
  48865. */
  48866. export interface IWebXRFeature extends IDisposable {
  48867. /**
  48868. * Is this feature attached
  48869. */
  48870. attached: boolean;
  48871. /**
  48872. * Should auto-attach be disabled?
  48873. */
  48874. disableAutoAttach: boolean;
  48875. /**
  48876. * Attach the feature to the session
  48877. * Will usually be called by the features manager
  48878. *
  48879. * @param force should attachment be forced (even when already attached)
  48880. * @returns true if successful.
  48881. */
  48882. attach(force?: boolean): boolean;
  48883. /**
  48884. * Detach the feature from the session
  48885. * Will usually be called by the features manager
  48886. *
  48887. * @returns true if successful.
  48888. */
  48889. detach(): boolean;
  48890. /**
  48891. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48892. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48893. *
  48894. * @returns whether or not the feature is compatible in this environment
  48895. */
  48896. isCompatible(): boolean;
  48897. /**
  48898. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48899. */
  48900. xrNativeFeatureName?: string;
  48901. /**
  48902. * A list of (Babylon WebXR) features this feature depends on
  48903. */
  48904. dependsOn?: string[];
  48905. }
  48906. /**
  48907. * A list of the currently available features without referencing them
  48908. */
  48909. export class WebXRFeatureName {
  48910. /**
  48911. * The name of the anchor system feature
  48912. */
  48913. static readonly ANCHOR_SYSTEM: string;
  48914. /**
  48915. * The name of the background remover feature
  48916. */
  48917. static readonly BACKGROUND_REMOVER: string;
  48918. /**
  48919. * The name of the hit test feature
  48920. */
  48921. static readonly HIT_TEST: string;
  48922. /**
  48923. * physics impostors for xr controllers feature
  48924. */
  48925. static readonly PHYSICS_CONTROLLERS: string;
  48926. /**
  48927. * The name of the plane detection feature
  48928. */
  48929. static readonly PLANE_DETECTION: string;
  48930. /**
  48931. * The name of the pointer selection feature
  48932. */
  48933. static readonly POINTER_SELECTION: string;
  48934. /**
  48935. * The name of the teleportation feature
  48936. */
  48937. static readonly TELEPORTATION: string;
  48938. /**
  48939. * The name of the feature points feature.
  48940. */
  48941. static readonly FEATURE_POINTS: string;
  48942. /**
  48943. * The name of the hand tracking feature.
  48944. */
  48945. static readonly HAND_TRACKING: string;
  48946. }
  48947. /**
  48948. * Defining the constructor of a feature. Used to register the modules.
  48949. */
  48950. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48951. /**
  48952. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48953. * It is mainly used in AR sessions.
  48954. *
  48955. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48956. */
  48957. export class WebXRFeaturesManager implements IDisposable {
  48958. private _xrSessionManager;
  48959. private static readonly _AvailableFeatures;
  48960. private _features;
  48961. /**
  48962. * constructs a new features manages.
  48963. *
  48964. * @param _xrSessionManager an instance of WebXRSessionManager
  48965. */
  48966. constructor(_xrSessionManager: WebXRSessionManager);
  48967. /**
  48968. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48969. * Mainly used internally.
  48970. *
  48971. * @param featureName the name of the feature to register
  48972. * @param constructorFunction the function used to construct the module
  48973. * @param version the (babylon) version of the module
  48974. * @param stable is that a stable version of this module
  48975. */
  48976. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48977. /**
  48978. * Returns a constructor of a specific feature.
  48979. *
  48980. * @param featureName the name of the feature to construct
  48981. * @param version the version of the feature to load
  48982. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48983. * @param options optional options provided to the module.
  48984. * @returns a function that, when called, will return a new instance of this feature
  48985. */
  48986. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48987. /**
  48988. * Can be used to return the list of features currently registered
  48989. *
  48990. * @returns an Array of available features
  48991. */
  48992. static GetAvailableFeatures(): string[];
  48993. /**
  48994. * Gets the versions available for a specific feature
  48995. * @param featureName the name of the feature
  48996. * @returns an array with the available versions
  48997. */
  48998. static GetAvailableVersions(featureName: string): string[];
  48999. /**
  49000. * Return the latest unstable version of this feature
  49001. * @param featureName the name of the feature to search
  49002. * @returns the version number. if not found will return -1
  49003. */
  49004. static GetLatestVersionOfFeature(featureName: string): number;
  49005. /**
  49006. * Return the latest stable version of this feature
  49007. * @param featureName the name of the feature to search
  49008. * @returns the version number. if not found will return -1
  49009. */
  49010. static GetStableVersionOfFeature(featureName: string): number;
  49011. /**
  49012. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49013. * Can be used during a session to start a feature
  49014. * @param featureName the name of feature to attach
  49015. */
  49016. attachFeature(featureName: string): void;
  49017. /**
  49018. * Can be used inside a session or when the session ends to detach a specific feature
  49019. * @param featureName the name of the feature to detach
  49020. */
  49021. detachFeature(featureName: string): void;
  49022. /**
  49023. * Used to disable an already-enabled feature
  49024. * The feature will be disposed and will be recreated once enabled.
  49025. * @param featureName the feature to disable
  49026. * @returns true if disable was successful
  49027. */
  49028. disableFeature(featureName: string | {
  49029. Name: string;
  49030. }): boolean;
  49031. /**
  49032. * dispose this features manager
  49033. */
  49034. dispose(): void;
  49035. /**
  49036. * Enable a feature using its name and a version. This will enable it in the scene, and will be responsible to attach it when the session starts.
  49037. * If used twice, the old version will be disposed and a new one will be constructed. This way you can re-enable with different configuration.
  49038. *
  49039. * @param featureName the name of the feature to load or the class of the feature
  49040. * @param version optional version to load. if not provided the latest version will be enabled
  49041. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49042. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49043. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49044. * @returns a new constructed feature or throws an error if feature not found.
  49045. */
  49046. enableFeature(featureName: string | {
  49047. Name: string;
  49048. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49049. /**
  49050. * get the implementation of an enabled feature.
  49051. * @param featureName the name of the feature to load
  49052. * @returns the feature class, if found
  49053. */
  49054. getEnabledFeature(featureName: string): IWebXRFeature;
  49055. /**
  49056. * Get the list of enabled features
  49057. * @returns an array of enabled features
  49058. */
  49059. getEnabledFeatures(): string[];
  49060. /**
  49061. * This function will exten the session creation configuration object with enabled features.
  49062. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49063. * according to the defined "required" variable, provided during enableFeature call
  49064. * @param xrSessionInit the xr Session init object to extend
  49065. *
  49066. * @returns an extended XRSessionInit object
  49067. */
  49068. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49069. }
  49070. }
  49071. declare module "babylonjs/XR/webXRExperienceHelper" {
  49072. import { Observable } from "babylonjs/Misc/observable";
  49073. import { IDisposable, Scene } from "babylonjs/scene";
  49074. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49075. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49076. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49077. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49078. /**
  49079. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49080. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49081. */
  49082. export class WebXRExperienceHelper implements IDisposable {
  49083. private scene;
  49084. private _nonVRCamera;
  49085. private _originalSceneAutoClear;
  49086. private _supported;
  49087. /**
  49088. * Camera used to render xr content
  49089. */
  49090. camera: WebXRCamera;
  49091. /** A features manager for this xr session */
  49092. featuresManager: WebXRFeaturesManager;
  49093. /**
  49094. * Observers registered here will be triggered after the camera's initial transformation is set
  49095. * This can be used to set a different ground level or an extra rotation.
  49096. *
  49097. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49098. * to the position set after this observable is done executing.
  49099. */
  49100. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49101. /**
  49102. * Fires when the state of the experience helper has changed
  49103. */
  49104. onStateChangedObservable: Observable<WebXRState>;
  49105. /** Session manager used to keep track of xr session */
  49106. sessionManager: WebXRSessionManager;
  49107. /**
  49108. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49109. */
  49110. state: WebXRState;
  49111. /**
  49112. * Creates a WebXRExperienceHelper
  49113. * @param scene The scene the helper should be created in
  49114. */
  49115. private constructor();
  49116. /**
  49117. * Creates the experience helper
  49118. * @param scene the scene to attach the experience helper to
  49119. * @returns a promise for the experience helper
  49120. */
  49121. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49122. /**
  49123. * Disposes of the experience helper
  49124. */
  49125. dispose(): void;
  49126. /**
  49127. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49128. * @param sessionMode options for the XR session
  49129. * @param referenceSpaceType frame of reference of the XR session
  49130. * @param renderTarget the output canvas that will be used to enter XR mode
  49131. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49132. * @returns promise that resolves after xr mode has entered
  49133. */
  49134. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49135. /**
  49136. * Exits XR mode and returns the scene to its original state
  49137. * @returns promise that resolves after xr mode has exited
  49138. */
  49139. exitXRAsync(): Promise<void>;
  49140. private _nonXRToXRCamera;
  49141. private _setState;
  49142. }
  49143. }
  49144. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49145. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49146. import { Observable } from "babylonjs/Misc/observable";
  49147. import { IDisposable } from "babylonjs/scene";
  49148. /**
  49149. * X-Y values for axes in WebXR
  49150. */
  49151. export interface IWebXRMotionControllerAxesValue {
  49152. /**
  49153. * The value of the x axis
  49154. */
  49155. x: number;
  49156. /**
  49157. * The value of the y-axis
  49158. */
  49159. y: number;
  49160. }
  49161. /**
  49162. * changed / previous values for the values of this component
  49163. */
  49164. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49165. /**
  49166. * current (this frame) value
  49167. */
  49168. current: T;
  49169. /**
  49170. * previous (last change) value
  49171. */
  49172. previous: T;
  49173. }
  49174. /**
  49175. * Represents changes in the component between current frame and last values recorded
  49176. */
  49177. export interface IWebXRMotionControllerComponentChanges {
  49178. /**
  49179. * will be populated with previous and current values if axes changed
  49180. */
  49181. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49182. /**
  49183. * will be populated with previous and current values if pressed changed
  49184. */
  49185. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49186. /**
  49187. * will be populated with previous and current values if touched changed
  49188. */
  49189. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49190. /**
  49191. * will be populated with previous and current values if value changed
  49192. */
  49193. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49194. }
  49195. /**
  49196. * This class represents a single component (for example button or thumbstick) of a motion controller
  49197. */
  49198. export class WebXRControllerComponent implements IDisposable {
  49199. /**
  49200. * the id of this component
  49201. */
  49202. id: string;
  49203. /**
  49204. * the type of the component
  49205. */
  49206. type: MotionControllerComponentType;
  49207. private _buttonIndex;
  49208. private _axesIndices;
  49209. private _axes;
  49210. private _changes;
  49211. private _currentValue;
  49212. private _hasChanges;
  49213. private _pressed;
  49214. private _touched;
  49215. /**
  49216. * button component type
  49217. */
  49218. static BUTTON_TYPE: MotionControllerComponentType;
  49219. /**
  49220. * squeeze component type
  49221. */
  49222. static SQUEEZE_TYPE: MotionControllerComponentType;
  49223. /**
  49224. * Thumbstick component type
  49225. */
  49226. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49227. /**
  49228. * Touchpad component type
  49229. */
  49230. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49231. /**
  49232. * trigger component type
  49233. */
  49234. static TRIGGER_TYPE: MotionControllerComponentType;
  49235. /**
  49236. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49237. * the axes data changes
  49238. */
  49239. onAxisValueChangedObservable: Observable<{
  49240. x: number;
  49241. y: number;
  49242. }>;
  49243. /**
  49244. * Observers registered here will be triggered when the state of a button changes
  49245. * State change is either pressed / touched / value
  49246. */
  49247. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49248. /**
  49249. * Creates a new component for a motion controller.
  49250. * It is created by the motion controller itself
  49251. *
  49252. * @param id the id of this component
  49253. * @param type the type of the component
  49254. * @param _buttonIndex index in the buttons array of the gamepad
  49255. * @param _axesIndices indices of the values in the axes array of the gamepad
  49256. */
  49257. constructor(
  49258. /**
  49259. * the id of this component
  49260. */
  49261. id: string,
  49262. /**
  49263. * the type of the component
  49264. */
  49265. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49266. /**
  49267. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49268. */
  49269. get axes(): IWebXRMotionControllerAxesValue;
  49270. /**
  49271. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49272. */
  49273. get changes(): IWebXRMotionControllerComponentChanges;
  49274. /**
  49275. * Return whether or not the component changed the last frame
  49276. */
  49277. get hasChanges(): boolean;
  49278. /**
  49279. * is the button currently pressed
  49280. */
  49281. get pressed(): boolean;
  49282. /**
  49283. * is the button currently touched
  49284. */
  49285. get touched(): boolean;
  49286. /**
  49287. * Get the current value of this component
  49288. */
  49289. get value(): number;
  49290. /**
  49291. * Dispose this component
  49292. */
  49293. dispose(): void;
  49294. /**
  49295. * Are there axes correlating to this component
  49296. * @return true is axes data is available
  49297. */
  49298. isAxes(): boolean;
  49299. /**
  49300. * Is this component a button (hence - pressable)
  49301. * @returns true if can be pressed
  49302. */
  49303. isButton(): boolean;
  49304. /**
  49305. * update this component using the gamepad object it is in. Called on every frame
  49306. * @param nativeController the native gamepad controller object
  49307. */
  49308. update(nativeController: IMinimalMotionControllerObject): void;
  49309. }
  49310. }
  49311. declare module "babylonjs/Loading/sceneLoader" {
  49312. import { Observable } from "babylonjs/Misc/observable";
  49313. import { Nullable } from "babylonjs/types";
  49314. import { Scene } from "babylonjs/scene";
  49315. import { Engine } from "babylonjs/Engines/engine";
  49316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49317. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49318. import { AssetContainer } from "babylonjs/assetContainer";
  49319. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49320. import { Skeleton } from "babylonjs/Bones/skeleton";
  49321. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49322. import { WebRequest } from "babylonjs/Misc/webRequest";
  49323. /**
  49324. * Interface used to represent data loading progression
  49325. */
  49326. export interface ISceneLoaderProgressEvent {
  49327. /**
  49328. * Defines if data length to load can be evaluated
  49329. */
  49330. readonly lengthComputable: boolean;
  49331. /**
  49332. * Defines the loaded data length
  49333. */
  49334. readonly loaded: number;
  49335. /**
  49336. * Defines the data length to load
  49337. */
  49338. readonly total: number;
  49339. }
  49340. /**
  49341. * Interface used by SceneLoader plugins to define supported file extensions
  49342. */
  49343. export interface ISceneLoaderPluginExtensions {
  49344. /**
  49345. * Defines the list of supported extensions
  49346. */
  49347. [extension: string]: {
  49348. isBinary: boolean;
  49349. };
  49350. }
  49351. /**
  49352. * Interface used by SceneLoader plugin factory
  49353. */
  49354. export interface ISceneLoaderPluginFactory {
  49355. /**
  49356. * Defines the name of the factory
  49357. */
  49358. name: string;
  49359. /**
  49360. * Function called to create a new plugin
  49361. * @return the new plugin
  49362. */
  49363. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49364. /**
  49365. * The callback that returns true if the data can be directly loaded.
  49366. * @param data string containing the file data
  49367. * @returns if the data can be loaded directly
  49368. */
  49369. canDirectLoad?(data: string): boolean;
  49370. }
  49371. /**
  49372. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49373. */
  49374. export interface ISceneLoaderPluginBase {
  49375. /**
  49376. * The friendly name of this plugin.
  49377. */
  49378. name: string;
  49379. /**
  49380. * The file extensions supported by this plugin.
  49381. */
  49382. extensions: string | ISceneLoaderPluginExtensions;
  49383. /**
  49384. * The callback called when loading from a url.
  49385. * @param scene scene loading this url
  49386. * @param url url to load
  49387. * @param onSuccess callback called when the file successfully loads
  49388. * @param onProgress callback called while file is loading (if the server supports this mode)
  49389. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49390. * @param onError callback called when the file fails to load
  49391. * @returns a file request object
  49392. */
  49393. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49394. /**
  49395. * The callback called when loading from a file object.
  49396. * @param scene scene loading this file
  49397. * @param file defines the file to load
  49398. * @param onSuccess defines the callback to call when data is loaded
  49399. * @param onProgress defines the callback to call during loading process
  49400. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49401. * @param onError defines the callback to call when an error occurs
  49402. * @returns a file request object
  49403. */
  49404. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49405. /**
  49406. * The callback that returns true if the data can be directly loaded.
  49407. * @param data string containing the file data
  49408. * @returns if the data can be loaded directly
  49409. */
  49410. canDirectLoad?(data: string): boolean;
  49411. /**
  49412. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49413. * @param scene scene loading this data
  49414. * @param data string containing the data
  49415. * @returns data to pass to the plugin
  49416. */
  49417. directLoad?(scene: Scene, data: string): any;
  49418. /**
  49419. * The callback that allows custom handling of the root url based on the response url.
  49420. * @param rootUrl the original root url
  49421. * @param responseURL the response url if available
  49422. * @returns the new root url
  49423. */
  49424. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49425. }
  49426. /**
  49427. * Interface used to define a SceneLoader plugin
  49428. */
  49429. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49430. /**
  49431. * Import meshes into a scene.
  49432. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49433. * @param scene The scene to import into
  49434. * @param data The data to import
  49435. * @param rootUrl The root url for scene and resources
  49436. * @param meshes The meshes array to import into
  49437. * @param particleSystems The particle systems array to import into
  49438. * @param skeletons The skeletons array to import into
  49439. * @param onError The callback when import fails
  49440. * @returns True if successful or false otherwise
  49441. */
  49442. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49443. /**
  49444. * Load into a scene.
  49445. * @param scene The scene to load into
  49446. * @param data The data to import
  49447. * @param rootUrl The root url for scene and resources
  49448. * @param onError The callback when import fails
  49449. * @returns True if successful or false otherwise
  49450. */
  49451. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49452. /**
  49453. * Load into an asset container.
  49454. * @param scene The scene to load into
  49455. * @param data The data to import
  49456. * @param rootUrl The root url for scene and resources
  49457. * @param onError The callback when import fails
  49458. * @returns The loaded asset container
  49459. */
  49460. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49461. }
  49462. /**
  49463. * Interface used to define an async SceneLoader plugin
  49464. */
  49465. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49466. /**
  49467. * Import meshes into a scene.
  49468. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49469. * @param scene The scene to import into
  49470. * @param data The data to import
  49471. * @param rootUrl The root url for scene and resources
  49472. * @param onProgress The callback when the load progresses
  49473. * @param fileName Defines the name of the file to load
  49474. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49475. */
  49476. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49477. meshes: AbstractMesh[];
  49478. particleSystems: IParticleSystem[];
  49479. skeletons: Skeleton[];
  49480. animationGroups: AnimationGroup[];
  49481. }>;
  49482. /**
  49483. * Load into a scene.
  49484. * @param scene The scene to load into
  49485. * @param data The data to import
  49486. * @param rootUrl The root url for scene and resources
  49487. * @param onProgress The callback when the load progresses
  49488. * @param fileName Defines the name of the file to load
  49489. * @returns Nothing
  49490. */
  49491. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49492. /**
  49493. * Load into an asset container.
  49494. * @param scene The scene to load into
  49495. * @param data The data to import
  49496. * @param rootUrl The root url for scene and resources
  49497. * @param onProgress The callback when the load progresses
  49498. * @param fileName Defines the name of the file to load
  49499. * @returns The loaded asset container
  49500. */
  49501. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49502. }
  49503. /**
  49504. * Mode that determines how to handle old animation groups before loading new ones.
  49505. */
  49506. export enum SceneLoaderAnimationGroupLoadingMode {
  49507. /**
  49508. * Reset all old animations to initial state then dispose them.
  49509. */
  49510. Clean = 0,
  49511. /**
  49512. * Stop all old animations.
  49513. */
  49514. Stop = 1,
  49515. /**
  49516. * Restart old animations from first frame.
  49517. */
  49518. Sync = 2,
  49519. /**
  49520. * Old animations remains untouched.
  49521. */
  49522. NoSync = 3
  49523. }
  49524. /**
  49525. * Defines a plugin registered by the SceneLoader
  49526. */
  49527. interface IRegisteredPlugin {
  49528. /**
  49529. * Defines the plugin to use
  49530. */
  49531. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49532. /**
  49533. * Defines if the plugin supports binary data
  49534. */
  49535. isBinary: boolean;
  49536. }
  49537. /**
  49538. * Class used to load scene from various file formats using registered plugins
  49539. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49540. */
  49541. export class SceneLoader {
  49542. /**
  49543. * No logging while loading
  49544. */
  49545. static readonly NO_LOGGING: number;
  49546. /**
  49547. * Minimal logging while loading
  49548. */
  49549. static readonly MINIMAL_LOGGING: number;
  49550. /**
  49551. * Summary logging while loading
  49552. */
  49553. static readonly SUMMARY_LOGGING: number;
  49554. /**
  49555. * Detailled logging while loading
  49556. */
  49557. static readonly DETAILED_LOGGING: number;
  49558. /**
  49559. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49560. */
  49561. static get ForceFullSceneLoadingForIncremental(): boolean;
  49562. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49563. /**
  49564. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49565. */
  49566. static get ShowLoadingScreen(): boolean;
  49567. static set ShowLoadingScreen(value: boolean);
  49568. /**
  49569. * Defines the current logging level (while loading the scene)
  49570. * @ignorenaming
  49571. */
  49572. static get loggingLevel(): number;
  49573. static set loggingLevel(value: number);
  49574. /**
  49575. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49576. */
  49577. static get CleanBoneMatrixWeights(): boolean;
  49578. static set CleanBoneMatrixWeights(value: boolean);
  49579. /**
  49580. * Event raised when a plugin is used to load a scene
  49581. */
  49582. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49583. private static _registeredPlugins;
  49584. private static _showingLoadingScreen;
  49585. /**
  49586. * Gets the default plugin (used to load Babylon files)
  49587. * @returns the .babylon plugin
  49588. */
  49589. static GetDefaultPlugin(): IRegisteredPlugin;
  49590. private static _GetPluginForExtension;
  49591. private static _GetPluginForDirectLoad;
  49592. private static _GetPluginForFilename;
  49593. private static _GetDirectLoad;
  49594. private static _LoadData;
  49595. private static _GetFileInfo;
  49596. /**
  49597. * Gets a plugin that can load the given extension
  49598. * @param extension defines the extension to load
  49599. * @returns a plugin or null if none works
  49600. */
  49601. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49602. /**
  49603. * Gets a boolean indicating that the given extension can be loaded
  49604. * @param extension defines the extension to load
  49605. * @returns true if the extension is supported
  49606. */
  49607. static IsPluginForExtensionAvailable(extension: string): boolean;
  49608. /**
  49609. * Adds a new plugin to the list of registered plugins
  49610. * @param plugin defines the plugin to add
  49611. */
  49612. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49613. /**
  49614. * Import meshes into a scene
  49615. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49616. * @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)
  49617. * @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)
  49618. * @param scene the instance of BABYLON.Scene to append to
  49619. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49620. * @param onProgress a callback with a progress event for each file being loaded
  49621. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49622. * @param pluginExtension the extension used to determine the plugin
  49623. * @returns The loaded plugin
  49624. */
  49625. 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: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49626. /**
  49627. * Import meshes into a scene
  49628. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49629. * @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)
  49630. * @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)
  49631. * @param scene the instance of BABYLON.Scene to append to
  49632. * @param onProgress a callback with a progress event for each file being loaded
  49633. * @param pluginExtension the extension used to determine the plugin
  49634. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49635. */
  49636. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49637. meshes: AbstractMesh[];
  49638. particleSystems: IParticleSystem[];
  49639. skeletons: Skeleton[];
  49640. animationGroups: AnimationGroup[];
  49641. }>;
  49642. /**
  49643. * Load a scene
  49644. * @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)
  49645. * @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)
  49646. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49647. * @param onSuccess a callback with the scene when import succeeds
  49648. * @param onProgress a callback with a progress event for each file being loaded
  49649. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49650. * @param pluginExtension the extension used to determine the plugin
  49651. * @returns The loaded plugin
  49652. */
  49653. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49654. /**
  49655. * Load a scene
  49656. * @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)
  49657. * @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)
  49658. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49659. * @param onProgress a callback with a progress event for each file being loaded
  49660. * @param pluginExtension the extension used to determine the plugin
  49661. * @returns The loaded scene
  49662. */
  49663. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49664. /**
  49665. * Append a scene
  49666. * @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)
  49667. * @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)
  49668. * @param scene is the instance of BABYLON.Scene to append to
  49669. * @param onSuccess a callback with the scene when import succeeds
  49670. * @param onProgress a callback with a progress event for each file being loaded
  49671. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49672. * @param pluginExtension the extension used to determine the plugin
  49673. * @returns The loaded plugin
  49674. */
  49675. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49676. /**
  49677. * Append a scene
  49678. * @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)
  49679. * @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)
  49680. * @param scene is the instance of BABYLON.Scene to append to
  49681. * @param onProgress a callback with a progress event for each file being loaded
  49682. * @param pluginExtension the extension used to determine the plugin
  49683. * @returns The given scene
  49684. */
  49685. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49686. /**
  49687. * Load a scene into an asset container
  49688. * @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)
  49689. * @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)
  49690. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49691. * @param onSuccess a callback with the scene when import succeeds
  49692. * @param onProgress a callback with a progress event for each file being loaded
  49693. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49694. * @param pluginExtension the extension used to determine the plugin
  49695. * @returns The loaded plugin
  49696. */
  49697. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49698. /**
  49699. * Load a scene into an asset container
  49700. * @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)
  49701. * @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)
  49702. * @param scene is the instance of Scene to append to
  49703. * @param onProgress a callback with a progress event for each file being loaded
  49704. * @param pluginExtension the extension used to determine the plugin
  49705. * @returns The loaded asset container
  49706. */
  49707. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49708. /**
  49709. * Import animations from a file into a scene
  49710. * @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)
  49711. * @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)
  49712. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49713. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49714. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49715. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49716. * @param onSuccess a callback with the scene when import succeeds
  49717. * @param onProgress a callback with a progress event for each file being loaded
  49718. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49719. * @param pluginExtension the extension used to determine the plugin
  49720. */
  49721. static ImportAnimations(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): void;
  49722. /**
  49723. * Import animations from a file into a scene
  49724. * @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)
  49725. * @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)
  49726. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49727. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49728. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49729. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49730. * @param onSuccess a callback with the scene when import succeeds
  49731. * @param onProgress a callback with a progress event for each file being loaded
  49732. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49733. * @param pluginExtension the extension used to determine the plugin
  49734. * @returns the updated scene with imported animations
  49735. */
  49736. static ImportAnimationsAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49737. }
  49738. }
  49739. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49740. import { IDisposable, Scene } from "babylonjs/scene";
  49741. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49742. import { Observable } from "babylonjs/Misc/observable";
  49743. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49744. import { Nullable } from "babylonjs/types";
  49745. /**
  49746. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49747. */
  49748. export type MotionControllerHandedness = "none" | "left" | "right";
  49749. /**
  49750. * The type of components available in motion controllers.
  49751. * This is not the name of the component.
  49752. */
  49753. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49754. /**
  49755. * The state of a controller component
  49756. */
  49757. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49758. /**
  49759. * The schema of motion controller layout.
  49760. * No object will be initialized using this interface
  49761. * This is used just to define the profile.
  49762. */
  49763. export interface IMotionControllerLayout {
  49764. /**
  49765. * Path to load the assets. Usually relative to the base path
  49766. */
  49767. assetPath: string;
  49768. /**
  49769. * Available components (unsorted)
  49770. */
  49771. components: {
  49772. /**
  49773. * A map of component Ids
  49774. */
  49775. [componentId: string]: {
  49776. /**
  49777. * The type of input the component outputs
  49778. */
  49779. type: MotionControllerComponentType;
  49780. /**
  49781. * The indices of this component in the gamepad object
  49782. */
  49783. gamepadIndices: {
  49784. /**
  49785. * Index of button
  49786. */
  49787. button?: number;
  49788. /**
  49789. * If available, index of x-axis
  49790. */
  49791. xAxis?: number;
  49792. /**
  49793. * If available, index of y-axis
  49794. */
  49795. yAxis?: number;
  49796. };
  49797. /**
  49798. * The mesh's root node name
  49799. */
  49800. rootNodeName: string;
  49801. /**
  49802. * Animation definitions for this model
  49803. */
  49804. visualResponses: {
  49805. [stateKey: string]: {
  49806. /**
  49807. * What property will be animated
  49808. */
  49809. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49810. /**
  49811. * What states influence this visual response
  49812. */
  49813. states: MotionControllerComponentStateType[];
  49814. /**
  49815. * Type of animation - movement or visibility
  49816. */
  49817. valueNodeProperty: "transform" | "visibility";
  49818. /**
  49819. * Base node name to move. Its position will be calculated according to the min and max nodes
  49820. */
  49821. valueNodeName?: string;
  49822. /**
  49823. * Minimum movement node
  49824. */
  49825. minNodeName?: string;
  49826. /**
  49827. * Max movement node
  49828. */
  49829. maxNodeName?: string;
  49830. };
  49831. };
  49832. /**
  49833. * If touch enabled, what is the name of node to display user feedback
  49834. */
  49835. touchPointNodeName?: string;
  49836. };
  49837. };
  49838. /**
  49839. * Is it xr standard mapping or not
  49840. */
  49841. gamepadMapping: "" | "xr-standard";
  49842. /**
  49843. * Base root node of this entire model
  49844. */
  49845. rootNodeName: string;
  49846. /**
  49847. * Defines the main button component id
  49848. */
  49849. selectComponentId: string;
  49850. }
  49851. /**
  49852. * A definition for the layout map in the input profile
  49853. */
  49854. export interface IMotionControllerLayoutMap {
  49855. /**
  49856. * Layouts with handedness type as a key
  49857. */
  49858. [handedness: string]: IMotionControllerLayout;
  49859. }
  49860. /**
  49861. * The XR Input profile schema
  49862. * Profiles can be found here:
  49863. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49864. */
  49865. export interface IMotionControllerProfile {
  49866. /**
  49867. * fallback profiles for this profileId
  49868. */
  49869. fallbackProfileIds: string[];
  49870. /**
  49871. * The layout map, with handedness as key
  49872. */
  49873. layouts: IMotionControllerLayoutMap;
  49874. /**
  49875. * The id of this profile
  49876. * correlates to the profile(s) in the xrInput.profiles array
  49877. */
  49878. profileId: string;
  49879. }
  49880. /**
  49881. * A helper-interface for the 3 meshes needed for controller button animation
  49882. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49883. */
  49884. export interface IMotionControllerButtonMeshMap {
  49885. /**
  49886. * the mesh that defines the pressed value mesh position.
  49887. * This is used to find the max-position of this button
  49888. */
  49889. pressedMesh: AbstractMesh;
  49890. /**
  49891. * the mesh that defines the unpressed value mesh position.
  49892. * This is used to find the min (or initial) position of this button
  49893. */
  49894. unpressedMesh: AbstractMesh;
  49895. /**
  49896. * The mesh that will be changed when value changes
  49897. */
  49898. valueMesh: AbstractMesh;
  49899. }
  49900. /**
  49901. * A helper-interface for the 3 meshes needed for controller axis animation.
  49902. * This will be expanded when touchpad animations are fully supported
  49903. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49904. */
  49905. export interface IMotionControllerMeshMap {
  49906. /**
  49907. * the mesh that defines the maximum value mesh position.
  49908. */
  49909. maxMesh?: AbstractMesh;
  49910. /**
  49911. * the mesh that defines the minimum value mesh position.
  49912. */
  49913. minMesh?: AbstractMesh;
  49914. /**
  49915. * The mesh that will be changed when axis value changes
  49916. */
  49917. valueMesh?: AbstractMesh;
  49918. }
  49919. /**
  49920. * The elements needed for change-detection of the gamepad objects in motion controllers
  49921. */
  49922. export interface IMinimalMotionControllerObject {
  49923. /**
  49924. * Available axes of this controller
  49925. */
  49926. axes: number[];
  49927. /**
  49928. * An array of available buttons
  49929. */
  49930. buttons: Array<{
  49931. /**
  49932. * Value of the button/trigger
  49933. */
  49934. value: number;
  49935. /**
  49936. * If the button/trigger is currently touched
  49937. */
  49938. touched: boolean;
  49939. /**
  49940. * If the button/trigger is currently pressed
  49941. */
  49942. pressed: boolean;
  49943. }>;
  49944. /**
  49945. * EXPERIMENTAL haptic support.
  49946. */
  49947. hapticActuators?: Array<{
  49948. pulse: (value: number, duration: number) => Promise<boolean>;
  49949. }>;
  49950. }
  49951. /**
  49952. * An Abstract Motion controller
  49953. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49954. * Each component has an observable to check for changes in value and state
  49955. */
  49956. export abstract class WebXRAbstractMotionController implements IDisposable {
  49957. protected scene: Scene;
  49958. protected layout: IMotionControllerLayout;
  49959. /**
  49960. * The gamepad object correlating to this controller
  49961. */
  49962. gamepadObject: IMinimalMotionControllerObject;
  49963. /**
  49964. * handedness (left/right/none) of this controller
  49965. */
  49966. handedness: MotionControllerHandedness;
  49967. private _initComponent;
  49968. private _modelReady;
  49969. /**
  49970. * A map of components (WebXRControllerComponent) in this motion controller
  49971. * Components have a ComponentType and can also have both button and axis definitions
  49972. */
  49973. readonly components: {
  49974. [id: string]: WebXRControllerComponent;
  49975. };
  49976. /**
  49977. * Disable the model's animation. Can be set at any time.
  49978. */
  49979. disableAnimation: boolean;
  49980. /**
  49981. * Observers registered here will be triggered when the model of this controller is done loading
  49982. */
  49983. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49984. /**
  49985. * The profile id of this motion controller
  49986. */
  49987. abstract profileId: string;
  49988. /**
  49989. * The root mesh of the model. It is null if the model was not yet initialized
  49990. */
  49991. rootMesh: Nullable<AbstractMesh>;
  49992. /**
  49993. * constructs a new abstract motion controller
  49994. * @param scene the scene to which the model of the controller will be added
  49995. * @param layout The profile layout to load
  49996. * @param gamepadObject The gamepad object correlating to this controller
  49997. * @param handedness handedness (left/right/none) of this controller
  49998. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49999. */
  50000. constructor(scene: Scene, layout: IMotionControllerLayout,
  50001. /**
  50002. * The gamepad object correlating to this controller
  50003. */
  50004. gamepadObject: IMinimalMotionControllerObject,
  50005. /**
  50006. * handedness (left/right/none) of this controller
  50007. */
  50008. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50009. /**
  50010. * Dispose this controller, the model mesh and all its components
  50011. */
  50012. dispose(): void;
  50013. /**
  50014. * Returns all components of specific type
  50015. * @param type the type to search for
  50016. * @return an array of components with this type
  50017. */
  50018. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50019. /**
  50020. * get a component based an its component id as defined in layout.components
  50021. * @param id the id of the component
  50022. * @returns the component correlates to the id or undefined if not found
  50023. */
  50024. getComponent(id: string): WebXRControllerComponent;
  50025. /**
  50026. * Get the list of components available in this motion controller
  50027. * @returns an array of strings correlating to available components
  50028. */
  50029. getComponentIds(): string[];
  50030. /**
  50031. * Get the first component of specific type
  50032. * @param type type of component to find
  50033. * @return a controller component or null if not found
  50034. */
  50035. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50036. /**
  50037. * Get the main (Select) component of this controller as defined in the layout
  50038. * @returns the main component of this controller
  50039. */
  50040. getMainComponent(): WebXRControllerComponent;
  50041. /**
  50042. * Loads the model correlating to this controller
  50043. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50044. * @returns A promise fulfilled with the result of the model loading
  50045. */
  50046. loadModel(): Promise<boolean>;
  50047. /**
  50048. * Update this model using the current XRFrame
  50049. * @param xrFrame the current xr frame to use and update the model
  50050. */
  50051. updateFromXRFrame(xrFrame: XRFrame): void;
  50052. /**
  50053. * Backwards compatibility due to a deeply-integrated typo
  50054. */
  50055. get handness(): XREye;
  50056. /**
  50057. * Pulse (vibrate) this controller
  50058. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50059. * Consecutive calls to this function will cancel the last pulse call
  50060. *
  50061. * @param value the strength of the pulse in 0.0...1.0 range
  50062. * @param duration Duration of the pulse in milliseconds
  50063. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50064. * @returns a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
  50065. */
  50066. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50067. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50068. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50069. /**
  50070. * Moves the axis on the controller mesh based on its current state
  50071. * @param axis the index of the axis
  50072. * @param axisValue the value of the axis which determines the meshes new position
  50073. * @hidden
  50074. */
  50075. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50076. /**
  50077. * Update the model itself with the current frame data
  50078. * @param xrFrame the frame to use for updating the model mesh
  50079. */
  50080. protected updateModel(xrFrame: XRFrame): void;
  50081. /**
  50082. * Get the filename and path for this controller's model
  50083. * @returns a map of filename and path
  50084. */
  50085. protected abstract _getFilenameAndPath(): {
  50086. filename: string;
  50087. path: string;
  50088. };
  50089. /**
  50090. * This function is called before the mesh is loaded. It checks for loading constraints.
  50091. * For example, this function can check if the GLB loader is available
  50092. * If this function returns false, the generic controller will be loaded instead
  50093. * @returns Is the client ready to load the mesh
  50094. */
  50095. protected abstract _getModelLoadingConstraints(): boolean;
  50096. /**
  50097. * This function will be called after the model was successfully loaded and can be used
  50098. * for mesh transformations before it is available for the user
  50099. * @param meshes the loaded meshes
  50100. */
  50101. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50102. /**
  50103. * Set the root mesh for this controller. Important for the WebXR controller class
  50104. * @param meshes the loaded meshes
  50105. */
  50106. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50107. /**
  50108. * A function executed each frame that updates the mesh (if needed)
  50109. * @param xrFrame the current xrFrame
  50110. */
  50111. protected abstract _updateModel(xrFrame: XRFrame): void;
  50112. private _getGenericFilenameAndPath;
  50113. private _getGenericParentMesh;
  50114. }
  50115. }
  50116. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50117. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50118. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50119. import { Scene } from "babylonjs/scene";
  50120. /**
  50121. * A generic trigger-only motion controller for WebXR
  50122. */
  50123. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50124. /**
  50125. * Static version of the profile id of this controller
  50126. */
  50127. static ProfileId: string;
  50128. profileId: string;
  50129. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50130. protected _getFilenameAndPath(): {
  50131. filename: string;
  50132. path: string;
  50133. };
  50134. protected _getModelLoadingConstraints(): boolean;
  50135. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50136. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50137. protected _updateModel(): void;
  50138. }
  50139. }
  50140. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50141. import { Vector4 } from "babylonjs/Maths/math.vector";
  50142. import { Mesh } from "babylonjs/Meshes/mesh";
  50143. import { Scene } from "babylonjs/scene";
  50144. import { Nullable } from "babylonjs/types";
  50145. /**
  50146. * Class containing static functions to help procedurally build meshes
  50147. */
  50148. export class SphereBuilder {
  50149. /**
  50150. * Creates a sphere mesh
  50151. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50152. * * 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`)
  50153. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50154. * * 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
  50155. * * 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)
  50156. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50157. * * 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
  50158. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50159. * @param name defines the name of the mesh
  50160. * @param options defines the options used to create the mesh
  50161. * @param scene defines the hosting scene
  50162. * @returns the sphere mesh
  50163. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50164. */
  50165. static CreateSphere(name: string, options: {
  50166. segments?: number;
  50167. diameter?: number;
  50168. diameterX?: number;
  50169. diameterY?: number;
  50170. diameterZ?: number;
  50171. arc?: number;
  50172. slice?: number;
  50173. sideOrientation?: number;
  50174. frontUVs?: Vector4;
  50175. backUVs?: Vector4;
  50176. updatable?: boolean;
  50177. }, scene?: Nullable<Scene>): Mesh;
  50178. }
  50179. }
  50180. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50181. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50182. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50183. import { Scene } from "babylonjs/scene";
  50184. /**
  50185. * A profiled motion controller has its profile loaded from an online repository.
  50186. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50187. */
  50188. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50189. private _repositoryUrl;
  50190. private _buttonMeshMapping;
  50191. private _touchDots;
  50192. /**
  50193. * The profile ID of this controller. Will be populated when the controller initializes.
  50194. */
  50195. profileId: string;
  50196. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50197. dispose(): void;
  50198. protected _getFilenameAndPath(): {
  50199. filename: string;
  50200. path: string;
  50201. };
  50202. protected _getModelLoadingConstraints(): boolean;
  50203. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50204. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50205. protected _updateModel(_xrFrame: XRFrame): void;
  50206. }
  50207. }
  50208. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50209. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50210. import { Scene } from "babylonjs/scene";
  50211. /**
  50212. * A construction function type to create a new controller based on an xrInput object
  50213. */
  50214. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50215. /**
  50216. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50217. *
  50218. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50219. * it should be replaced with auto-loaded controllers.
  50220. *
  50221. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50222. */
  50223. export class WebXRMotionControllerManager {
  50224. private static _AvailableControllers;
  50225. private static _Fallbacks;
  50226. private static _ProfileLoadingPromises;
  50227. private static _ProfilesList;
  50228. /**
  50229. * The base URL of the online controller repository. Can be changed at any time.
  50230. */
  50231. static BaseRepositoryUrl: string;
  50232. /**
  50233. * Which repository gets priority - local or online
  50234. */
  50235. static PrioritizeOnlineRepository: boolean;
  50236. /**
  50237. * Use the online repository, or use only locally-defined controllers
  50238. */
  50239. static UseOnlineRepository: boolean;
  50240. /**
  50241. * Clear the cache used for profile loading and reload when requested again
  50242. */
  50243. static ClearProfilesCache(): void;
  50244. /**
  50245. * Register the default fallbacks.
  50246. * This function is called automatically when this file is imported.
  50247. */
  50248. static DefaultFallbacks(): void;
  50249. /**
  50250. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50251. * @param profileId the profile to which a fallback needs to be found
  50252. * @return an array with corresponding fallback profiles
  50253. */
  50254. static FindFallbackWithProfileId(profileId: string): string[];
  50255. /**
  50256. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50257. * The order of search:
  50258. *
  50259. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50260. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50261. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50262. * 4) return the generic trigger controller if none were found
  50263. *
  50264. * @param xrInput the xrInput to which a new controller is initialized
  50265. * @param scene the scene to which the model will be added
  50266. * @param forceProfile force a certain profile for this controller
  50267. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50268. */
  50269. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50270. /**
  50271. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50272. *
  50273. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50274. *
  50275. * @param type the profile type to register
  50276. * @param constructFunction the function to be called when loading this profile
  50277. */
  50278. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50279. /**
  50280. * Register a fallback to a specific profile.
  50281. * @param profileId the profileId that will receive the fallbacks
  50282. * @param fallbacks A list of fallback profiles
  50283. */
  50284. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50285. /**
  50286. * Will update the list of profiles available in the repository
  50287. * @return a promise that resolves to a map of profiles available online
  50288. */
  50289. static UpdateProfilesList(): Promise<{
  50290. [profile: string]: string;
  50291. }>;
  50292. private static _LoadProfileFromRepository;
  50293. private static _LoadProfilesFromAvailableControllers;
  50294. }
  50295. }
  50296. declare module "babylonjs/XR/webXRInputSource" {
  50297. import { Observable } from "babylonjs/Misc/observable";
  50298. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50299. import { Ray } from "babylonjs/Culling/ray";
  50300. import { Scene } from "babylonjs/scene";
  50301. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50302. /**
  50303. * Configuration options for the WebXR controller creation
  50304. */
  50305. export interface IWebXRControllerOptions {
  50306. /**
  50307. * Should the controller mesh be animated when a user interacts with it
  50308. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50309. */
  50310. disableMotionControllerAnimation?: boolean;
  50311. /**
  50312. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50313. */
  50314. doNotLoadControllerMesh?: boolean;
  50315. /**
  50316. * Force a specific controller type for this controller.
  50317. * This can be used when creating your own profile or when testing different controllers
  50318. */
  50319. forceControllerProfile?: string;
  50320. /**
  50321. * Defines a rendering group ID for meshes that will be loaded.
  50322. * This is for the default controllers only.
  50323. */
  50324. renderingGroupId?: number;
  50325. }
  50326. /**
  50327. * Represents an XR controller
  50328. */
  50329. export class WebXRInputSource {
  50330. private _scene;
  50331. /** The underlying input source for the controller */
  50332. inputSource: XRInputSource;
  50333. private _options;
  50334. private _tmpVector;
  50335. private _uniqueId;
  50336. private _disposed;
  50337. /**
  50338. * 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
  50339. */
  50340. grip?: AbstractMesh;
  50341. /**
  50342. * If available, this is the gamepad object related to this controller.
  50343. * Using this object it is possible to get click events and trackpad changes of the
  50344. * webxr controller that is currently being used.
  50345. */
  50346. motionController?: WebXRAbstractMotionController;
  50347. /**
  50348. * Event that fires when the controller is removed/disposed.
  50349. * The object provided as event data is this controller, after associated assets were disposed.
  50350. * uniqueId is still available.
  50351. */
  50352. onDisposeObservable: Observable<WebXRInputSource>;
  50353. /**
  50354. * Will be triggered when the mesh associated with the motion controller is done loading.
  50355. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50356. * A shortened version of controller -> motion controller -> on mesh loaded.
  50357. */
  50358. onMeshLoadedObservable: Observable<AbstractMesh>;
  50359. /**
  50360. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50361. */
  50362. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50363. /**
  50364. * Pointer which can be used to select objects or attach a visible laser to
  50365. */
  50366. pointer: AbstractMesh;
  50367. /**
  50368. * Creates the input source object
  50369. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50370. * @param _scene the scene which the controller should be associated to
  50371. * @param inputSource the underlying input source for the controller
  50372. * @param _options options for this controller creation
  50373. */
  50374. constructor(_scene: Scene,
  50375. /** The underlying input source for the controller */
  50376. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50377. /**
  50378. * Get this controllers unique id
  50379. */
  50380. get uniqueId(): string;
  50381. /**
  50382. * Disposes of the object
  50383. */
  50384. dispose(): void;
  50385. /**
  50386. * Gets a world space ray coming from the pointer or grip
  50387. * @param result the resulting ray
  50388. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50389. */
  50390. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50391. /**
  50392. * Updates the controller pose based on the given XRFrame
  50393. * @param xrFrame xr frame to update the pose with
  50394. * @param referenceSpace reference space to use
  50395. */
  50396. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50397. }
  50398. }
  50399. declare module "babylonjs/XR/webXRInput" {
  50400. import { Observable } from "babylonjs/Misc/observable";
  50401. import { IDisposable } from "babylonjs/scene";
  50402. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50403. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50404. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50405. /**
  50406. * The schema for initialization options of the XR Input class
  50407. */
  50408. export interface IWebXRInputOptions {
  50409. /**
  50410. * If set to true no model will be automatically loaded
  50411. */
  50412. doNotLoadControllerMeshes?: boolean;
  50413. /**
  50414. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50415. * If not found, the xr input profile data will be used.
  50416. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50417. */
  50418. forceInputProfile?: string;
  50419. /**
  50420. * Do not send a request to the controller repository to load the profile.
  50421. *
  50422. * Instead, use the controllers available in babylon itself.
  50423. */
  50424. disableOnlineControllerRepository?: boolean;
  50425. /**
  50426. * A custom URL for the controllers repository
  50427. */
  50428. customControllersRepositoryURL?: string;
  50429. /**
  50430. * Should the controller model's components not move according to the user input
  50431. */
  50432. disableControllerAnimation?: boolean;
  50433. /**
  50434. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50435. */
  50436. controllerOptions?: IWebXRControllerOptions;
  50437. }
  50438. /**
  50439. * XR input used to track XR inputs such as controllers/rays
  50440. */
  50441. export class WebXRInput implements IDisposable {
  50442. /**
  50443. * the xr session manager for this session
  50444. */
  50445. xrSessionManager: WebXRSessionManager;
  50446. /**
  50447. * the WebXR camera for this session. Mainly used for teleportation
  50448. */
  50449. xrCamera: WebXRCamera;
  50450. private readonly options;
  50451. /**
  50452. * XR controllers being tracked
  50453. */
  50454. controllers: Array<WebXRInputSource>;
  50455. private _frameObserver;
  50456. private _sessionEndedObserver;
  50457. private _sessionInitObserver;
  50458. /**
  50459. * Event when a controller has been connected/added
  50460. */
  50461. onControllerAddedObservable: Observable<WebXRInputSource>;
  50462. /**
  50463. * Event when a controller has been removed/disconnected
  50464. */
  50465. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50466. /**
  50467. * Initializes the WebXRInput
  50468. * @param xrSessionManager the xr session manager for this session
  50469. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50470. * @param options = initialization options for this xr input
  50471. */
  50472. constructor(
  50473. /**
  50474. * the xr session manager for this session
  50475. */
  50476. xrSessionManager: WebXRSessionManager,
  50477. /**
  50478. * the WebXR camera for this session. Mainly used for teleportation
  50479. */
  50480. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50481. private _onInputSourcesChange;
  50482. private _addAndRemoveControllers;
  50483. /**
  50484. * Disposes of the object
  50485. */
  50486. dispose(): void;
  50487. }
  50488. }
  50489. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50490. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50491. import { Observable, EventState } from "babylonjs/Misc/observable";
  50492. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50493. /**
  50494. * This is the base class for all WebXR features.
  50495. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50496. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50497. */
  50498. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50499. protected _xrSessionManager: WebXRSessionManager;
  50500. private _attached;
  50501. private _removeOnDetach;
  50502. /**
  50503. * Should auto-attach be disabled?
  50504. */
  50505. disableAutoAttach: boolean;
  50506. /**
  50507. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50508. */
  50509. xrNativeFeatureName: string;
  50510. /**
  50511. * Construct a new (abstract) WebXR feature
  50512. * @param _xrSessionManager the xr session manager for this feature
  50513. */
  50514. constructor(_xrSessionManager: WebXRSessionManager);
  50515. /**
  50516. * Is this feature attached
  50517. */
  50518. get attached(): boolean;
  50519. /**
  50520. * attach this feature
  50521. *
  50522. * @param force should attachment be forced (even when already attached)
  50523. * @returns true if successful, false is failed or already attached
  50524. */
  50525. attach(force?: boolean): boolean;
  50526. /**
  50527. * detach this feature.
  50528. *
  50529. * @returns true if successful, false if failed or already detached
  50530. */
  50531. detach(): boolean;
  50532. /**
  50533. * Dispose this feature and all of the resources attached
  50534. */
  50535. dispose(): void;
  50536. /**
  50537. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50538. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50539. *
  50540. * @returns whether or not the feature is compatible in this environment
  50541. */
  50542. isCompatible(): boolean;
  50543. /**
  50544. * This is used to register callbacks that will automatically be removed when detach is called.
  50545. * @param observable the observable to which the observer will be attached
  50546. * @param callback the callback to register
  50547. */
  50548. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50549. /**
  50550. * Code in this function will be executed on each xrFrame received from the browser.
  50551. * This function will not execute after the feature is detached.
  50552. * @param _xrFrame the current frame
  50553. */
  50554. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50555. }
  50556. }
  50557. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50558. import { IDisposable, Scene } from "babylonjs/scene";
  50559. import { Nullable } from "babylonjs/types";
  50560. import { Observable } from "babylonjs/Misc/observable";
  50561. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50562. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50563. import { Camera } from "babylonjs/Cameras/camera";
  50564. /**
  50565. * Renders a layer on top of an existing scene
  50566. */
  50567. export class UtilityLayerRenderer implements IDisposable {
  50568. /** the original scene that will be rendered on top of */
  50569. originalScene: Scene;
  50570. private _pointerCaptures;
  50571. private _lastPointerEvents;
  50572. private static _DefaultUtilityLayer;
  50573. private static _DefaultKeepDepthUtilityLayer;
  50574. private _sharedGizmoLight;
  50575. private _renderCamera;
  50576. /**
  50577. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50578. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50579. * @returns the camera that is used when rendering the utility layer
  50580. */
  50581. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50582. /**
  50583. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50584. * @param cam the camera that should be used when rendering the utility layer
  50585. */
  50586. setRenderCamera(cam: Nullable<Camera>): void;
  50587. /**
  50588. * @hidden
  50589. * Light which used by gizmos to get light shading
  50590. */
  50591. _getSharedGizmoLight(): HemisphericLight;
  50592. /**
  50593. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50594. */
  50595. pickUtilitySceneFirst: boolean;
  50596. /**
  50597. * 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)
  50598. */
  50599. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50600. /**
  50601. * 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)
  50602. */
  50603. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50604. /**
  50605. * The scene that is rendered on top of the original scene
  50606. */
  50607. utilityLayerScene: Scene;
  50608. /**
  50609. * If the utility layer should automatically be rendered on top of existing scene
  50610. */
  50611. shouldRender: boolean;
  50612. /**
  50613. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50614. */
  50615. onlyCheckPointerDownEvents: boolean;
  50616. /**
  50617. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50618. */
  50619. processAllEvents: boolean;
  50620. /**
  50621. * Observable raised when the pointer move from the utility layer scene to the main scene
  50622. */
  50623. onPointerOutObservable: Observable<number>;
  50624. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50625. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50626. private _afterRenderObserver;
  50627. private _sceneDisposeObserver;
  50628. private _originalPointerObserver;
  50629. /**
  50630. * Instantiates a UtilityLayerRenderer
  50631. * @param originalScene the original scene that will be rendered on top of
  50632. * @param handleEvents boolean indicating if the utility layer should handle events
  50633. */
  50634. constructor(
  50635. /** the original scene that will be rendered on top of */
  50636. originalScene: Scene, handleEvents?: boolean);
  50637. private _notifyObservers;
  50638. /**
  50639. * Renders the utility layers scene on top of the original scene
  50640. */
  50641. render(): void;
  50642. /**
  50643. * Disposes of the renderer
  50644. */
  50645. dispose(): void;
  50646. private _updateCamera;
  50647. }
  50648. }
  50649. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50650. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50651. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50652. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50653. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50654. import { Scene } from "babylonjs/scene";
  50655. import { Nullable } from "babylonjs/types";
  50656. import { Color3 } from "babylonjs/Maths/math.color";
  50657. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50658. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50659. /**
  50660. * Options interface for the pointer selection module
  50661. */
  50662. export interface IWebXRControllerPointerSelectionOptions {
  50663. /**
  50664. * if provided, this scene will be used to render meshes.
  50665. */
  50666. customUtilityLayerScene?: Scene;
  50667. /**
  50668. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  50669. * If not disabled, the last picked point will be used to execute a pointer up event
  50670. * If disabled, pointer up event will be triggered right after the pointer down event.
  50671. * Used in screen and gaze target ray mode only
  50672. */
  50673. disablePointerUpOnTouchOut: boolean;
  50674. /**
  50675. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50676. */
  50677. forceGazeMode: boolean;
  50678. /**
  50679. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  50680. * to start a new countdown to the pointer down event.
  50681. * Defaults to 1.
  50682. */
  50683. gazeModePointerMovedFactor?: number;
  50684. /**
  50685. * Different button type to use instead of the main component
  50686. */
  50687. overrideButtonId?: string;
  50688. /**
  50689. * use this rendering group id for the meshes (optional)
  50690. */
  50691. renderingGroupId?: number;
  50692. /**
  50693. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50694. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50695. * 3000 means 3 seconds between pointing at something and selecting it
  50696. */
  50697. timeToSelect?: number;
  50698. /**
  50699. * Should meshes created here be added to a utility layer or the main scene
  50700. */
  50701. useUtilityLayer?: boolean;
  50702. /**
  50703. * Optional WebXR camera to be used for gaze selection
  50704. */
  50705. gazeCamera?: WebXRCamera;
  50706. /**
  50707. * the xr input to use with this pointer selection
  50708. */
  50709. xrInput: WebXRInput;
  50710. }
  50711. /**
  50712. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50713. */
  50714. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50715. private readonly _options;
  50716. private static _idCounter;
  50717. private _attachController;
  50718. private _controllers;
  50719. private _scene;
  50720. private _tmpVectorForPickCompare;
  50721. /**
  50722. * The module's name
  50723. */
  50724. static readonly Name: string;
  50725. /**
  50726. * The (Babylon) version of this module.
  50727. * This is an integer representing the implementation version.
  50728. * This number does not correspond to the WebXR specs version
  50729. */
  50730. static readonly Version: number;
  50731. /**
  50732. * Disable lighting on the laser pointer (so it will always be visible)
  50733. */
  50734. disablePointerLighting: boolean;
  50735. /**
  50736. * Disable lighting on the selection mesh (so it will always be visible)
  50737. */
  50738. disableSelectionMeshLighting: boolean;
  50739. /**
  50740. * Should the laser pointer be displayed
  50741. */
  50742. displayLaserPointer: boolean;
  50743. /**
  50744. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50745. */
  50746. displaySelectionMesh: boolean;
  50747. /**
  50748. * This color will be set to the laser pointer when selection is triggered
  50749. */
  50750. laserPointerPickedColor: Color3;
  50751. /**
  50752. * Default color of the laser pointer
  50753. */
  50754. laserPointerDefaultColor: Color3;
  50755. /**
  50756. * default color of the selection ring
  50757. */
  50758. selectionMeshDefaultColor: Color3;
  50759. /**
  50760. * This color will be applied to the selection ring when selection is triggered
  50761. */
  50762. selectionMeshPickedColor: Color3;
  50763. /**
  50764. * Optional filter to be used for ray selection. This predicate shares behavior with
  50765. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50766. */
  50767. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50768. /**
  50769. * constructs a new background remover module
  50770. * @param _xrSessionManager the session manager for this module
  50771. * @param _options read-only options to be used in this module
  50772. */
  50773. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50774. /**
  50775. * attach this feature
  50776. * Will usually be called by the features manager
  50777. *
  50778. * @returns true if successful.
  50779. */
  50780. attach(): boolean;
  50781. /**
  50782. * detach this feature.
  50783. * Will usually be called by the features manager
  50784. *
  50785. * @returns true if successful.
  50786. */
  50787. detach(): boolean;
  50788. /**
  50789. * Will get the mesh under a specific pointer.
  50790. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50791. * @param controllerId the controllerId to check
  50792. * @returns The mesh under pointer or null if no mesh is under the pointer
  50793. */
  50794. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50795. /**
  50796. * Get the xr controller that correlates to the pointer id in the pointer event
  50797. *
  50798. * @param id the pointer id to search for
  50799. * @returns the controller that correlates to this id or null if not found
  50800. */
  50801. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50802. protected _onXRFrame(_xrFrame: XRFrame): void;
  50803. private _attachGazeMode;
  50804. private _attachScreenRayMode;
  50805. private _attachTrackedPointerRayMode;
  50806. private _convertNormalToDirectionOfRay;
  50807. private _detachController;
  50808. private _generateNewMeshPair;
  50809. private _pickingMoved;
  50810. private _updatePointerDistance;
  50811. /** @hidden */
  50812. get lasterPointerDefaultColor(): Color3;
  50813. }
  50814. }
  50815. declare module "babylonjs/XR/webXREnterExitUI" {
  50816. import { Nullable } from "babylonjs/types";
  50817. import { Observable } from "babylonjs/Misc/observable";
  50818. import { IDisposable, Scene } from "babylonjs/scene";
  50819. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50820. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50821. /**
  50822. * Button which can be used to enter a different mode of XR
  50823. */
  50824. export class WebXREnterExitUIButton {
  50825. /** button element */
  50826. element: HTMLElement;
  50827. /** XR initialization options for the button */
  50828. sessionMode: XRSessionMode;
  50829. /** Reference space type */
  50830. referenceSpaceType: XRReferenceSpaceType;
  50831. /**
  50832. * Creates a WebXREnterExitUIButton
  50833. * @param element button element
  50834. * @param sessionMode XR initialization session mode
  50835. * @param referenceSpaceType the type of reference space to be used
  50836. */
  50837. constructor(
  50838. /** button element */
  50839. element: HTMLElement,
  50840. /** XR initialization options for the button */
  50841. sessionMode: XRSessionMode,
  50842. /** Reference space type */
  50843. referenceSpaceType: XRReferenceSpaceType);
  50844. /**
  50845. * Extendable function which can be used to update the button's visuals when the state changes
  50846. * @param activeButton the current active button in the UI
  50847. */
  50848. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50849. }
  50850. /**
  50851. * Options to create the webXR UI
  50852. */
  50853. export class WebXREnterExitUIOptions {
  50854. /**
  50855. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50856. */
  50857. customButtons?: Array<WebXREnterExitUIButton>;
  50858. /**
  50859. * A reference space type to use when creating the default button.
  50860. * Default is local-floor
  50861. */
  50862. referenceSpaceType?: XRReferenceSpaceType;
  50863. /**
  50864. * Context to enter xr with
  50865. */
  50866. renderTarget?: Nullable<WebXRRenderTarget>;
  50867. /**
  50868. * A session mode to use when creating the default button.
  50869. * Default is immersive-vr
  50870. */
  50871. sessionMode?: XRSessionMode;
  50872. /**
  50873. * A list of optional features to init the session with
  50874. */
  50875. optionalFeatures?: string[];
  50876. /**
  50877. * A list of optional features to init the session with
  50878. */
  50879. requiredFeatures?: string[];
  50880. }
  50881. /**
  50882. * UI to allow the user to enter/exit XR mode
  50883. */
  50884. export class WebXREnterExitUI implements IDisposable {
  50885. private scene;
  50886. /** version of the options passed to this UI */
  50887. options: WebXREnterExitUIOptions;
  50888. private _activeButton;
  50889. private _buttons;
  50890. /**
  50891. * The HTML Div Element to which buttons are added.
  50892. */
  50893. readonly overlay: HTMLDivElement;
  50894. /**
  50895. * Fired every time the active button is changed.
  50896. *
  50897. * When xr is entered via a button that launches xr that button will be the callback parameter
  50898. *
  50899. * When exiting xr the callback parameter will be null)
  50900. */
  50901. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50902. /**
  50903. *
  50904. * @param scene babylon scene object to use
  50905. * @param options (read-only) version of the options passed to this UI
  50906. */
  50907. private constructor();
  50908. /**
  50909. * Creates UI to allow the user to enter/exit XR mode
  50910. * @param scene the scene to add the ui to
  50911. * @param helper the xr experience helper to enter/exit xr with
  50912. * @param options options to configure the UI
  50913. * @returns the created ui
  50914. */
  50915. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50916. /**
  50917. * Disposes of the XR UI component
  50918. */
  50919. dispose(): void;
  50920. private _updateButtons;
  50921. }
  50922. }
  50923. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50924. import { Vector3 } from "babylonjs/Maths/math.vector";
  50925. import { Color4 } from "babylonjs/Maths/math.color";
  50926. import { Nullable } from "babylonjs/types";
  50927. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50928. import { Scene } from "babylonjs/scene";
  50929. /**
  50930. * Class containing static functions to help procedurally build meshes
  50931. */
  50932. export class LinesBuilder {
  50933. /**
  50934. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50935. * * 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
  50936. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50937. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50938. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50939. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50940. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50941. * * 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
  50942. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50943. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50944. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50945. * @param name defines the name of the new line system
  50946. * @param options defines the options used to create the line system
  50947. * @param scene defines the hosting scene
  50948. * @returns a new line system mesh
  50949. */
  50950. static CreateLineSystem(name: string, options: {
  50951. lines: Vector3[][];
  50952. updatable?: boolean;
  50953. instance?: Nullable<LinesMesh>;
  50954. colors?: Nullable<Color4[][]>;
  50955. useVertexAlpha?: boolean;
  50956. }, scene: Nullable<Scene>): LinesMesh;
  50957. /**
  50958. * Creates a line mesh
  50959. * 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
  50960. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50961. * * The parameter `points` is an array successive Vector3
  50962. * * 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
  50963. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50964. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50965. * * When updating an instance, remember that only point positions can change, not the number of points
  50966. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50967. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50968. * @param name defines the name of the new line system
  50969. * @param options defines the options used to create the line system
  50970. * @param scene defines the hosting scene
  50971. * @returns a new line mesh
  50972. */
  50973. static CreateLines(name: string, options: {
  50974. points: Vector3[];
  50975. updatable?: boolean;
  50976. instance?: Nullable<LinesMesh>;
  50977. colors?: Color4[];
  50978. useVertexAlpha?: boolean;
  50979. }, scene?: Nullable<Scene>): LinesMesh;
  50980. /**
  50981. * Creates a dashed line mesh
  50982. * * 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
  50983. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50984. * * The parameter `points` is an array successive Vector3
  50985. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50986. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50987. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50988. * * 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
  50989. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50990. * * When updating an instance, remember that only point positions can change, not the number of points
  50991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50992. * @param name defines the name of the mesh
  50993. * @param options defines the options used to create the mesh
  50994. * @param scene defines the hosting scene
  50995. * @returns the dashed line mesh
  50996. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50997. */
  50998. static CreateDashedLines(name: string, options: {
  50999. points: Vector3[];
  51000. dashSize?: number;
  51001. gapSize?: number;
  51002. dashNb?: number;
  51003. updatable?: boolean;
  51004. instance?: LinesMesh;
  51005. useVertexAlpha?: boolean;
  51006. }, scene?: Nullable<Scene>): LinesMesh;
  51007. }
  51008. }
  51009. declare module "babylonjs/Misc/timer" {
  51010. import { Observable, Observer } from "babylonjs/Misc/observable";
  51011. import { Nullable } from "babylonjs/types";
  51012. import { IDisposable } from "babylonjs/scene";
  51013. /**
  51014. * Construction options for a timer
  51015. */
  51016. export interface ITimerOptions<T> {
  51017. /**
  51018. * Time-to-end
  51019. */
  51020. timeout: number;
  51021. /**
  51022. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51023. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51024. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51025. */
  51026. contextObservable: Observable<T>;
  51027. /**
  51028. * Optional parameters when adding an observer to the observable
  51029. */
  51030. observableParameters?: {
  51031. mask?: number;
  51032. insertFirst?: boolean;
  51033. scope?: any;
  51034. };
  51035. /**
  51036. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51037. */
  51038. breakCondition?: (data?: ITimerData<T>) => boolean;
  51039. /**
  51040. * Will be triggered when the time condition has met
  51041. */
  51042. onEnded?: (data: ITimerData<any>) => void;
  51043. /**
  51044. * Will be triggered when the break condition has met (prematurely ended)
  51045. */
  51046. onAborted?: (data: ITimerData<any>) => void;
  51047. /**
  51048. * Optional function to execute on each tick (or count)
  51049. */
  51050. onTick?: (data: ITimerData<any>) => void;
  51051. }
  51052. /**
  51053. * An interface defining the data sent by the timer
  51054. */
  51055. export interface ITimerData<T> {
  51056. /**
  51057. * When did it start
  51058. */
  51059. startTime: number;
  51060. /**
  51061. * Time now
  51062. */
  51063. currentTime: number;
  51064. /**
  51065. * Time passed since started
  51066. */
  51067. deltaTime: number;
  51068. /**
  51069. * How much is completed, in [0.0...1.0].
  51070. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51071. */
  51072. completeRate: number;
  51073. /**
  51074. * What the registered observable sent in the last count
  51075. */
  51076. payload: T;
  51077. }
  51078. /**
  51079. * The current state of the timer
  51080. */
  51081. export enum TimerState {
  51082. /**
  51083. * Timer initialized, not yet started
  51084. */
  51085. INIT = 0,
  51086. /**
  51087. * Timer started and counting
  51088. */
  51089. STARTED = 1,
  51090. /**
  51091. * Timer ended (whether aborted or time reached)
  51092. */
  51093. ENDED = 2
  51094. }
  51095. /**
  51096. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51097. *
  51098. * @param options options with which to initialize this timer
  51099. */
  51100. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51101. /**
  51102. * An advanced implementation of a timer class
  51103. */
  51104. export class AdvancedTimer<T = any> implements IDisposable {
  51105. /**
  51106. * Will notify each time the timer calculates the remaining time
  51107. */
  51108. onEachCountObservable: Observable<ITimerData<T>>;
  51109. /**
  51110. * Will trigger when the timer was aborted due to the break condition
  51111. */
  51112. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51113. /**
  51114. * Will trigger when the timer ended successfully
  51115. */
  51116. onTimerEndedObservable: Observable<ITimerData<T>>;
  51117. /**
  51118. * Will trigger when the timer state has changed
  51119. */
  51120. onStateChangedObservable: Observable<TimerState>;
  51121. private _observer;
  51122. private _contextObservable;
  51123. private _observableParameters;
  51124. private _startTime;
  51125. private _timer;
  51126. private _state;
  51127. private _breakCondition;
  51128. private _timeToEnd;
  51129. private _breakOnNextTick;
  51130. /**
  51131. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51132. * @param options construction options for this advanced timer
  51133. */
  51134. constructor(options: ITimerOptions<T>);
  51135. /**
  51136. * set a breaking condition for this timer. Default is to never break during count
  51137. * @param predicate the new break condition. Returns true to break, false otherwise
  51138. */
  51139. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51140. /**
  51141. * Reset ALL associated observables in this advanced timer
  51142. */
  51143. clearObservables(): void;
  51144. /**
  51145. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51146. *
  51147. * @param timeToEnd how much time to measure until timer ended
  51148. */
  51149. start(timeToEnd?: number): void;
  51150. /**
  51151. * Will force a stop on the next tick.
  51152. */
  51153. stop(): void;
  51154. /**
  51155. * Dispose this timer, clearing all resources
  51156. */
  51157. dispose(): void;
  51158. private _setState;
  51159. private _tick;
  51160. private _stop;
  51161. }
  51162. }
  51163. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51164. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51165. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51166. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51167. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51168. import { Vector3 } from "babylonjs/Maths/math.vector";
  51169. import { Material } from "babylonjs/Materials/material";
  51170. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51171. import { Scene } from "babylonjs/scene";
  51172. /**
  51173. * The options container for the teleportation module
  51174. */
  51175. export interface IWebXRTeleportationOptions {
  51176. /**
  51177. * if provided, this scene will be used to render meshes.
  51178. */
  51179. customUtilityLayerScene?: Scene;
  51180. /**
  51181. * Values to configure the default target mesh
  51182. */
  51183. defaultTargetMeshOptions?: {
  51184. /**
  51185. * Fill color of the teleportation area
  51186. */
  51187. teleportationFillColor?: string;
  51188. /**
  51189. * Border color for the teleportation area
  51190. */
  51191. teleportationBorderColor?: string;
  51192. /**
  51193. * Disable the mesh's animation sequence
  51194. */
  51195. disableAnimation?: boolean;
  51196. /**
  51197. * Disable lighting on the material or the ring and arrow
  51198. */
  51199. disableLighting?: boolean;
  51200. /**
  51201. * Override the default material of the torus and arrow
  51202. */
  51203. torusArrowMaterial?: Material;
  51204. };
  51205. /**
  51206. * A list of meshes to use as floor meshes.
  51207. * Meshes can be added and removed after initializing the feature using the
  51208. * addFloorMesh and removeFloorMesh functions
  51209. * If empty, rotation will still work
  51210. */
  51211. floorMeshes?: AbstractMesh[];
  51212. /**
  51213. * use this rendering group id for the meshes (optional)
  51214. */
  51215. renderingGroupId?: number;
  51216. /**
  51217. * Should teleportation move only to snap points
  51218. */
  51219. snapPointsOnly?: boolean;
  51220. /**
  51221. * An array of points to which the teleportation will snap to.
  51222. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51223. */
  51224. snapPositions?: Vector3[];
  51225. /**
  51226. * How close should the teleportation ray be in order to snap to position.
  51227. * Default to 0.8 units (meters)
  51228. */
  51229. snapToPositionRadius?: number;
  51230. /**
  51231. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51232. * If you want to support rotation, make sure your mesh has a direction indicator.
  51233. *
  51234. * When left untouched, the default mesh will be initialized.
  51235. */
  51236. teleportationTargetMesh?: AbstractMesh;
  51237. /**
  51238. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51239. */
  51240. timeToTeleport?: number;
  51241. /**
  51242. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51243. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51244. */
  51245. useMainComponentOnly?: boolean;
  51246. /**
  51247. * Should meshes created here be added to a utility layer or the main scene
  51248. */
  51249. useUtilityLayer?: boolean;
  51250. /**
  51251. * Babylon XR Input class for controller
  51252. */
  51253. xrInput: WebXRInput;
  51254. /**
  51255. * Meshes that the teleportation ray cannot go through
  51256. */
  51257. pickBlockerMeshes?: AbstractMesh[];
  51258. }
  51259. /**
  51260. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51261. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51262. * the input of the attached controllers.
  51263. */
  51264. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51265. private _options;
  51266. private _controllers;
  51267. private _currentTeleportationControllerId;
  51268. private _floorMeshes;
  51269. private _quadraticBezierCurve;
  51270. private _selectionFeature;
  51271. private _snapToPositions;
  51272. private _snappedToPoint;
  51273. private _teleportationRingMaterial?;
  51274. private _tmpRay;
  51275. private _tmpVector;
  51276. private _tmpQuaternion;
  51277. /**
  51278. * The module's name
  51279. */
  51280. static readonly Name: string;
  51281. /**
  51282. * The (Babylon) version of this module.
  51283. * This is an integer representing the implementation version.
  51284. * This number does not correspond to the webxr specs version
  51285. */
  51286. static readonly Version: number;
  51287. /**
  51288. * Is movement backwards enabled
  51289. */
  51290. backwardsMovementEnabled: boolean;
  51291. /**
  51292. * Distance to travel when moving backwards
  51293. */
  51294. backwardsTeleportationDistance: number;
  51295. /**
  51296. * The distance from the user to the inspection point in the direction of the controller
  51297. * A higher number will allow the user to move further
  51298. * defaults to 5 (meters, in xr units)
  51299. */
  51300. parabolicCheckRadius: number;
  51301. /**
  51302. * Should the module support parabolic ray on top of direct ray
  51303. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51304. * Very helpful when moving between floors / different heights
  51305. */
  51306. parabolicRayEnabled: boolean;
  51307. /**
  51308. * How much rotation should be applied when rotating right and left
  51309. */
  51310. rotationAngle: number;
  51311. /**
  51312. * Is rotation enabled when moving forward?
  51313. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51314. */
  51315. rotationEnabled: boolean;
  51316. /**
  51317. * constructs a new anchor system
  51318. * @param _xrSessionManager an instance of WebXRSessionManager
  51319. * @param _options configuration object for this feature
  51320. */
  51321. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51322. /**
  51323. * Get the snapPointsOnly flag
  51324. */
  51325. get snapPointsOnly(): boolean;
  51326. /**
  51327. * Sets the snapPointsOnly flag
  51328. * @param snapToPoints should teleportation be exclusively to snap points
  51329. */
  51330. set snapPointsOnly(snapToPoints: boolean);
  51331. /**
  51332. * Add a new mesh to the floor meshes array
  51333. * @param mesh the mesh to use as floor mesh
  51334. */
  51335. addFloorMesh(mesh: AbstractMesh): void;
  51336. /**
  51337. * Add a new snap-to point to fix teleportation to this position
  51338. * @param newSnapPoint The new Snap-To point
  51339. */
  51340. addSnapPoint(newSnapPoint: Vector3): void;
  51341. attach(): boolean;
  51342. detach(): boolean;
  51343. dispose(): void;
  51344. /**
  51345. * Remove a mesh from the floor meshes array
  51346. * @param mesh the mesh to remove
  51347. */
  51348. removeFloorMesh(mesh: AbstractMesh): void;
  51349. /**
  51350. * Remove a mesh from the floor meshes array using its name
  51351. * @param name the mesh name to remove
  51352. */
  51353. removeFloorMeshByName(name: string): void;
  51354. /**
  51355. * This function will iterate through the array, searching for this point or equal to it. It will then remove it from the snap-to array
  51356. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51357. * @returns was the point found and removed or not
  51358. */
  51359. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51360. /**
  51361. * This function sets a selection feature that will be disabled when
  51362. * the forward ray is shown and will be reattached when hidden.
  51363. * This is used to remove the selection rays when moving.
  51364. * @param selectionFeature the feature to disable when forward movement is enabled
  51365. */
  51366. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51367. protected _onXRFrame(_xrFrame: XRFrame): void;
  51368. private _attachController;
  51369. private _createDefaultTargetMesh;
  51370. private _detachController;
  51371. private _findClosestSnapPointWithRadius;
  51372. private _setTargetMeshPosition;
  51373. private _setTargetMeshVisibility;
  51374. private _showParabolicPath;
  51375. private _teleportForward;
  51376. }
  51377. }
  51378. declare module "babylonjs/XR/webXRDefaultExperience" {
  51379. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51380. import { Scene } from "babylonjs/scene";
  51381. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51382. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51383. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51384. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51385. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51386. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51387. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51388. /**
  51389. * Options for the default xr helper
  51390. */
  51391. export class WebXRDefaultExperienceOptions {
  51392. /**
  51393. * Enable or disable default UI to enter XR
  51394. */
  51395. disableDefaultUI?: boolean;
  51396. /**
  51397. * Should teleportation not initialize. defaults to false.
  51398. */
  51399. disableTeleportation?: boolean;
  51400. /**
  51401. * Floor meshes that will be used for teleport
  51402. */
  51403. floorMeshes?: Array<AbstractMesh>;
  51404. /**
  51405. * If set to true, the first frame will not be used to reset position
  51406. * The first frame is mainly used when copying transformation from the old camera
  51407. * Mainly used in AR
  51408. */
  51409. ignoreNativeCameraTransformation?: boolean;
  51410. /**
  51411. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51412. */
  51413. inputOptions?: IWebXRInputOptions;
  51414. /**
  51415. * optional configuration for the output canvas
  51416. */
  51417. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51418. /**
  51419. * optional UI options. This can be used among other to change session mode and reference space type
  51420. */
  51421. uiOptions?: WebXREnterExitUIOptions;
  51422. /**
  51423. * When loading teleportation and pointer select, use stable versions instead of latest.
  51424. */
  51425. useStablePlugins?: boolean;
  51426. /**
  51427. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51428. */
  51429. renderingGroupId?: number;
  51430. /**
  51431. * A list of optional features to init the session with
  51432. * If set to true, all features we support will be added
  51433. */
  51434. optionalFeatures?: boolean | string[];
  51435. }
  51436. /**
  51437. * Default experience which provides a similar setup to the previous webVRExperience
  51438. */
  51439. export class WebXRDefaultExperience {
  51440. /**
  51441. * Base experience
  51442. */
  51443. baseExperience: WebXRExperienceHelper;
  51444. /**
  51445. * Enables ui for entering/exiting xr
  51446. */
  51447. enterExitUI: WebXREnterExitUI;
  51448. /**
  51449. * Input experience extension
  51450. */
  51451. input: WebXRInput;
  51452. /**
  51453. * Enables laser pointer and selection
  51454. */
  51455. pointerSelection: WebXRControllerPointerSelection;
  51456. /**
  51457. * Default target xr should render to
  51458. */
  51459. renderTarget: WebXRRenderTarget;
  51460. /**
  51461. * Enables teleportation
  51462. */
  51463. teleportation: WebXRMotionControllerTeleportation;
  51464. private constructor();
  51465. /**
  51466. * Creates the default xr experience
  51467. * @param scene scene
  51468. * @param options options for basic configuration
  51469. * @returns resulting WebXRDefaultExperience
  51470. */
  51471. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51472. /**
  51473. * DIsposes of the experience helper
  51474. */
  51475. dispose(): void;
  51476. }
  51477. }
  51478. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51479. import { Observable } from "babylonjs/Misc/observable";
  51480. import { Nullable } from "babylonjs/types";
  51481. import { Camera } from "babylonjs/Cameras/camera";
  51482. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51483. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51484. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51485. import { Scene } from "babylonjs/scene";
  51486. import { Vector3 } from "babylonjs/Maths/math.vector";
  51487. import { Color3 } from "babylonjs/Maths/math.color";
  51488. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51490. import { Mesh } from "babylonjs/Meshes/mesh";
  51491. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51492. import { EasingFunction } from "babylonjs/Animations/easing";
  51493. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51494. import "babylonjs/Meshes/Builders/groundBuilder";
  51495. import "babylonjs/Meshes/Builders/torusBuilder";
  51496. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51497. import "babylonjs/Gamepads/gamepadSceneComponent";
  51498. import "babylonjs/Animations/animatable";
  51499. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51500. /**
  51501. * Options to modify the vr teleportation behavior.
  51502. */
  51503. export interface VRTeleportationOptions {
  51504. /**
  51505. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51506. */
  51507. floorMeshName?: string;
  51508. /**
  51509. * A list of meshes to be used as the teleportation floor. (default: empty)
  51510. */
  51511. floorMeshes?: Mesh[];
  51512. /**
  51513. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51514. */
  51515. teleportationMode?: number;
  51516. /**
  51517. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51518. */
  51519. teleportationTime?: number;
  51520. /**
  51521. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51522. */
  51523. teleportationSpeed?: number;
  51524. /**
  51525. * The easing function used in the animation or null for Linear. (default CircleEase)
  51526. */
  51527. easingFunction?: EasingFunction;
  51528. }
  51529. /**
  51530. * Options to modify the vr experience helper's behavior.
  51531. */
  51532. export interface VRExperienceHelperOptions extends WebVROptions {
  51533. /**
  51534. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51535. */
  51536. createDeviceOrientationCamera?: boolean;
  51537. /**
  51538. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51539. */
  51540. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51541. /**
  51542. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51543. */
  51544. laserToggle?: boolean;
  51545. /**
  51546. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51547. */
  51548. floorMeshes?: Mesh[];
  51549. /**
  51550. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51551. */
  51552. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51553. /**
  51554. * Defines if WebXR should be used instead of WebVR (if available)
  51555. */
  51556. useXR?: boolean;
  51557. }
  51558. /**
  51559. * Event containing information after VR has been entered
  51560. */
  51561. export class OnAfterEnteringVRObservableEvent {
  51562. /**
  51563. * If entering vr was successful
  51564. */
  51565. success: boolean;
  51566. }
  51567. /**
  51568. * Helps to quickly add VR support to an existing scene.
  51569. * See https://doc.babylonjs.com/how_to/webvr_helper
  51570. */
  51571. export class VRExperienceHelper {
  51572. /** Options to modify the vr experience helper's behavior. */
  51573. webVROptions: VRExperienceHelperOptions;
  51574. private _scene;
  51575. private _position;
  51576. private _btnVR;
  51577. private _btnVRDisplayed;
  51578. private _webVRsupported;
  51579. private _webVRready;
  51580. private _webVRrequesting;
  51581. private _webVRpresenting;
  51582. private _hasEnteredVR;
  51583. private _fullscreenVRpresenting;
  51584. private _inputElement;
  51585. private _webVRCamera;
  51586. private _vrDeviceOrientationCamera;
  51587. private _deviceOrientationCamera;
  51588. private _existingCamera;
  51589. private _onKeyDown;
  51590. private _onVrDisplayPresentChange;
  51591. private _onVRDisplayChanged;
  51592. private _onVRRequestPresentStart;
  51593. private _onVRRequestPresentComplete;
  51594. /**
  51595. * 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)
  51596. */
  51597. enableGazeEvenWhenNoPointerLock: boolean;
  51598. /**
  51599. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51600. */
  51601. exitVROnDoubleTap: boolean;
  51602. /**
  51603. * Observable raised right before entering VR.
  51604. */
  51605. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51606. /**
  51607. * Observable raised when entering VR has completed.
  51608. */
  51609. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51610. /**
  51611. * Observable raised when exiting VR.
  51612. */
  51613. onExitingVRObservable: Observable<VRExperienceHelper>;
  51614. /**
  51615. * Observable raised when controller mesh is loaded.
  51616. */
  51617. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51618. /** Return this.onEnteringVRObservable
  51619. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51620. */
  51621. get onEnteringVR(): Observable<VRExperienceHelper>;
  51622. /** Return this.onExitingVRObservable
  51623. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51624. */
  51625. get onExitingVR(): Observable<VRExperienceHelper>;
  51626. /** Return this.onControllerMeshLoadedObservable
  51627. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51628. */
  51629. get onControllerMeshLoaded(): Observable<WebVRController>;
  51630. private _rayLength;
  51631. private _useCustomVRButton;
  51632. private _teleportationRequested;
  51633. private _teleportActive;
  51634. private _floorMeshName;
  51635. private _floorMeshesCollection;
  51636. private _teleportationMode;
  51637. private _teleportationTime;
  51638. private _teleportationSpeed;
  51639. private _teleportationEasing;
  51640. private _rotationAllowed;
  51641. private _teleportBackwardsVector;
  51642. private _teleportationTarget;
  51643. private _isDefaultTeleportationTarget;
  51644. private _postProcessMove;
  51645. private _teleportationFillColor;
  51646. private _teleportationBorderColor;
  51647. private _rotationAngle;
  51648. private _haloCenter;
  51649. private _cameraGazer;
  51650. private _padSensibilityUp;
  51651. private _padSensibilityDown;
  51652. private _leftController;
  51653. private _rightController;
  51654. private _gazeColor;
  51655. private _laserColor;
  51656. private _pickedLaserColor;
  51657. private _pickedGazeColor;
  51658. /**
  51659. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51660. */
  51661. onNewMeshSelected: Observable<AbstractMesh>;
  51662. /**
  51663. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51664. * This observable will provide the mesh and the controller used to select the mesh
  51665. */
  51666. onMeshSelectedWithController: Observable<{
  51667. mesh: AbstractMesh;
  51668. controller: WebVRController;
  51669. }>;
  51670. /**
  51671. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51672. */
  51673. onNewMeshPicked: Observable<PickingInfo>;
  51674. private _circleEase;
  51675. /**
  51676. * Observable raised before camera teleportation
  51677. */
  51678. onBeforeCameraTeleport: Observable<Vector3>;
  51679. /**
  51680. * Observable raised after camera teleportation
  51681. */
  51682. onAfterCameraTeleport: Observable<Vector3>;
  51683. /**
  51684. * Observable raised when current selected mesh gets unselected
  51685. */
  51686. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51687. private _raySelectionPredicate;
  51688. /**
  51689. * To be optionaly changed by user to define custom ray selection
  51690. */
  51691. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51692. /**
  51693. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51694. */
  51695. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51696. /**
  51697. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51698. */
  51699. teleportationEnabled: boolean;
  51700. private _defaultHeight;
  51701. private _teleportationInitialized;
  51702. private _interactionsEnabled;
  51703. private _interactionsRequested;
  51704. private _displayGaze;
  51705. private _displayLaserPointer;
  51706. /**
  51707. * The mesh used to display where the user is going to teleport.
  51708. */
  51709. get teleportationTarget(): Mesh;
  51710. /**
  51711. * Sets the mesh to be used to display where the user is going to teleport.
  51712. */
  51713. set teleportationTarget(value: Mesh);
  51714. /**
  51715. * 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
  51716. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51717. * See https://doc.babylonjs.com/resources/baking_transformations
  51718. */
  51719. get gazeTrackerMesh(): Mesh;
  51720. set gazeTrackerMesh(value: Mesh);
  51721. /**
  51722. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51723. */
  51724. updateGazeTrackerScale: boolean;
  51725. /**
  51726. * If the gaze trackers color should be updated when selecting meshes
  51727. */
  51728. updateGazeTrackerColor: boolean;
  51729. /**
  51730. * If the controller laser color should be updated when selecting meshes
  51731. */
  51732. updateControllerLaserColor: boolean;
  51733. /**
  51734. * The gaze tracking mesh corresponding to the left controller
  51735. */
  51736. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51737. /**
  51738. * The gaze tracking mesh corresponding to the right controller
  51739. */
  51740. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51741. /**
  51742. * If the ray of the gaze should be displayed.
  51743. */
  51744. get displayGaze(): boolean;
  51745. /**
  51746. * Sets if the ray of the gaze should be displayed.
  51747. */
  51748. set displayGaze(value: boolean);
  51749. /**
  51750. * If the ray of the LaserPointer should be displayed.
  51751. */
  51752. get displayLaserPointer(): boolean;
  51753. /**
  51754. * Sets if the ray of the LaserPointer should be displayed.
  51755. */
  51756. set displayLaserPointer(value: boolean);
  51757. /**
  51758. * The deviceOrientationCamera used as the camera when not in VR.
  51759. */
  51760. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51761. /**
  51762. * Based on the current WebVR support, returns the current VR camera used.
  51763. */
  51764. get currentVRCamera(): Nullable<Camera>;
  51765. /**
  51766. * The webVRCamera which is used when in VR.
  51767. */
  51768. get webVRCamera(): WebVRFreeCamera;
  51769. /**
  51770. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51771. */
  51772. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51773. /**
  51774. * The html button that is used to trigger entering into VR.
  51775. */
  51776. get vrButton(): Nullable<HTMLButtonElement>;
  51777. private get _teleportationRequestInitiated();
  51778. /**
  51779. * Defines whether or not Pointer lock should be requested when switching to
  51780. * full screen.
  51781. */
  51782. requestPointerLockOnFullScreen: boolean;
  51783. /**
  51784. * If asking to force XR, this will be populated with the default xr experience
  51785. */
  51786. xr: WebXRDefaultExperience;
  51787. /**
  51788. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51789. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51790. */
  51791. xrTestDone: boolean;
  51792. /**
  51793. * Instantiates a VRExperienceHelper.
  51794. * Helps to quickly add VR support to an existing scene.
  51795. * @param scene The scene the VRExperienceHelper belongs to.
  51796. * @param webVROptions Options to modify the vr experience helper's behavior.
  51797. */
  51798. constructor(scene: Scene,
  51799. /** Options to modify the vr experience helper's behavior. */
  51800. webVROptions?: VRExperienceHelperOptions);
  51801. private completeVRInit;
  51802. private _onDefaultMeshLoaded;
  51803. private _onResize;
  51804. private _onFullscreenChange;
  51805. /**
  51806. * Gets a value indicating if we are currently in VR mode.
  51807. */
  51808. get isInVRMode(): boolean;
  51809. private onVrDisplayPresentChange;
  51810. private onVRDisplayChanged;
  51811. private moveButtonToBottomRight;
  51812. private displayVRButton;
  51813. private updateButtonVisibility;
  51814. private _cachedAngularSensibility;
  51815. /**
  51816. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51817. * Otherwise, will use the fullscreen API.
  51818. */
  51819. enterVR(): void;
  51820. /**
  51821. * Attempt to exit VR, or fullscreen.
  51822. */
  51823. exitVR(): void;
  51824. /**
  51825. * The position of the vr experience helper.
  51826. */
  51827. get position(): Vector3;
  51828. /**
  51829. * Sets the position of the vr experience helper.
  51830. */
  51831. set position(value: Vector3);
  51832. /**
  51833. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51834. */
  51835. enableInteractions(): void;
  51836. private get _noControllerIsActive();
  51837. private beforeRender;
  51838. private _isTeleportationFloor;
  51839. /**
  51840. * Adds a floor mesh to be used for teleportation.
  51841. * @param floorMesh the mesh to be used for teleportation.
  51842. */
  51843. addFloorMesh(floorMesh: Mesh): void;
  51844. /**
  51845. * Removes a floor mesh from being used for teleportation.
  51846. * @param floorMesh the mesh to be removed.
  51847. */
  51848. removeFloorMesh(floorMesh: Mesh): void;
  51849. /**
  51850. * Enables interactions and teleportation using the VR controllers and gaze.
  51851. * @param vrTeleportationOptions options to modify teleportation behavior.
  51852. */
  51853. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51854. private _onNewGamepadConnected;
  51855. private _tryEnableInteractionOnController;
  51856. private _onNewGamepadDisconnected;
  51857. private _enableInteractionOnController;
  51858. private _checkTeleportWithRay;
  51859. private _checkRotate;
  51860. private _checkTeleportBackwards;
  51861. private _enableTeleportationOnController;
  51862. private _createTeleportationCircles;
  51863. private _displayTeleportationTarget;
  51864. private _hideTeleportationTarget;
  51865. private _rotateCamera;
  51866. private _moveTeleportationSelectorTo;
  51867. private _workingVector;
  51868. private _workingQuaternion;
  51869. private _workingMatrix;
  51870. /**
  51871. * Time Constant Teleportation Mode
  51872. */
  51873. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51874. /**
  51875. * Speed Constant Teleportation Mode
  51876. */
  51877. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51878. /**
  51879. * Teleports the users feet to the desired location
  51880. * @param location The location where the user's feet should be placed
  51881. */
  51882. teleportCamera(location: Vector3): void;
  51883. private _convertNormalToDirectionOfRay;
  51884. private _castRayAndSelectObject;
  51885. private _notifySelectedMeshUnselected;
  51886. /**
  51887. * Permanently set new colors for the laser pointer
  51888. * @param color the new laser color
  51889. * @param pickedColor the new laser color when picked mesh detected
  51890. */
  51891. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51892. /**
  51893. * Set lighting enabled / disabled on the laser pointer of both controllers
  51894. * @param enabled should the lighting be enabled on the laser pointer
  51895. */
  51896. setLaserLightingState(enabled?: boolean): void;
  51897. /**
  51898. * Permanently set new colors for the gaze pointer
  51899. * @param color the new gaze color
  51900. * @param pickedColor the new gaze color when picked mesh detected
  51901. */
  51902. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51903. /**
  51904. * Sets the color of the laser ray from the vr controllers.
  51905. * @param color new color for the ray.
  51906. */
  51907. changeLaserColor(color: Color3): void;
  51908. /**
  51909. * Sets the color of the ray from the vr headsets gaze.
  51910. * @param color new color for the ray.
  51911. */
  51912. changeGazeColor(color: Color3): void;
  51913. /**
  51914. * Exits VR and disposes of the vr experience helper
  51915. */
  51916. dispose(): void;
  51917. /**
  51918. * Gets the name of the VRExperienceHelper class
  51919. * @returns "VRExperienceHelper"
  51920. */
  51921. getClassName(): string;
  51922. }
  51923. }
  51924. declare module "babylonjs/Cameras/VR/index" {
  51925. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51926. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51927. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51928. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51929. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51930. export * from "babylonjs/Cameras/VR/webVRCamera";
  51931. }
  51932. declare module "babylonjs/Cameras/RigModes/index" {
  51933. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51934. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51935. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51936. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51937. }
  51938. declare module "babylonjs/Cameras/index" {
  51939. export * from "babylonjs/Cameras/Inputs/index";
  51940. export * from "babylonjs/Cameras/cameraInputsManager";
  51941. export * from "babylonjs/Cameras/camera";
  51942. export * from "babylonjs/Cameras/targetCamera";
  51943. export * from "babylonjs/Cameras/freeCamera";
  51944. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51945. export * from "babylonjs/Cameras/touchCamera";
  51946. export * from "babylonjs/Cameras/arcRotateCamera";
  51947. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51948. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51949. export * from "babylonjs/Cameras/flyCamera";
  51950. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51951. export * from "babylonjs/Cameras/followCamera";
  51952. export * from "babylonjs/Cameras/followCameraInputsManager";
  51953. export * from "babylonjs/Cameras/gamepadCamera";
  51954. export * from "babylonjs/Cameras/Stereoscopic/index";
  51955. export * from "babylonjs/Cameras/universalCamera";
  51956. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51957. export * from "babylonjs/Cameras/VR/index";
  51958. export * from "babylonjs/Cameras/RigModes/index";
  51959. }
  51960. declare module "babylonjs/Collisions/index" {
  51961. export * from "babylonjs/Collisions/collider";
  51962. export * from "babylonjs/Collisions/collisionCoordinator";
  51963. export * from "babylonjs/Collisions/pickingInfo";
  51964. export * from "babylonjs/Collisions/intersectionInfo";
  51965. export * from "babylonjs/Collisions/meshCollisionData";
  51966. }
  51967. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51968. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51969. import { Vector3 } from "babylonjs/Maths/math.vector";
  51970. import { Ray } from "babylonjs/Culling/ray";
  51971. import { Plane } from "babylonjs/Maths/math.plane";
  51972. /**
  51973. * Contains an array of blocks representing the octree
  51974. */
  51975. export interface IOctreeContainer<T> {
  51976. /**
  51977. * Blocks within the octree
  51978. */
  51979. blocks: Array<OctreeBlock<T>>;
  51980. }
  51981. /**
  51982. * Class used to store a cell in an octree
  51983. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51984. */
  51985. export class OctreeBlock<T> {
  51986. /**
  51987. * Gets the content of the current block
  51988. */
  51989. entries: T[];
  51990. /**
  51991. * Gets the list of block children
  51992. */
  51993. blocks: Array<OctreeBlock<T>>;
  51994. private _depth;
  51995. private _maxDepth;
  51996. private _capacity;
  51997. private _minPoint;
  51998. private _maxPoint;
  51999. private _boundingVectors;
  52000. private _creationFunc;
  52001. /**
  52002. * Creates a new block
  52003. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  52004. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  52005. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52006. * @param depth defines the current depth of this block in the octree
  52007. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  52008. * @param creationFunc defines a callback to call when an element is added to the block
  52009. */
  52010. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52011. /**
  52012. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52013. */
  52014. get capacity(): number;
  52015. /**
  52016. * Gets the minimum vector (in world space) of the block's bounding box
  52017. */
  52018. get minPoint(): Vector3;
  52019. /**
  52020. * Gets the maximum vector (in world space) of the block's bounding box
  52021. */
  52022. get maxPoint(): Vector3;
  52023. /**
  52024. * Add a new element to this block
  52025. * @param entry defines the element to add
  52026. */
  52027. addEntry(entry: T): void;
  52028. /**
  52029. * Remove an element from this block
  52030. * @param entry defines the element to remove
  52031. */
  52032. removeEntry(entry: T): void;
  52033. /**
  52034. * Add an array of elements to this block
  52035. * @param entries defines the array of elements to add
  52036. */
  52037. addEntries(entries: T[]): void;
  52038. /**
  52039. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52040. * @param frustumPlanes defines the frustum planes to test
  52041. * @param selection defines the array to store current content if selection is positive
  52042. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52043. */
  52044. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52045. /**
  52046. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52047. * @param sphereCenter defines the bounding sphere center
  52048. * @param sphereRadius defines the bounding sphere radius
  52049. * @param selection defines the array to store current content if selection is positive
  52050. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52051. */
  52052. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52053. /**
  52054. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52055. * @param ray defines the ray to test with
  52056. * @param selection defines the array to store current content if selection is positive
  52057. */
  52058. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52059. /**
  52060. * Subdivide the content into child blocks (this block will then be empty)
  52061. */
  52062. createInnerBlocks(): void;
  52063. /**
  52064. * @hidden
  52065. */
  52066. 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;
  52067. }
  52068. }
  52069. declare module "babylonjs/Culling/Octrees/octree" {
  52070. import { SmartArray } from "babylonjs/Misc/smartArray";
  52071. import { Vector3 } from "babylonjs/Maths/math.vector";
  52072. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52073. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52074. import { Ray } from "babylonjs/Culling/ray";
  52075. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52076. import { Plane } from "babylonjs/Maths/math.plane";
  52077. /**
  52078. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52079. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52080. */
  52081. export class Octree<T> {
  52082. /** 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.) */
  52083. maxDepth: number;
  52084. /**
  52085. * Blocks within the octree containing objects
  52086. */
  52087. blocks: Array<OctreeBlock<T>>;
  52088. /**
  52089. * Content stored in the octree
  52090. */
  52091. dynamicContent: T[];
  52092. private _maxBlockCapacity;
  52093. private _selectionContent;
  52094. private _creationFunc;
  52095. /**
  52096. * Creates a octree
  52097. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52098. * @param creationFunc function to be used to instatiate the octree
  52099. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52100. * @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.)
  52101. */
  52102. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52103. /** 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.) */
  52104. maxDepth?: number);
  52105. /**
  52106. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52107. * @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);
  52108. * @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);
  52109. * @param entries meshes to be added to the octree blocks
  52110. */
  52111. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52112. /**
  52113. * Adds a mesh to the octree
  52114. * @param entry Mesh to add to the octree
  52115. */
  52116. addMesh(entry: T): void;
  52117. /**
  52118. * Remove an element from the octree
  52119. * @param entry defines the element to remove
  52120. */
  52121. removeMesh(entry: T): void;
  52122. /**
  52123. * Selects an array of meshes within the frustum
  52124. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52125. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52126. * @returns array of meshes within the frustum
  52127. */
  52128. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52129. /**
  52130. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52131. * @param sphereCenter defines the bounding sphere center
  52132. * @param sphereRadius defines the bounding sphere radius
  52133. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52134. * @returns an array of objects that intersect the sphere
  52135. */
  52136. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52137. /**
  52138. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52139. * @param ray defines the ray to test with
  52140. * @returns array of intersected objects
  52141. */
  52142. intersectsRay(ray: Ray): SmartArray<T>;
  52143. /**
  52144. * Adds a mesh into the octree block if it intersects the block
  52145. */
  52146. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52147. /**
  52148. * Adds a submesh into the octree block if it intersects the block
  52149. */
  52150. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52151. }
  52152. }
  52153. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52154. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52155. import { Scene } from "babylonjs/scene";
  52156. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52157. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52158. import { Ray } from "babylonjs/Culling/ray";
  52159. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52160. import { Collider } from "babylonjs/Collisions/collider";
  52161. module "babylonjs/scene" {
  52162. interface Scene {
  52163. /**
  52164. * @hidden
  52165. * Backing Filed
  52166. */
  52167. _selectionOctree: Octree<AbstractMesh>;
  52168. /**
  52169. * Gets the octree used to boost mesh selection (picking)
  52170. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52171. */
  52172. selectionOctree: Octree<AbstractMesh>;
  52173. /**
  52174. * Creates or updates the octree used to boost selection (picking)
  52175. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52176. * @param maxCapacity defines the maximum capacity per leaf
  52177. * @param maxDepth defines the maximum depth of the octree
  52178. * @returns an octree of AbstractMesh
  52179. */
  52180. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52181. }
  52182. }
  52183. module "babylonjs/Meshes/abstractMesh" {
  52184. interface AbstractMesh {
  52185. /**
  52186. * @hidden
  52187. * Backing Field
  52188. */
  52189. _submeshesOctree: Octree<SubMesh>;
  52190. /**
  52191. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52192. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52193. * @param maxCapacity defines the maximum size of each block (64 by default)
  52194. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52195. * @returns the new octree
  52196. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52197. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52198. */
  52199. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52200. }
  52201. }
  52202. /**
  52203. * Defines the octree scene component responsible to manage any octrees
  52204. * in a given scene.
  52205. */
  52206. export class OctreeSceneComponent {
  52207. /**
  52208. * The component name help to identify the component in the list of scene components.
  52209. */
  52210. readonly name: string;
  52211. /**
  52212. * The scene the component belongs to.
  52213. */
  52214. scene: Scene;
  52215. /**
  52216. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52217. */
  52218. readonly checksIsEnabled: boolean;
  52219. /**
  52220. * Creates a new instance of the component for the given scene
  52221. * @param scene Defines the scene to register the component in
  52222. */
  52223. constructor(scene: Scene);
  52224. /**
  52225. * Registers the component in a given scene
  52226. */
  52227. register(): void;
  52228. /**
  52229. * Return the list of active meshes
  52230. * @returns the list of active meshes
  52231. */
  52232. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52233. /**
  52234. * Return the list of active sub meshes
  52235. * @param mesh The mesh to get the candidates sub meshes from
  52236. * @returns the list of active sub meshes
  52237. */
  52238. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52239. private _tempRay;
  52240. /**
  52241. * Return the list of sub meshes intersecting with a given local ray
  52242. * @param mesh defines the mesh to find the submesh for
  52243. * @param localRay defines the ray in local space
  52244. * @returns the list of intersecting sub meshes
  52245. */
  52246. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52247. /**
  52248. * Return the list of sub meshes colliding with a collider
  52249. * @param mesh defines the mesh to find the submesh for
  52250. * @param collider defines the collider to evaluate the collision against
  52251. * @returns the list of colliding sub meshes
  52252. */
  52253. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52254. /**
  52255. * Rebuilds the elements related to this component in case of
  52256. * context lost for instance.
  52257. */
  52258. rebuild(): void;
  52259. /**
  52260. * Disposes the component and the associated ressources.
  52261. */
  52262. dispose(): void;
  52263. }
  52264. }
  52265. declare module "babylonjs/Culling/Octrees/index" {
  52266. export * from "babylonjs/Culling/Octrees/octree";
  52267. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52268. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52269. }
  52270. declare module "babylonjs/Culling/index" {
  52271. export * from "babylonjs/Culling/boundingBox";
  52272. export * from "babylonjs/Culling/boundingInfo";
  52273. export * from "babylonjs/Culling/boundingSphere";
  52274. export * from "babylonjs/Culling/Octrees/index";
  52275. export * from "babylonjs/Culling/ray";
  52276. }
  52277. declare module "babylonjs/Gizmos/gizmo" {
  52278. import { Nullable } from "babylonjs/types";
  52279. import { IDisposable } from "babylonjs/scene";
  52280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52281. import { Mesh } from "babylonjs/Meshes/mesh";
  52282. import { Node } from "babylonjs/node";
  52283. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52284. /**
  52285. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52286. */
  52287. export class Gizmo implements IDisposable {
  52288. /** The utility layer the gizmo will be added to */
  52289. gizmoLayer: UtilityLayerRenderer;
  52290. /**
  52291. * The root mesh of the gizmo
  52292. */
  52293. _rootMesh: Mesh;
  52294. private _attachedMesh;
  52295. private _attachedNode;
  52296. /**
  52297. * Ratio for the scale of the gizmo (Default: 1)
  52298. */
  52299. protected _scaleRatio: number;
  52300. /**
  52301. * Ratio for the scale of the gizmo (Default: 1)
  52302. */
  52303. set scaleRatio(value: number);
  52304. get scaleRatio(): number;
  52305. /**
  52306. * If a custom mesh has been set (Default: false)
  52307. */
  52308. protected _customMeshSet: boolean;
  52309. /**
  52310. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52311. * * When set, interactions will be enabled
  52312. */
  52313. get attachedMesh(): Nullable<AbstractMesh>;
  52314. set attachedMesh(value: Nullable<AbstractMesh>);
  52315. /**
  52316. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52317. * * When set, interactions will be enabled
  52318. */
  52319. get attachedNode(): Nullable<Node>;
  52320. set attachedNode(value: Nullable<Node>);
  52321. /**
  52322. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52323. * @param mesh The mesh to replace the default mesh of the gizmo
  52324. */
  52325. setCustomMesh(mesh: Mesh): void;
  52326. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52327. /**
  52328. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52329. */
  52330. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52331. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52332. /**
  52333. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52334. */
  52335. updateGizmoPositionToMatchAttachedMesh: boolean;
  52336. /**
  52337. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52338. */
  52339. updateScale: boolean;
  52340. protected _interactionsEnabled: boolean;
  52341. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52342. private _beforeRenderObserver;
  52343. private _tempQuaternion;
  52344. private _tempVector;
  52345. private _tempVector2;
  52346. private _tempMatrix1;
  52347. private _tempMatrix2;
  52348. private _rightHandtoLeftHandMatrix;
  52349. /**
  52350. * Creates a gizmo
  52351. * @param gizmoLayer The utility layer the gizmo will be added to
  52352. */
  52353. constructor(
  52354. /** The utility layer the gizmo will be added to */
  52355. gizmoLayer?: UtilityLayerRenderer);
  52356. /**
  52357. * Updates the gizmo to match the attached mesh's position/rotation
  52358. */
  52359. protected _update(): void;
  52360. /**
  52361. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52362. * @param value Node, TransformNode or mesh
  52363. */
  52364. protected _matrixChanged(): void;
  52365. /**
  52366. * Disposes of the gizmo
  52367. */
  52368. dispose(): void;
  52369. }
  52370. }
  52371. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52372. import { Observable } from "babylonjs/Misc/observable";
  52373. import { Nullable } from "babylonjs/types";
  52374. import { Vector3 } from "babylonjs/Maths/math.vector";
  52375. import { Color3 } from "babylonjs/Maths/math.color";
  52376. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52377. import { Node } from "babylonjs/node";
  52378. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52379. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52380. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52381. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52382. import { Scene } from "babylonjs/scene";
  52383. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52384. /**
  52385. * Single plane drag gizmo
  52386. */
  52387. export class PlaneDragGizmo extends Gizmo {
  52388. /**
  52389. * Drag behavior responsible for the gizmos dragging interactions
  52390. */
  52391. dragBehavior: PointerDragBehavior;
  52392. private _pointerObserver;
  52393. /**
  52394. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52395. */
  52396. snapDistance: number;
  52397. /**
  52398. * Event that fires each time the gizmo snaps to a new location.
  52399. * * snapDistance is the the change in distance
  52400. */
  52401. onSnapObservable: Observable<{
  52402. snapDistance: number;
  52403. }>;
  52404. private _plane;
  52405. private _coloredMaterial;
  52406. private _hoverMaterial;
  52407. private _isEnabled;
  52408. private _parent;
  52409. /** @hidden */
  52410. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52411. /** @hidden */
  52412. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52413. /**
  52414. * Creates a PlaneDragGizmo
  52415. * @param gizmoLayer The utility layer the gizmo will be added to
  52416. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52417. * @param color The color of the gizmo
  52418. */
  52419. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52420. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52421. /**
  52422. * If the gizmo is enabled
  52423. */
  52424. set isEnabled(value: boolean);
  52425. get isEnabled(): boolean;
  52426. /**
  52427. * Disposes of the gizmo
  52428. */
  52429. dispose(): void;
  52430. }
  52431. }
  52432. declare module "babylonjs/Gizmos/positionGizmo" {
  52433. import { Observable } from "babylonjs/Misc/observable";
  52434. import { Nullable } from "babylonjs/types";
  52435. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52436. import { Node } from "babylonjs/node";
  52437. import { Mesh } from "babylonjs/Meshes/mesh";
  52438. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52439. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52440. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52441. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52442. /**
  52443. * Gizmo that enables dragging a mesh along 3 axis
  52444. */
  52445. export class PositionGizmo extends Gizmo {
  52446. /**
  52447. * Internal gizmo used for interactions on the x axis
  52448. */
  52449. xGizmo: AxisDragGizmo;
  52450. /**
  52451. * Internal gizmo used for interactions on the y axis
  52452. */
  52453. yGizmo: AxisDragGizmo;
  52454. /**
  52455. * Internal gizmo used for interactions on the z axis
  52456. */
  52457. zGizmo: AxisDragGizmo;
  52458. /**
  52459. * Internal gizmo used for interactions on the yz plane
  52460. */
  52461. xPlaneGizmo: PlaneDragGizmo;
  52462. /**
  52463. * Internal gizmo used for interactions on the xz plane
  52464. */
  52465. yPlaneGizmo: PlaneDragGizmo;
  52466. /**
  52467. * Internal gizmo used for interactions on the xy plane
  52468. */
  52469. zPlaneGizmo: PlaneDragGizmo;
  52470. /**
  52471. * private variables
  52472. */
  52473. private _meshAttached;
  52474. private _nodeAttached;
  52475. private _snapDistance;
  52476. /** Fires an event when any of it's sub gizmos are dragged */
  52477. onDragStartObservable: Observable<unknown>;
  52478. /** Fires an event when any of it's sub gizmos are released from dragging */
  52479. onDragEndObservable: Observable<unknown>;
  52480. /**
  52481. * If set to true, planar drag is enabled
  52482. */
  52483. private _planarGizmoEnabled;
  52484. get attachedMesh(): Nullable<AbstractMesh>;
  52485. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52486. get attachedNode(): Nullable<Node>;
  52487. set attachedNode(node: Nullable<Node>);
  52488. /**
  52489. * Creates a PositionGizmo
  52490. * @param gizmoLayer The utility layer the gizmo will be added to
  52491. @param thickness display gizmo axis thickness
  52492. */
  52493. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52494. /**
  52495. * If the planar drag gizmo is enabled
  52496. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52497. */
  52498. set planarGizmoEnabled(value: boolean);
  52499. get planarGizmoEnabled(): boolean;
  52500. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52501. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52502. /**
  52503. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52504. */
  52505. set snapDistance(value: number);
  52506. get snapDistance(): number;
  52507. /**
  52508. * Ratio for the scale of the gizmo (Default: 1)
  52509. */
  52510. set scaleRatio(value: number);
  52511. get scaleRatio(): number;
  52512. /**
  52513. * Disposes of the gizmo
  52514. */
  52515. dispose(): void;
  52516. /**
  52517. * CustomMeshes are not supported by this gizmo
  52518. * @param mesh The mesh to replace the default mesh of the gizmo
  52519. */
  52520. setCustomMesh(mesh: Mesh): void;
  52521. }
  52522. }
  52523. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52524. import { Observable } from "babylonjs/Misc/observable";
  52525. import { Nullable } from "babylonjs/types";
  52526. import { Vector3 } from "babylonjs/Maths/math.vector";
  52527. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52528. import { Node } from "babylonjs/node";
  52529. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52530. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52531. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52532. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52533. import { Scene } from "babylonjs/scene";
  52534. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52535. import { Color3 } from "babylonjs/Maths/math.color";
  52536. /**
  52537. * Single axis drag gizmo
  52538. */
  52539. export class AxisDragGizmo extends Gizmo {
  52540. /**
  52541. * Drag behavior responsible for the gizmos dragging interactions
  52542. */
  52543. dragBehavior: PointerDragBehavior;
  52544. private _pointerObserver;
  52545. /**
  52546. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52547. */
  52548. snapDistance: number;
  52549. /**
  52550. * Event that fires each time the gizmo snaps to a new location.
  52551. * * snapDistance is the the change in distance
  52552. */
  52553. onSnapObservable: Observable<{
  52554. snapDistance: number;
  52555. }>;
  52556. private _isEnabled;
  52557. private _parent;
  52558. private _arrow;
  52559. private _coloredMaterial;
  52560. private _hoverMaterial;
  52561. /** @hidden */
  52562. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52563. /** @hidden */
  52564. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52565. /**
  52566. * Creates an AxisDragGizmo
  52567. * @param gizmoLayer The utility layer the gizmo will be added to
  52568. * @param dragAxis The axis which the gizmo will be able to drag on
  52569. * @param color The color of the gizmo
  52570. * @param thickness display gizmo axis thickness
  52571. */
  52572. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52573. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52574. /**
  52575. * If the gizmo is enabled
  52576. */
  52577. set isEnabled(value: boolean);
  52578. get isEnabled(): boolean;
  52579. /**
  52580. * Disposes of the gizmo
  52581. */
  52582. dispose(): void;
  52583. }
  52584. }
  52585. declare module "babylonjs/Debug/axesViewer" {
  52586. import { Vector3 } from "babylonjs/Maths/math.vector";
  52587. import { Nullable } from "babylonjs/types";
  52588. import { Scene } from "babylonjs/scene";
  52589. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52590. /**
  52591. * The Axes viewer will show 3 axes in a specific point in space
  52592. */
  52593. export class AxesViewer {
  52594. private _xAxis;
  52595. private _yAxis;
  52596. private _zAxis;
  52597. private _scaleLinesFactor;
  52598. private _instanced;
  52599. /**
  52600. * Gets the hosting scene
  52601. */
  52602. scene: Nullable<Scene>;
  52603. /**
  52604. * Gets or sets a number used to scale line length
  52605. */
  52606. scaleLines: number;
  52607. /** Gets the node hierarchy used to render x-axis */
  52608. get xAxis(): TransformNode;
  52609. /** Gets the node hierarchy used to render y-axis */
  52610. get yAxis(): TransformNode;
  52611. /** Gets the node hierarchy used to render z-axis */
  52612. get zAxis(): TransformNode;
  52613. /**
  52614. * Creates a new AxesViewer
  52615. * @param scene defines the hosting scene
  52616. * @param scaleLines defines a number used to scale line length (1 by default)
  52617. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52618. * @param xAxis defines the node hierarchy used to render the x-axis
  52619. * @param yAxis defines the node hierarchy used to render the y-axis
  52620. * @param zAxis defines the node hierarchy used to render the z-axis
  52621. */
  52622. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52623. /**
  52624. * Force the viewer to update
  52625. * @param position defines the position of the viewer
  52626. * @param xaxis defines the x axis of the viewer
  52627. * @param yaxis defines the y axis of the viewer
  52628. * @param zaxis defines the z axis of the viewer
  52629. */
  52630. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52631. /**
  52632. * Creates an instance of this axes viewer.
  52633. * @returns a new axes viewer with instanced meshes
  52634. */
  52635. createInstance(): AxesViewer;
  52636. /** Releases resources */
  52637. dispose(): void;
  52638. private static _SetRenderingGroupId;
  52639. }
  52640. }
  52641. declare module "babylonjs/Debug/boneAxesViewer" {
  52642. import { Nullable } from "babylonjs/types";
  52643. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52644. import { Vector3 } from "babylonjs/Maths/math.vector";
  52645. import { Mesh } from "babylonjs/Meshes/mesh";
  52646. import { Bone } from "babylonjs/Bones/bone";
  52647. import { Scene } from "babylonjs/scene";
  52648. /**
  52649. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52650. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52651. */
  52652. export class BoneAxesViewer extends AxesViewer {
  52653. /**
  52654. * Gets or sets the target mesh where to display the axes viewer
  52655. */
  52656. mesh: Nullable<Mesh>;
  52657. /**
  52658. * Gets or sets the target bone where to display the axes viewer
  52659. */
  52660. bone: Nullable<Bone>;
  52661. /** Gets current position */
  52662. pos: Vector3;
  52663. /** Gets direction of X axis */
  52664. xaxis: Vector3;
  52665. /** Gets direction of Y axis */
  52666. yaxis: Vector3;
  52667. /** Gets direction of Z axis */
  52668. zaxis: Vector3;
  52669. /**
  52670. * Creates a new BoneAxesViewer
  52671. * @param scene defines the hosting scene
  52672. * @param bone defines the target bone
  52673. * @param mesh defines the target mesh
  52674. * @param scaleLines defines a scaling factor for line length (1 by default)
  52675. */
  52676. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52677. /**
  52678. * Force the viewer to update
  52679. */
  52680. update(): void;
  52681. /** Releases resources */
  52682. dispose(): void;
  52683. }
  52684. }
  52685. declare module "babylonjs/Debug/debugLayer" {
  52686. import { Scene } from "babylonjs/scene";
  52687. /**
  52688. * Interface used to define scene explorer extensibility option
  52689. */
  52690. export interface IExplorerExtensibilityOption {
  52691. /**
  52692. * Define the option label
  52693. */
  52694. label: string;
  52695. /**
  52696. * Defines the action to execute on click
  52697. */
  52698. action: (entity: any) => void;
  52699. }
  52700. /**
  52701. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52702. */
  52703. export interface IExplorerExtensibilityGroup {
  52704. /**
  52705. * Defines a predicate to test if a given type mut be extended
  52706. */
  52707. predicate: (entity: any) => boolean;
  52708. /**
  52709. * Gets the list of options added to a type
  52710. */
  52711. entries: IExplorerExtensibilityOption[];
  52712. }
  52713. /**
  52714. * Interface used to define the options to use to create the Inspector
  52715. */
  52716. export interface IInspectorOptions {
  52717. /**
  52718. * Display in overlay mode (default: false)
  52719. */
  52720. overlay?: boolean;
  52721. /**
  52722. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52723. */
  52724. globalRoot?: HTMLElement;
  52725. /**
  52726. * Display the Scene explorer
  52727. */
  52728. showExplorer?: boolean;
  52729. /**
  52730. * Display the property inspector
  52731. */
  52732. showInspector?: boolean;
  52733. /**
  52734. * Display in embed mode (both panes on the right)
  52735. */
  52736. embedMode?: boolean;
  52737. /**
  52738. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52739. */
  52740. handleResize?: boolean;
  52741. /**
  52742. * Allow the panes to popup (default: true)
  52743. */
  52744. enablePopup?: boolean;
  52745. /**
  52746. * Allow the panes to be closed by users (default: true)
  52747. */
  52748. enableClose?: boolean;
  52749. /**
  52750. * Optional list of extensibility entries
  52751. */
  52752. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52753. /**
  52754. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52755. */
  52756. inspectorURL?: string;
  52757. /**
  52758. * Optional initial tab (default to DebugLayerTab.Properties)
  52759. */
  52760. initialTab?: DebugLayerTab;
  52761. }
  52762. module "babylonjs/scene" {
  52763. interface Scene {
  52764. /**
  52765. * @hidden
  52766. * Backing field
  52767. */
  52768. _debugLayer: DebugLayer;
  52769. /**
  52770. * Gets the debug layer (aka Inspector) associated with the scene
  52771. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52772. */
  52773. debugLayer: DebugLayer;
  52774. }
  52775. }
  52776. /**
  52777. * Enum of inspector action tab
  52778. */
  52779. export enum DebugLayerTab {
  52780. /**
  52781. * Properties tag (default)
  52782. */
  52783. Properties = 0,
  52784. /**
  52785. * Debug tab
  52786. */
  52787. Debug = 1,
  52788. /**
  52789. * Statistics tab
  52790. */
  52791. Statistics = 2,
  52792. /**
  52793. * Tools tab
  52794. */
  52795. Tools = 3,
  52796. /**
  52797. * Settings tab
  52798. */
  52799. Settings = 4
  52800. }
  52801. /**
  52802. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52803. * what is happening in your scene
  52804. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52805. */
  52806. export class DebugLayer {
  52807. /**
  52808. * Define the url to get the inspector script from.
  52809. * By default it uses the babylonjs CDN.
  52810. * @ignoreNaming
  52811. */
  52812. static InspectorURL: string;
  52813. private _scene;
  52814. private BJSINSPECTOR;
  52815. private _onPropertyChangedObservable?;
  52816. /**
  52817. * Observable triggered when a property is changed through the inspector.
  52818. */
  52819. get onPropertyChangedObservable(): any;
  52820. /**
  52821. * Instantiates a new debug layer.
  52822. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52823. * what is happening in your scene
  52824. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52825. * @param scene Defines the scene to inspect
  52826. */
  52827. constructor(scene: Scene);
  52828. /** Creates the inspector window. */
  52829. private _createInspector;
  52830. /**
  52831. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52832. * @param entity defines the entity to select
  52833. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52834. */
  52835. select(entity: any, lineContainerTitles?: string | string[]): void;
  52836. /** Get the inspector from bundle or global */
  52837. private _getGlobalInspector;
  52838. /**
  52839. * Get if the inspector is visible or not.
  52840. * @returns true if visible otherwise, false
  52841. */
  52842. isVisible(): boolean;
  52843. /**
  52844. * Hide the inspector and close its window.
  52845. */
  52846. hide(): void;
  52847. /**
  52848. * Update the scene in the inspector
  52849. */
  52850. setAsActiveScene(): void;
  52851. /**
  52852. * Launch the debugLayer.
  52853. * @param config Define the configuration of the inspector
  52854. * @return a promise fulfilled when the debug layer is visible
  52855. */
  52856. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52857. }
  52858. }
  52859. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52860. import { Nullable } from "babylonjs/types";
  52861. import { Scene } from "babylonjs/scene";
  52862. import { Vector4 } from "babylonjs/Maths/math.vector";
  52863. import { Color4 } from "babylonjs/Maths/math.color";
  52864. import { Mesh } from "babylonjs/Meshes/mesh";
  52865. /**
  52866. * Class containing static functions to help procedurally build meshes
  52867. */
  52868. export class BoxBuilder {
  52869. /**
  52870. * Creates a box mesh
  52871. * * The parameter `size` sets the size (float) of each box side (default 1)
  52872. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52873. * * 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)
  52874. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52875. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52876. * * 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
  52877. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52878. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52879. * @param name defines the name of the mesh
  52880. * @param options defines the options used to create the mesh
  52881. * @param scene defines the hosting scene
  52882. * @returns the box mesh
  52883. */
  52884. static CreateBox(name: string, options: {
  52885. size?: number;
  52886. width?: number;
  52887. height?: number;
  52888. depth?: number;
  52889. faceUV?: Vector4[];
  52890. faceColors?: Color4[];
  52891. sideOrientation?: number;
  52892. frontUVs?: Vector4;
  52893. backUVs?: Vector4;
  52894. wrap?: boolean;
  52895. topBaseAt?: number;
  52896. bottomBaseAt?: number;
  52897. updatable?: boolean;
  52898. }, scene?: Nullable<Scene>): Mesh;
  52899. }
  52900. }
  52901. declare module "babylonjs/Debug/physicsViewer" {
  52902. import { Nullable } from "babylonjs/types";
  52903. import { Scene } from "babylonjs/scene";
  52904. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52905. import { Mesh } from "babylonjs/Meshes/mesh";
  52906. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52907. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52908. /**
  52909. * Used to show the physics impostor around the specific mesh
  52910. */
  52911. export class PhysicsViewer {
  52912. /** @hidden */
  52913. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52914. /** @hidden */
  52915. protected _meshes: Array<Nullable<AbstractMesh>>;
  52916. /** @hidden */
  52917. protected _scene: Nullable<Scene>;
  52918. /** @hidden */
  52919. protected _numMeshes: number;
  52920. /** @hidden */
  52921. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52922. private _renderFunction;
  52923. private _utilityLayer;
  52924. private _debugBoxMesh;
  52925. private _debugSphereMesh;
  52926. private _debugCylinderMesh;
  52927. private _debugMaterial;
  52928. private _debugMeshMeshes;
  52929. /**
  52930. * Creates a new PhysicsViewer
  52931. * @param scene defines the hosting scene
  52932. */
  52933. constructor(scene: Scene);
  52934. /** @hidden */
  52935. protected _updateDebugMeshes(): void;
  52936. /**
  52937. * Renders a specified physic impostor
  52938. * @param impostor defines the impostor to render
  52939. * @param targetMesh defines the mesh represented by the impostor
  52940. * @returns the new debug mesh used to render the impostor
  52941. */
  52942. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52943. /**
  52944. * Hides a specified physic impostor
  52945. * @param impostor defines the impostor to hide
  52946. */
  52947. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52948. private _getDebugMaterial;
  52949. private _getDebugBoxMesh;
  52950. private _getDebugSphereMesh;
  52951. private _getDebugCylinderMesh;
  52952. private _getDebugMeshMesh;
  52953. private _getDebugMesh;
  52954. /** Releases all resources */
  52955. dispose(): void;
  52956. }
  52957. }
  52958. declare module "babylonjs/Debug/rayHelper" {
  52959. import { Nullable } from "babylonjs/types";
  52960. import { Ray } from "babylonjs/Culling/ray";
  52961. import { Vector3 } from "babylonjs/Maths/math.vector";
  52962. import { Color3 } from "babylonjs/Maths/math.color";
  52963. import { Scene } from "babylonjs/scene";
  52964. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52965. import "babylonjs/Meshes/Builders/linesBuilder";
  52966. /**
  52967. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52968. * in order to better appreciate the issue one might have.
  52969. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52970. */
  52971. export class RayHelper {
  52972. /**
  52973. * Defines the ray we are currently tryin to visualize.
  52974. */
  52975. ray: Nullable<Ray>;
  52976. private _renderPoints;
  52977. private _renderLine;
  52978. private _renderFunction;
  52979. private _scene;
  52980. private _onAfterRenderObserver;
  52981. private _onAfterStepObserver;
  52982. private _attachedToMesh;
  52983. private _meshSpaceDirection;
  52984. private _meshSpaceOrigin;
  52985. /**
  52986. * Helper function to create a colored helper in a scene in one line.
  52987. * @param ray Defines the ray we are currently tryin to visualize
  52988. * @param scene Defines the scene the ray is used in
  52989. * @param color Defines the color we want to see the ray in
  52990. * @returns The newly created ray helper.
  52991. */
  52992. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52993. /**
  52994. * Instantiate a new ray helper.
  52995. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52996. * in order to better appreciate the issue one might have.
  52997. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52998. * @param ray Defines the ray we are currently tryin to visualize
  52999. */
  53000. constructor(ray: Ray);
  53001. /**
  53002. * Shows the ray we are willing to debug.
  53003. * @param scene Defines the scene the ray needs to be rendered in
  53004. * @param color Defines the color the ray needs to be rendered in
  53005. */
  53006. show(scene: Scene, color?: Color3): void;
  53007. /**
  53008. * Hides the ray we are debugging.
  53009. */
  53010. hide(): void;
  53011. private _render;
  53012. /**
  53013. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53014. * @param mesh Defines the mesh we want the helper attached to
  53015. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53016. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53017. * @param length Defines the length of the ray
  53018. */
  53019. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53020. /**
  53021. * Detach the ray helper from the mesh it has previously been attached to.
  53022. */
  53023. detachFromMesh(): void;
  53024. private _updateToMesh;
  53025. /**
  53026. * Dispose the helper and release its associated resources.
  53027. */
  53028. dispose(): void;
  53029. }
  53030. }
  53031. declare module "babylonjs/Debug/ISkeletonViewer" {
  53032. import { Skeleton } from "babylonjs/Bones/skeleton";
  53033. import { Color3 } from "babylonjs/Maths/math.color";
  53034. /**
  53035. * Defines the options associated with the creation of a SkeletonViewer.
  53036. */
  53037. export interface ISkeletonViewerOptions {
  53038. /** Should the system pause animations before building the Viewer? */
  53039. pauseAnimations: boolean;
  53040. /** Should the system return the skeleton to rest before building? */
  53041. returnToRest: boolean;
  53042. /** public Display Mode of the Viewer */
  53043. displayMode: number;
  53044. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53045. displayOptions: ISkeletonViewerDisplayOptions;
  53046. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53047. computeBonesUsingShaders: boolean;
  53048. /** Flag ignore non weighted bones */
  53049. useAllBones: boolean;
  53050. }
  53051. /**
  53052. * Defines how to display the various bone meshes for the viewer.
  53053. */
  53054. export interface ISkeletonViewerDisplayOptions {
  53055. /** How far down to start tapering the bone spurs */
  53056. midStep?: number;
  53057. /** How big is the midStep? */
  53058. midStepFactor?: number;
  53059. /** Base for the Sphere Size */
  53060. sphereBaseSize?: number;
  53061. /** The ratio of the sphere to the longest bone in units */
  53062. sphereScaleUnit?: number;
  53063. /** Ratio for the Sphere Size */
  53064. sphereFactor?: number;
  53065. }
  53066. /**
  53067. * Defines the constructor options for the BoneWeight Shader.
  53068. */
  53069. export interface IBoneWeightShaderOptions {
  53070. /** Skeleton to Map */
  53071. skeleton: Skeleton;
  53072. /** Colors for Uninfluenced bones */
  53073. colorBase?: Color3;
  53074. /** Colors for 0.0-0.25 Weight bones */
  53075. colorZero?: Color3;
  53076. /** Color for 0.25-0.5 Weight Influence */
  53077. colorQuarter?: Color3;
  53078. /** Color for 0.5-0.75 Weight Influence */
  53079. colorHalf?: Color3;
  53080. /** Color for 0.75-1 Weight Influence */
  53081. colorFull?: Color3;
  53082. /** Color for Zero Weight Influence */
  53083. targetBoneIndex?: number;
  53084. }
  53085. /**
  53086. * Simple structure of the gradient steps for the Color Map.
  53087. */
  53088. export interface ISkeletonMapShaderColorMapKnot {
  53089. /** Color of the Knot */
  53090. color: Color3;
  53091. /** Location of the Knot */
  53092. location: number;
  53093. }
  53094. /**
  53095. * Defines the constructor options for the SkeletonMap Shader.
  53096. */
  53097. export interface ISkeletonMapShaderOptions {
  53098. /** Skeleton to Map */
  53099. skeleton: Skeleton;
  53100. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  53101. colorMap?: ISkeletonMapShaderColorMapKnot[];
  53102. }
  53103. }
  53104. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53105. import { Nullable } from "babylonjs/types";
  53106. import { Scene } from "babylonjs/scene";
  53107. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53108. import { Color4 } from "babylonjs/Maths/math.color";
  53109. import { Mesh } from "babylonjs/Meshes/mesh";
  53110. /**
  53111. * Class containing static functions to help procedurally build meshes
  53112. */
  53113. export class RibbonBuilder {
  53114. /**
  53115. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53116. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53117. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53118. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53119. * * 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
  53120. * * 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
  53121. * * 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
  53122. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53123. * * 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
  53124. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53125. * * 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
  53126. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53127. * * 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
  53128. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53129. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53130. * @param name defines the name of the mesh
  53131. * @param options defines the options used to create the mesh
  53132. * @param scene defines the hosting scene
  53133. * @returns the ribbon mesh
  53134. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53135. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53136. */
  53137. static CreateRibbon(name: string, options: {
  53138. pathArray: Vector3[][];
  53139. closeArray?: boolean;
  53140. closePath?: boolean;
  53141. offset?: number;
  53142. updatable?: boolean;
  53143. sideOrientation?: number;
  53144. frontUVs?: Vector4;
  53145. backUVs?: Vector4;
  53146. instance?: Mesh;
  53147. invertUV?: boolean;
  53148. uvs?: Vector2[];
  53149. colors?: Color4[];
  53150. }, scene?: Nullable<Scene>): Mesh;
  53151. }
  53152. }
  53153. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53154. import { Nullable } from "babylonjs/types";
  53155. import { Scene } from "babylonjs/scene";
  53156. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53157. import { Mesh } from "babylonjs/Meshes/mesh";
  53158. /**
  53159. * Class containing static functions to help procedurally build meshes
  53160. */
  53161. export class ShapeBuilder {
  53162. /**
  53163. * 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.
  53164. * * 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.
  53165. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53166. * * 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.
  53167. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53168. * * 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
  53169. * * 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
  53170. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53171. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53172. * * 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
  53173. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53174. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53175. * @param name defines the name of the mesh
  53176. * @param options defines the options used to create the mesh
  53177. * @param scene defines the hosting scene
  53178. * @returns the extruded shape mesh
  53179. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53180. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53181. */
  53182. static ExtrudeShape(name: string, options: {
  53183. shape: Vector3[];
  53184. path: Vector3[];
  53185. scale?: number;
  53186. rotation?: number;
  53187. cap?: number;
  53188. updatable?: boolean;
  53189. sideOrientation?: number;
  53190. frontUVs?: Vector4;
  53191. backUVs?: Vector4;
  53192. instance?: Mesh;
  53193. invertUV?: boolean;
  53194. }, scene?: Nullable<Scene>): Mesh;
  53195. /**
  53196. * Creates an custom extruded shape mesh.
  53197. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53198. * * 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.
  53199. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53200. * * 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
  53201. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53202. * * 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
  53203. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53204. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53205. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53206. * * 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
  53207. * * 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
  53208. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53209. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53210. * * 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
  53211. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53212. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53213. * @param name defines the name of the mesh
  53214. * @param options defines the options used to create the mesh
  53215. * @param scene defines the hosting scene
  53216. * @returns the custom extruded shape mesh
  53217. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53218. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53219. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53220. */
  53221. static ExtrudeShapeCustom(name: string, options: {
  53222. shape: Vector3[];
  53223. path: Vector3[];
  53224. scaleFunction?: any;
  53225. rotationFunction?: any;
  53226. ribbonCloseArray?: boolean;
  53227. ribbonClosePath?: boolean;
  53228. cap?: number;
  53229. updatable?: boolean;
  53230. sideOrientation?: number;
  53231. frontUVs?: Vector4;
  53232. backUVs?: Vector4;
  53233. instance?: Mesh;
  53234. invertUV?: boolean;
  53235. }, scene?: Nullable<Scene>): Mesh;
  53236. private static _ExtrudeShapeGeneric;
  53237. }
  53238. }
  53239. declare module "babylonjs/Debug/skeletonViewer" {
  53240. import { Color3 } from "babylonjs/Maths/math.color";
  53241. import { Scene } from "babylonjs/scene";
  53242. import { Nullable } from "babylonjs/types";
  53243. import { Skeleton } from "babylonjs/Bones/skeleton";
  53244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53245. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53246. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53247. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53248. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  53249. import { ISkeletonViewerOptions, IBoneWeightShaderOptions, ISkeletonMapShaderOptions } from "babylonjs/Debug/ISkeletonViewer";
  53250. /**
  53251. * Class used to render a debug view of a given skeleton
  53252. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53253. */
  53254. export class SkeletonViewer {
  53255. /** defines the skeleton to render */
  53256. skeleton: Skeleton;
  53257. /** defines the mesh attached to the skeleton */
  53258. mesh: AbstractMesh;
  53259. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53260. autoUpdateBonesMatrices: boolean;
  53261. /** defines the rendering group id to use with the viewer */
  53262. renderingGroupId: number;
  53263. /** is the options for the viewer */
  53264. options: Partial<ISkeletonViewerOptions>;
  53265. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53266. static readonly DISPLAY_LINES: number;
  53267. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53268. static readonly DISPLAY_SPHERES: number;
  53269. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53270. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53271. /** public static method to create a BoneWeight Shader
  53272. * @param options The constructor options
  53273. * @param scene The scene that the shader is scoped to
  53274. * @returns The created ShaderMaterial
  53275. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  53276. */
  53277. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  53278. /** public static method to create a BoneWeight Shader
  53279. * @param options The constructor options
  53280. * @param scene The scene that the shader is scoped to
  53281. * @returns The created ShaderMaterial
  53282. */
  53283. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  53284. /** private static method to create a BoneWeight Shader
  53285. * @param size The size of the buffer to create (usually the bone count)
  53286. * @param colorMap The gradient data to generate
  53287. * @param scene The scene that the shader is scoped to
  53288. * @returns an Array of floats from the color gradient values
  53289. */
  53290. private static _CreateBoneMapColorBuffer;
  53291. /** If SkeletonViewer scene scope. */
  53292. private _scene;
  53293. /** Gets or sets the color used to render the skeleton */
  53294. color: Color3;
  53295. /** Array of the points of the skeleton fo the line view. */
  53296. private _debugLines;
  53297. /** The SkeletonViewers Mesh. */
  53298. private _debugMesh;
  53299. /** If SkeletonViewer is enabled. */
  53300. private _isEnabled;
  53301. /** If SkeletonViewer is ready. */
  53302. private _ready;
  53303. /** SkeletonViewer render observable. */
  53304. private _obs;
  53305. /** The Utility Layer to render the gizmos in. */
  53306. private _utilityLayer;
  53307. private _boneIndices;
  53308. /** Gets the Scene. */
  53309. get scene(): Scene;
  53310. /** Gets the utilityLayer. */
  53311. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53312. /** Checks Ready Status. */
  53313. get isReady(): Boolean;
  53314. /** Sets Ready Status. */
  53315. set ready(value: boolean);
  53316. /** Gets the debugMesh */
  53317. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53318. /** Sets the debugMesh */
  53319. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53320. /** Gets the material */
  53321. get material(): StandardMaterial;
  53322. /** Sets the material */
  53323. set material(value: StandardMaterial);
  53324. /** Gets the material */
  53325. get displayMode(): number;
  53326. /** Sets the material */
  53327. set displayMode(value: number);
  53328. /**
  53329. * Creates a new SkeletonViewer
  53330. * @param skeleton defines the skeleton to render
  53331. * @param mesh defines the mesh attached to the skeleton
  53332. * @param scene defines the hosting scene
  53333. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53334. * @param renderingGroupId defines the rendering group id to use with the viewer
  53335. * @param options All of the extra constructor options for the SkeletonViewer
  53336. */
  53337. constructor(
  53338. /** defines the skeleton to render */
  53339. skeleton: Skeleton,
  53340. /** defines the mesh attached to the skeleton */
  53341. mesh: AbstractMesh,
  53342. /** The Scene scope*/
  53343. scene: Scene,
  53344. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53345. autoUpdateBonesMatrices?: boolean,
  53346. /** defines the rendering group id to use with the viewer */
  53347. renderingGroupId?: number,
  53348. /** is the options for the viewer */
  53349. options?: Partial<ISkeletonViewerOptions>);
  53350. /** The Dynamic bindings for the update functions */
  53351. private _bindObs;
  53352. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53353. update(): void;
  53354. /** Gets or sets a boolean indicating if the viewer is enabled */
  53355. set isEnabled(value: boolean);
  53356. get isEnabled(): boolean;
  53357. private _getBonePosition;
  53358. private _getLinesForBonesWithLength;
  53359. private _getLinesForBonesNoLength;
  53360. /** function to revert the mesh and scene back to the initial state. */
  53361. private _revert;
  53362. /** function to build and bind sphere joint points and spur bone representations. */
  53363. private _buildSpheresAndSpurs;
  53364. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53365. private _displayLinesUpdate;
  53366. /** Changes the displayMode of the skeleton viewer
  53367. * @param mode The displayMode numerical value
  53368. */
  53369. changeDisplayMode(mode: number): void;
  53370. /** Changes the displayMode of the skeleton viewer
  53371. * @param option String of the option name
  53372. * @param value The numerical option value
  53373. */
  53374. changeDisplayOptions(option: string, value: number): void;
  53375. /** Release associated resources */
  53376. dispose(): void;
  53377. }
  53378. }
  53379. declare module "babylonjs/Debug/index" {
  53380. export * from "babylonjs/Debug/axesViewer";
  53381. export * from "babylonjs/Debug/boneAxesViewer";
  53382. export * from "babylonjs/Debug/debugLayer";
  53383. export * from "babylonjs/Debug/physicsViewer";
  53384. export * from "babylonjs/Debug/rayHelper";
  53385. export * from "babylonjs/Debug/skeletonViewer";
  53386. export * from "babylonjs/Debug/ISkeletonViewer";
  53387. }
  53388. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53389. /**
  53390. * Enum for Device Types
  53391. */
  53392. export enum DeviceType {
  53393. /** Generic */
  53394. Generic = 0,
  53395. /** Keyboard */
  53396. Keyboard = 1,
  53397. /** Mouse */
  53398. Mouse = 2,
  53399. /** Touch Pointers */
  53400. Touch = 3,
  53401. /** PS4 Dual Shock */
  53402. DualShock = 4,
  53403. /** Xbox */
  53404. Xbox = 5,
  53405. /** Switch Controller */
  53406. Switch = 6
  53407. }
  53408. /**
  53409. * Enum for All Pointers (Touch/Mouse)
  53410. */
  53411. export enum PointerInput {
  53412. /** Horizontal Axis */
  53413. Horizontal = 0,
  53414. /** Vertical Axis */
  53415. Vertical = 1,
  53416. /** Left Click or Touch */
  53417. LeftClick = 2,
  53418. /** Middle Click */
  53419. MiddleClick = 3,
  53420. /** Right Click */
  53421. RightClick = 4,
  53422. /** Browser Back */
  53423. BrowserBack = 5,
  53424. /** Browser Forward */
  53425. BrowserForward = 6
  53426. }
  53427. /**
  53428. * Enum for Dual Shock Gamepad
  53429. */
  53430. export enum DualShockInput {
  53431. /** Cross */
  53432. Cross = 0,
  53433. /** Circle */
  53434. Circle = 1,
  53435. /** Square */
  53436. Square = 2,
  53437. /** Triangle */
  53438. Triangle = 3,
  53439. /** L1 */
  53440. L1 = 4,
  53441. /** R1 */
  53442. R1 = 5,
  53443. /** L2 */
  53444. L2 = 6,
  53445. /** R2 */
  53446. R2 = 7,
  53447. /** Share */
  53448. Share = 8,
  53449. /** Options */
  53450. Options = 9,
  53451. /** L3 */
  53452. L3 = 10,
  53453. /** R3 */
  53454. R3 = 11,
  53455. /** DPadUp */
  53456. DPadUp = 12,
  53457. /** DPadDown */
  53458. DPadDown = 13,
  53459. /** DPadLeft */
  53460. DPadLeft = 14,
  53461. /** DRight */
  53462. DPadRight = 15,
  53463. /** Home */
  53464. Home = 16,
  53465. /** TouchPad */
  53466. TouchPad = 17,
  53467. /** LStickXAxis */
  53468. LStickXAxis = 18,
  53469. /** LStickYAxis */
  53470. LStickYAxis = 19,
  53471. /** RStickXAxis */
  53472. RStickXAxis = 20,
  53473. /** RStickYAxis */
  53474. RStickYAxis = 21
  53475. }
  53476. /**
  53477. * Enum for Xbox Gamepad
  53478. */
  53479. export enum XboxInput {
  53480. /** A */
  53481. A = 0,
  53482. /** B */
  53483. B = 1,
  53484. /** X */
  53485. X = 2,
  53486. /** Y */
  53487. Y = 3,
  53488. /** LB */
  53489. LB = 4,
  53490. /** RB */
  53491. RB = 5,
  53492. /** LT */
  53493. LT = 6,
  53494. /** RT */
  53495. RT = 7,
  53496. /** Back */
  53497. Back = 8,
  53498. /** Start */
  53499. Start = 9,
  53500. /** LS */
  53501. LS = 10,
  53502. /** RS */
  53503. RS = 11,
  53504. /** DPadUp */
  53505. DPadUp = 12,
  53506. /** DPadDown */
  53507. DPadDown = 13,
  53508. /** DPadLeft */
  53509. DPadLeft = 14,
  53510. /** DRight */
  53511. DPadRight = 15,
  53512. /** Home */
  53513. Home = 16,
  53514. /** LStickXAxis */
  53515. LStickXAxis = 17,
  53516. /** LStickYAxis */
  53517. LStickYAxis = 18,
  53518. /** RStickXAxis */
  53519. RStickXAxis = 19,
  53520. /** RStickYAxis */
  53521. RStickYAxis = 20
  53522. }
  53523. /**
  53524. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53525. */
  53526. export enum SwitchInput {
  53527. /** B */
  53528. B = 0,
  53529. /** A */
  53530. A = 1,
  53531. /** Y */
  53532. Y = 2,
  53533. /** X */
  53534. X = 3,
  53535. /** L */
  53536. L = 4,
  53537. /** R */
  53538. R = 5,
  53539. /** ZL */
  53540. ZL = 6,
  53541. /** ZR */
  53542. ZR = 7,
  53543. /** Minus */
  53544. Minus = 8,
  53545. /** Plus */
  53546. Plus = 9,
  53547. /** LS */
  53548. LS = 10,
  53549. /** RS */
  53550. RS = 11,
  53551. /** DPadUp */
  53552. DPadUp = 12,
  53553. /** DPadDown */
  53554. DPadDown = 13,
  53555. /** DPadLeft */
  53556. DPadLeft = 14,
  53557. /** DRight */
  53558. DPadRight = 15,
  53559. /** Home */
  53560. Home = 16,
  53561. /** Capture */
  53562. Capture = 17,
  53563. /** LStickXAxis */
  53564. LStickXAxis = 18,
  53565. /** LStickYAxis */
  53566. LStickYAxis = 19,
  53567. /** RStickXAxis */
  53568. RStickXAxis = 20,
  53569. /** RStickYAxis */
  53570. RStickYAxis = 21
  53571. }
  53572. }
  53573. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53574. import { Engine } from "babylonjs/Engines/engine";
  53575. import { IDisposable } from "babylonjs/scene";
  53576. import { Nullable } from "babylonjs/types";
  53577. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53578. /**
  53579. * This class will take all inputs from Keyboard, Pointer, and
  53580. * any Gamepads and provide a polling system that all devices
  53581. * will use. This class assumes that there will only be one
  53582. * pointer device and one keyboard.
  53583. */
  53584. export class DeviceInputSystem implements IDisposable {
  53585. /**
  53586. * Callback to be triggered when a device is connected
  53587. */
  53588. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53589. /**
  53590. * Callback to be triggered when a device is disconnected
  53591. */
  53592. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53593. /**
  53594. * Callback to be triggered when event driven input is updated
  53595. */
  53596. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53597. private _inputs;
  53598. private _gamepads;
  53599. private _keyboardActive;
  53600. private _pointerActive;
  53601. private _elementToAttachTo;
  53602. private _keyboardDownEvent;
  53603. private _keyboardUpEvent;
  53604. private _pointerMoveEvent;
  53605. private _pointerDownEvent;
  53606. private _pointerUpEvent;
  53607. private _gamepadConnectedEvent;
  53608. private _gamepadDisconnectedEvent;
  53609. private static _MAX_KEYCODES;
  53610. private static _MAX_POINTER_INPUTS;
  53611. private constructor();
  53612. /**
  53613. * Creates a new DeviceInputSystem instance
  53614. * @param engine Engine to pull input element from
  53615. * @returns The new instance
  53616. */
  53617. static Create(engine: Engine): DeviceInputSystem;
  53618. /**
  53619. * Checks for current device input value, given an id and input index
  53620. * @param deviceName Id of connected device
  53621. * @param inputIndex Index of device input
  53622. * @returns Current value of input
  53623. */
  53624. /**
  53625. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53626. * @param deviceType Enum specifiying device type
  53627. * @param deviceSlot "Slot" or index that device is referenced in
  53628. * @param inputIndex Id of input to be checked
  53629. * @returns Current value of input
  53630. */
  53631. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53632. /**
  53633. * Dispose of all the eventlisteners
  53634. */
  53635. dispose(): void;
  53636. /**
  53637. * Add device and inputs to device array
  53638. * @param deviceType Enum specifiying device type
  53639. * @param deviceSlot "Slot" or index that device is referenced in
  53640. * @param numberOfInputs Number of input entries to create for given device
  53641. */
  53642. private _registerDevice;
  53643. /**
  53644. * Given a specific device name, remove that device from the device map
  53645. * @param deviceType Enum specifiying device type
  53646. * @param deviceSlot "Slot" or index that device is referenced in
  53647. */
  53648. private _unregisterDevice;
  53649. /**
  53650. * Handle all actions that come from keyboard interaction
  53651. */
  53652. private _handleKeyActions;
  53653. /**
  53654. * Handle all actions that come from pointer interaction
  53655. */
  53656. private _handlePointerActions;
  53657. /**
  53658. * Handle all actions that come from gamepad interaction
  53659. */
  53660. private _handleGamepadActions;
  53661. /**
  53662. * Update all non-event based devices with each frame
  53663. * @param deviceType Enum specifiying device type
  53664. * @param deviceSlot "Slot" or index that device is referenced in
  53665. * @param inputIndex Id of input to be checked
  53666. */
  53667. private _updateDevice;
  53668. /**
  53669. * Gets DeviceType from the device name
  53670. * @param deviceName Name of Device from DeviceInputSystem
  53671. * @returns DeviceType enum value
  53672. */
  53673. private _getGamepadDeviceType;
  53674. }
  53675. }
  53676. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53677. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53678. /**
  53679. * Type to handle enforcement of inputs
  53680. */
  53681. export type DeviceInput<T extends DeviceType> = T extends DeviceType.Keyboard | DeviceType.Generic ? number : T extends DeviceType.Mouse | DeviceType.Touch ? PointerInput : T extends DeviceType.DualShock ? DualShockInput : T extends DeviceType.Xbox ? XboxInput : T extends DeviceType.Switch ? SwitchInput : never;
  53682. }
  53683. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53684. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53685. import { Engine } from "babylonjs/Engines/engine";
  53686. import { IDisposable } from "babylonjs/scene";
  53687. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53688. import { Nullable } from "babylonjs/types";
  53689. import { Observable } from "babylonjs/Misc/observable";
  53690. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53691. /**
  53692. * Class that handles all input for a specific device
  53693. */
  53694. export class DeviceSource<T extends DeviceType> {
  53695. /** Type of device */
  53696. readonly deviceType: DeviceType;
  53697. /** "Slot" or index that device is referenced in */
  53698. readonly deviceSlot: number;
  53699. /**
  53700. * Observable to handle device input changes per device
  53701. */
  53702. readonly onInputChangedObservable: Observable<{
  53703. inputIndex: DeviceInput<T>;
  53704. previousState: Nullable<number>;
  53705. currentState: Nullable<number>;
  53706. }>;
  53707. private readonly _deviceInputSystem;
  53708. /**
  53709. * Default Constructor
  53710. * @param deviceInputSystem Reference to DeviceInputSystem
  53711. * @param deviceType Type of device
  53712. * @param deviceSlot "Slot" or index that device is referenced in
  53713. */
  53714. constructor(deviceInputSystem: DeviceInputSystem,
  53715. /** Type of device */
  53716. deviceType: DeviceType,
  53717. /** "Slot" or index that device is referenced in */
  53718. deviceSlot?: number);
  53719. /**
  53720. * Get input for specific input
  53721. * @param inputIndex index of specific input on device
  53722. * @returns Input value from DeviceInputSystem
  53723. */
  53724. getInput(inputIndex: DeviceInput<T>): number;
  53725. }
  53726. /**
  53727. * Class to keep track of devices
  53728. */
  53729. export class DeviceSourceManager implements IDisposable {
  53730. /**
  53731. * Observable to be triggered when before a device is connected
  53732. */
  53733. readonly onBeforeDeviceConnectedObservable: Observable<{
  53734. deviceType: DeviceType;
  53735. deviceSlot: number;
  53736. }>;
  53737. /**
  53738. * Observable to be triggered when before a device is disconnected
  53739. */
  53740. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53741. deviceType: DeviceType;
  53742. deviceSlot: number;
  53743. }>;
  53744. /**
  53745. * Observable to be triggered when after a device is connected
  53746. */
  53747. readonly onAfterDeviceConnectedObservable: Observable<{
  53748. deviceType: DeviceType;
  53749. deviceSlot: number;
  53750. }>;
  53751. /**
  53752. * Observable to be triggered when after a device is disconnected
  53753. */
  53754. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53755. deviceType: DeviceType;
  53756. deviceSlot: number;
  53757. }>;
  53758. private readonly _devices;
  53759. private readonly _firstDevice;
  53760. private readonly _deviceInputSystem;
  53761. /**
  53762. * Default Constructor
  53763. * @param engine engine to pull input element from
  53764. */
  53765. constructor(engine: Engine);
  53766. /**
  53767. * Gets a DeviceSource, given a type and slot
  53768. * @param deviceType Enum specifying device type
  53769. * @param deviceSlot "Slot" or index that device is referenced in
  53770. * @returns DeviceSource object
  53771. */
  53772. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53773. /**
  53774. * Gets an array of DeviceSource objects for a given device type
  53775. * @param deviceType Enum specifying device type
  53776. * @returns Array of DeviceSource objects
  53777. */
  53778. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53779. /**
  53780. * Dispose of DeviceInputSystem and other parts
  53781. */
  53782. dispose(): void;
  53783. /**
  53784. * Function to add device name to device list
  53785. * @param deviceType Enum specifying device type
  53786. * @param deviceSlot "Slot" or index that device is referenced in
  53787. */
  53788. private _addDevice;
  53789. /**
  53790. * Function to remove device name to device list
  53791. * @param deviceType Enum specifying device type
  53792. * @param deviceSlot "Slot" or index that device is referenced in
  53793. */
  53794. private _removeDevice;
  53795. /**
  53796. * Updates array storing first connected device of each type
  53797. * @param type Type of Device
  53798. */
  53799. private _updateFirstDevices;
  53800. }
  53801. }
  53802. declare module "babylonjs/DeviceInput/index" {
  53803. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53804. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53805. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53806. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53807. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53808. }
  53809. declare module "babylonjs/Engines/nullEngine" {
  53810. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53811. import { Engine } from "babylonjs/Engines/engine";
  53812. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53813. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53814. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53815. import { Effect } from "babylonjs/Materials/effect";
  53816. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53817. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53818. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53819. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53820. /**
  53821. * Options to create the null engine
  53822. */
  53823. export class NullEngineOptions {
  53824. /**
  53825. * Render width (Default: 512)
  53826. */
  53827. renderWidth: number;
  53828. /**
  53829. * Render height (Default: 256)
  53830. */
  53831. renderHeight: number;
  53832. /**
  53833. * Texture size (Default: 512)
  53834. */
  53835. textureSize: number;
  53836. /**
  53837. * If delta time between frames should be constant
  53838. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53839. */
  53840. deterministicLockstep: boolean;
  53841. /**
  53842. * Maximum about of steps between frames (Default: 4)
  53843. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53844. */
  53845. lockstepMaxSteps: number;
  53846. /**
  53847. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53848. */
  53849. useHighPrecisionMatrix?: boolean;
  53850. }
  53851. /**
  53852. * The null engine class provides support for headless version of babylon.js.
  53853. * This can be used in server side scenario or for testing purposes
  53854. */
  53855. export class NullEngine extends Engine {
  53856. private _options;
  53857. /**
  53858. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53859. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53860. * @returns true if engine is in deterministic lock step mode
  53861. */
  53862. isDeterministicLockStep(): boolean;
  53863. /**
  53864. * Gets the max steps when engine is running in deterministic lock step
  53865. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53866. * @returns the max steps
  53867. */
  53868. getLockstepMaxSteps(): number;
  53869. /**
  53870. * Gets the current hardware scaling level.
  53871. * By default the hardware scaling level is computed from the window device ratio.
  53872. * 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.
  53873. * @returns a number indicating the current hardware scaling level
  53874. */
  53875. getHardwareScalingLevel(): number;
  53876. constructor(options?: NullEngineOptions);
  53877. /**
  53878. * Creates a vertex buffer
  53879. * @param vertices the data for the vertex buffer
  53880. * @returns the new WebGL static buffer
  53881. */
  53882. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53883. /**
  53884. * Creates a new index buffer
  53885. * @param indices defines the content of the index buffer
  53886. * @param updatable defines if the index buffer must be updatable
  53887. * @returns a new webGL buffer
  53888. */
  53889. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53890. /**
  53891. * Clear the current render buffer or the current render target (if any is set up)
  53892. * @param color defines the color to use
  53893. * @param backBuffer defines if the back buffer must be cleared
  53894. * @param depth defines if the depth buffer must be cleared
  53895. * @param stencil defines if the stencil buffer must be cleared
  53896. */
  53897. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53898. /**
  53899. * Gets the current render width
  53900. * @param useScreen defines if screen size must be used (or the current render target if any)
  53901. * @returns a number defining the current render width
  53902. */
  53903. getRenderWidth(useScreen?: boolean): number;
  53904. /**
  53905. * Gets the current render height
  53906. * @param useScreen defines if screen size must be used (or the current render target if any)
  53907. * @returns a number defining the current render height
  53908. */
  53909. getRenderHeight(useScreen?: boolean): number;
  53910. /**
  53911. * Set the WebGL's viewport
  53912. * @param viewport defines the viewport element to be used
  53913. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53914. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53915. */
  53916. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53917. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53918. /**
  53919. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53920. * @param pipelineContext defines the pipeline context to use
  53921. * @param uniformsNames defines the list of uniform names
  53922. * @returns an array of webGL uniform locations
  53923. */
  53924. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53925. /**
  53926. * Gets the lsit of active attributes for a given webGL program
  53927. * @param pipelineContext defines the pipeline context to use
  53928. * @param attributesNames defines the list of attribute names to get
  53929. * @returns an array of indices indicating the offset of each attribute
  53930. */
  53931. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53932. /**
  53933. * Binds an effect to the webGL context
  53934. * @param effect defines the effect to bind
  53935. */
  53936. bindSamplers(effect: Effect): void;
  53937. /**
  53938. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53939. * @param effect defines the effect to activate
  53940. */
  53941. enableEffect(effect: Effect): void;
  53942. /**
  53943. * Set various states to the webGL context
  53944. * @param culling defines backface culling state
  53945. * @param zOffset defines the value to apply to zOffset (0 by default)
  53946. * @param force defines if states must be applied even if cache is up to date
  53947. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53948. */
  53949. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53950. /**
  53951. * Set the value of an uniform to an array of int32
  53952. * @param uniform defines the webGL uniform location where to store the value
  53953. * @param array defines the array of int32 to store
  53954. */
  53955. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53956. /**
  53957. * Set the value of an uniform to an array of int32 (stored as vec2)
  53958. * @param uniform defines the webGL uniform location where to store the value
  53959. * @param array defines the array of int32 to store
  53960. */
  53961. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53962. /**
  53963. * Set the value of an uniform to an array of int32 (stored as vec3)
  53964. * @param uniform defines the webGL uniform location where to store the value
  53965. * @param array defines the array of int32 to store
  53966. */
  53967. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53968. /**
  53969. * Set the value of an uniform to an array of int32 (stored as vec4)
  53970. * @param uniform defines the webGL uniform location where to store the value
  53971. * @param array defines the array of int32 to store
  53972. */
  53973. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53974. /**
  53975. * Set the value of an uniform to an array of float32
  53976. * @param uniform defines the webGL uniform location where to store the value
  53977. * @param array defines the array of float32 to store
  53978. */
  53979. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53980. /**
  53981. * Set the value of an uniform to an array of float32 (stored as vec2)
  53982. * @param uniform defines the webGL uniform location where to store the value
  53983. * @param array defines the array of float32 to store
  53984. */
  53985. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53986. /**
  53987. * Set the value of an uniform to an array of float32 (stored as vec3)
  53988. * @param uniform defines the webGL uniform location where to store the value
  53989. * @param array defines the array of float32 to store
  53990. */
  53991. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53992. /**
  53993. * Set the value of an uniform to an array of float32 (stored as vec4)
  53994. * @param uniform defines the webGL uniform location where to store the value
  53995. * @param array defines the array of float32 to store
  53996. */
  53997. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53998. /**
  53999. * Set the value of an uniform to an array of number
  54000. * @param uniform defines the webGL uniform location where to store the value
  54001. * @param array defines the array of number to store
  54002. */
  54003. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54004. /**
  54005. * Set the value of an uniform to an array of number (stored as vec2)
  54006. * @param uniform defines the webGL uniform location where to store the value
  54007. * @param array defines the array of number to store
  54008. */
  54009. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54010. /**
  54011. * Set the value of an uniform to an array of number (stored as vec3)
  54012. * @param uniform defines the webGL uniform location where to store the value
  54013. * @param array defines the array of number to store
  54014. */
  54015. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54016. /**
  54017. * Set the value of an uniform to an array of number (stored as vec4)
  54018. * @param uniform defines the webGL uniform location where to store the value
  54019. * @param array defines the array of number to store
  54020. */
  54021. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54022. /**
  54023. * Set the value of an uniform to an array of float32 (stored as matrices)
  54024. * @param uniform defines the webGL uniform location where to store the value
  54025. * @param matrices defines the array of float32 to store
  54026. */
  54027. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54028. /**
  54029. * Set the value of an uniform to a matrix (3x3)
  54030. * @param uniform defines the webGL uniform location where to store the value
  54031. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  54032. */
  54033. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54034. /**
  54035. * Set the value of an uniform to a matrix (2x2)
  54036. * @param uniform defines the webGL uniform location where to store the value
  54037. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  54038. */
  54039. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54040. /**
  54041. * Set the value of an uniform to a number (float)
  54042. * @param uniform defines the webGL uniform location where to store the value
  54043. * @param value defines the float number to store
  54044. */
  54045. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54046. /**
  54047. * Set the value of an uniform to a vec2
  54048. * @param uniform defines the webGL uniform location where to store the value
  54049. * @param x defines the 1st component of the value
  54050. * @param y defines the 2nd component of the value
  54051. */
  54052. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54053. /**
  54054. * Set the value of an uniform to a vec3
  54055. * @param uniform defines the webGL uniform location where to store the value
  54056. * @param x defines the 1st component of the value
  54057. * @param y defines the 2nd component of the value
  54058. * @param z defines the 3rd component of the value
  54059. */
  54060. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54061. /**
  54062. * Set the value of an uniform to a boolean
  54063. * @param uniform defines the webGL uniform location where to store the value
  54064. * @param bool defines the boolean to store
  54065. */
  54066. setBool(uniform: WebGLUniformLocation, bool: number): void;
  54067. /**
  54068. * Set the value of an uniform to a vec4
  54069. * @param uniform defines the webGL uniform location where to store the value
  54070. * @param x defines the 1st component of the value
  54071. * @param y defines the 2nd component of the value
  54072. * @param z defines the 3rd component of the value
  54073. * @param w defines the 4th component of the value
  54074. */
  54075. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54076. /**
  54077. * Sets the current alpha mode
  54078. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54079. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54080. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54081. */
  54082. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54083. /**
  54084. * Bind webGl buffers directly to the webGL context
  54085. * @param vertexBuffers defines the vertex buffer to bind
  54086. * @param indexBuffer defines the index buffer to bind
  54087. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54088. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54089. * @param effect defines the effect associated with the vertex buffer
  54090. */
  54091. bindBuffers(vertexBuffers: {
  54092. [key: string]: VertexBuffer;
  54093. }, indexBuffer: DataBuffer, effect: Effect): void;
  54094. /**
  54095. * Force the entire cache to be cleared
  54096. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54097. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54098. */
  54099. wipeCaches(bruteForce?: boolean): void;
  54100. /**
  54101. * Send a draw order
  54102. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54103. * @param indexStart defines the starting index
  54104. * @param indexCount defines the number of index to draw
  54105. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54106. */
  54107. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54108. /**
  54109. * Draw a list of indexed primitives
  54110. * @param fillMode defines the primitive to use
  54111. * @param indexStart defines the starting index
  54112. * @param indexCount defines the number of index to draw
  54113. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54114. */
  54115. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54116. /**
  54117. * Draw a list of unindexed primitives
  54118. * @param fillMode defines the primitive to use
  54119. * @param verticesStart defines the index of first vertex to draw
  54120. * @param verticesCount defines the count of vertices to draw
  54121. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54122. */
  54123. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54124. /** @hidden */
  54125. _createTexture(): WebGLTexture;
  54126. /** @hidden */
  54127. _releaseTexture(texture: InternalTexture): void;
  54128. /**
  54129. * Usually called from Texture.ts.
  54130. * Passed information to create a WebGLTexture
  54131. * @param urlArg defines a value which contains one of the following:
  54132. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54133. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54134. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54135. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54136. * @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)
  54137. * @param scene needed for loading to the correct scene
  54138. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54139. * @param onLoad optional callback to be called upon successful completion
  54140. * @param onError optional callback to be called upon failure
  54141. * @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
  54142. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54143. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54144. * @param forcedExtension defines the extension to use to pick the right loader
  54145. * @param mimeType defines an optional mime type
  54146. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54147. */
  54148. 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>, mimeType?: string): InternalTexture;
  54149. /**
  54150. * Creates a new render target texture
  54151. * @param size defines the size of the texture
  54152. * @param options defines the options used to create the texture
  54153. * @returns a new render target texture stored in an InternalTexture
  54154. */
  54155. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54156. /**
  54157. * Update the sampling mode of a given texture
  54158. * @param samplingMode defines the required sampling mode
  54159. * @param texture defines the texture to update
  54160. */
  54161. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54162. /**
  54163. * Binds the frame buffer to the specified texture.
  54164. * @param texture The texture to render to or null for the default canvas
  54165. * @param faceIndex The face of the texture to render to in case of cube texture
  54166. * @param requiredWidth The width of the target to render to
  54167. * @param requiredHeight The height of the target to render to
  54168. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54169. * @param lodLevel defines le lod level to bind to the frame buffer
  54170. */
  54171. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54172. /**
  54173. * Unbind the current render target texture from the webGL context
  54174. * @param texture defines the render target texture to unbind
  54175. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54176. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54177. */
  54178. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54179. /**
  54180. * Creates a dynamic vertex buffer
  54181. * @param vertices the data for the dynamic vertex buffer
  54182. * @returns the new WebGL dynamic buffer
  54183. */
  54184. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54185. /**
  54186. * Update the content of a dynamic texture
  54187. * @param texture defines the texture to update
  54188. * @param canvas defines the canvas containing the source
  54189. * @param invertY defines if data must be stored with Y axis inverted
  54190. * @param premulAlpha defines if alpha is stored as premultiplied
  54191. * @param format defines the format of the data
  54192. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54193. */
  54194. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54195. /**
  54196. * Gets a boolean indicating if all created effects are ready
  54197. * @returns true if all effects are ready
  54198. */
  54199. areAllEffectsReady(): boolean;
  54200. /**
  54201. * @hidden
  54202. * Get the current error code of the webGL context
  54203. * @returns the error code
  54204. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54205. */
  54206. getError(): number;
  54207. /** @hidden */
  54208. _getUnpackAlignement(): number;
  54209. /** @hidden */
  54210. _unpackFlipY(value: boolean): void;
  54211. /**
  54212. * Update a dynamic index buffer
  54213. * @param indexBuffer defines the target index buffer
  54214. * @param indices defines the data to update
  54215. * @param offset defines the offset in the target index buffer where update should start
  54216. */
  54217. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54218. /**
  54219. * Updates a dynamic vertex buffer.
  54220. * @param vertexBuffer the vertex buffer to update
  54221. * @param vertices the data used to update the vertex buffer
  54222. * @param byteOffset the byte offset of the data (optional)
  54223. * @param byteLength the byte length of the data (optional)
  54224. */
  54225. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54226. /** @hidden */
  54227. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54228. /** @hidden */
  54229. _bindTexture(channel: number, texture: InternalTexture): void;
  54230. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54231. /**
  54232. * 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
  54233. */
  54234. releaseEffects(): void;
  54235. displayLoadingUI(): void;
  54236. hideLoadingUI(): void;
  54237. /** @hidden */
  54238. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54239. /** @hidden */
  54240. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54241. /** @hidden */
  54242. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54243. /** @hidden */
  54244. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54245. }
  54246. }
  54247. declare module "babylonjs/Instrumentation/timeToken" {
  54248. import { Nullable } from "babylonjs/types";
  54249. /**
  54250. * @hidden
  54251. **/
  54252. export class _TimeToken {
  54253. _startTimeQuery: Nullable<WebGLQuery>;
  54254. _endTimeQuery: Nullable<WebGLQuery>;
  54255. _timeElapsedQuery: Nullable<WebGLQuery>;
  54256. _timeElapsedQueryEnded: boolean;
  54257. }
  54258. }
  54259. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54260. import { Nullable, int } from "babylonjs/types";
  54261. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54262. /** @hidden */
  54263. export class _OcclusionDataStorage {
  54264. /** @hidden */
  54265. occlusionInternalRetryCounter: number;
  54266. /** @hidden */
  54267. isOcclusionQueryInProgress: boolean;
  54268. /** @hidden */
  54269. isOccluded: boolean;
  54270. /** @hidden */
  54271. occlusionRetryCount: number;
  54272. /** @hidden */
  54273. occlusionType: number;
  54274. /** @hidden */
  54275. occlusionQueryAlgorithmType: number;
  54276. }
  54277. module "babylonjs/Engines/engine" {
  54278. interface Engine {
  54279. /**
  54280. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54281. * @return the new query
  54282. */
  54283. createQuery(): WebGLQuery;
  54284. /**
  54285. * Delete and release a webGL query
  54286. * @param query defines the query to delete
  54287. * @return the current engine
  54288. */
  54289. deleteQuery(query: WebGLQuery): Engine;
  54290. /**
  54291. * Check if a given query has resolved and got its value
  54292. * @param query defines the query to check
  54293. * @returns true if the query got its value
  54294. */
  54295. isQueryResultAvailable(query: WebGLQuery): boolean;
  54296. /**
  54297. * Gets the value of a given query
  54298. * @param query defines the query to check
  54299. * @returns the value of the query
  54300. */
  54301. getQueryResult(query: WebGLQuery): number;
  54302. /**
  54303. * Initiates an occlusion query
  54304. * @param algorithmType defines the algorithm to use
  54305. * @param query defines the query to use
  54306. * @returns the current engine
  54307. * @see https://doc.babylonjs.com/features/occlusionquery
  54308. */
  54309. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54310. /**
  54311. * Ends an occlusion query
  54312. * @see https://doc.babylonjs.com/features/occlusionquery
  54313. * @param algorithmType defines the algorithm to use
  54314. * @returns the current engine
  54315. */
  54316. endOcclusionQuery(algorithmType: number): Engine;
  54317. /**
  54318. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54319. * Please note that only one query can be issued at a time
  54320. * @returns a time token used to track the time span
  54321. */
  54322. startTimeQuery(): Nullable<_TimeToken>;
  54323. /**
  54324. * Ends a time query
  54325. * @param token defines the token used to measure the time span
  54326. * @returns the time spent (in ns)
  54327. */
  54328. endTimeQuery(token: _TimeToken): int;
  54329. /** @hidden */
  54330. _currentNonTimestampToken: Nullable<_TimeToken>;
  54331. /** @hidden */
  54332. _createTimeQuery(): WebGLQuery;
  54333. /** @hidden */
  54334. _deleteTimeQuery(query: WebGLQuery): void;
  54335. /** @hidden */
  54336. _getGlAlgorithmType(algorithmType: number): number;
  54337. /** @hidden */
  54338. _getTimeQueryResult(query: WebGLQuery): any;
  54339. /** @hidden */
  54340. _getTimeQueryAvailability(query: WebGLQuery): any;
  54341. }
  54342. }
  54343. module "babylonjs/Meshes/abstractMesh" {
  54344. interface AbstractMesh {
  54345. /**
  54346. * Backing filed
  54347. * @hidden
  54348. */
  54349. __occlusionDataStorage: _OcclusionDataStorage;
  54350. /**
  54351. * Access property
  54352. * @hidden
  54353. */
  54354. _occlusionDataStorage: _OcclusionDataStorage;
  54355. /**
  54356. * 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.
  54357. * The default value is -1 which means don't break the query and wait till the result
  54358. * @see https://doc.babylonjs.com/features/occlusionquery
  54359. */
  54360. occlusionRetryCount: number;
  54361. /**
  54362. * 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:
  54363. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54364. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54365. * * 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.
  54366. * @see https://doc.babylonjs.com/features/occlusionquery
  54367. */
  54368. occlusionType: number;
  54369. /**
  54370. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54371. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54372. * * 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.
  54373. * @see https://doc.babylonjs.com/features/occlusionquery
  54374. */
  54375. occlusionQueryAlgorithmType: number;
  54376. /**
  54377. * 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
  54378. * @see https://doc.babylonjs.com/features/occlusionquery
  54379. */
  54380. isOccluded: boolean;
  54381. /**
  54382. * Flag to check the progress status of the query
  54383. * @see https://doc.babylonjs.com/features/occlusionquery
  54384. */
  54385. isOcclusionQueryInProgress: boolean;
  54386. }
  54387. }
  54388. }
  54389. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54390. import { Nullable } from "babylonjs/types";
  54391. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54392. /** @hidden */
  54393. export var _forceTransformFeedbackToBundle: boolean;
  54394. module "babylonjs/Engines/engine" {
  54395. interface Engine {
  54396. /**
  54397. * Creates a webGL transform feedback object
  54398. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54399. * @returns the webGL transform feedback object
  54400. */
  54401. createTransformFeedback(): WebGLTransformFeedback;
  54402. /**
  54403. * Delete a webGL transform feedback object
  54404. * @param value defines the webGL transform feedback object to delete
  54405. */
  54406. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54407. /**
  54408. * Bind a webGL transform feedback object to the webgl context
  54409. * @param value defines the webGL transform feedback object to bind
  54410. */
  54411. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54412. /**
  54413. * Begins a transform feedback operation
  54414. * @param usePoints defines if points or triangles must be used
  54415. */
  54416. beginTransformFeedback(usePoints: boolean): void;
  54417. /**
  54418. * Ends a transform feedback operation
  54419. */
  54420. endTransformFeedback(): void;
  54421. /**
  54422. * Specify the varyings to use with transform feedback
  54423. * @param program defines the associated webGL program
  54424. * @param value defines the list of strings representing the varying names
  54425. */
  54426. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54427. /**
  54428. * Bind a webGL buffer for a transform feedback operation
  54429. * @param value defines the webGL buffer to bind
  54430. */
  54431. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54432. }
  54433. }
  54434. }
  54435. declare module "babylonjs/Engines/Extensions/engine.views" {
  54436. import { Camera } from "babylonjs/Cameras/camera";
  54437. import { Nullable } from "babylonjs/types";
  54438. /**
  54439. * Class used to define an additional view for the engine
  54440. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54441. */
  54442. export class EngineView {
  54443. /** Defines the canvas where to render the view */
  54444. target: HTMLCanvasElement;
  54445. /** Defines an optional camera used to render the view (will use active camera else) */
  54446. camera?: Camera;
  54447. }
  54448. module "babylonjs/Engines/engine" {
  54449. interface Engine {
  54450. /**
  54451. * Gets or sets the HTML element to use for attaching events
  54452. */
  54453. inputElement: Nullable<HTMLElement>;
  54454. /**
  54455. * Gets the current engine view
  54456. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54457. */
  54458. activeView: Nullable<EngineView>;
  54459. /** Gets or sets the list of views */
  54460. views: EngineView[];
  54461. /**
  54462. * Register a new child canvas
  54463. * @param canvas defines the canvas to register
  54464. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54465. * @returns the associated view
  54466. */
  54467. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54468. /**
  54469. * Remove a registered child canvas
  54470. * @param canvas defines the canvas to remove
  54471. * @returns the current engine
  54472. */
  54473. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54474. }
  54475. }
  54476. }
  54477. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54478. import { Nullable } from "babylonjs/types";
  54479. module "babylonjs/Engines/engine" {
  54480. interface Engine {
  54481. /** @hidden */
  54482. _excludedCompressedTextures: string[];
  54483. /** @hidden */
  54484. _textureFormatInUse: string;
  54485. /**
  54486. * Gets the list of texture formats supported
  54487. */
  54488. readonly texturesSupported: Array<string>;
  54489. /**
  54490. * Gets the texture format in use
  54491. */
  54492. readonly textureFormatInUse: Nullable<string>;
  54493. /**
  54494. * Set the compressed texture extensions or file names to skip.
  54495. *
  54496. * @param skippedFiles defines the list of those texture files you want to skip
  54497. * Example: [".dds", ".env", "myfile.png"]
  54498. */
  54499. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54500. /**
  54501. * Set the compressed texture format to use, based on the formats you have, and the formats
  54502. * supported by the hardware / browser.
  54503. *
  54504. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54505. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54506. * to API arguments needed to compressed textures. This puts the burden on the container
  54507. * generator to house the arcane code for determining these for current & future formats.
  54508. *
  54509. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54510. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54511. *
  54512. * Note: The result of this call is not taken into account when a texture is base64.
  54513. *
  54514. * @param formatsAvailable defines the list of those format families you have created
  54515. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54516. *
  54517. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54518. * @returns The extension selected.
  54519. */
  54520. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54521. }
  54522. }
  54523. }
  54524. declare module "babylonjs/Engines/Extensions/index" {
  54525. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54526. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54527. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54528. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54529. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54530. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54531. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54532. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54533. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54534. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54535. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54536. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54537. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54538. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54539. export * from "babylonjs/Engines/Extensions/engine.views";
  54540. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54541. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54542. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54543. }
  54544. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54545. import { Nullable } from "babylonjs/types";
  54546. /**
  54547. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54548. */
  54549. export interface CubeMapInfo {
  54550. /**
  54551. * The pixel array for the front face.
  54552. * This is stored in format, left to right, up to down format.
  54553. */
  54554. front: Nullable<ArrayBufferView>;
  54555. /**
  54556. * The pixel array for the back face.
  54557. * This is stored in format, left to right, up to down format.
  54558. */
  54559. back: Nullable<ArrayBufferView>;
  54560. /**
  54561. * The pixel array for the left face.
  54562. * This is stored in format, left to right, up to down format.
  54563. */
  54564. left: Nullable<ArrayBufferView>;
  54565. /**
  54566. * The pixel array for the right face.
  54567. * This is stored in format, left to right, up to down format.
  54568. */
  54569. right: Nullable<ArrayBufferView>;
  54570. /**
  54571. * The pixel array for the up face.
  54572. * This is stored in format, left to right, up to down format.
  54573. */
  54574. up: Nullable<ArrayBufferView>;
  54575. /**
  54576. * The pixel array for the down face.
  54577. * This is stored in format, left to right, up to down format.
  54578. */
  54579. down: Nullable<ArrayBufferView>;
  54580. /**
  54581. * The size of the cubemap stored.
  54582. *
  54583. * Each faces will be size * size pixels.
  54584. */
  54585. size: number;
  54586. /**
  54587. * The format of the texture.
  54588. *
  54589. * RGBA, RGB.
  54590. */
  54591. format: number;
  54592. /**
  54593. * The type of the texture data.
  54594. *
  54595. * UNSIGNED_INT, FLOAT.
  54596. */
  54597. type: number;
  54598. /**
  54599. * Specifies whether the texture is in gamma space.
  54600. */
  54601. gammaSpace: boolean;
  54602. }
  54603. /**
  54604. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54605. */
  54606. export class PanoramaToCubeMapTools {
  54607. private static FACE_LEFT;
  54608. private static FACE_RIGHT;
  54609. private static FACE_FRONT;
  54610. private static FACE_BACK;
  54611. private static FACE_DOWN;
  54612. private static FACE_UP;
  54613. /**
  54614. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54615. *
  54616. * @param float32Array The source data.
  54617. * @param inputWidth The width of the input panorama.
  54618. * @param inputHeight The height of the input panorama.
  54619. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54620. * @return The cubemap data
  54621. */
  54622. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54623. private static CreateCubemapTexture;
  54624. private static CalcProjectionSpherical;
  54625. }
  54626. }
  54627. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54628. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54629. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54630. import { Nullable } from "babylonjs/types";
  54631. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54632. /**
  54633. * Helper class dealing with the extraction of spherical polynomial dataArray
  54634. * from a cube map.
  54635. */
  54636. export class CubeMapToSphericalPolynomialTools {
  54637. private static FileFaces;
  54638. /**
  54639. * Converts a texture to the according Spherical Polynomial data.
  54640. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54641. *
  54642. * @param texture The texture to extract the information from.
  54643. * @return The Spherical Polynomial data.
  54644. */
  54645. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54646. /**
  54647. * Converts a cubemap to the according Spherical Polynomial data.
  54648. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54649. *
  54650. * @param cubeInfo The Cube map to extract the information from.
  54651. * @return The Spherical Polynomial data.
  54652. */
  54653. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54654. }
  54655. }
  54656. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54657. import { Nullable } from "babylonjs/types";
  54658. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54659. module "babylonjs/Materials/Textures/baseTexture" {
  54660. interface BaseTexture {
  54661. /**
  54662. * Get the polynomial representation of the texture data.
  54663. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54664. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54665. */
  54666. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54667. }
  54668. }
  54669. }
  54670. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54671. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54672. /** @hidden */
  54673. export var rgbdEncodePixelShader: {
  54674. name: string;
  54675. shader: string;
  54676. };
  54677. }
  54678. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54679. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54680. /** @hidden */
  54681. export var rgbdDecodePixelShader: {
  54682. name: string;
  54683. shader: string;
  54684. };
  54685. }
  54686. declare module "babylonjs/Misc/environmentTextureTools" {
  54687. import { Nullable } from "babylonjs/types";
  54688. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54689. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54690. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54691. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54692. import "babylonjs/Engines/Extensions/engine.readTexture";
  54693. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54694. import "babylonjs/Shaders/rgbdEncode.fragment";
  54695. import "babylonjs/Shaders/rgbdDecode.fragment";
  54696. /**
  54697. * Raw texture data and descriptor sufficient for WebGL texture upload
  54698. */
  54699. export interface EnvironmentTextureInfo {
  54700. /**
  54701. * Version of the environment map
  54702. */
  54703. version: number;
  54704. /**
  54705. * Width of image
  54706. */
  54707. width: number;
  54708. /**
  54709. * Irradiance information stored in the file.
  54710. */
  54711. irradiance: any;
  54712. /**
  54713. * Specular information stored in the file.
  54714. */
  54715. specular: any;
  54716. }
  54717. /**
  54718. * Defines One Image in the file. It requires only the position in the file
  54719. * as well as the length.
  54720. */
  54721. interface BufferImageData {
  54722. /**
  54723. * Length of the image data.
  54724. */
  54725. length: number;
  54726. /**
  54727. * Position of the data from the null terminator delimiting the end of the JSON.
  54728. */
  54729. position: number;
  54730. }
  54731. /**
  54732. * Defines the specular data enclosed in the file.
  54733. * This corresponds to the version 1 of the data.
  54734. */
  54735. export interface EnvironmentTextureSpecularInfoV1 {
  54736. /**
  54737. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54738. */
  54739. specularDataPosition?: number;
  54740. /**
  54741. * This contains all the images data needed to reconstruct the cubemap.
  54742. */
  54743. mipmaps: Array<BufferImageData>;
  54744. /**
  54745. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54746. */
  54747. lodGenerationScale: number;
  54748. }
  54749. /**
  54750. * Sets of helpers addressing the serialization and deserialization of environment texture
  54751. * stored in a BabylonJS env file.
  54752. * Those files are usually stored as .env files.
  54753. */
  54754. export class EnvironmentTextureTools {
  54755. /**
  54756. * Magic number identifying the env file.
  54757. */
  54758. private static _MagicBytes;
  54759. /**
  54760. * Gets the environment info from an env file.
  54761. * @param data The array buffer containing the .env bytes.
  54762. * @returns the environment file info (the json header) if successfully parsed.
  54763. */
  54764. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54765. /**
  54766. * Creates an environment texture from a loaded cube texture.
  54767. * @param texture defines the cube texture to convert in env file
  54768. * @return a promise containing the environment data if succesfull.
  54769. */
  54770. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54771. /**
  54772. * Creates a JSON representation of the spherical data.
  54773. * @param texture defines the texture containing the polynomials
  54774. * @return the JSON representation of the spherical info
  54775. */
  54776. private static _CreateEnvTextureIrradiance;
  54777. /**
  54778. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54779. * @param data the image data
  54780. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54781. * @return the views described by info providing access to the underlying buffer
  54782. */
  54783. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54784. /**
  54785. * Uploads the texture info contained in the env file to the GPU.
  54786. * @param texture defines the internal texture to upload to
  54787. * @param data defines the data to load
  54788. * @param info defines the texture info retrieved through the GetEnvInfo method
  54789. * @returns a promise
  54790. */
  54791. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54792. private static _OnImageReadyAsync;
  54793. /**
  54794. * Uploads the levels of image data to the GPU.
  54795. * @param texture defines the internal texture to upload to
  54796. * @param imageData defines the array buffer views of image data [mipmap][face]
  54797. * @returns a promise
  54798. */
  54799. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54800. /**
  54801. * Uploads spherical polynomials information to the texture.
  54802. * @param texture defines the texture we are trying to upload the information to
  54803. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54804. */
  54805. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54806. /** @hidden */
  54807. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54808. }
  54809. }
  54810. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54811. /**
  54812. * Class used to inline functions in shader code
  54813. */
  54814. export class ShaderCodeInliner {
  54815. private static readonly _RegexpFindFunctionNameAndType;
  54816. private _sourceCode;
  54817. private _functionDescr;
  54818. private _numMaxIterations;
  54819. /** Gets or sets the token used to mark the functions to inline */
  54820. inlineToken: string;
  54821. /** Gets or sets the debug mode */
  54822. debug: boolean;
  54823. /** Gets the code after the inlining process */
  54824. get code(): string;
  54825. /**
  54826. * Initializes the inliner
  54827. * @param sourceCode shader code source to inline
  54828. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54829. */
  54830. constructor(sourceCode: string, numMaxIterations?: number);
  54831. /**
  54832. * Start the processing of the shader code
  54833. */
  54834. processCode(): void;
  54835. private _collectFunctions;
  54836. private _processInlining;
  54837. private _extractBetweenMarkers;
  54838. private _skipWhitespaces;
  54839. private _removeComments;
  54840. private _replaceFunctionCallsByCode;
  54841. private _findBackward;
  54842. private _escapeRegExp;
  54843. private _replaceNames;
  54844. }
  54845. }
  54846. declare module "babylonjs/Engines/nativeEngine" {
  54847. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54848. import { Engine } from "babylonjs/Engines/engine";
  54849. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54850. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54851. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54852. import { Effect } from "babylonjs/Materials/effect";
  54853. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54854. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54855. import { IColor4Like } from "babylonjs/Maths/math.like";
  54856. import { Scene } from "babylonjs/scene";
  54857. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54858. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54859. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54860. /**
  54861. * Container for accessors for natively-stored mesh data buffers.
  54862. */
  54863. class NativeDataBuffer extends DataBuffer {
  54864. /**
  54865. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54866. */
  54867. nativeIndexBuffer?: any;
  54868. /**
  54869. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54870. */
  54871. nativeVertexBuffer?: any;
  54872. }
  54873. /** @hidden */
  54874. class NativeTexture extends InternalTexture {
  54875. getInternalTexture(): InternalTexture;
  54876. getViewCount(): number;
  54877. }
  54878. /** @hidden */
  54879. export class NativeEngine extends Engine {
  54880. private readonly _native;
  54881. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54882. private readonly INVALID_HANDLE;
  54883. private _boundBuffersVertexArray;
  54884. getHardwareScalingLevel(): number;
  54885. constructor();
  54886. dispose(): void;
  54887. /**
  54888. * Can be used to override the current requestAnimationFrame requester.
  54889. * @hidden
  54890. */
  54891. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54892. /**
  54893. * Override default engine behavior.
  54894. * @param color
  54895. * @param backBuffer
  54896. * @param depth
  54897. * @param stencil
  54898. */
  54899. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54900. /**
  54901. * Gets host document
  54902. * @returns the host document object
  54903. */
  54904. getHostDocument(): Nullable<Document>;
  54905. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54906. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54907. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54908. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54909. [key: string]: VertexBuffer;
  54910. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54911. bindBuffers(vertexBuffers: {
  54912. [key: string]: VertexBuffer;
  54913. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54914. recordVertexArrayObject(vertexBuffers: {
  54915. [key: string]: VertexBuffer;
  54916. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54917. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54918. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54919. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54920. /**
  54921. * Draw a list of indexed primitives
  54922. * @param fillMode defines the primitive to use
  54923. * @param indexStart defines the starting index
  54924. * @param indexCount defines the number of index to draw
  54925. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54926. */
  54927. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54928. /**
  54929. * Draw a list of unindexed primitives
  54930. * @param fillMode defines the primitive to use
  54931. * @param verticesStart defines the index of first vertex to draw
  54932. * @param verticesCount defines the count of vertices to draw
  54933. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54934. */
  54935. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54936. createPipelineContext(): IPipelineContext;
  54937. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54938. /** @hidden */
  54939. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54940. /** @hidden */
  54941. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54942. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54943. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54944. protected _setProgram(program: WebGLProgram): void;
  54945. _releaseEffect(effect: Effect): void;
  54946. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54947. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54948. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54949. bindSamplers(effect: Effect): void;
  54950. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54951. getRenderWidth(useScreen?: boolean): number;
  54952. getRenderHeight(useScreen?: boolean): number;
  54953. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54954. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54955. /**
  54956. * Set the z offset to apply to current rendering
  54957. * @param value defines the offset to apply
  54958. */
  54959. setZOffset(value: number): void;
  54960. /**
  54961. * Gets the current value of the zOffset
  54962. * @returns the current zOffset state
  54963. */
  54964. getZOffset(): number;
  54965. /**
  54966. * Enable or disable depth buffering
  54967. * @param enable defines the state to set
  54968. */
  54969. setDepthBuffer(enable: boolean): void;
  54970. /**
  54971. * Gets a boolean indicating if depth writing is enabled
  54972. * @returns the current depth writing state
  54973. */
  54974. getDepthWrite(): boolean;
  54975. /**
  54976. * Enable or disable depth writing
  54977. * @param enable defines the state to set
  54978. */
  54979. setDepthWrite(enable: boolean): void;
  54980. /**
  54981. * Enable or disable color writing
  54982. * @param enable defines the state to set
  54983. */
  54984. setColorWrite(enable: boolean): void;
  54985. /**
  54986. * Gets a boolean indicating if color writing is enabled
  54987. * @returns the current color writing state
  54988. */
  54989. getColorWrite(): boolean;
  54990. /**
  54991. * Sets alpha constants used by some alpha blending modes
  54992. * @param r defines the red component
  54993. * @param g defines the green component
  54994. * @param b defines the blue component
  54995. * @param a defines the alpha component
  54996. */
  54997. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54998. /**
  54999. * Sets the current alpha mode
  55000. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  55001. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  55002. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55003. */
  55004. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  55005. /**
  55006. * Gets the current alpha mode
  55007. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55008. * @returns the current alpha mode
  55009. */
  55010. getAlphaMode(): number;
  55011. setInt(uniform: WebGLUniformLocation, int: number): void;
  55012. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  55013. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  55014. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  55015. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  55016. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  55017. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  55018. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  55019. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  55020. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  55021. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  55022. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  55023. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  55024. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  55025. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  55026. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  55027. setFloat(uniform: WebGLUniformLocation, value: number): void;
  55028. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  55029. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  55030. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  55031. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  55032. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  55033. wipeCaches(bruteForce?: boolean): void;
  55034. _createTexture(): WebGLTexture;
  55035. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  55036. /**
  55037. * Usually called from Texture.ts.
  55038. * Passed information to create a WebGLTexture
  55039. * @param url defines a value which contains one of the following:
  55040. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  55041. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  55042. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  55043. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  55044. * @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)
  55045. * @param scene needed for loading to the correct scene
  55046. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  55047. * @param onLoad optional callback to be called upon successful completion
  55048. * @param onError optional callback to be called upon failure
  55049. * @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
  55050. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  55051. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  55052. * @param forcedExtension defines the extension to use to pick the right loader
  55053. * @param mimeType defines an optional mime type
  55054. * @returns a InternalTexture for assignment back into BABYLON.Texture
  55055. */
  55056. createTexture(url: 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>, mimeType?: string): InternalTexture;
  55057. /**
  55058. * Creates a cube texture
  55059. * @param rootUrl defines the url where the files to load is located
  55060. * @param scene defines the current scene
  55061. * @param files defines the list of files to load (1 per face)
  55062. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  55063. * @param onLoad defines an optional callback raised when the texture is loaded
  55064. * @param onError defines an optional callback raised if there is an issue to load the texture
  55065. * @param format defines the format of the data
  55066. * @param forcedExtension defines the extension to use to pick the right loader
  55067. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  55068. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55069. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55070. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  55071. * @returns the cube texture as an InternalTexture
  55072. */
  55073. 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;
  55074. private _getSamplingFilter;
  55075. private static _GetNativeTextureFormat;
  55076. createRenderTargetTexture(size: number | {
  55077. width: number;
  55078. height: number;
  55079. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55080. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55081. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55082. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55083. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55084. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55085. /**
  55086. * Updates a dynamic vertex buffer.
  55087. * @param vertexBuffer the vertex buffer to update
  55088. * @param data the data used to update the vertex buffer
  55089. * @param byteOffset the byte offset of the data (optional)
  55090. * @param byteLength the byte length of the data (optional)
  55091. */
  55092. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55093. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55094. private _updateAnisotropicLevel;
  55095. private _getAddressMode;
  55096. /** @hidden */
  55097. _bindTexture(channel: number, texture: InternalTexture): void;
  55098. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55099. releaseEffects(): void;
  55100. /** @hidden */
  55101. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55102. /** @hidden */
  55103. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55104. /** @hidden */
  55105. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55106. /** @hidden */
  55107. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55108. }
  55109. }
  55110. declare module "babylonjs/Engines/index" {
  55111. export * from "babylonjs/Engines/constants";
  55112. export * from "babylonjs/Engines/engineCapabilities";
  55113. export * from "babylonjs/Engines/instancingAttributeInfo";
  55114. export * from "babylonjs/Engines/thinEngine";
  55115. export * from "babylonjs/Engines/engine";
  55116. export * from "babylonjs/Engines/engineStore";
  55117. export * from "babylonjs/Engines/nullEngine";
  55118. export * from "babylonjs/Engines/Extensions/index";
  55119. export * from "babylonjs/Engines/IPipelineContext";
  55120. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55121. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55122. export * from "babylonjs/Engines/nativeEngine";
  55123. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55124. export * from "babylonjs/Engines/performanceConfigurator";
  55125. }
  55126. declare module "babylonjs/Events/clipboardEvents" {
  55127. /**
  55128. * Gather the list of clipboard event types as constants.
  55129. */
  55130. export class ClipboardEventTypes {
  55131. /**
  55132. * The clipboard event is fired when a copy command is active (pressed).
  55133. */
  55134. static readonly COPY: number;
  55135. /**
  55136. * The clipboard event is fired when a cut command is active (pressed).
  55137. */
  55138. static readonly CUT: number;
  55139. /**
  55140. * The clipboard event is fired when a paste command is active (pressed).
  55141. */
  55142. static readonly PASTE: number;
  55143. }
  55144. /**
  55145. * This class is used to store clipboard related info for the onClipboardObservable event.
  55146. */
  55147. export class ClipboardInfo {
  55148. /**
  55149. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55150. */
  55151. type: number;
  55152. /**
  55153. * Defines the related dom event
  55154. */
  55155. event: ClipboardEvent;
  55156. /**
  55157. *Creates an instance of ClipboardInfo.
  55158. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55159. * @param event Defines the related dom event
  55160. */
  55161. constructor(
  55162. /**
  55163. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55164. */
  55165. type: number,
  55166. /**
  55167. * Defines the related dom event
  55168. */
  55169. event: ClipboardEvent);
  55170. /**
  55171. * Get the clipboard event's type from the keycode.
  55172. * @param keyCode Defines the keyCode for the current keyboard event.
  55173. * @return {number}
  55174. */
  55175. static GetTypeFromCharacter(keyCode: number): number;
  55176. }
  55177. }
  55178. declare module "babylonjs/Events/index" {
  55179. export * from "babylonjs/Events/keyboardEvents";
  55180. export * from "babylonjs/Events/pointerEvents";
  55181. export * from "babylonjs/Events/clipboardEvents";
  55182. }
  55183. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55184. import { Scene } from "babylonjs/scene";
  55185. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55186. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55187. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55188. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55189. /**
  55190. * Google Daydream controller
  55191. */
  55192. export class DaydreamController extends WebVRController {
  55193. /**
  55194. * Base Url for the controller model.
  55195. */
  55196. static MODEL_BASE_URL: string;
  55197. /**
  55198. * File name for the controller model.
  55199. */
  55200. static MODEL_FILENAME: string;
  55201. /**
  55202. * Gamepad Id prefix used to identify Daydream Controller.
  55203. */
  55204. static readonly GAMEPAD_ID_PREFIX: string;
  55205. /**
  55206. * Creates a new DaydreamController from a gamepad
  55207. * @param vrGamepad the gamepad that the controller should be created from
  55208. */
  55209. constructor(vrGamepad: any);
  55210. /**
  55211. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55212. * @param scene scene in which to add meshes
  55213. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55214. */
  55215. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55216. /**
  55217. * Called once for each button that changed state since the last frame
  55218. * @param buttonIdx Which button index changed
  55219. * @param state New state of the button
  55220. * @param changes Which properties on the state changed since last frame
  55221. */
  55222. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55223. }
  55224. }
  55225. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55226. import { Scene } from "babylonjs/scene";
  55227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55228. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55229. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55230. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55231. /**
  55232. * Gear VR Controller
  55233. */
  55234. export class GearVRController extends WebVRController {
  55235. /**
  55236. * Base Url for the controller model.
  55237. */
  55238. static MODEL_BASE_URL: string;
  55239. /**
  55240. * File name for the controller model.
  55241. */
  55242. static MODEL_FILENAME: string;
  55243. /**
  55244. * Gamepad Id prefix used to identify this controller.
  55245. */
  55246. static readonly GAMEPAD_ID_PREFIX: string;
  55247. private readonly _buttonIndexToObservableNameMap;
  55248. /**
  55249. * Creates a new GearVRController from a gamepad
  55250. * @param vrGamepad the gamepad that the controller should be created from
  55251. */
  55252. constructor(vrGamepad: any);
  55253. /**
  55254. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55255. * @param scene scene in which to add meshes
  55256. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55257. */
  55258. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55259. /**
  55260. * Called once for each button that changed state since the last frame
  55261. * @param buttonIdx Which button index changed
  55262. * @param state New state of the button
  55263. * @param changes Which properties on the state changed since last frame
  55264. */
  55265. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55266. }
  55267. }
  55268. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55269. import { Scene } from "babylonjs/scene";
  55270. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55271. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55272. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55273. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55274. /**
  55275. * Generic Controller
  55276. */
  55277. export class GenericController extends WebVRController {
  55278. /**
  55279. * Base Url for the controller model.
  55280. */
  55281. static readonly MODEL_BASE_URL: string;
  55282. /**
  55283. * File name for the controller model.
  55284. */
  55285. static readonly MODEL_FILENAME: string;
  55286. /**
  55287. * Creates a new GenericController from a gamepad
  55288. * @param vrGamepad the gamepad that the controller should be created from
  55289. */
  55290. constructor(vrGamepad: any);
  55291. /**
  55292. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55293. * @param scene scene in which to add meshes
  55294. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55295. */
  55296. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55297. /**
  55298. * Called once for each button that changed state since the last frame
  55299. * @param buttonIdx Which button index changed
  55300. * @param state New state of the button
  55301. * @param changes Which properties on the state changed since last frame
  55302. */
  55303. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55304. }
  55305. }
  55306. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55307. import { Observable } from "babylonjs/Misc/observable";
  55308. import { Scene } from "babylonjs/scene";
  55309. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55310. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55311. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55312. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55313. /**
  55314. * Oculus Touch Controller
  55315. */
  55316. export class OculusTouchController extends WebVRController {
  55317. /**
  55318. * Base Url for the controller model.
  55319. */
  55320. static MODEL_BASE_URL: string;
  55321. /**
  55322. * File name for the left controller model.
  55323. */
  55324. static MODEL_LEFT_FILENAME: string;
  55325. /**
  55326. * File name for the right controller model.
  55327. */
  55328. static MODEL_RIGHT_FILENAME: string;
  55329. /**
  55330. * Base Url for the Quest controller model.
  55331. */
  55332. static QUEST_MODEL_BASE_URL: string;
  55333. /**
  55334. * @hidden
  55335. * If the controllers are running on a device that needs the updated Quest controller models
  55336. */
  55337. static _IsQuest: boolean;
  55338. /**
  55339. * Fired when the secondary trigger on this controller is modified
  55340. */
  55341. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55342. /**
  55343. * Fired when the thumb rest on this controller is modified
  55344. */
  55345. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55346. /**
  55347. * Creates a new OculusTouchController from a gamepad
  55348. * @param vrGamepad the gamepad that the controller should be created from
  55349. */
  55350. constructor(vrGamepad: any);
  55351. /**
  55352. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55353. * @param scene scene in which to add meshes
  55354. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55355. */
  55356. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55357. /**
  55358. * Fired when the A button on this controller is modified
  55359. */
  55360. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55361. /**
  55362. * Fired when the B button on this controller is modified
  55363. */
  55364. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55365. /**
  55366. * Fired when the X button on this controller is modified
  55367. */
  55368. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55369. /**
  55370. * Fired when the Y button on this controller is modified
  55371. */
  55372. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55373. /**
  55374. * Called once for each button that changed state since the last frame
  55375. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55376. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55377. * 2) secondary trigger (same)
  55378. * 3) A (right) X (left), touch, pressed = value
  55379. * 4) B / Y
  55380. * 5) thumb rest
  55381. * @param buttonIdx Which button index changed
  55382. * @param state New state of the button
  55383. * @param changes Which properties on the state changed since last frame
  55384. */
  55385. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55386. }
  55387. }
  55388. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55389. import { Scene } from "babylonjs/scene";
  55390. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55391. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55392. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55393. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55394. import { Observable } from "babylonjs/Misc/observable";
  55395. /**
  55396. * Vive Controller
  55397. */
  55398. export class ViveController extends WebVRController {
  55399. /**
  55400. * Base Url for the controller model.
  55401. */
  55402. static MODEL_BASE_URL: string;
  55403. /**
  55404. * File name for the controller model.
  55405. */
  55406. static MODEL_FILENAME: string;
  55407. /**
  55408. * Creates a new ViveController from a gamepad
  55409. * @param vrGamepad the gamepad that the controller should be created from
  55410. */
  55411. constructor(vrGamepad: any);
  55412. /**
  55413. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55414. * @param scene scene in which to add meshes
  55415. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55416. */
  55417. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55418. /**
  55419. * Fired when the left button on this controller is modified
  55420. */
  55421. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55422. /**
  55423. * Fired when the right button on this controller is modified
  55424. */
  55425. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55426. /**
  55427. * Fired when the menu button on this controller is modified
  55428. */
  55429. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55430. /**
  55431. * Called once for each button that changed state since the last frame
  55432. * Vive mapping:
  55433. * 0: touchpad
  55434. * 1: trigger
  55435. * 2: left AND right buttons
  55436. * 3: menu button
  55437. * @param buttonIdx Which button index changed
  55438. * @param state New state of the button
  55439. * @param changes Which properties on the state changed since last frame
  55440. */
  55441. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55442. }
  55443. }
  55444. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55445. import { Observable } from "babylonjs/Misc/observable";
  55446. import { Scene } from "babylonjs/scene";
  55447. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55448. import { Ray } from "babylonjs/Culling/ray";
  55449. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55450. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55451. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55452. /**
  55453. * Defines the WindowsMotionController object that the state of the windows motion controller
  55454. */
  55455. export class WindowsMotionController extends WebVRController {
  55456. /**
  55457. * The base url used to load the left and right controller models
  55458. */
  55459. static MODEL_BASE_URL: string;
  55460. /**
  55461. * The name of the left controller model file
  55462. */
  55463. static MODEL_LEFT_FILENAME: string;
  55464. /**
  55465. * The name of the right controller model file
  55466. */
  55467. static MODEL_RIGHT_FILENAME: string;
  55468. /**
  55469. * The controller name prefix for this controller type
  55470. */
  55471. static readonly GAMEPAD_ID_PREFIX: string;
  55472. /**
  55473. * The controller id pattern for this controller type
  55474. */
  55475. private static readonly GAMEPAD_ID_PATTERN;
  55476. private _loadedMeshInfo;
  55477. protected readonly _mapping: {
  55478. buttons: string[];
  55479. buttonMeshNames: {
  55480. trigger: string;
  55481. menu: string;
  55482. grip: string;
  55483. thumbstick: string;
  55484. trackpad: string;
  55485. };
  55486. buttonObservableNames: {
  55487. trigger: string;
  55488. menu: string;
  55489. grip: string;
  55490. thumbstick: string;
  55491. trackpad: string;
  55492. };
  55493. axisMeshNames: string[];
  55494. pointingPoseMeshName: string;
  55495. };
  55496. /**
  55497. * Fired when the trackpad on this controller is clicked
  55498. */
  55499. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55500. /**
  55501. * Fired when the trackpad on this controller is modified
  55502. */
  55503. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55504. /**
  55505. * The current x and y values of this controller's trackpad
  55506. */
  55507. trackpad: StickValues;
  55508. /**
  55509. * Creates a new WindowsMotionController from a gamepad
  55510. * @param vrGamepad the gamepad that the controller should be created from
  55511. */
  55512. constructor(vrGamepad: any);
  55513. /**
  55514. * Fired when the trigger on this controller is modified
  55515. */
  55516. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55517. /**
  55518. * Fired when the menu button on this controller is modified
  55519. */
  55520. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55521. /**
  55522. * Fired when the grip button on this controller is modified
  55523. */
  55524. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55525. /**
  55526. * Fired when the thumbstick button on this controller is modified
  55527. */
  55528. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55529. /**
  55530. * Fired when the touchpad button on this controller is modified
  55531. */
  55532. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55533. /**
  55534. * Fired when the touchpad values on this controller are modified
  55535. */
  55536. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55537. protected _updateTrackpad(): void;
  55538. /**
  55539. * Called once per frame by the engine.
  55540. */
  55541. update(): void;
  55542. /**
  55543. * Called once for each button that changed state since the last frame
  55544. * @param buttonIdx Which button index changed
  55545. * @param state New state of the button
  55546. * @param changes Which properties on the state changed since last frame
  55547. */
  55548. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55549. /**
  55550. * Moves the buttons on the controller mesh based on their current state
  55551. * @param buttonName the name of the button to move
  55552. * @param buttonValue the value of the button which determines the buttons new position
  55553. */
  55554. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55555. /**
  55556. * Moves the axis on the controller mesh based on its current state
  55557. * @param axis the index of the axis
  55558. * @param axisValue the value of the axis which determines the meshes new position
  55559. * @hidden
  55560. */
  55561. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55562. /**
  55563. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55564. * @param scene scene in which to add meshes
  55565. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55566. */
  55567. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55568. /**
  55569. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55570. * can be transformed by button presses and axes values, based on this._mapping.
  55571. *
  55572. * @param scene scene in which the meshes exist
  55573. * @param meshes list of meshes that make up the controller model to process
  55574. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55575. */
  55576. private processModel;
  55577. private createMeshInfo;
  55578. /**
  55579. * Gets the ray of the controller in the direction the controller is pointing
  55580. * @param length the length the resulting ray should be
  55581. * @returns a ray in the direction the controller is pointing
  55582. */
  55583. getForwardRay(length?: number): Ray;
  55584. /**
  55585. * Disposes of the controller
  55586. */
  55587. dispose(): void;
  55588. }
  55589. /**
  55590. * This class represents a new windows motion controller in XR.
  55591. */
  55592. export class XRWindowsMotionController extends WindowsMotionController {
  55593. /**
  55594. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55595. */
  55596. protected readonly _mapping: {
  55597. buttons: string[];
  55598. buttonMeshNames: {
  55599. trigger: string;
  55600. menu: string;
  55601. grip: string;
  55602. thumbstick: string;
  55603. trackpad: string;
  55604. };
  55605. buttonObservableNames: {
  55606. trigger: string;
  55607. menu: string;
  55608. grip: string;
  55609. thumbstick: string;
  55610. trackpad: string;
  55611. };
  55612. axisMeshNames: string[];
  55613. pointingPoseMeshName: string;
  55614. };
  55615. /**
  55616. * Construct a new XR-Based windows motion controller
  55617. *
  55618. * @param gamepadInfo the gamepad object from the browser
  55619. */
  55620. constructor(gamepadInfo: any);
  55621. /**
  55622. * holds the thumbstick values (X,Y)
  55623. */
  55624. thumbstickValues: StickValues;
  55625. /**
  55626. * Fired when the thumbstick on this controller is clicked
  55627. */
  55628. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55629. /**
  55630. * Fired when the thumbstick on this controller is modified
  55631. */
  55632. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55633. /**
  55634. * Fired when the touchpad button on this controller is modified
  55635. */
  55636. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55637. /**
  55638. * Fired when the touchpad values on this controller are modified
  55639. */
  55640. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55641. /**
  55642. * Fired when the thumbstick button on this controller is modified
  55643. * here to prevent breaking changes
  55644. */
  55645. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55646. /**
  55647. * updating the thumbstick(!) and not the trackpad.
  55648. * This is named this way due to the difference between WebVR and XR and to avoid
  55649. * changing the parent class.
  55650. */
  55651. protected _updateTrackpad(): void;
  55652. /**
  55653. * Disposes the class with joy
  55654. */
  55655. dispose(): void;
  55656. }
  55657. }
  55658. declare module "babylonjs/Gamepads/Controllers/index" {
  55659. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55660. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55661. export * from "babylonjs/Gamepads/Controllers/genericController";
  55662. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55663. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55664. export * from "babylonjs/Gamepads/Controllers/viveController";
  55665. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55666. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55667. }
  55668. declare module "babylonjs/Gamepads/index" {
  55669. export * from "babylonjs/Gamepads/Controllers/index";
  55670. export * from "babylonjs/Gamepads/gamepad";
  55671. export * from "babylonjs/Gamepads/gamepadManager";
  55672. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55673. export * from "babylonjs/Gamepads/xboxGamepad";
  55674. export * from "babylonjs/Gamepads/dualShockGamepad";
  55675. }
  55676. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55677. import { Scene } from "babylonjs/scene";
  55678. import { Vector4 } from "babylonjs/Maths/math.vector";
  55679. import { Color4 } from "babylonjs/Maths/math.color";
  55680. import { Mesh } from "babylonjs/Meshes/mesh";
  55681. import { Nullable } from "babylonjs/types";
  55682. /**
  55683. * Class containing static functions to help procedurally build meshes
  55684. */
  55685. export class PolyhedronBuilder {
  55686. /**
  55687. * Creates a polyhedron mesh
  55688. * * 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
  55689. * * The parameter `size` (positive float, default 1) sets the polygon size
  55690. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55691. * * 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`
  55692. * * 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
  55693. * * 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)`)
  55694. * * 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
  55695. * * 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
  55696. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55697. * * 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
  55698. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55699. * @param name defines the name of the mesh
  55700. * @param options defines the options used to create the mesh
  55701. * @param scene defines the hosting scene
  55702. * @returns the polyhedron mesh
  55703. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55704. */
  55705. static CreatePolyhedron(name: string, options: {
  55706. type?: number;
  55707. size?: number;
  55708. sizeX?: number;
  55709. sizeY?: number;
  55710. sizeZ?: number;
  55711. custom?: any;
  55712. faceUV?: Vector4[];
  55713. faceColors?: Color4[];
  55714. flat?: boolean;
  55715. updatable?: boolean;
  55716. sideOrientation?: number;
  55717. frontUVs?: Vector4;
  55718. backUVs?: Vector4;
  55719. }, scene?: Nullable<Scene>): Mesh;
  55720. }
  55721. }
  55722. declare module "babylonjs/Gizmos/scaleGizmo" {
  55723. import { Observable } from "babylonjs/Misc/observable";
  55724. import { Nullable } from "babylonjs/types";
  55725. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55726. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55727. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55728. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55729. import { Node } from "babylonjs/node";
  55730. /**
  55731. * Gizmo that enables scaling a mesh along 3 axis
  55732. */
  55733. export class ScaleGizmo extends Gizmo {
  55734. /**
  55735. * Internal gizmo used for interactions on the x axis
  55736. */
  55737. xGizmo: AxisScaleGizmo;
  55738. /**
  55739. * Internal gizmo used for interactions on the y axis
  55740. */
  55741. yGizmo: AxisScaleGizmo;
  55742. /**
  55743. * Internal gizmo used for interactions on the z axis
  55744. */
  55745. zGizmo: AxisScaleGizmo;
  55746. /**
  55747. * Internal gizmo used to scale all axis equally
  55748. */
  55749. uniformScaleGizmo: AxisScaleGizmo;
  55750. private _meshAttached;
  55751. private _nodeAttached;
  55752. private _snapDistance;
  55753. private _uniformScalingMesh;
  55754. private _octahedron;
  55755. private _sensitivity;
  55756. /** Fires an event when any of it's sub gizmos are dragged */
  55757. onDragStartObservable: Observable<unknown>;
  55758. /** Fires an event when any of it's sub gizmos are released from dragging */
  55759. onDragEndObservable: Observable<unknown>;
  55760. get attachedMesh(): Nullable<AbstractMesh>;
  55761. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55762. get attachedNode(): Nullable<Node>;
  55763. set attachedNode(node: Nullable<Node>);
  55764. /**
  55765. * Creates a ScaleGizmo
  55766. * @param gizmoLayer The utility layer the gizmo will be added to
  55767. * @param thickness display gizmo axis thickness
  55768. */
  55769. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55770. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55771. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55772. /**
  55773. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55774. */
  55775. set snapDistance(value: number);
  55776. get snapDistance(): number;
  55777. /**
  55778. * Ratio for the scale of the gizmo (Default: 1)
  55779. */
  55780. set scaleRatio(value: number);
  55781. get scaleRatio(): number;
  55782. /**
  55783. * Sensitivity factor for dragging (Default: 1)
  55784. */
  55785. set sensitivity(value: number);
  55786. get sensitivity(): number;
  55787. /**
  55788. * Disposes of the gizmo
  55789. */
  55790. dispose(): void;
  55791. }
  55792. }
  55793. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55794. import { Observable } from "babylonjs/Misc/observable";
  55795. import { Nullable } from "babylonjs/types";
  55796. import { Vector3 } from "babylonjs/Maths/math.vector";
  55797. import { Node } from "babylonjs/node";
  55798. import { Mesh } from "babylonjs/Meshes/mesh";
  55799. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55800. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55801. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55802. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55803. import { Color3 } from "babylonjs/Maths/math.color";
  55804. /**
  55805. * Single axis scale gizmo
  55806. */
  55807. export class AxisScaleGizmo extends Gizmo {
  55808. /**
  55809. * Drag behavior responsible for the gizmos dragging interactions
  55810. */
  55811. dragBehavior: PointerDragBehavior;
  55812. private _pointerObserver;
  55813. /**
  55814. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55815. */
  55816. snapDistance: number;
  55817. /**
  55818. * Event that fires each time the gizmo snaps to a new location.
  55819. * * snapDistance is the the change in distance
  55820. */
  55821. onSnapObservable: Observable<{
  55822. snapDistance: number;
  55823. }>;
  55824. /**
  55825. * If the scaling operation should be done on all axis (default: false)
  55826. */
  55827. uniformScaling: boolean;
  55828. /**
  55829. * Custom sensitivity value for the drag strength
  55830. */
  55831. sensitivity: number;
  55832. private _isEnabled;
  55833. private _parent;
  55834. private _arrow;
  55835. private _coloredMaterial;
  55836. private _hoverMaterial;
  55837. /**
  55838. * Creates an AxisScaleGizmo
  55839. * @param gizmoLayer The utility layer the gizmo will be added to
  55840. * @param dragAxis The axis which the gizmo will be able to scale on
  55841. * @param color The color of the gizmo
  55842. * @param thickness display gizmo axis thickness
  55843. */
  55844. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55845. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55846. /**
  55847. * If the gizmo is enabled
  55848. */
  55849. set isEnabled(value: boolean);
  55850. get isEnabled(): boolean;
  55851. /**
  55852. * Disposes of the gizmo
  55853. */
  55854. dispose(): void;
  55855. /**
  55856. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55857. * @param mesh The mesh to replace the default mesh of the gizmo
  55858. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55859. */
  55860. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55861. }
  55862. }
  55863. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55864. import { Observable } from "babylonjs/Misc/observable";
  55865. import { Nullable } from "babylonjs/types";
  55866. import { Vector3 } from "babylonjs/Maths/math.vector";
  55867. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55868. import { Mesh } from "babylonjs/Meshes/mesh";
  55869. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55870. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55871. import { Color3 } from "babylonjs/Maths/math.color";
  55872. import "babylonjs/Meshes/Builders/boxBuilder";
  55873. /**
  55874. * Bounding box gizmo
  55875. */
  55876. export class BoundingBoxGizmo extends Gizmo {
  55877. private _lineBoundingBox;
  55878. private _rotateSpheresParent;
  55879. private _scaleBoxesParent;
  55880. private _boundingDimensions;
  55881. private _renderObserver;
  55882. private _pointerObserver;
  55883. private _scaleDragSpeed;
  55884. private _tmpQuaternion;
  55885. private _tmpVector;
  55886. private _tmpRotationMatrix;
  55887. /**
  55888. * 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)
  55889. */
  55890. ignoreChildren: boolean;
  55891. /**
  55892. * 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)
  55893. */
  55894. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55895. /**
  55896. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55897. */
  55898. rotationSphereSize: number;
  55899. /**
  55900. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55901. */
  55902. scaleBoxSize: number;
  55903. /**
  55904. * 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)
  55905. */
  55906. fixedDragMeshScreenSize: boolean;
  55907. /**
  55908. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55909. */
  55910. fixedDragMeshScreenSizeDistanceFactor: number;
  55911. /**
  55912. * Fired when a rotation sphere or scale box is dragged
  55913. */
  55914. onDragStartObservable: Observable<{}>;
  55915. /**
  55916. * Fired when a scale box is dragged
  55917. */
  55918. onScaleBoxDragObservable: Observable<{}>;
  55919. /**
  55920. * Fired when a scale box drag is ended
  55921. */
  55922. onScaleBoxDragEndObservable: Observable<{}>;
  55923. /**
  55924. * Fired when a rotation sphere is dragged
  55925. */
  55926. onRotationSphereDragObservable: Observable<{}>;
  55927. /**
  55928. * Fired when a rotation sphere drag is ended
  55929. */
  55930. onRotationSphereDragEndObservable: Observable<{}>;
  55931. /**
  55932. * Relative bounding box pivot used when scaling the attached node. 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)
  55933. */
  55934. scalePivot: Nullable<Vector3>;
  55935. /**
  55936. * Mesh used as a pivot to rotate the attached node
  55937. */
  55938. private _anchorMesh;
  55939. private _existingMeshScale;
  55940. private _dragMesh;
  55941. private pointerDragBehavior;
  55942. private coloredMaterial;
  55943. private hoverColoredMaterial;
  55944. /**
  55945. * Sets the color of the bounding box gizmo
  55946. * @param color the color to set
  55947. */
  55948. setColor(color: Color3): void;
  55949. /**
  55950. * Creates an BoundingBoxGizmo
  55951. * @param gizmoLayer The utility layer the gizmo will be added to
  55952. * @param color The color of the gizmo
  55953. */
  55954. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55955. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55956. private _selectNode;
  55957. /**
  55958. * Updates the bounding box information for the Gizmo
  55959. */
  55960. updateBoundingBox(): void;
  55961. private _updateRotationSpheres;
  55962. private _updateScaleBoxes;
  55963. /**
  55964. * Enables rotation on the specified axis and disables rotation on the others
  55965. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55966. */
  55967. setEnabledRotationAxis(axis: string): void;
  55968. /**
  55969. * Enables/disables scaling
  55970. * @param enable if scaling should be enabled
  55971. * @param homogeneousScaling defines if scaling should only be homogeneous
  55972. */
  55973. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55974. private _updateDummy;
  55975. /**
  55976. * Enables a pointer drag behavior on the bounding box of the gizmo
  55977. */
  55978. enableDragBehavior(): void;
  55979. /**
  55980. * Disposes of the gizmo
  55981. */
  55982. dispose(): void;
  55983. /**
  55984. * 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)
  55985. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55986. * @returns the bounding box mesh with the passed in mesh as a child
  55987. */
  55988. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55989. /**
  55990. * CustomMeshes are not supported by this gizmo
  55991. * @param mesh The mesh to replace the default mesh of the gizmo
  55992. */
  55993. setCustomMesh(mesh: Mesh): void;
  55994. }
  55995. }
  55996. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55997. import { Observable } from "babylonjs/Misc/observable";
  55998. import { Nullable } from "babylonjs/types";
  55999. import { Vector3 } from "babylonjs/Maths/math.vector";
  56000. import { Color3 } from "babylonjs/Maths/math.color";
  56001. import { Node } from "babylonjs/node";
  56002. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  56003. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56004. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56005. import "babylonjs/Meshes/Builders/linesBuilder";
  56006. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56007. /**
  56008. * Single plane rotation gizmo
  56009. */
  56010. export class PlaneRotationGizmo extends Gizmo {
  56011. /**
  56012. * Drag behavior responsible for the gizmos dragging interactions
  56013. */
  56014. dragBehavior: PointerDragBehavior;
  56015. private _pointerObserver;
  56016. /**
  56017. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  56018. */
  56019. snapDistance: number;
  56020. /**
  56021. * Event that fires each time the gizmo snaps to a new location.
  56022. * * snapDistance is the the change in distance
  56023. */
  56024. onSnapObservable: Observable<{
  56025. snapDistance: number;
  56026. }>;
  56027. private _isEnabled;
  56028. private _parent;
  56029. /**
  56030. * Creates a PlaneRotationGizmo
  56031. * @param gizmoLayer The utility layer the gizmo will be added to
  56032. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  56033. * @param color The color of the gizmo
  56034. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56035. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56036. * @param thickness display gizmo axis thickness
  56037. */
  56038. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  56039. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56040. /**
  56041. * If the gizmo is enabled
  56042. */
  56043. set isEnabled(value: boolean);
  56044. get isEnabled(): boolean;
  56045. /**
  56046. * Disposes of the gizmo
  56047. */
  56048. dispose(): void;
  56049. }
  56050. }
  56051. declare module "babylonjs/Gizmos/rotationGizmo" {
  56052. import { Observable } from "babylonjs/Misc/observable";
  56053. import { Nullable } from "babylonjs/types";
  56054. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56055. import { Mesh } from "babylonjs/Meshes/mesh";
  56056. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56057. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  56058. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56059. import { Node } from "babylonjs/node";
  56060. /**
  56061. * Gizmo that enables rotating a mesh along 3 axis
  56062. */
  56063. export class RotationGizmo extends Gizmo {
  56064. /**
  56065. * Internal gizmo used for interactions on the x axis
  56066. */
  56067. xGizmo: PlaneRotationGizmo;
  56068. /**
  56069. * Internal gizmo used for interactions on the y axis
  56070. */
  56071. yGizmo: PlaneRotationGizmo;
  56072. /**
  56073. * Internal gizmo used for interactions on the z axis
  56074. */
  56075. zGizmo: PlaneRotationGizmo;
  56076. /** Fires an event when any of it's sub gizmos are dragged */
  56077. onDragStartObservable: Observable<unknown>;
  56078. /** Fires an event when any of it's sub gizmos are released from dragging */
  56079. onDragEndObservable: Observable<unknown>;
  56080. private _meshAttached;
  56081. private _nodeAttached;
  56082. get attachedMesh(): Nullable<AbstractMesh>;
  56083. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56084. get attachedNode(): Nullable<Node>;
  56085. set attachedNode(node: Nullable<Node>);
  56086. /**
  56087. * Creates a RotationGizmo
  56088. * @param gizmoLayer The utility layer the gizmo will be added to
  56089. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56090. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56091. * @param thickness display gizmo axis thickness
  56092. */
  56093. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56094. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56095. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56096. /**
  56097. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56098. */
  56099. set snapDistance(value: number);
  56100. get snapDistance(): number;
  56101. /**
  56102. * Ratio for the scale of the gizmo (Default: 1)
  56103. */
  56104. set scaleRatio(value: number);
  56105. get scaleRatio(): number;
  56106. /**
  56107. * Disposes of the gizmo
  56108. */
  56109. dispose(): void;
  56110. /**
  56111. * CustomMeshes are not supported by this gizmo
  56112. * @param mesh The mesh to replace the default mesh of the gizmo
  56113. */
  56114. setCustomMesh(mesh: Mesh): void;
  56115. }
  56116. }
  56117. declare module "babylonjs/Gizmos/gizmoManager" {
  56118. import { Observable } from "babylonjs/Misc/observable";
  56119. import { Nullable } from "babylonjs/types";
  56120. import { Scene, IDisposable } from "babylonjs/scene";
  56121. import { Node } from "babylonjs/node";
  56122. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56123. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56124. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56125. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56126. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56127. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56128. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56129. /**
  56130. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56131. */
  56132. export class GizmoManager implements IDisposable {
  56133. private scene;
  56134. /**
  56135. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56136. */
  56137. gizmos: {
  56138. positionGizmo: Nullable<PositionGizmo>;
  56139. rotationGizmo: Nullable<RotationGizmo>;
  56140. scaleGizmo: Nullable<ScaleGizmo>;
  56141. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56142. };
  56143. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56144. clearGizmoOnEmptyPointerEvent: boolean;
  56145. /** Fires an event when the manager is attached to a mesh */
  56146. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56147. /** Fires an event when the manager is attached to a node */
  56148. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56149. private _gizmosEnabled;
  56150. private _pointerObserver;
  56151. private _attachedMesh;
  56152. private _attachedNode;
  56153. private _boundingBoxColor;
  56154. private _defaultUtilityLayer;
  56155. private _defaultKeepDepthUtilityLayer;
  56156. private _thickness;
  56157. /**
  56158. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56159. */
  56160. boundingBoxDragBehavior: SixDofDragBehavior;
  56161. /**
  56162. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56163. */
  56164. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56165. /**
  56166. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56167. */
  56168. attachableNodes: Nullable<Array<Node>>;
  56169. /**
  56170. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56171. */
  56172. usePointerToAttachGizmos: boolean;
  56173. /**
  56174. * Utility layer that the bounding box gizmo belongs to
  56175. */
  56176. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56177. /**
  56178. * Utility layer that all gizmos besides bounding box belong to
  56179. */
  56180. get utilityLayer(): UtilityLayerRenderer;
  56181. /**
  56182. * Instatiates a gizmo manager
  56183. * @param scene the scene to overlay the gizmos on top of
  56184. * @param thickness display gizmo axis thickness
  56185. */
  56186. constructor(scene: Scene, thickness?: number);
  56187. /**
  56188. * Attaches a set of gizmos to the specified mesh
  56189. * @param mesh The mesh the gizmo's should be attached to
  56190. */
  56191. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56192. /**
  56193. * Attaches a set of gizmos to the specified node
  56194. * @param node The node the gizmo's should be attached to
  56195. */
  56196. attachToNode(node: Nullable<Node>): void;
  56197. /**
  56198. * If the position gizmo is enabled
  56199. */
  56200. set positionGizmoEnabled(value: boolean);
  56201. get positionGizmoEnabled(): boolean;
  56202. /**
  56203. * If the rotation gizmo is enabled
  56204. */
  56205. set rotationGizmoEnabled(value: boolean);
  56206. get rotationGizmoEnabled(): boolean;
  56207. /**
  56208. * If the scale gizmo is enabled
  56209. */
  56210. set scaleGizmoEnabled(value: boolean);
  56211. get scaleGizmoEnabled(): boolean;
  56212. /**
  56213. * If the boundingBox gizmo is enabled
  56214. */
  56215. set boundingBoxGizmoEnabled(value: boolean);
  56216. get boundingBoxGizmoEnabled(): boolean;
  56217. /**
  56218. * Disposes of the gizmo manager
  56219. */
  56220. dispose(): void;
  56221. }
  56222. }
  56223. declare module "babylonjs/Lights/directionalLight" {
  56224. import { Camera } from "babylonjs/Cameras/camera";
  56225. import { Scene } from "babylonjs/scene";
  56226. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56228. import { Light } from "babylonjs/Lights/light";
  56229. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56230. import { Effect } from "babylonjs/Materials/effect";
  56231. /**
  56232. * A directional light is defined by a direction (what a surprise!).
  56233. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56234. * 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.
  56235. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56236. */
  56237. export class DirectionalLight extends ShadowLight {
  56238. private _shadowFrustumSize;
  56239. /**
  56240. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56241. */
  56242. get shadowFrustumSize(): number;
  56243. /**
  56244. * Specifies a fix frustum size for the shadow generation.
  56245. */
  56246. set shadowFrustumSize(value: number);
  56247. private _shadowOrthoScale;
  56248. /**
  56249. * Gets the shadow projection scale against the optimal computed one.
  56250. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56251. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56252. */
  56253. get shadowOrthoScale(): number;
  56254. /**
  56255. * Sets the shadow projection scale against the optimal computed one.
  56256. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56257. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56258. */
  56259. set shadowOrthoScale(value: number);
  56260. /**
  56261. * Automatically compute the projection matrix to best fit (including all the casters)
  56262. * on each frame.
  56263. */
  56264. autoUpdateExtends: boolean;
  56265. /**
  56266. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56267. * on each frame. autoUpdateExtends must be set to true for this to work
  56268. */
  56269. autoCalcShadowZBounds: boolean;
  56270. private _orthoLeft;
  56271. private _orthoRight;
  56272. private _orthoTop;
  56273. private _orthoBottom;
  56274. /**
  56275. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56276. * The directional light is emitted from everywhere in the given direction.
  56277. * It can cast shadows.
  56278. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56279. * @param name The friendly name of the light
  56280. * @param direction The direction of the light
  56281. * @param scene The scene the light belongs to
  56282. */
  56283. constructor(name: string, direction: Vector3, scene: Scene);
  56284. /**
  56285. * Returns the string "DirectionalLight".
  56286. * @return The class name
  56287. */
  56288. getClassName(): string;
  56289. /**
  56290. * Returns the integer 1.
  56291. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56292. */
  56293. getTypeID(): number;
  56294. /**
  56295. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56296. * Returns the DirectionalLight Shadow projection matrix.
  56297. */
  56298. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56299. /**
  56300. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56301. * Returns the DirectionalLight Shadow projection matrix.
  56302. */
  56303. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56304. /**
  56305. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56306. * Returns the DirectionalLight Shadow projection matrix.
  56307. */
  56308. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56309. protected _buildUniformLayout(): void;
  56310. /**
  56311. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56312. * @param effect The effect to update
  56313. * @param lightIndex The index of the light in the effect to update
  56314. * @returns The directional light
  56315. */
  56316. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56317. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56318. /**
  56319. * Gets the minZ used for shadow according to both the scene and the light.
  56320. *
  56321. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56322. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56323. * @param activeCamera The camera we are returning the min for
  56324. * @returns the depth min z
  56325. */
  56326. getDepthMinZ(activeCamera: Camera): number;
  56327. /**
  56328. * Gets the maxZ used for shadow according to both the scene and the light.
  56329. *
  56330. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56331. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56332. * @param activeCamera The camera we are returning the max for
  56333. * @returns the depth max z
  56334. */
  56335. getDepthMaxZ(activeCamera: Camera): number;
  56336. /**
  56337. * Prepares the list of defines specific to the light type.
  56338. * @param defines the list of defines
  56339. * @param lightIndex defines the index of the light for the effect
  56340. */
  56341. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56342. }
  56343. }
  56344. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56345. import { Mesh } from "babylonjs/Meshes/mesh";
  56346. /**
  56347. * Class containing static functions to help procedurally build meshes
  56348. */
  56349. export class HemisphereBuilder {
  56350. /**
  56351. * Creates a hemisphere mesh
  56352. * @param name defines the name of the mesh
  56353. * @param options defines the options used to create the mesh
  56354. * @param scene defines the hosting scene
  56355. * @returns the hemisphere mesh
  56356. */
  56357. static CreateHemisphere(name: string, options: {
  56358. segments?: number;
  56359. diameter?: number;
  56360. sideOrientation?: number;
  56361. }, scene: any): Mesh;
  56362. }
  56363. }
  56364. declare module "babylonjs/Lights/spotLight" {
  56365. import { Nullable } from "babylonjs/types";
  56366. import { Scene } from "babylonjs/scene";
  56367. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56368. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56369. import { Effect } from "babylonjs/Materials/effect";
  56370. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56371. import { Light } from "babylonjs/Lights/light";
  56372. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56373. /**
  56374. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56375. * These values define a cone of light starting from the position, emitting toward the direction.
  56376. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56377. * and the exponent defines the speed of the decay of the light with distance (reach).
  56378. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56379. */
  56380. export class SpotLight extends ShadowLight {
  56381. private _angle;
  56382. private _innerAngle;
  56383. private _cosHalfAngle;
  56384. private _lightAngleScale;
  56385. private _lightAngleOffset;
  56386. /**
  56387. * Gets the cone angle of the spot light in Radians.
  56388. */
  56389. get angle(): number;
  56390. /**
  56391. * Sets the cone angle of the spot light in Radians.
  56392. */
  56393. set angle(value: number);
  56394. /**
  56395. * Only used in gltf falloff mode, this defines the angle where
  56396. * the directional falloff will start before cutting at angle which could be seen
  56397. * as outer angle.
  56398. */
  56399. get innerAngle(): number;
  56400. /**
  56401. * Only used in gltf falloff mode, this defines the angle where
  56402. * the directional falloff will start before cutting at angle which could be seen
  56403. * as outer angle.
  56404. */
  56405. set innerAngle(value: number);
  56406. private _shadowAngleScale;
  56407. /**
  56408. * Allows scaling the angle of the light for shadow generation only.
  56409. */
  56410. get shadowAngleScale(): number;
  56411. /**
  56412. * Allows scaling the angle of the light for shadow generation only.
  56413. */
  56414. set shadowAngleScale(value: number);
  56415. /**
  56416. * The light decay speed with the distance from the emission spot.
  56417. */
  56418. exponent: number;
  56419. private _projectionTextureMatrix;
  56420. /**
  56421. * Allows reading the projecton texture
  56422. */
  56423. get projectionTextureMatrix(): Matrix;
  56424. protected _projectionTextureLightNear: number;
  56425. /**
  56426. * Gets the near clip of the Spotlight for texture projection.
  56427. */
  56428. get projectionTextureLightNear(): number;
  56429. /**
  56430. * Sets the near clip of the Spotlight for texture projection.
  56431. */
  56432. set projectionTextureLightNear(value: number);
  56433. protected _projectionTextureLightFar: number;
  56434. /**
  56435. * Gets the far clip of the Spotlight for texture projection.
  56436. */
  56437. get projectionTextureLightFar(): number;
  56438. /**
  56439. * Sets the far clip of the Spotlight for texture projection.
  56440. */
  56441. set projectionTextureLightFar(value: number);
  56442. protected _projectionTextureUpDirection: Vector3;
  56443. /**
  56444. * Gets the Up vector of the Spotlight for texture projection.
  56445. */
  56446. get projectionTextureUpDirection(): Vector3;
  56447. /**
  56448. * Sets the Up vector of the Spotlight for texture projection.
  56449. */
  56450. set projectionTextureUpDirection(value: Vector3);
  56451. private _projectionTexture;
  56452. /**
  56453. * Gets the projection texture of the light.
  56454. */
  56455. get projectionTexture(): Nullable<BaseTexture>;
  56456. /**
  56457. * Sets the projection texture of the light.
  56458. */
  56459. set projectionTexture(value: Nullable<BaseTexture>);
  56460. private _projectionTextureViewLightDirty;
  56461. private _projectionTextureProjectionLightDirty;
  56462. private _projectionTextureDirty;
  56463. private _projectionTextureViewTargetVector;
  56464. private _projectionTextureViewLightMatrix;
  56465. private _projectionTextureProjectionLightMatrix;
  56466. private _projectionTextureScalingMatrix;
  56467. /**
  56468. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56469. * It can cast shadows.
  56470. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56471. * @param name The light friendly name
  56472. * @param position The position of the spot light in the scene
  56473. * @param direction The direction of the light in the scene
  56474. * @param angle The cone angle of the light in Radians
  56475. * @param exponent The light decay speed with the distance from the emission spot
  56476. * @param scene The scene the lights belongs to
  56477. */
  56478. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56479. /**
  56480. * Returns the string "SpotLight".
  56481. * @returns the class name
  56482. */
  56483. getClassName(): string;
  56484. /**
  56485. * Returns the integer 2.
  56486. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56487. */
  56488. getTypeID(): number;
  56489. /**
  56490. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56491. */
  56492. protected _setDirection(value: Vector3): void;
  56493. /**
  56494. * Overrides the position setter to recompute the projection texture view light Matrix.
  56495. */
  56496. protected _setPosition(value: Vector3): void;
  56497. /**
  56498. * 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.
  56499. * Returns the SpotLight.
  56500. */
  56501. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56502. protected _computeProjectionTextureViewLightMatrix(): void;
  56503. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56504. /**
  56505. * Main function for light texture projection matrix computing.
  56506. */
  56507. protected _computeProjectionTextureMatrix(): void;
  56508. protected _buildUniformLayout(): void;
  56509. private _computeAngleValues;
  56510. /**
  56511. * Sets the passed Effect "effect" with the Light textures.
  56512. * @param effect The effect to update
  56513. * @param lightIndex The index of the light in the effect to update
  56514. * @returns The light
  56515. */
  56516. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56517. /**
  56518. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56519. * @param effect The effect to update
  56520. * @param lightIndex The index of the light in the effect to update
  56521. * @returns The spot light
  56522. */
  56523. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56524. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56525. /**
  56526. * Disposes the light and the associated resources.
  56527. */
  56528. dispose(): void;
  56529. /**
  56530. * Prepares the list of defines specific to the light type.
  56531. * @param defines the list of defines
  56532. * @param lightIndex defines the index of the light for the effect
  56533. */
  56534. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56535. }
  56536. }
  56537. declare module "babylonjs/Gizmos/lightGizmo" {
  56538. import { Nullable } from "babylonjs/types";
  56539. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56540. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56541. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56542. import { Light } from "babylonjs/Lights/light";
  56543. import { Observable } from "babylonjs/Misc/observable";
  56544. /**
  56545. * Gizmo that enables viewing a light
  56546. */
  56547. export class LightGizmo extends Gizmo {
  56548. private _lightMesh;
  56549. private _material;
  56550. private _cachedPosition;
  56551. private _cachedForward;
  56552. private _attachedMeshParent;
  56553. private _pointerObserver;
  56554. /**
  56555. * Event that fires each time the gizmo is clicked
  56556. */
  56557. onClickedObservable: Observable<Light>;
  56558. /**
  56559. * Creates a LightGizmo
  56560. * @param gizmoLayer The utility layer the gizmo will be added to
  56561. */
  56562. constructor(gizmoLayer?: UtilityLayerRenderer);
  56563. private _light;
  56564. /**
  56565. * The light that the gizmo is attached to
  56566. */
  56567. set light(light: Nullable<Light>);
  56568. get light(): Nullable<Light>;
  56569. /**
  56570. * Gets the material used to render the light gizmo
  56571. */
  56572. get material(): StandardMaterial;
  56573. /**
  56574. * @hidden
  56575. * Updates the gizmo to match the attached mesh's position/rotation
  56576. */
  56577. protected _update(): void;
  56578. private static _Scale;
  56579. /**
  56580. * Creates the lines for a light mesh
  56581. */
  56582. private static _CreateLightLines;
  56583. /**
  56584. * Disposes of the light gizmo
  56585. */
  56586. dispose(): void;
  56587. private static _CreateHemisphericLightMesh;
  56588. private static _CreatePointLightMesh;
  56589. private static _CreateSpotLightMesh;
  56590. private static _CreateDirectionalLightMesh;
  56591. }
  56592. }
  56593. declare module "babylonjs/Gizmos/cameraGizmo" {
  56594. import { Nullable } from "babylonjs/types";
  56595. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56596. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56597. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56598. import { Camera } from "babylonjs/Cameras/camera";
  56599. import { Observable } from "babylonjs/Misc/observable";
  56600. /**
  56601. * Gizmo that enables viewing a camera
  56602. */
  56603. export class CameraGizmo extends Gizmo {
  56604. private _cameraMesh;
  56605. private _cameraLinesMesh;
  56606. private _material;
  56607. private _pointerObserver;
  56608. /**
  56609. * Event that fires each time the gizmo is clicked
  56610. */
  56611. onClickedObservable: Observable<Camera>;
  56612. /**
  56613. * Creates a CameraGizmo
  56614. * @param gizmoLayer The utility layer the gizmo will be added to
  56615. */
  56616. constructor(gizmoLayer?: UtilityLayerRenderer);
  56617. private _camera;
  56618. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56619. get displayFrustum(): boolean;
  56620. set displayFrustum(value: boolean);
  56621. /**
  56622. * The camera that the gizmo is attached to
  56623. */
  56624. set camera(camera: Nullable<Camera>);
  56625. get camera(): Nullable<Camera>;
  56626. /**
  56627. * Gets the material used to render the camera gizmo
  56628. */
  56629. get material(): StandardMaterial;
  56630. /**
  56631. * @hidden
  56632. * Updates the gizmo to match the attached mesh's position/rotation
  56633. */
  56634. protected _update(): void;
  56635. private static _Scale;
  56636. private _invProjection;
  56637. /**
  56638. * Disposes of the camera gizmo
  56639. */
  56640. dispose(): void;
  56641. private static _CreateCameraMesh;
  56642. private static _CreateCameraFrustum;
  56643. }
  56644. }
  56645. declare module "babylonjs/Gizmos/index" {
  56646. export * from "babylonjs/Gizmos/axisDragGizmo";
  56647. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56648. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56649. export * from "babylonjs/Gizmos/gizmo";
  56650. export * from "babylonjs/Gizmos/gizmoManager";
  56651. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56652. export * from "babylonjs/Gizmos/positionGizmo";
  56653. export * from "babylonjs/Gizmos/rotationGizmo";
  56654. export * from "babylonjs/Gizmos/scaleGizmo";
  56655. export * from "babylonjs/Gizmos/lightGizmo";
  56656. export * from "babylonjs/Gizmos/cameraGizmo";
  56657. export * from "babylonjs/Gizmos/planeDragGizmo";
  56658. }
  56659. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56660. /** @hidden */
  56661. export var backgroundFragmentDeclaration: {
  56662. name: string;
  56663. shader: string;
  56664. };
  56665. }
  56666. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56667. /** @hidden */
  56668. export var backgroundUboDeclaration: {
  56669. name: string;
  56670. shader: string;
  56671. };
  56672. }
  56673. declare module "babylonjs/Shaders/background.fragment" {
  56674. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56675. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56676. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56677. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56678. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56679. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56680. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56681. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56682. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56683. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56684. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56685. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56686. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56687. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56688. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56689. /** @hidden */
  56690. export var backgroundPixelShader: {
  56691. name: string;
  56692. shader: string;
  56693. };
  56694. }
  56695. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56696. /** @hidden */
  56697. export var backgroundVertexDeclaration: {
  56698. name: string;
  56699. shader: string;
  56700. };
  56701. }
  56702. declare module "babylonjs/Shaders/background.vertex" {
  56703. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56704. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56705. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56706. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56707. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56708. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56709. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56710. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56711. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56712. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56713. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56714. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56715. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56716. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56717. /** @hidden */
  56718. export var backgroundVertexShader: {
  56719. name: string;
  56720. shader: string;
  56721. };
  56722. }
  56723. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56724. import { Nullable, int, float } from "babylonjs/types";
  56725. import { Scene } from "babylonjs/scene";
  56726. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56727. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56728. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56729. import { Mesh } from "babylonjs/Meshes/mesh";
  56730. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56731. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56732. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56733. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56734. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56735. import { Color3 } from "babylonjs/Maths/math.color";
  56736. import "babylonjs/Shaders/background.fragment";
  56737. import "babylonjs/Shaders/background.vertex";
  56738. /**
  56739. * Background material used to create an efficient environement around your scene.
  56740. */
  56741. export class BackgroundMaterial extends PushMaterial {
  56742. /**
  56743. * Standard reflectance value at parallel view angle.
  56744. */
  56745. static StandardReflectance0: number;
  56746. /**
  56747. * Standard reflectance value at grazing angle.
  56748. */
  56749. static StandardReflectance90: number;
  56750. protected _primaryColor: Color3;
  56751. /**
  56752. * Key light Color (multiply against the environement texture)
  56753. */
  56754. primaryColor: Color3;
  56755. protected __perceptualColor: Nullable<Color3>;
  56756. /**
  56757. * Experimental Internal Use Only.
  56758. *
  56759. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56760. * This acts as a helper to set the primary color to a more "human friendly" value.
  56761. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56762. * output color as close as possible from the chosen value.
  56763. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56764. * part of lighting setup.)
  56765. */
  56766. get _perceptualColor(): Nullable<Color3>;
  56767. set _perceptualColor(value: Nullable<Color3>);
  56768. protected _primaryColorShadowLevel: float;
  56769. /**
  56770. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56771. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56772. */
  56773. get primaryColorShadowLevel(): float;
  56774. set primaryColorShadowLevel(value: float);
  56775. protected _primaryColorHighlightLevel: float;
  56776. /**
  56777. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56778. * The primary color is used at the level chosen to define what the white area would look.
  56779. */
  56780. get primaryColorHighlightLevel(): float;
  56781. set primaryColorHighlightLevel(value: float);
  56782. protected _reflectionTexture: Nullable<BaseTexture>;
  56783. /**
  56784. * Reflection Texture used in the material.
  56785. * Should be author in a specific way for the best result (refer to the documentation).
  56786. */
  56787. reflectionTexture: Nullable<BaseTexture>;
  56788. protected _reflectionBlur: float;
  56789. /**
  56790. * Reflection Texture level of blur.
  56791. *
  56792. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56793. * texture twice.
  56794. */
  56795. reflectionBlur: float;
  56796. protected _diffuseTexture: Nullable<BaseTexture>;
  56797. /**
  56798. * Diffuse Texture used in the material.
  56799. * Should be author in a specific way for the best result (refer to the documentation).
  56800. */
  56801. diffuseTexture: Nullable<BaseTexture>;
  56802. protected _shadowLights: Nullable<IShadowLight[]>;
  56803. /**
  56804. * Specify the list of lights casting shadow on the material.
  56805. * All scene shadow lights will be included if null.
  56806. */
  56807. shadowLights: Nullable<IShadowLight[]>;
  56808. protected _shadowLevel: float;
  56809. /**
  56810. * Helps adjusting the shadow to a softer level if required.
  56811. * 0 means black shadows and 1 means no shadows.
  56812. */
  56813. shadowLevel: float;
  56814. protected _sceneCenter: Vector3;
  56815. /**
  56816. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56817. * It is usually zero but might be interesting to modify according to your setup.
  56818. */
  56819. sceneCenter: Vector3;
  56820. protected _opacityFresnel: boolean;
  56821. /**
  56822. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56823. * This helps ensuring a nice transition when the camera goes under the ground.
  56824. */
  56825. opacityFresnel: boolean;
  56826. protected _reflectionFresnel: boolean;
  56827. /**
  56828. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56829. * This helps adding a mirror texture on the ground.
  56830. */
  56831. reflectionFresnel: boolean;
  56832. protected _reflectionFalloffDistance: number;
  56833. /**
  56834. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56835. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56836. */
  56837. reflectionFalloffDistance: number;
  56838. protected _reflectionAmount: number;
  56839. /**
  56840. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56841. */
  56842. reflectionAmount: number;
  56843. protected _reflectionReflectance0: number;
  56844. /**
  56845. * This specifies the weight of the reflection at grazing angle.
  56846. */
  56847. reflectionReflectance0: number;
  56848. protected _reflectionReflectance90: number;
  56849. /**
  56850. * This specifies the weight of the reflection at a perpendicular point of view.
  56851. */
  56852. reflectionReflectance90: number;
  56853. /**
  56854. * Sets the reflection reflectance fresnel values according to the default standard
  56855. * empirically know to work well :-)
  56856. */
  56857. set reflectionStandardFresnelWeight(value: number);
  56858. protected _useRGBColor: boolean;
  56859. /**
  56860. * Helps to directly use the maps channels instead of their level.
  56861. */
  56862. useRGBColor: boolean;
  56863. protected _enableNoise: boolean;
  56864. /**
  56865. * This helps reducing the banding effect that could occur on the background.
  56866. */
  56867. enableNoise: boolean;
  56868. /**
  56869. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56870. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56871. * Recommended to be keep at 1.0 except for special cases.
  56872. */
  56873. get fovMultiplier(): number;
  56874. set fovMultiplier(value: number);
  56875. private _fovMultiplier;
  56876. /**
  56877. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56878. */
  56879. useEquirectangularFOV: boolean;
  56880. private _maxSimultaneousLights;
  56881. /**
  56882. * Number of Simultaneous lights allowed on the material.
  56883. */
  56884. maxSimultaneousLights: int;
  56885. private _shadowOnly;
  56886. /**
  56887. * Make the material only render shadows
  56888. */
  56889. shadowOnly: boolean;
  56890. /**
  56891. * Default configuration related to image processing available in the Background Material.
  56892. */
  56893. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56894. /**
  56895. * Keep track of the image processing observer to allow dispose and replace.
  56896. */
  56897. private _imageProcessingObserver;
  56898. /**
  56899. * Attaches a new image processing configuration to the PBR Material.
  56900. * @param configuration (if null the scene configuration will be use)
  56901. */
  56902. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56903. /**
  56904. * Gets the image processing configuration used either in this material.
  56905. */
  56906. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56907. /**
  56908. * Sets the Default image processing configuration used either in the this material.
  56909. *
  56910. * If sets to null, the scene one is in use.
  56911. */
  56912. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56913. /**
  56914. * Gets wether the color curves effect is enabled.
  56915. */
  56916. get cameraColorCurvesEnabled(): boolean;
  56917. /**
  56918. * Sets wether the color curves effect is enabled.
  56919. */
  56920. set cameraColorCurvesEnabled(value: boolean);
  56921. /**
  56922. * Gets wether the color grading effect is enabled.
  56923. */
  56924. get cameraColorGradingEnabled(): boolean;
  56925. /**
  56926. * Gets wether the color grading effect is enabled.
  56927. */
  56928. set cameraColorGradingEnabled(value: boolean);
  56929. /**
  56930. * Gets wether tonemapping is enabled or not.
  56931. */
  56932. get cameraToneMappingEnabled(): boolean;
  56933. /**
  56934. * Sets wether tonemapping is enabled or not
  56935. */
  56936. set cameraToneMappingEnabled(value: boolean);
  56937. /**
  56938. * The camera exposure used on this material.
  56939. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56940. * This corresponds to a photographic exposure.
  56941. */
  56942. get cameraExposure(): float;
  56943. /**
  56944. * The camera exposure used on this material.
  56945. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56946. * This corresponds to a photographic exposure.
  56947. */
  56948. set cameraExposure(value: float);
  56949. /**
  56950. * Gets The camera contrast used on this material.
  56951. */
  56952. get cameraContrast(): float;
  56953. /**
  56954. * Sets The camera contrast used on this material.
  56955. */
  56956. set cameraContrast(value: float);
  56957. /**
  56958. * Gets the Color Grading 2D Lookup Texture.
  56959. */
  56960. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56961. /**
  56962. * Sets the Color Grading 2D Lookup Texture.
  56963. */
  56964. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56965. /**
  56966. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56967. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56968. * 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;
  56969. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56970. */
  56971. get cameraColorCurves(): Nullable<ColorCurves>;
  56972. /**
  56973. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56974. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56975. * 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;
  56976. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56977. */
  56978. set cameraColorCurves(value: Nullable<ColorCurves>);
  56979. /**
  56980. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56981. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56982. */
  56983. switchToBGR: boolean;
  56984. private _renderTargets;
  56985. private _reflectionControls;
  56986. private _white;
  56987. private _primaryShadowColor;
  56988. private _primaryHighlightColor;
  56989. /**
  56990. * Instantiates a Background Material in the given scene
  56991. * @param name The friendly name of the material
  56992. * @param scene The scene to add the material to
  56993. */
  56994. constructor(name: string, scene: Scene);
  56995. /**
  56996. * Gets a boolean indicating that current material needs to register RTT
  56997. */
  56998. get hasRenderTargetTextures(): boolean;
  56999. /**
  57000. * The entire material has been created in order to prevent overdraw.
  57001. * @returns false
  57002. */
  57003. needAlphaTesting(): boolean;
  57004. /**
  57005. * The entire material has been created in order to prevent overdraw.
  57006. * @returns true if blending is enable
  57007. */
  57008. needAlphaBlending(): boolean;
  57009. /**
  57010. * Checks wether the material is ready to be rendered for a given mesh.
  57011. * @param mesh The mesh to render
  57012. * @param subMesh The submesh to check against
  57013. * @param useInstances Specify wether or not the material is used with instances
  57014. * @returns true if all the dependencies are ready (Textures, Effects...)
  57015. */
  57016. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  57017. /**
  57018. * Compute the primary color according to the chosen perceptual color.
  57019. */
  57020. private _computePrimaryColorFromPerceptualColor;
  57021. /**
  57022. * Compute the highlights and shadow colors according to their chosen levels.
  57023. */
  57024. private _computePrimaryColors;
  57025. /**
  57026. * Build the uniform buffer used in the material.
  57027. */
  57028. buildUniformLayout(): void;
  57029. /**
  57030. * Unbind the material.
  57031. */
  57032. unbind(): void;
  57033. /**
  57034. * Bind only the world matrix to the material.
  57035. * @param world The world matrix to bind.
  57036. */
  57037. bindOnlyWorldMatrix(world: Matrix): void;
  57038. /**
  57039. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  57040. * @param world The world matrix to bind.
  57041. * @param subMesh The submesh to bind for.
  57042. */
  57043. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  57044. /**
  57045. * Checks to see if a texture is used in the material.
  57046. * @param texture - Base texture to use.
  57047. * @returns - Boolean specifying if a texture is used in the material.
  57048. */
  57049. hasTexture(texture: BaseTexture): boolean;
  57050. /**
  57051. * Dispose the material.
  57052. * @param forceDisposeEffect Force disposal of the associated effect.
  57053. * @param forceDisposeTextures Force disposal of the associated textures.
  57054. */
  57055. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  57056. /**
  57057. * Clones the material.
  57058. * @param name The cloned name.
  57059. * @returns The cloned material.
  57060. */
  57061. clone(name: string): BackgroundMaterial;
  57062. /**
  57063. * Serializes the current material to its JSON representation.
  57064. * @returns The JSON representation.
  57065. */
  57066. serialize(): any;
  57067. /**
  57068. * Gets the class name of the material
  57069. * @returns "BackgroundMaterial"
  57070. */
  57071. getClassName(): string;
  57072. /**
  57073. * Parse a JSON input to create back a background material.
  57074. * @param source The JSON data to parse
  57075. * @param scene The scene to create the parsed material in
  57076. * @param rootUrl The root url of the assets the material depends upon
  57077. * @returns the instantiated BackgroundMaterial.
  57078. */
  57079. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  57080. }
  57081. }
  57082. declare module "babylonjs/Helpers/environmentHelper" {
  57083. import { Observable } from "babylonjs/Misc/observable";
  57084. import { Nullable } from "babylonjs/types";
  57085. import { Scene } from "babylonjs/scene";
  57086. import { Vector3 } from "babylonjs/Maths/math.vector";
  57087. import { Color3 } from "babylonjs/Maths/math.color";
  57088. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57089. import { Mesh } from "babylonjs/Meshes/mesh";
  57090. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57091. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57092. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57093. import "babylonjs/Meshes/Builders/planeBuilder";
  57094. import "babylonjs/Meshes/Builders/boxBuilder";
  57095. /**
  57096. * Represents the different options available during the creation of
  57097. * a Environment helper.
  57098. *
  57099. * This can control the default ground, skybox and image processing setup of your scene.
  57100. */
  57101. export interface IEnvironmentHelperOptions {
  57102. /**
  57103. * Specifies whether or not to create a ground.
  57104. * True by default.
  57105. */
  57106. createGround: boolean;
  57107. /**
  57108. * Specifies the ground size.
  57109. * 15 by default.
  57110. */
  57111. groundSize: number;
  57112. /**
  57113. * The texture used on the ground for the main color.
  57114. * Comes from the BabylonJS CDN by default.
  57115. *
  57116. * Remarks: Can be either a texture or a url.
  57117. */
  57118. groundTexture: string | BaseTexture;
  57119. /**
  57120. * The color mixed in the ground texture by default.
  57121. * BabylonJS clearColor by default.
  57122. */
  57123. groundColor: Color3;
  57124. /**
  57125. * Specifies the ground opacity.
  57126. * 1 by default.
  57127. */
  57128. groundOpacity: number;
  57129. /**
  57130. * Enables the ground to receive shadows.
  57131. * True by default.
  57132. */
  57133. enableGroundShadow: boolean;
  57134. /**
  57135. * Helps preventing the shadow to be fully black on the ground.
  57136. * 0.5 by default.
  57137. */
  57138. groundShadowLevel: number;
  57139. /**
  57140. * Creates a mirror texture attach to the ground.
  57141. * false by default.
  57142. */
  57143. enableGroundMirror: boolean;
  57144. /**
  57145. * Specifies the ground mirror size ratio.
  57146. * 0.3 by default as the default kernel is 64.
  57147. */
  57148. groundMirrorSizeRatio: number;
  57149. /**
  57150. * Specifies the ground mirror blur kernel size.
  57151. * 64 by default.
  57152. */
  57153. groundMirrorBlurKernel: number;
  57154. /**
  57155. * Specifies the ground mirror visibility amount.
  57156. * 1 by default
  57157. */
  57158. groundMirrorAmount: number;
  57159. /**
  57160. * Specifies the ground mirror reflectance weight.
  57161. * This uses the standard weight of the background material to setup the fresnel effect
  57162. * of the mirror.
  57163. * 1 by default.
  57164. */
  57165. groundMirrorFresnelWeight: number;
  57166. /**
  57167. * Specifies the ground mirror Falloff distance.
  57168. * This can helps reducing the size of the reflection.
  57169. * 0 by Default.
  57170. */
  57171. groundMirrorFallOffDistance: number;
  57172. /**
  57173. * Specifies the ground mirror texture type.
  57174. * Unsigned Int by Default.
  57175. */
  57176. groundMirrorTextureType: number;
  57177. /**
  57178. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57179. * the shown objects.
  57180. */
  57181. groundYBias: number;
  57182. /**
  57183. * Specifies whether or not to create a skybox.
  57184. * True by default.
  57185. */
  57186. createSkybox: boolean;
  57187. /**
  57188. * Specifies the skybox size.
  57189. * 20 by default.
  57190. */
  57191. skyboxSize: number;
  57192. /**
  57193. * The texture used on the skybox for the main color.
  57194. * Comes from the BabylonJS CDN by default.
  57195. *
  57196. * Remarks: Can be either a texture or a url.
  57197. */
  57198. skyboxTexture: string | BaseTexture;
  57199. /**
  57200. * The color mixed in the skybox texture by default.
  57201. * BabylonJS clearColor by default.
  57202. */
  57203. skyboxColor: Color3;
  57204. /**
  57205. * The background rotation around the Y axis of the scene.
  57206. * This helps aligning the key lights of your scene with the background.
  57207. * 0 by default.
  57208. */
  57209. backgroundYRotation: number;
  57210. /**
  57211. * Compute automatically the size of the elements to best fit with the scene.
  57212. */
  57213. sizeAuto: boolean;
  57214. /**
  57215. * Default position of the rootMesh if autoSize is not true.
  57216. */
  57217. rootPosition: Vector3;
  57218. /**
  57219. * Sets up the image processing in the scene.
  57220. * true by default.
  57221. */
  57222. setupImageProcessing: boolean;
  57223. /**
  57224. * The texture used as your environment texture in the scene.
  57225. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57226. *
  57227. * Remarks: Can be either a texture or a url.
  57228. */
  57229. environmentTexture: string | BaseTexture;
  57230. /**
  57231. * The value of the exposure to apply to the scene.
  57232. * 0.6 by default if setupImageProcessing is true.
  57233. */
  57234. cameraExposure: number;
  57235. /**
  57236. * The value of the contrast to apply to the scene.
  57237. * 1.6 by default if setupImageProcessing is true.
  57238. */
  57239. cameraContrast: number;
  57240. /**
  57241. * Specifies whether or not tonemapping should be enabled in the scene.
  57242. * true by default if setupImageProcessing is true.
  57243. */
  57244. toneMappingEnabled: boolean;
  57245. }
  57246. /**
  57247. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57248. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57249. * It also helps with the default setup of your imageProcessing configuration.
  57250. */
  57251. export class EnvironmentHelper {
  57252. /**
  57253. * Default ground texture URL.
  57254. */
  57255. private static _groundTextureCDNUrl;
  57256. /**
  57257. * Default skybox texture URL.
  57258. */
  57259. private static _skyboxTextureCDNUrl;
  57260. /**
  57261. * Default environment texture URL.
  57262. */
  57263. private static _environmentTextureCDNUrl;
  57264. /**
  57265. * Creates the default options for the helper.
  57266. */
  57267. private static _getDefaultOptions;
  57268. private _rootMesh;
  57269. /**
  57270. * Gets the root mesh created by the helper.
  57271. */
  57272. get rootMesh(): Mesh;
  57273. private _skybox;
  57274. /**
  57275. * Gets the skybox created by the helper.
  57276. */
  57277. get skybox(): Nullable<Mesh>;
  57278. private _skyboxTexture;
  57279. /**
  57280. * Gets the skybox texture created by the helper.
  57281. */
  57282. get skyboxTexture(): Nullable<BaseTexture>;
  57283. private _skyboxMaterial;
  57284. /**
  57285. * Gets the skybox material created by the helper.
  57286. */
  57287. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57288. private _ground;
  57289. /**
  57290. * Gets the ground mesh created by the helper.
  57291. */
  57292. get ground(): Nullable<Mesh>;
  57293. private _groundTexture;
  57294. /**
  57295. * Gets the ground texture created by the helper.
  57296. */
  57297. get groundTexture(): Nullable<BaseTexture>;
  57298. private _groundMirror;
  57299. /**
  57300. * Gets the ground mirror created by the helper.
  57301. */
  57302. get groundMirror(): Nullable<MirrorTexture>;
  57303. /**
  57304. * Gets the ground mirror render list to helps pushing the meshes
  57305. * you wish in the ground reflection.
  57306. */
  57307. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57308. private _groundMaterial;
  57309. /**
  57310. * Gets the ground material created by the helper.
  57311. */
  57312. get groundMaterial(): Nullable<BackgroundMaterial>;
  57313. /**
  57314. * Stores the creation options.
  57315. */
  57316. private readonly _scene;
  57317. private _options;
  57318. /**
  57319. * This observable will be notified with any error during the creation of the environment,
  57320. * mainly texture creation errors.
  57321. */
  57322. onErrorObservable: Observable<{
  57323. message?: string;
  57324. exception?: any;
  57325. }>;
  57326. /**
  57327. * constructor
  57328. * @param options Defines the options we want to customize the helper
  57329. * @param scene The scene to add the material to
  57330. */
  57331. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57332. /**
  57333. * Updates the background according to the new options
  57334. * @param options
  57335. */
  57336. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57337. /**
  57338. * Sets the primary color of all the available elements.
  57339. * @param color the main color to affect to the ground and the background
  57340. */
  57341. setMainColor(color: Color3): void;
  57342. /**
  57343. * Setup the image processing according to the specified options.
  57344. */
  57345. private _setupImageProcessing;
  57346. /**
  57347. * Setup the environment texture according to the specified options.
  57348. */
  57349. private _setupEnvironmentTexture;
  57350. /**
  57351. * Setup the background according to the specified options.
  57352. */
  57353. private _setupBackground;
  57354. /**
  57355. * Get the scene sizes according to the setup.
  57356. */
  57357. private _getSceneSize;
  57358. /**
  57359. * Setup the ground according to the specified options.
  57360. */
  57361. private _setupGround;
  57362. /**
  57363. * Setup the ground material according to the specified options.
  57364. */
  57365. private _setupGroundMaterial;
  57366. /**
  57367. * Setup the ground diffuse texture according to the specified options.
  57368. */
  57369. private _setupGroundDiffuseTexture;
  57370. /**
  57371. * Setup the ground mirror texture according to the specified options.
  57372. */
  57373. private _setupGroundMirrorTexture;
  57374. /**
  57375. * Setup the ground to receive the mirror texture.
  57376. */
  57377. private _setupMirrorInGroundMaterial;
  57378. /**
  57379. * Setup the skybox according to the specified options.
  57380. */
  57381. private _setupSkybox;
  57382. /**
  57383. * Setup the skybox material according to the specified options.
  57384. */
  57385. private _setupSkyboxMaterial;
  57386. /**
  57387. * Setup the skybox reflection texture according to the specified options.
  57388. */
  57389. private _setupSkyboxReflectionTexture;
  57390. private _errorHandler;
  57391. /**
  57392. * Dispose all the elements created by the Helper.
  57393. */
  57394. dispose(): void;
  57395. }
  57396. }
  57397. declare module "babylonjs/Helpers/textureDome" {
  57398. import { Scene } from "babylonjs/scene";
  57399. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57400. import { Mesh } from "babylonjs/Meshes/mesh";
  57401. import { Texture } from "babylonjs/Materials/Textures/texture";
  57402. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57403. import "babylonjs/Meshes/Builders/sphereBuilder";
  57404. import { Nullable } from "babylonjs/types";
  57405. import { Observable } from "babylonjs/Misc/observable";
  57406. /**
  57407. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57408. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57409. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57410. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57411. */
  57412. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57413. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57414. /**
  57415. * Define the source as a Monoscopic panoramic 360/180.
  57416. */
  57417. static readonly MODE_MONOSCOPIC: number;
  57418. /**
  57419. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57420. */
  57421. static readonly MODE_TOPBOTTOM: number;
  57422. /**
  57423. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57424. */
  57425. static readonly MODE_SIDEBYSIDE: number;
  57426. private _halfDome;
  57427. protected _useDirectMapping: boolean;
  57428. /**
  57429. * The texture being displayed on the sphere
  57430. */
  57431. protected _texture: T;
  57432. /**
  57433. * Gets the texture being displayed on the sphere
  57434. */
  57435. get texture(): T;
  57436. /**
  57437. * Sets the texture being displayed on the sphere
  57438. */
  57439. set texture(newTexture: T);
  57440. /**
  57441. * The skybox material
  57442. */
  57443. protected _material: BackgroundMaterial;
  57444. /**
  57445. * The surface used for the dome
  57446. */
  57447. protected _mesh: Mesh;
  57448. /**
  57449. * Gets the mesh used for the dome.
  57450. */
  57451. get mesh(): Mesh;
  57452. /**
  57453. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57454. */
  57455. private _halfDomeMask;
  57456. /**
  57457. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57458. * Also see the options.resolution property.
  57459. */
  57460. get fovMultiplier(): number;
  57461. set fovMultiplier(value: number);
  57462. protected _textureMode: number;
  57463. /**
  57464. * Gets or set the current texture mode for the texture. It can be:
  57465. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57466. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57467. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57468. */
  57469. get textureMode(): number;
  57470. /**
  57471. * Sets the current texture mode for the texture. It can be:
  57472. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57473. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57474. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57475. */
  57476. set textureMode(value: number);
  57477. /**
  57478. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57479. */
  57480. get halfDome(): boolean;
  57481. /**
  57482. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57483. */
  57484. set halfDome(enabled: boolean);
  57485. /**
  57486. * Oberserver used in Stereoscopic VR Mode.
  57487. */
  57488. private _onBeforeCameraRenderObserver;
  57489. /**
  57490. * Observable raised when an error occured while loading the 360 image
  57491. */
  57492. onLoadErrorObservable: Observable<string>;
  57493. /**
  57494. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57495. * @param name Element's name, child elements will append suffixes for their own names.
  57496. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57497. * @param options An object containing optional or exposed sub element properties
  57498. */
  57499. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57500. resolution?: number;
  57501. clickToPlay?: boolean;
  57502. autoPlay?: boolean;
  57503. loop?: boolean;
  57504. size?: number;
  57505. poster?: string;
  57506. faceForward?: boolean;
  57507. useDirectMapping?: boolean;
  57508. halfDomeMode?: boolean;
  57509. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57510. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57511. protected _changeTextureMode(value: number): void;
  57512. /**
  57513. * Releases resources associated with this node.
  57514. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57515. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57516. */
  57517. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57518. }
  57519. }
  57520. declare module "babylonjs/Helpers/photoDome" {
  57521. import { Scene } from "babylonjs/scene";
  57522. import { Texture } from "babylonjs/Materials/Textures/texture";
  57523. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57524. /**
  57525. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57526. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57527. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57528. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57529. */
  57530. export class PhotoDome extends TextureDome<Texture> {
  57531. /**
  57532. * Define the image as a Monoscopic panoramic 360 image.
  57533. */
  57534. static readonly MODE_MONOSCOPIC: number;
  57535. /**
  57536. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57537. */
  57538. static readonly MODE_TOPBOTTOM: number;
  57539. /**
  57540. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57541. */
  57542. static readonly MODE_SIDEBYSIDE: number;
  57543. /**
  57544. * Gets or sets the texture being displayed on the sphere
  57545. */
  57546. get photoTexture(): Texture;
  57547. /**
  57548. * sets the texture being displayed on the sphere
  57549. */
  57550. set photoTexture(value: Texture);
  57551. /**
  57552. * Gets the current video mode for the video. It can be:
  57553. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57554. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57555. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57556. */
  57557. get imageMode(): number;
  57558. /**
  57559. * Sets the current video mode for the video. It can be:
  57560. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57561. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57562. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57563. */
  57564. set imageMode(value: number);
  57565. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57566. }
  57567. }
  57568. declare module "babylonjs/Misc/rgbdTextureTools" {
  57569. import "babylonjs/Shaders/rgbdDecode.fragment";
  57570. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57571. import { Texture } from "babylonjs/Materials/Textures/texture";
  57572. /**
  57573. * Class used to host RGBD texture specific utilities
  57574. */
  57575. export class RGBDTextureTools {
  57576. /**
  57577. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57578. * @param texture the texture to expand.
  57579. */
  57580. static ExpandRGBDTexture(texture: Texture): void;
  57581. }
  57582. }
  57583. declare module "babylonjs/Misc/brdfTextureTools" {
  57584. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57585. import { Scene } from "babylonjs/scene";
  57586. /**
  57587. * Class used to host texture specific utilities
  57588. */
  57589. export class BRDFTextureTools {
  57590. /**
  57591. * Prevents texture cache collision
  57592. */
  57593. private static _instanceNumber;
  57594. /**
  57595. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57596. * @param scene defines the hosting scene
  57597. * @returns the environment BRDF texture
  57598. */
  57599. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57600. private static _environmentBRDFBase64Texture;
  57601. }
  57602. }
  57603. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57604. import { Nullable } from "babylonjs/types";
  57605. import { Color3 } from "babylonjs/Maths/math.color";
  57606. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57607. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57608. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57609. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57610. import { Engine } from "babylonjs/Engines/engine";
  57611. import { Scene } from "babylonjs/scene";
  57612. /**
  57613. * @hidden
  57614. */
  57615. export interface IMaterialClearCoatDefines {
  57616. CLEARCOAT: boolean;
  57617. CLEARCOAT_DEFAULTIOR: boolean;
  57618. CLEARCOAT_TEXTURE: boolean;
  57619. CLEARCOAT_TEXTUREDIRECTUV: number;
  57620. CLEARCOAT_BUMP: boolean;
  57621. CLEARCOAT_BUMPDIRECTUV: number;
  57622. CLEARCOAT_TINT: boolean;
  57623. CLEARCOAT_TINT_TEXTURE: boolean;
  57624. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57625. /** @hidden */
  57626. _areTexturesDirty: boolean;
  57627. }
  57628. /**
  57629. * Define the code related to the clear coat parameters of the pbr material.
  57630. */
  57631. export class PBRClearCoatConfiguration {
  57632. /**
  57633. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57634. * The default fits with a polyurethane material.
  57635. */
  57636. private static readonly _DefaultIndexOfRefraction;
  57637. private _isEnabled;
  57638. /**
  57639. * Defines if the clear coat is enabled in the material.
  57640. */
  57641. isEnabled: boolean;
  57642. /**
  57643. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57644. */
  57645. intensity: number;
  57646. /**
  57647. * Defines the clear coat layer roughness.
  57648. */
  57649. roughness: number;
  57650. private _indexOfRefraction;
  57651. /**
  57652. * Defines the index of refraction of the clear coat.
  57653. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57654. * The default fits with a polyurethane material.
  57655. * Changing the default value is more performance intensive.
  57656. */
  57657. indexOfRefraction: number;
  57658. private _texture;
  57659. /**
  57660. * Stores the clear coat values in a texture.
  57661. */
  57662. texture: Nullable<BaseTexture>;
  57663. private _bumpTexture;
  57664. /**
  57665. * Define the clear coat specific bump texture.
  57666. */
  57667. bumpTexture: Nullable<BaseTexture>;
  57668. private _isTintEnabled;
  57669. /**
  57670. * Defines if the clear coat tint is enabled in the material.
  57671. */
  57672. isTintEnabled: boolean;
  57673. /**
  57674. * Defines the clear coat tint of the material.
  57675. * This is only use if tint is enabled
  57676. */
  57677. tintColor: Color3;
  57678. /**
  57679. * Defines the distance at which the tint color should be found in the
  57680. * clear coat media.
  57681. * This is only use if tint is enabled
  57682. */
  57683. tintColorAtDistance: number;
  57684. /**
  57685. * Defines the clear coat layer thickness.
  57686. * This is only use if tint is enabled
  57687. */
  57688. tintThickness: number;
  57689. private _tintTexture;
  57690. /**
  57691. * Stores the clear tint values in a texture.
  57692. * rgb is tint
  57693. * a is a thickness factor
  57694. */
  57695. tintTexture: Nullable<BaseTexture>;
  57696. /** @hidden */
  57697. private _internalMarkAllSubMeshesAsTexturesDirty;
  57698. /** @hidden */
  57699. _markAllSubMeshesAsTexturesDirty(): void;
  57700. /**
  57701. * Instantiate a new istance of clear coat configuration.
  57702. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57703. */
  57704. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57705. /**
  57706. * Gets wehter the submesh is ready to be used or not.
  57707. * @param defines the list of "defines" to update.
  57708. * @param scene defines the scene the material belongs to.
  57709. * @param engine defines the engine the material belongs to.
  57710. * @param disableBumpMap defines wether the material disables bump or not.
  57711. * @returns - boolean indicating that the submesh is ready or not.
  57712. */
  57713. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57714. /**
  57715. * Checks to see if a texture is used in the material.
  57716. * @param defines the list of "defines" to update.
  57717. * @param scene defines the scene to the material belongs to.
  57718. */
  57719. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57720. /**
  57721. * Binds the material data.
  57722. * @param uniformBuffer defines the Uniform buffer to fill in.
  57723. * @param scene defines the scene the material belongs to.
  57724. * @param engine defines the engine the material belongs to.
  57725. * @param disableBumpMap defines wether the material disables bump or not.
  57726. * @param isFrozen defines wether the material is frozen or not.
  57727. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57728. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57729. */
  57730. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57731. /**
  57732. * Checks to see if a texture is used in the material.
  57733. * @param texture - Base texture to use.
  57734. * @returns - Boolean specifying if a texture is used in the material.
  57735. */
  57736. hasTexture(texture: BaseTexture): boolean;
  57737. /**
  57738. * Returns an array of the actively used textures.
  57739. * @param activeTextures Array of BaseTextures
  57740. */
  57741. getActiveTextures(activeTextures: BaseTexture[]): void;
  57742. /**
  57743. * Returns the animatable textures.
  57744. * @param animatables Array of animatable textures.
  57745. */
  57746. getAnimatables(animatables: IAnimatable[]): void;
  57747. /**
  57748. * Disposes the resources of the material.
  57749. * @param forceDisposeTextures - Forces the disposal of all textures.
  57750. */
  57751. dispose(forceDisposeTextures?: boolean): void;
  57752. /**
  57753. * Get the current class name of the texture useful for serialization or dynamic coding.
  57754. * @returns "PBRClearCoatConfiguration"
  57755. */
  57756. getClassName(): string;
  57757. /**
  57758. * Add fallbacks to the effect fallbacks list.
  57759. * @param defines defines the Base texture to use.
  57760. * @param fallbacks defines the current fallback list.
  57761. * @param currentRank defines the current fallback rank.
  57762. * @returns the new fallback rank.
  57763. */
  57764. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57765. /**
  57766. * Add the required uniforms to the current list.
  57767. * @param uniforms defines the current uniform list.
  57768. */
  57769. static AddUniforms(uniforms: string[]): void;
  57770. /**
  57771. * Add the required samplers to the current list.
  57772. * @param samplers defines the current sampler list.
  57773. */
  57774. static AddSamplers(samplers: string[]): void;
  57775. /**
  57776. * Add the required uniforms to the current buffer.
  57777. * @param uniformBuffer defines the current uniform buffer.
  57778. */
  57779. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57780. /**
  57781. * Makes a duplicate of the current configuration into another one.
  57782. * @param clearCoatConfiguration define the config where to copy the info
  57783. */
  57784. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57785. /**
  57786. * Serializes this clear coat configuration.
  57787. * @returns - An object with the serialized config.
  57788. */
  57789. serialize(): any;
  57790. /**
  57791. * Parses a anisotropy Configuration from a serialized object.
  57792. * @param source - Serialized object.
  57793. * @param scene Defines the scene we are parsing for
  57794. * @param rootUrl Defines the rootUrl to load from
  57795. */
  57796. parse(source: any, scene: Scene, rootUrl: string): void;
  57797. }
  57798. }
  57799. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57800. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57801. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57802. import { Vector2 } from "babylonjs/Maths/math.vector";
  57803. import { Scene } from "babylonjs/scene";
  57804. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57805. import { Nullable } from "babylonjs/types";
  57806. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57807. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57808. /**
  57809. * @hidden
  57810. */
  57811. export interface IMaterialAnisotropicDefines {
  57812. ANISOTROPIC: boolean;
  57813. ANISOTROPIC_TEXTURE: boolean;
  57814. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57815. MAINUV1: boolean;
  57816. _areTexturesDirty: boolean;
  57817. _needUVs: boolean;
  57818. }
  57819. /**
  57820. * Define the code related to the anisotropic parameters of the pbr material.
  57821. */
  57822. export class PBRAnisotropicConfiguration {
  57823. private _isEnabled;
  57824. /**
  57825. * Defines if the anisotropy is enabled in the material.
  57826. */
  57827. isEnabled: boolean;
  57828. /**
  57829. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57830. */
  57831. intensity: number;
  57832. /**
  57833. * Defines if the effect is along the tangents, bitangents or in between.
  57834. * By default, the effect is "strectching" the highlights along the tangents.
  57835. */
  57836. direction: Vector2;
  57837. private _texture;
  57838. /**
  57839. * Stores the anisotropy values in a texture.
  57840. * rg is direction (like normal from -1 to 1)
  57841. * b is a intensity
  57842. */
  57843. texture: Nullable<BaseTexture>;
  57844. /** @hidden */
  57845. private _internalMarkAllSubMeshesAsTexturesDirty;
  57846. /** @hidden */
  57847. _markAllSubMeshesAsTexturesDirty(): void;
  57848. /**
  57849. * Instantiate a new istance of anisotropy configuration.
  57850. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57851. */
  57852. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57853. /**
  57854. * Specifies that the submesh is ready to be used.
  57855. * @param defines the list of "defines" to update.
  57856. * @param scene defines the scene the material belongs to.
  57857. * @returns - boolean indicating that the submesh is ready or not.
  57858. */
  57859. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57860. /**
  57861. * Checks to see if a texture is used in the material.
  57862. * @param defines the list of "defines" to update.
  57863. * @param mesh the mesh we are preparing the defines for.
  57864. * @param scene defines the scene the material belongs to.
  57865. */
  57866. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57867. /**
  57868. * Binds the material data.
  57869. * @param uniformBuffer defines the Uniform buffer to fill in.
  57870. * @param scene defines the scene the material belongs to.
  57871. * @param isFrozen defines wether the material is frozen or not.
  57872. */
  57873. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57874. /**
  57875. * Checks to see if a texture is used in the material.
  57876. * @param texture - Base texture to use.
  57877. * @returns - Boolean specifying if a texture is used in the material.
  57878. */
  57879. hasTexture(texture: BaseTexture): boolean;
  57880. /**
  57881. * Returns an array of the actively used textures.
  57882. * @param activeTextures Array of BaseTextures
  57883. */
  57884. getActiveTextures(activeTextures: BaseTexture[]): void;
  57885. /**
  57886. * Returns the animatable textures.
  57887. * @param animatables Array of animatable textures.
  57888. */
  57889. getAnimatables(animatables: IAnimatable[]): void;
  57890. /**
  57891. * Disposes the resources of the material.
  57892. * @param forceDisposeTextures - Forces the disposal of all textures.
  57893. */
  57894. dispose(forceDisposeTextures?: boolean): void;
  57895. /**
  57896. * Get the current class name of the texture useful for serialization or dynamic coding.
  57897. * @returns "PBRAnisotropicConfiguration"
  57898. */
  57899. getClassName(): string;
  57900. /**
  57901. * Add fallbacks to the effect fallbacks list.
  57902. * @param defines defines the Base texture to use.
  57903. * @param fallbacks defines the current fallback list.
  57904. * @param currentRank defines the current fallback rank.
  57905. * @returns the new fallback rank.
  57906. */
  57907. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57908. /**
  57909. * Add the required uniforms to the current list.
  57910. * @param uniforms defines the current uniform list.
  57911. */
  57912. static AddUniforms(uniforms: string[]): void;
  57913. /**
  57914. * Add the required uniforms to the current buffer.
  57915. * @param uniformBuffer defines the current uniform buffer.
  57916. */
  57917. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57918. /**
  57919. * Add the required samplers to the current list.
  57920. * @param samplers defines the current sampler list.
  57921. */
  57922. static AddSamplers(samplers: string[]): void;
  57923. /**
  57924. * Makes a duplicate of the current configuration into another one.
  57925. * @param anisotropicConfiguration define the config where to copy the info
  57926. */
  57927. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57928. /**
  57929. * Serializes this anisotropy configuration.
  57930. * @returns - An object with the serialized config.
  57931. */
  57932. serialize(): any;
  57933. /**
  57934. * Parses a anisotropy Configuration from a serialized object.
  57935. * @param source - Serialized object.
  57936. * @param scene Defines the scene we are parsing for
  57937. * @param rootUrl Defines the rootUrl to load from
  57938. */
  57939. parse(source: any, scene: Scene, rootUrl: string): void;
  57940. }
  57941. }
  57942. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57943. import { Scene } from "babylonjs/scene";
  57944. /**
  57945. * @hidden
  57946. */
  57947. export interface IMaterialBRDFDefines {
  57948. BRDF_V_HEIGHT_CORRELATED: boolean;
  57949. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57950. SPHERICAL_HARMONICS: boolean;
  57951. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57952. /** @hidden */
  57953. _areMiscDirty: boolean;
  57954. }
  57955. /**
  57956. * Define the code related to the BRDF parameters of the pbr material.
  57957. */
  57958. export class PBRBRDFConfiguration {
  57959. /**
  57960. * Default value used for the energy conservation.
  57961. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57962. */
  57963. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57964. /**
  57965. * Default value used for the Smith Visibility Height Correlated mode.
  57966. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57967. */
  57968. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57969. /**
  57970. * Default value used for the IBL diffuse part.
  57971. * This can help switching back to the polynomials mode globally which is a tiny bit
  57972. * less GPU intensive at the drawback of a lower quality.
  57973. */
  57974. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57975. /**
  57976. * Default value used for activating energy conservation for the specular workflow.
  57977. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57978. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57979. */
  57980. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57981. private _useEnergyConservation;
  57982. /**
  57983. * Defines if the material uses energy conservation.
  57984. */
  57985. useEnergyConservation: boolean;
  57986. private _useSmithVisibilityHeightCorrelated;
  57987. /**
  57988. * LEGACY Mode set to false
  57989. * Defines if the material uses height smith correlated visibility term.
  57990. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57991. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57992. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57993. * Not relying on height correlated will also disable energy conservation.
  57994. */
  57995. useSmithVisibilityHeightCorrelated: boolean;
  57996. private _useSphericalHarmonics;
  57997. /**
  57998. * LEGACY Mode set to false
  57999. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  58000. * diffuse part of the IBL.
  58001. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  58002. * to the ground truth.
  58003. */
  58004. useSphericalHarmonics: boolean;
  58005. private _useSpecularGlossinessInputEnergyConservation;
  58006. /**
  58007. * Defines if the material uses energy conservation, when the specular workflow is active.
  58008. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58009. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58010. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  58011. */
  58012. useSpecularGlossinessInputEnergyConservation: boolean;
  58013. /** @hidden */
  58014. private _internalMarkAllSubMeshesAsMiscDirty;
  58015. /** @hidden */
  58016. _markAllSubMeshesAsMiscDirty(): void;
  58017. /**
  58018. * Instantiate a new istance of clear coat configuration.
  58019. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  58020. */
  58021. constructor(markAllSubMeshesAsMiscDirty: () => void);
  58022. /**
  58023. * Checks to see if a texture is used in the material.
  58024. * @param defines the list of "defines" to update.
  58025. */
  58026. prepareDefines(defines: IMaterialBRDFDefines): void;
  58027. /**
  58028. * Get the current class name of the texture useful for serialization or dynamic coding.
  58029. * @returns "PBRClearCoatConfiguration"
  58030. */
  58031. getClassName(): string;
  58032. /**
  58033. * Makes a duplicate of the current configuration into another one.
  58034. * @param brdfConfiguration define the config where to copy the info
  58035. */
  58036. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  58037. /**
  58038. * Serializes this BRDF configuration.
  58039. * @returns - An object with the serialized config.
  58040. */
  58041. serialize(): any;
  58042. /**
  58043. * Parses a anisotropy Configuration from a serialized object.
  58044. * @param source - Serialized object.
  58045. * @param scene Defines the scene we are parsing for
  58046. * @param rootUrl Defines the rootUrl to load from
  58047. */
  58048. parse(source: any, scene: Scene, rootUrl: string): void;
  58049. }
  58050. }
  58051. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  58052. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58053. import { Color3 } from "babylonjs/Maths/math.color";
  58054. import { Scene } from "babylonjs/scene";
  58055. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58056. import { Nullable } from "babylonjs/types";
  58057. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58058. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58059. /**
  58060. * @hidden
  58061. */
  58062. export interface IMaterialSheenDefines {
  58063. SHEEN: boolean;
  58064. SHEEN_TEXTURE: boolean;
  58065. SHEEN_TEXTUREDIRECTUV: number;
  58066. SHEEN_LINKWITHALBEDO: boolean;
  58067. SHEEN_ROUGHNESS: boolean;
  58068. SHEEN_ALBEDOSCALING: boolean;
  58069. /** @hidden */
  58070. _areTexturesDirty: boolean;
  58071. }
  58072. /**
  58073. * Define the code related to the Sheen parameters of the pbr material.
  58074. */
  58075. export class PBRSheenConfiguration {
  58076. private _isEnabled;
  58077. /**
  58078. * Defines if the material uses sheen.
  58079. */
  58080. isEnabled: boolean;
  58081. private _linkSheenWithAlbedo;
  58082. /**
  58083. * Defines if the sheen is linked to the sheen color.
  58084. */
  58085. linkSheenWithAlbedo: boolean;
  58086. /**
  58087. * Defines the sheen intensity.
  58088. */
  58089. intensity: number;
  58090. /**
  58091. * Defines the sheen color.
  58092. */
  58093. color: Color3;
  58094. private _texture;
  58095. /**
  58096. * Stores the sheen tint values in a texture.
  58097. * rgb is tint
  58098. * a is a intensity or roughness if roughness has been defined
  58099. */
  58100. texture: Nullable<BaseTexture>;
  58101. private _roughness;
  58102. /**
  58103. * Defines the sheen roughness.
  58104. * It is not taken into account if linkSheenWithAlbedo is true.
  58105. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58106. */
  58107. roughness: Nullable<number>;
  58108. private _albedoScaling;
  58109. /**
  58110. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58111. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58112. * making it easier to setup and tweak the effect
  58113. */
  58114. albedoScaling: boolean;
  58115. /** @hidden */
  58116. private _internalMarkAllSubMeshesAsTexturesDirty;
  58117. /** @hidden */
  58118. _markAllSubMeshesAsTexturesDirty(): void;
  58119. /**
  58120. * Instantiate a new istance of clear coat configuration.
  58121. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58122. */
  58123. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58124. /**
  58125. * Specifies that the submesh is ready to be used.
  58126. * @param defines the list of "defines" to update.
  58127. * @param scene defines the scene the material belongs to.
  58128. * @returns - boolean indicating that the submesh is ready or not.
  58129. */
  58130. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58131. /**
  58132. * Checks to see if a texture is used in the material.
  58133. * @param defines the list of "defines" to update.
  58134. * @param scene defines the scene the material belongs to.
  58135. */
  58136. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58137. /**
  58138. * Binds the material data.
  58139. * @param uniformBuffer defines the Uniform buffer to fill in.
  58140. * @param scene defines the scene the material belongs to.
  58141. * @param isFrozen defines wether the material is frozen or not.
  58142. */
  58143. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58144. /**
  58145. * Checks to see if a texture is used in the material.
  58146. * @param texture - Base texture to use.
  58147. * @returns - Boolean specifying if a texture is used in the material.
  58148. */
  58149. hasTexture(texture: BaseTexture): boolean;
  58150. /**
  58151. * Returns an array of the actively used textures.
  58152. * @param activeTextures Array of BaseTextures
  58153. */
  58154. getActiveTextures(activeTextures: BaseTexture[]): void;
  58155. /**
  58156. * Returns the animatable textures.
  58157. * @param animatables Array of animatable textures.
  58158. */
  58159. getAnimatables(animatables: IAnimatable[]): void;
  58160. /**
  58161. * Disposes the resources of the material.
  58162. * @param forceDisposeTextures - Forces the disposal of all textures.
  58163. */
  58164. dispose(forceDisposeTextures?: boolean): void;
  58165. /**
  58166. * Get the current class name of the texture useful for serialization or dynamic coding.
  58167. * @returns "PBRSheenConfiguration"
  58168. */
  58169. getClassName(): string;
  58170. /**
  58171. * Add fallbacks to the effect fallbacks list.
  58172. * @param defines defines the Base texture to use.
  58173. * @param fallbacks defines the current fallback list.
  58174. * @param currentRank defines the current fallback rank.
  58175. * @returns the new fallback rank.
  58176. */
  58177. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58178. /**
  58179. * Add the required uniforms to the current list.
  58180. * @param uniforms defines the current uniform list.
  58181. */
  58182. static AddUniforms(uniforms: string[]): void;
  58183. /**
  58184. * Add the required uniforms to the current buffer.
  58185. * @param uniformBuffer defines the current uniform buffer.
  58186. */
  58187. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58188. /**
  58189. * Add the required samplers to the current list.
  58190. * @param samplers defines the current sampler list.
  58191. */
  58192. static AddSamplers(samplers: string[]): void;
  58193. /**
  58194. * Makes a duplicate of the current configuration into another one.
  58195. * @param sheenConfiguration define the config where to copy the info
  58196. */
  58197. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58198. /**
  58199. * Serializes this BRDF configuration.
  58200. * @returns - An object with the serialized config.
  58201. */
  58202. serialize(): any;
  58203. /**
  58204. * Parses a anisotropy Configuration from a serialized object.
  58205. * @param source - Serialized object.
  58206. * @param scene Defines the scene we are parsing for
  58207. * @param rootUrl Defines the rootUrl to load from
  58208. */
  58209. parse(source: any, scene: Scene, rootUrl: string): void;
  58210. }
  58211. }
  58212. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58213. import { Nullable } from "babylonjs/types";
  58214. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58215. import { Color3 } from "babylonjs/Maths/math.color";
  58216. import { SmartArray } from "babylonjs/Misc/smartArray";
  58217. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58218. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58219. import { Effect } from "babylonjs/Materials/effect";
  58220. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58221. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58222. import { Engine } from "babylonjs/Engines/engine";
  58223. import { Scene } from "babylonjs/scene";
  58224. /**
  58225. * @hidden
  58226. */
  58227. export interface IMaterialSubSurfaceDefines {
  58228. SUBSURFACE: boolean;
  58229. SS_REFRACTION: boolean;
  58230. SS_TRANSLUCENCY: boolean;
  58231. SS_SCATTERING: boolean;
  58232. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58233. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58234. SS_REFRACTIONMAP_3D: boolean;
  58235. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58236. SS_LODINREFRACTIONALPHA: boolean;
  58237. SS_GAMMAREFRACTION: boolean;
  58238. SS_RGBDREFRACTION: boolean;
  58239. SS_LINEARSPECULARREFRACTION: boolean;
  58240. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58241. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58242. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58243. /** @hidden */
  58244. _areTexturesDirty: boolean;
  58245. }
  58246. /**
  58247. * Define the code related to the sub surface parameters of the pbr material.
  58248. */
  58249. export class PBRSubSurfaceConfiguration {
  58250. private _isRefractionEnabled;
  58251. /**
  58252. * Defines if the refraction is enabled in the material.
  58253. */
  58254. isRefractionEnabled: boolean;
  58255. private _isTranslucencyEnabled;
  58256. /**
  58257. * Defines if the translucency is enabled in the material.
  58258. */
  58259. isTranslucencyEnabled: boolean;
  58260. private _isScatteringEnabled;
  58261. /**
  58262. * Defines if the sub surface scattering is enabled in the material.
  58263. */
  58264. isScatteringEnabled: boolean;
  58265. private _scatteringDiffusionProfileIndex;
  58266. /**
  58267. * Diffusion profile for subsurface scattering.
  58268. * Useful for better scattering in the skins or foliages.
  58269. */
  58270. get scatteringDiffusionProfile(): Nullable<Color3>;
  58271. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58272. /**
  58273. * Defines the refraction intensity of the material.
  58274. * The refraction when enabled replaces the Diffuse part of the material.
  58275. * The intensity helps transitionning between diffuse and refraction.
  58276. */
  58277. refractionIntensity: number;
  58278. /**
  58279. * Defines the translucency intensity of the material.
  58280. * When translucency has been enabled, this defines how much of the "translucency"
  58281. * is addded to the diffuse part of the material.
  58282. */
  58283. translucencyIntensity: number;
  58284. /**
  58285. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58286. */
  58287. useAlbedoToTintRefraction: boolean;
  58288. private _thicknessTexture;
  58289. /**
  58290. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58291. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58292. * 0 would mean minimumThickness
  58293. * 1 would mean maximumThickness
  58294. * The other channels might be use as a mask to vary the different effects intensity.
  58295. */
  58296. thicknessTexture: Nullable<BaseTexture>;
  58297. private _refractionTexture;
  58298. /**
  58299. * Defines the texture to use for refraction.
  58300. */
  58301. refractionTexture: Nullable<BaseTexture>;
  58302. private _indexOfRefraction;
  58303. /**
  58304. * Index of refraction of the material base layer.
  58305. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58306. *
  58307. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58308. *
  58309. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58310. */
  58311. indexOfRefraction: number;
  58312. private _volumeIndexOfRefraction;
  58313. /**
  58314. * Index of refraction of the material's volume.
  58315. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58316. *
  58317. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58318. * the volume will use the same IOR as the surface.
  58319. */
  58320. get volumeIndexOfRefraction(): number;
  58321. set volumeIndexOfRefraction(value: number);
  58322. private _invertRefractionY;
  58323. /**
  58324. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58325. */
  58326. invertRefractionY: boolean;
  58327. private _linkRefractionWithTransparency;
  58328. /**
  58329. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58330. * Materials half opaque for instance using refraction could benefit from this control.
  58331. */
  58332. linkRefractionWithTransparency: boolean;
  58333. /**
  58334. * Defines the minimum thickness stored in the thickness map.
  58335. * If no thickness map is defined, this value will be used to simulate thickness.
  58336. */
  58337. minimumThickness: number;
  58338. /**
  58339. * Defines the maximum thickness stored in the thickness map.
  58340. */
  58341. maximumThickness: number;
  58342. /**
  58343. * Defines the volume tint of the material.
  58344. * This is used for both translucency and scattering.
  58345. */
  58346. tintColor: Color3;
  58347. /**
  58348. * Defines the distance at which the tint color should be found in the media.
  58349. * This is used for refraction only.
  58350. */
  58351. tintColorAtDistance: number;
  58352. /**
  58353. * Defines how far each channel transmit through the media.
  58354. * It is defined as a color to simplify it selection.
  58355. */
  58356. diffusionDistance: Color3;
  58357. private _useMaskFromThicknessTexture;
  58358. /**
  58359. * Stores the intensity of the different subsurface effects in the thickness texture.
  58360. * * the green channel is the translucency intensity.
  58361. * * the blue channel is the scattering intensity.
  58362. * * the alpha channel is the refraction intensity.
  58363. */
  58364. useMaskFromThicknessTexture: boolean;
  58365. private _scene;
  58366. /** @hidden */
  58367. private _internalMarkAllSubMeshesAsTexturesDirty;
  58368. private _internalMarkScenePrePassDirty;
  58369. /** @hidden */
  58370. _markAllSubMeshesAsTexturesDirty(): void;
  58371. /** @hidden */
  58372. _markScenePrePassDirty(): void;
  58373. /**
  58374. * Instantiate a new istance of sub surface configuration.
  58375. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58376. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58377. * @param scene The scene
  58378. */
  58379. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58380. /**
  58381. * Gets wehter the submesh is ready to be used or not.
  58382. * @param defines the list of "defines" to update.
  58383. * @param scene defines the scene the material belongs to.
  58384. * @returns - boolean indicating that the submesh is ready or not.
  58385. */
  58386. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58387. /**
  58388. * Checks to see if a texture is used in the material.
  58389. * @param defines the list of "defines" to update.
  58390. * @param scene defines the scene to the material belongs to.
  58391. */
  58392. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58393. /**
  58394. * Binds the material data.
  58395. * @param uniformBuffer defines the Uniform buffer to fill in.
  58396. * @param scene defines the scene the material belongs to.
  58397. * @param engine defines the engine the material belongs to.
  58398. * @param isFrozen defines whether the material is frozen or not.
  58399. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58400. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58401. */
  58402. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58403. /**
  58404. * Unbinds the material from the mesh.
  58405. * @param activeEffect defines the effect that should be unbound from.
  58406. * @returns true if unbound, otherwise false
  58407. */
  58408. unbind(activeEffect: Effect): boolean;
  58409. /**
  58410. * Returns the texture used for refraction or null if none is used.
  58411. * @param scene defines the scene the material belongs to.
  58412. * @returns - Refraction texture if present. If no refraction texture and refraction
  58413. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58414. */
  58415. private _getRefractionTexture;
  58416. /**
  58417. * Returns true if alpha blending should be disabled.
  58418. */
  58419. get disableAlphaBlending(): boolean;
  58420. /**
  58421. * Fills the list of render target textures.
  58422. * @param renderTargets the list of render targets to update
  58423. */
  58424. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58425. /**
  58426. * Checks to see if a texture is used in the material.
  58427. * @param texture - Base texture to use.
  58428. * @returns - Boolean specifying if a texture is used in the material.
  58429. */
  58430. hasTexture(texture: BaseTexture): boolean;
  58431. /**
  58432. * Gets a boolean indicating that current material needs to register RTT
  58433. * @returns true if this uses a render target otherwise false.
  58434. */
  58435. hasRenderTargetTextures(): boolean;
  58436. /**
  58437. * Returns an array of the actively used textures.
  58438. * @param activeTextures Array of BaseTextures
  58439. */
  58440. getActiveTextures(activeTextures: BaseTexture[]): void;
  58441. /**
  58442. * Returns the animatable textures.
  58443. * @param animatables Array of animatable textures.
  58444. */
  58445. getAnimatables(animatables: IAnimatable[]): void;
  58446. /**
  58447. * Disposes the resources of the material.
  58448. * @param forceDisposeTextures - Forces the disposal of all textures.
  58449. */
  58450. dispose(forceDisposeTextures?: boolean): void;
  58451. /**
  58452. * Get the current class name of the texture useful for serialization or dynamic coding.
  58453. * @returns "PBRSubSurfaceConfiguration"
  58454. */
  58455. getClassName(): string;
  58456. /**
  58457. * Add fallbacks to the effect fallbacks list.
  58458. * @param defines defines the Base texture to use.
  58459. * @param fallbacks defines the current fallback list.
  58460. * @param currentRank defines the current fallback rank.
  58461. * @returns the new fallback rank.
  58462. */
  58463. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58464. /**
  58465. * Add the required uniforms to the current list.
  58466. * @param uniforms defines the current uniform list.
  58467. */
  58468. static AddUniforms(uniforms: string[]): void;
  58469. /**
  58470. * Add the required samplers to the current list.
  58471. * @param samplers defines the current sampler list.
  58472. */
  58473. static AddSamplers(samplers: string[]): void;
  58474. /**
  58475. * Add the required uniforms to the current buffer.
  58476. * @param uniformBuffer defines the current uniform buffer.
  58477. */
  58478. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58479. /**
  58480. * Makes a duplicate of the current configuration into another one.
  58481. * @param configuration define the config where to copy the info
  58482. */
  58483. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58484. /**
  58485. * Serializes this Sub Surface configuration.
  58486. * @returns - An object with the serialized config.
  58487. */
  58488. serialize(): any;
  58489. /**
  58490. * Parses a anisotropy Configuration from a serialized object.
  58491. * @param source - Serialized object.
  58492. * @param scene Defines the scene we are parsing for
  58493. * @param rootUrl Defines the rootUrl to load from
  58494. */
  58495. parse(source: any, scene: Scene, rootUrl: string): void;
  58496. }
  58497. }
  58498. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58499. /** @hidden */
  58500. export var pbrFragmentDeclaration: {
  58501. name: string;
  58502. shader: string;
  58503. };
  58504. }
  58505. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58506. /** @hidden */
  58507. export var pbrUboDeclaration: {
  58508. name: string;
  58509. shader: string;
  58510. };
  58511. }
  58512. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58513. /** @hidden */
  58514. export var pbrFragmentExtraDeclaration: {
  58515. name: string;
  58516. shader: string;
  58517. };
  58518. }
  58519. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58520. /** @hidden */
  58521. export var pbrFragmentSamplersDeclaration: {
  58522. name: string;
  58523. shader: string;
  58524. };
  58525. }
  58526. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58527. /** @hidden */
  58528. export var importanceSampling: {
  58529. name: string;
  58530. shader: string;
  58531. };
  58532. }
  58533. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58534. /** @hidden */
  58535. export var pbrHelperFunctions: {
  58536. name: string;
  58537. shader: string;
  58538. };
  58539. }
  58540. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58541. /** @hidden */
  58542. export var harmonicsFunctions: {
  58543. name: string;
  58544. shader: string;
  58545. };
  58546. }
  58547. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58548. /** @hidden */
  58549. export var pbrDirectLightingSetupFunctions: {
  58550. name: string;
  58551. shader: string;
  58552. };
  58553. }
  58554. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58555. /** @hidden */
  58556. export var pbrDirectLightingFalloffFunctions: {
  58557. name: string;
  58558. shader: string;
  58559. };
  58560. }
  58561. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58562. /** @hidden */
  58563. export var pbrBRDFFunctions: {
  58564. name: string;
  58565. shader: string;
  58566. };
  58567. }
  58568. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58569. /** @hidden */
  58570. export var hdrFilteringFunctions: {
  58571. name: string;
  58572. shader: string;
  58573. };
  58574. }
  58575. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58576. /** @hidden */
  58577. export var pbrDirectLightingFunctions: {
  58578. name: string;
  58579. shader: string;
  58580. };
  58581. }
  58582. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58583. /** @hidden */
  58584. export var pbrIBLFunctions: {
  58585. name: string;
  58586. shader: string;
  58587. };
  58588. }
  58589. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58590. /** @hidden */
  58591. export var pbrBlockAlbedoOpacity: {
  58592. name: string;
  58593. shader: string;
  58594. };
  58595. }
  58596. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58597. /** @hidden */
  58598. export var pbrBlockReflectivity: {
  58599. name: string;
  58600. shader: string;
  58601. };
  58602. }
  58603. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58604. /** @hidden */
  58605. export var pbrBlockAmbientOcclusion: {
  58606. name: string;
  58607. shader: string;
  58608. };
  58609. }
  58610. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58611. /** @hidden */
  58612. export var pbrBlockAlphaFresnel: {
  58613. name: string;
  58614. shader: string;
  58615. };
  58616. }
  58617. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58618. /** @hidden */
  58619. export var pbrBlockAnisotropic: {
  58620. name: string;
  58621. shader: string;
  58622. };
  58623. }
  58624. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58625. /** @hidden */
  58626. export var pbrBlockReflection: {
  58627. name: string;
  58628. shader: string;
  58629. };
  58630. }
  58631. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58632. /** @hidden */
  58633. export var pbrBlockSheen: {
  58634. name: string;
  58635. shader: string;
  58636. };
  58637. }
  58638. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58639. /** @hidden */
  58640. export var pbrBlockClearcoat: {
  58641. name: string;
  58642. shader: string;
  58643. };
  58644. }
  58645. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58646. /** @hidden */
  58647. export var pbrBlockSubSurface: {
  58648. name: string;
  58649. shader: string;
  58650. };
  58651. }
  58652. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58653. /** @hidden */
  58654. export var pbrBlockNormalGeometric: {
  58655. name: string;
  58656. shader: string;
  58657. };
  58658. }
  58659. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58660. /** @hidden */
  58661. export var pbrBlockNormalFinal: {
  58662. name: string;
  58663. shader: string;
  58664. };
  58665. }
  58666. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58667. /** @hidden */
  58668. export var pbrBlockLightmapInit: {
  58669. name: string;
  58670. shader: string;
  58671. };
  58672. }
  58673. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58674. /** @hidden */
  58675. export var pbrBlockGeometryInfo: {
  58676. name: string;
  58677. shader: string;
  58678. };
  58679. }
  58680. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58681. /** @hidden */
  58682. export var pbrBlockReflectance0: {
  58683. name: string;
  58684. shader: string;
  58685. };
  58686. }
  58687. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58688. /** @hidden */
  58689. export var pbrBlockReflectance: {
  58690. name: string;
  58691. shader: string;
  58692. };
  58693. }
  58694. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58695. /** @hidden */
  58696. export var pbrBlockDirectLighting: {
  58697. name: string;
  58698. shader: string;
  58699. };
  58700. }
  58701. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58702. /** @hidden */
  58703. export var pbrBlockFinalLitComponents: {
  58704. name: string;
  58705. shader: string;
  58706. };
  58707. }
  58708. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58709. /** @hidden */
  58710. export var pbrBlockFinalUnlitComponents: {
  58711. name: string;
  58712. shader: string;
  58713. };
  58714. }
  58715. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58716. /** @hidden */
  58717. export var pbrBlockFinalColorComposition: {
  58718. name: string;
  58719. shader: string;
  58720. };
  58721. }
  58722. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58723. /** @hidden */
  58724. export var pbrBlockImageProcessing: {
  58725. name: string;
  58726. shader: string;
  58727. };
  58728. }
  58729. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58730. /** @hidden */
  58731. export var pbrDebug: {
  58732. name: string;
  58733. shader: string;
  58734. };
  58735. }
  58736. declare module "babylonjs/Shaders/pbr.fragment" {
  58737. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58738. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58739. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58740. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58741. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58742. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58743. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58744. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58745. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58746. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58747. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58748. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58749. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58750. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58751. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58752. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58753. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58754. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58755. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58756. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58757. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58758. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58759. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58760. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58761. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58762. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58763. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58764. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58765. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58766. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58767. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58768. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58769. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58770. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58771. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58772. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58773. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58774. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58775. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58776. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58777. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58778. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58779. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58780. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58781. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58782. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58783. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58784. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58785. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58786. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58787. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58788. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58789. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58790. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58791. /** @hidden */
  58792. export var pbrPixelShader: {
  58793. name: string;
  58794. shader: string;
  58795. };
  58796. }
  58797. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58798. /** @hidden */
  58799. export var pbrVertexDeclaration: {
  58800. name: string;
  58801. shader: string;
  58802. };
  58803. }
  58804. declare module "babylonjs/Shaders/pbr.vertex" {
  58805. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58806. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58807. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58808. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58809. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58810. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58811. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58812. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58813. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58814. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58815. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58816. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58817. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58818. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58819. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58820. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58821. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58822. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58823. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58824. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58825. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58826. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58827. /** @hidden */
  58828. export var pbrVertexShader: {
  58829. name: string;
  58830. shader: string;
  58831. };
  58832. }
  58833. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58834. import { Nullable } from "babylonjs/types";
  58835. import { Scene } from "babylonjs/scene";
  58836. import { Matrix } from "babylonjs/Maths/math.vector";
  58837. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58838. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58839. import { Mesh } from "babylonjs/Meshes/mesh";
  58840. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58841. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58842. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58843. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58844. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58845. import { Color3 } from "babylonjs/Maths/math.color";
  58846. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58847. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58848. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58849. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58850. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58851. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58852. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58853. import "babylonjs/Shaders/pbr.fragment";
  58854. import "babylonjs/Shaders/pbr.vertex";
  58855. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58856. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58857. /**
  58858. * Manages the defines for the PBR Material.
  58859. * @hidden
  58860. */
  58861. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58862. PBR: boolean;
  58863. NUM_SAMPLES: string;
  58864. REALTIME_FILTERING: boolean;
  58865. MAINUV1: boolean;
  58866. MAINUV2: boolean;
  58867. UV1: boolean;
  58868. UV2: boolean;
  58869. ALBEDO: boolean;
  58870. GAMMAALBEDO: boolean;
  58871. ALBEDODIRECTUV: number;
  58872. VERTEXCOLOR: boolean;
  58873. DETAIL: boolean;
  58874. DETAILDIRECTUV: number;
  58875. DETAIL_NORMALBLENDMETHOD: number;
  58876. AMBIENT: boolean;
  58877. AMBIENTDIRECTUV: number;
  58878. AMBIENTINGRAYSCALE: boolean;
  58879. OPACITY: boolean;
  58880. VERTEXALPHA: boolean;
  58881. OPACITYDIRECTUV: number;
  58882. OPACITYRGB: boolean;
  58883. ALPHATEST: boolean;
  58884. DEPTHPREPASS: boolean;
  58885. ALPHABLEND: boolean;
  58886. ALPHAFROMALBEDO: boolean;
  58887. ALPHATESTVALUE: string;
  58888. SPECULAROVERALPHA: boolean;
  58889. RADIANCEOVERALPHA: boolean;
  58890. ALPHAFRESNEL: boolean;
  58891. LINEARALPHAFRESNEL: boolean;
  58892. PREMULTIPLYALPHA: boolean;
  58893. EMISSIVE: boolean;
  58894. EMISSIVEDIRECTUV: number;
  58895. REFLECTIVITY: boolean;
  58896. REFLECTIVITYDIRECTUV: number;
  58897. SPECULARTERM: boolean;
  58898. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58899. MICROSURFACEAUTOMATIC: boolean;
  58900. LODBASEDMICROSFURACE: boolean;
  58901. MICROSURFACEMAP: boolean;
  58902. MICROSURFACEMAPDIRECTUV: number;
  58903. METALLICWORKFLOW: boolean;
  58904. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58905. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58906. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58907. AOSTOREINMETALMAPRED: boolean;
  58908. METALLIC_REFLECTANCE: boolean;
  58909. METALLIC_REFLECTANCEDIRECTUV: number;
  58910. ENVIRONMENTBRDF: boolean;
  58911. ENVIRONMENTBRDF_RGBD: boolean;
  58912. NORMAL: boolean;
  58913. TANGENT: boolean;
  58914. BUMP: boolean;
  58915. BUMPDIRECTUV: number;
  58916. OBJECTSPACE_NORMALMAP: boolean;
  58917. PARALLAX: boolean;
  58918. PARALLAXOCCLUSION: boolean;
  58919. NORMALXYSCALE: boolean;
  58920. LIGHTMAP: boolean;
  58921. LIGHTMAPDIRECTUV: number;
  58922. USELIGHTMAPASSHADOWMAP: boolean;
  58923. GAMMALIGHTMAP: boolean;
  58924. RGBDLIGHTMAP: boolean;
  58925. REFLECTION: boolean;
  58926. REFLECTIONMAP_3D: boolean;
  58927. REFLECTIONMAP_SPHERICAL: boolean;
  58928. REFLECTIONMAP_PLANAR: boolean;
  58929. REFLECTIONMAP_CUBIC: boolean;
  58930. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58931. REFLECTIONMAP_PROJECTION: boolean;
  58932. REFLECTIONMAP_SKYBOX: boolean;
  58933. REFLECTIONMAP_EXPLICIT: boolean;
  58934. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58935. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58936. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58937. INVERTCUBICMAP: boolean;
  58938. USESPHERICALFROMREFLECTIONMAP: boolean;
  58939. USEIRRADIANCEMAP: boolean;
  58940. SPHERICAL_HARMONICS: boolean;
  58941. USESPHERICALINVERTEX: boolean;
  58942. REFLECTIONMAP_OPPOSITEZ: boolean;
  58943. LODINREFLECTIONALPHA: boolean;
  58944. GAMMAREFLECTION: boolean;
  58945. RGBDREFLECTION: boolean;
  58946. LINEARSPECULARREFLECTION: boolean;
  58947. RADIANCEOCCLUSION: boolean;
  58948. HORIZONOCCLUSION: boolean;
  58949. INSTANCES: boolean;
  58950. THIN_INSTANCES: boolean;
  58951. PREPASS: boolean;
  58952. SCENE_MRT_COUNT: number;
  58953. NUM_BONE_INFLUENCERS: number;
  58954. BonesPerMesh: number;
  58955. BONETEXTURE: boolean;
  58956. NONUNIFORMSCALING: boolean;
  58957. MORPHTARGETS: boolean;
  58958. MORPHTARGETS_NORMAL: boolean;
  58959. MORPHTARGETS_TANGENT: boolean;
  58960. MORPHTARGETS_UV: boolean;
  58961. NUM_MORPH_INFLUENCERS: number;
  58962. IMAGEPROCESSING: boolean;
  58963. VIGNETTE: boolean;
  58964. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58965. VIGNETTEBLENDMODEOPAQUE: boolean;
  58966. TONEMAPPING: boolean;
  58967. TONEMAPPING_ACES: boolean;
  58968. CONTRAST: boolean;
  58969. COLORCURVES: boolean;
  58970. COLORGRADING: boolean;
  58971. COLORGRADING3D: boolean;
  58972. SAMPLER3DGREENDEPTH: boolean;
  58973. SAMPLER3DBGRMAP: boolean;
  58974. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58975. EXPOSURE: boolean;
  58976. MULTIVIEW: boolean;
  58977. USEPHYSICALLIGHTFALLOFF: boolean;
  58978. USEGLTFLIGHTFALLOFF: boolean;
  58979. TWOSIDEDLIGHTING: boolean;
  58980. SHADOWFLOAT: boolean;
  58981. CLIPPLANE: boolean;
  58982. CLIPPLANE2: boolean;
  58983. CLIPPLANE3: boolean;
  58984. CLIPPLANE4: boolean;
  58985. CLIPPLANE5: boolean;
  58986. CLIPPLANE6: boolean;
  58987. POINTSIZE: boolean;
  58988. FOG: boolean;
  58989. LOGARITHMICDEPTH: boolean;
  58990. FORCENORMALFORWARD: boolean;
  58991. SPECULARAA: boolean;
  58992. CLEARCOAT: boolean;
  58993. CLEARCOAT_DEFAULTIOR: boolean;
  58994. CLEARCOAT_TEXTURE: boolean;
  58995. CLEARCOAT_TEXTUREDIRECTUV: number;
  58996. CLEARCOAT_BUMP: boolean;
  58997. CLEARCOAT_BUMPDIRECTUV: number;
  58998. CLEARCOAT_TINT: boolean;
  58999. CLEARCOAT_TINT_TEXTURE: boolean;
  59000. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  59001. ANISOTROPIC: boolean;
  59002. ANISOTROPIC_TEXTURE: boolean;
  59003. ANISOTROPIC_TEXTUREDIRECTUV: number;
  59004. BRDF_V_HEIGHT_CORRELATED: boolean;
  59005. MS_BRDF_ENERGY_CONSERVATION: boolean;
  59006. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  59007. SHEEN: boolean;
  59008. SHEEN_TEXTURE: boolean;
  59009. SHEEN_TEXTUREDIRECTUV: number;
  59010. SHEEN_LINKWITHALBEDO: boolean;
  59011. SHEEN_ROUGHNESS: boolean;
  59012. SHEEN_ALBEDOSCALING: boolean;
  59013. SUBSURFACE: boolean;
  59014. SS_REFRACTION: boolean;
  59015. SS_TRANSLUCENCY: boolean;
  59016. SS_SCATTERING: boolean;
  59017. SS_THICKNESSANDMASK_TEXTURE: boolean;
  59018. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  59019. SS_REFRACTIONMAP_3D: boolean;
  59020. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  59021. SS_LODINREFRACTIONALPHA: boolean;
  59022. SS_GAMMAREFRACTION: boolean;
  59023. SS_RGBDREFRACTION: boolean;
  59024. SS_LINEARSPECULARREFRACTION: boolean;
  59025. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  59026. SS_ALBEDOFORREFRACTIONTINT: boolean;
  59027. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  59028. UNLIT: boolean;
  59029. DEBUGMODE: number;
  59030. /**
  59031. * Initializes the PBR Material defines.
  59032. */
  59033. constructor();
  59034. /**
  59035. * Resets the PBR Material defines.
  59036. */
  59037. reset(): void;
  59038. }
  59039. /**
  59040. * The Physically based material base class of BJS.
  59041. *
  59042. * This offers the main features of a standard PBR material.
  59043. * For more information, please refer to the documentation :
  59044. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59045. */
  59046. export abstract class PBRBaseMaterial extends PushMaterial {
  59047. /**
  59048. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59049. */
  59050. static readonly PBRMATERIAL_OPAQUE: number;
  59051. /**
  59052. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59053. */
  59054. static readonly PBRMATERIAL_ALPHATEST: number;
  59055. /**
  59056. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59057. */
  59058. static readonly PBRMATERIAL_ALPHABLEND: number;
  59059. /**
  59060. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59061. * They are also discarded below the alpha cutoff threshold to improve performances.
  59062. */
  59063. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59064. /**
  59065. * Defines the default value of how much AO map is occluding the analytical lights
  59066. * (point spot...).
  59067. */
  59068. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59069. /**
  59070. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  59071. */
  59072. static readonly LIGHTFALLOFF_PHYSICAL: number;
  59073. /**
  59074. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  59075. * to enhance interoperability with other engines.
  59076. */
  59077. static readonly LIGHTFALLOFF_GLTF: number;
  59078. /**
  59079. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  59080. * to enhance interoperability with other materials.
  59081. */
  59082. static readonly LIGHTFALLOFF_STANDARD: number;
  59083. /**
  59084. * Intensity of the direct lights e.g. the four lights available in your scene.
  59085. * This impacts both the direct diffuse and specular highlights.
  59086. */
  59087. protected _directIntensity: number;
  59088. /**
  59089. * Intensity of the emissive part of the material.
  59090. * This helps controlling the emissive effect without modifying the emissive color.
  59091. */
  59092. protected _emissiveIntensity: number;
  59093. /**
  59094. * Intensity of the environment e.g. how much the environment will light the object
  59095. * either through harmonics for rough material or through the refelction for shiny ones.
  59096. */
  59097. protected _environmentIntensity: number;
  59098. /**
  59099. * This is a special control allowing the reduction of the specular highlights coming from the
  59100. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59101. */
  59102. protected _specularIntensity: number;
  59103. /**
  59104. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59105. */
  59106. private _lightingInfos;
  59107. /**
  59108. * Debug Control allowing disabling the bump map on this material.
  59109. */
  59110. protected _disableBumpMap: boolean;
  59111. /**
  59112. * AKA Diffuse Texture in standard nomenclature.
  59113. */
  59114. protected _albedoTexture: Nullable<BaseTexture>;
  59115. /**
  59116. * AKA Occlusion Texture in other nomenclature.
  59117. */
  59118. protected _ambientTexture: Nullable<BaseTexture>;
  59119. /**
  59120. * AKA Occlusion Texture Intensity in other nomenclature.
  59121. */
  59122. protected _ambientTextureStrength: number;
  59123. /**
  59124. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59125. * 1 means it completely occludes it
  59126. * 0 mean it has no impact
  59127. */
  59128. protected _ambientTextureImpactOnAnalyticalLights: number;
  59129. /**
  59130. * Stores the alpha values in a texture.
  59131. */
  59132. protected _opacityTexture: Nullable<BaseTexture>;
  59133. /**
  59134. * Stores the reflection values in a texture.
  59135. */
  59136. protected _reflectionTexture: Nullable<BaseTexture>;
  59137. /**
  59138. * Stores the emissive values in a texture.
  59139. */
  59140. protected _emissiveTexture: Nullable<BaseTexture>;
  59141. /**
  59142. * AKA Specular texture in other nomenclature.
  59143. */
  59144. protected _reflectivityTexture: Nullable<BaseTexture>;
  59145. /**
  59146. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59147. */
  59148. protected _metallicTexture: Nullable<BaseTexture>;
  59149. /**
  59150. * Specifies the metallic scalar of the metallic/roughness workflow.
  59151. * Can also be used to scale the metalness values of the metallic texture.
  59152. */
  59153. protected _metallic: Nullable<number>;
  59154. /**
  59155. * Specifies the roughness scalar of the metallic/roughness workflow.
  59156. * Can also be used to scale the roughness values of the metallic texture.
  59157. */
  59158. protected _roughness: Nullable<number>;
  59159. /**
  59160. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59161. * By default the indexOfrefraction is used to compute F0;
  59162. *
  59163. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59164. *
  59165. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59166. * F90 = metallicReflectanceColor;
  59167. */
  59168. protected _metallicF0Factor: number;
  59169. /**
  59170. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59171. * By default the F90 is always 1;
  59172. *
  59173. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59174. *
  59175. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59176. * F90 = metallicReflectanceColor;
  59177. */
  59178. protected _metallicReflectanceColor: Color3;
  59179. /**
  59180. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59181. * This is multiply against the scalar values defined in the material.
  59182. */
  59183. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59184. /**
  59185. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59186. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59187. */
  59188. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59189. /**
  59190. * Stores surface normal data used to displace a mesh in a texture.
  59191. */
  59192. protected _bumpTexture: Nullable<BaseTexture>;
  59193. /**
  59194. * Stores the pre-calculated light information of a mesh in a texture.
  59195. */
  59196. protected _lightmapTexture: Nullable<BaseTexture>;
  59197. /**
  59198. * The color of a material in ambient lighting.
  59199. */
  59200. protected _ambientColor: Color3;
  59201. /**
  59202. * AKA Diffuse Color in other nomenclature.
  59203. */
  59204. protected _albedoColor: Color3;
  59205. /**
  59206. * AKA Specular Color in other nomenclature.
  59207. */
  59208. protected _reflectivityColor: Color3;
  59209. /**
  59210. * The color applied when light is reflected from a material.
  59211. */
  59212. protected _reflectionColor: Color3;
  59213. /**
  59214. * The color applied when light is emitted from a material.
  59215. */
  59216. protected _emissiveColor: Color3;
  59217. /**
  59218. * AKA Glossiness in other nomenclature.
  59219. */
  59220. protected _microSurface: number;
  59221. /**
  59222. * Specifies that the material will use the light map as a show map.
  59223. */
  59224. protected _useLightmapAsShadowmap: boolean;
  59225. /**
  59226. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59227. * makes the reflect vector face the model (under horizon).
  59228. */
  59229. protected _useHorizonOcclusion: boolean;
  59230. /**
  59231. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59232. * too much the area relying on ambient texture to define their ambient occlusion.
  59233. */
  59234. protected _useRadianceOcclusion: boolean;
  59235. /**
  59236. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59237. */
  59238. protected _useAlphaFromAlbedoTexture: boolean;
  59239. /**
  59240. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59241. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59242. */
  59243. protected _useSpecularOverAlpha: boolean;
  59244. /**
  59245. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59246. */
  59247. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59248. /**
  59249. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59250. */
  59251. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59252. /**
  59253. * Specifies if the metallic texture contains the roughness information in its green channel.
  59254. */
  59255. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59256. /**
  59257. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59258. */
  59259. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59260. /**
  59261. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59262. */
  59263. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59264. /**
  59265. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59266. */
  59267. protected _useAmbientInGrayScale: boolean;
  59268. /**
  59269. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59270. * The material will try to infer what glossiness each pixel should be.
  59271. */
  59272. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59273. /**
  59274. * Defines the falloff type used in this material.
  59275. * It by default is Physical.
  59276. */
  59277. protected _lightFalloff: number;
  59278. /**
  59279. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59280. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59281. */
  59282. protected _useRadianceOverAlpha: boolean;
  59283. /**
  59284. * Allows using an object space normal map (instead of tangent space).
  59285. */
  59286. protected _useObjectSpaceNormalMap: boolean;
  59287. /**
  59288. * Allows using the bump map in parallax mode.
  59289. */
  59290. protected _useParallax: boolean;
  59291. /**
  59292. * Allows using the bump map in parallax occlusion mode.
  59293. */
  59294. protected _useParallaxOcclusion: boolean;
  59295. /**
  59296. * Controls the scale bias of the parallax mode.
  59297. */
  59298. protected _parallaxScaleBias: number;
  59299. /**
  59300. * If sets to true, disables all the lights affecting the material.
  59301. */
  59302. protected _disableLighting: boolean;
  59303. /**
  59304. * Number of Simultaneous lights allowed on the material.
  59305. */
  59306. protected _maxSimultaneousLights: number;
  59307. /**
  59308. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59309. */
  59310. protected _invertNormalMapX: boolean;
  59311. /**
  59312. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59313. */
  59314. protected _invertNormalMapY: boolean;
  59315. /**
  59316. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59317. */
  59318. protected _twoSidedLighting: boolean;
  59319. /**
  59320. * Defines the alpha limits in alpha test mode.
  59321. */
  59322. protected _alphaCutOff: number;
  59323. /**
  59324. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59325. */
  59326. protected _forceAlphaTest: boolean;
  59327. /**
  59328. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59329. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59330. */
  59331. protected _useAlphaFresnel: boolean;
  59332. /**
  59333. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59334. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59335. */
  59336. protected _useLinearAlphaFresnel: boolean;
  59337. /**
  59338. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59339. * from cos thetav and roughness:
  59340. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59341. */
  59342. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59343. /**
  59344. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59345. */
  59346. protected _forceIrradianceInFragment: boolean;
  59347. private _realTimeFiltering;
  59348. /**
  59349. * Enables realtime filtering on the texture.
  59350. */
  59351. get realTimeFiltering(): boolean;
  59352. set realTimeFiltering(b: boolean);
  59353. private _realTimeFilteringQuality;
  59354. /**
  59355. * Quality switch for realtime filtering
  59356. */
  59357. get realTimeFilteringQuality(): number;
  59358. set realTimeFilteringQuality(n: number);
  59359. /**
  59360. * Can this material render to several textures at once
  59361. */
  59362. get canRenderToMRT(): boolean;
  59363. /**
  59364. * Force normal to face away from face.
  59365. */
  59366. protected _forceNormalForward: boolean;
  59367. /**
  59368. * Enables specular anti aliasing in the PBR shader.
  59369. * It will both interacts on the Geometry for analytical and IBL lighting.
  59370. * It also prefilter the roughness map based on the bump values.
  59371. */
  59372. protected _enableSpecularAntiAliasing: boolean;
  59373. /**
  59374. * Default configuration related to image processing available in the PBR Material.
  59375. */
  59376. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59377. /**
  59378. * Keep track of the image processing observer to allow dispose and replace.
  59379. */
  59380. private _imageProcessingObserver;
  59381. /**
  59382. * Attaches a new image processing configuration to the PBR Material.
  59383. * @param configuration
  59384. */
  59385. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59386. /**
  59387. * Stores the available render targets.
  59388. */
  59389. private _renderTargets;
  59390. /**
  59391. * Sets the global ambient color for the material used in lighting calculations.
  59392. */
  59393. private _globalAmbientColor;
  59394. /**
  59395. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59396. */
  59397. private _useLogarithmicDepth;
  59398. /**
  59399. * If set to true, no lighting calculations will be applied.
  59400. */
  59401. private _unlit;
  59402. private _debugMode;
  59403. /**
  59404. * @hidden
  59405. * This is reserved for the inspector.
  59406. * Defines the material debug mode.
  59407. * It helps seeing only some components of the material while troubleshooting.
  59408. */
  59409. debugMode: number;
  59410. /**
  59411. * @hidden
  59412. * This is reserved for the inspector.
  59413. * Specify from where on screen the debug mode should start.
  59414. * The value goes from -1 (full screen) to 1 (not visible)
  59415. * It helps with side by side comparison against the final render
  59416. * This defaults to -1
  59417. */
  59418. private debugLimit;
  59419. /**
  59420. * @hidden
  59421. * This is reserved for the inspector.
  59422. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59423. * You can use the factor to better multiply the final value.
  59424. */
  59425. private debugFactor;
  59426. /**
  59427. * Defines the clear coat layer parameters for the material.
  59428. */
  59429. readonly clearCoat: PBRClearCoatConfiguration;
  59430. /**
  59431. * Defines the anisotropic parameters for the material.
  59432. */
  59433. readonly anisotropy: PBRAnisotropicConfiguration;
  59434. /**
  59435. * Defines the BRDF parameters for the material.
  59436. */
  59437. readonly brdf: PBRBRDFConfiguration;
  59438. /**
  59439. * Defines the Sheen parameters for the material.
  59440. */
  59441. readonly sheen: PBRSheenConfiguration;
  59442. /**
  59443. * Defines the SubSurface parameters for the material.
  59444. */
  59445. readonly subSurface: PBRSubSurfaceConfiguration;
  59446. /**
  59447. * Defines the detail map parameters for the material.
  59448. */
  59449. readonly detailMap: DetailMapConfiguration;
  59450. protected _rebuildInParallel: boolean;
  59451. /**
  59452. * Instantiates a new PBRMaterial instance.
  59453. *
  59454. * @param name The material name
  59455. * @param scene The scene the material will be use in.
  59456. */
  59457. constructor(name: string, scene: Scene);
  59458. /**
  59459. * Gets a boolean indicating that current material needs to register RTT
  59460. */
  59461. get hasRenderTargetTextures(): boolean;
  59462. /**
  59463. * Gets the name of the material class.
  59464. */
  59465. getClassName(): string;
  59466. /**
  59467. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59468. */
  59469. get useLogarithmicDepth(): boolean;
  59470. /**
  59471. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59472. */
  59473. set useLogarithmicDepth(value: boolean);
  59474. /**
  59475. * Returns true if alpha blending should be disabled.
  59476. */
  59477. protected get _disableAlphaBlending(): boolean;
  59478. /**
  59479. * Specifies whether or not this material should be rendered in alpha blend mode.
  59480. */
  59481. needAlphaBlending(): boolean;
  59482. /**
  59483. * Specifies whether or not this material should be rendered in alpha test mode.
  59484. */
  59485. needAlphaTesting(): boolean;
  59486. /**
  59487. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59488. */
  59489. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59490. /**
  59491. * Gets the texture used for the alpha test.
  59492. */
  59493. getAlphaTestTexture(): Nullable<BaseTexture>;
  59494. /**
  59495. * Specifies that the submesh is ready to be used.
  59496. * @param mesh - BJS mesh.
  59497. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59498. * @param useInstances - Specifies that instances should be used.
  59499. * @returns - boolean indicating that the submesh is ready or not.
  59500. */
  59501. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59502. /**
  59503. * Specifies if the material uses metallic roughness workflow.
  59504. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59505. */
  59506. isMetallicWorkflow(): boolean;
  59507. private _prepareEffect;
  59508. private _prepareDefines;
  59509. /**
  59510. * Force shader compilation
  59511. */
  59512. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59513. /**
  59514. * Initializes the uniform buffer layout for the shader.
  59515. */
  59516. buildUniformLayout(): void;
  59517. /**
  59518. * Unbinds the material from the mesh
  59519. */
  59520. unbind(): void;
  59521. /**
  59522. * Binds the submesh data.
  59523. * @param world - The world matrix.
  59524. * @param mesh - The BJS mesh.
  59525. * @param subMesh - A submesh of the BJS mesh.
  59526. */
  59527. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59528. /**
  59529. * Returns the animatable textures.
  59530. * @returns - Array of animatable textures.
  59531. */
  59532. getAnimatables(): IAnimatable[];
  59533. /**
  59534. * Returns the texture used for reflections.
  59535. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59536. */
  59537. private _getReflectionTexture;
  59538. /**
  59539. * Returns an array of the actively used textures.
  59540. * @returns - Array of BaseTextures
  59541. */
  59542. getActiveTextures(): BaseTexture[];
  59543. /**
  59544. * Checks to see if a texture is used in the material.
  59545. * @param texture - Base texture to use.
  59546. * @returns - Boolean specifying if a texture is used in the material.
  59547. */
  59548. hasTexture(texture: BaseTexture): boolean;
  59549. /**
  59550. * Sets the required values to the prepass renderer.
  59551. * @param prePassRenderer defines the prepass renderer to setup
  59552. */
  59553. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59554. /**
  59555. * Disposes the resources of the material.
  59556. * @param forceDisposeEffect - Forces the disposal of effects.
  59557. * @param forceDisposeTextures - Forces the disposal of all textures.
  59558. */
  59559. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59560. }
  59561. }
  59562. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59563. import { Nullable } from "babylonjs/types";
  59564. import { Scene } from "babylonjs/scene";
  59565. import { Color3 } from "babylonjs/Maths/math.color";
  59566. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59567. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59568. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59569. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59570. /**
  59571. * The Physically based material of BJS.
  59572. *
  59573. * This offers the main features of a standard PBR material.
  59574. * For more information, please refer to the documentation :
  59575. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59576. */
  59577. export class PBRMaterial extends PBRBaseMaterial {
  59578. /**
  59579. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59580. */
  59581. static readonly PBRMATERIAL_OPAQUE: number;
  59582. /**
  59583. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59584. */
  59585. static readonly PBRMATERIAL_ALPHATEST: number;
  59586. /**
  59587. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59588. */
  59589. static readonly PBRMATERIAL_ALPHABLEND: number;
  59590. /**
  59591. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59592. * They are also discarded below the alpha cutoff threshold to improve performances.
  59593. */
  59594. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59595. /**
  59596. * Defines the default value of how much AO map is occluding the analytical lights
  59597. * (point spot...).
  59598. */
  59599. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59600. /**
  59601. * Intensity of the direct lights e.g. the four lights available in your scene.
  59602. * This impacts both the direct diffuse and specular highlights.
  59603. */
  59604. directIntensity: number;
  59605. /**
  59606. * Intensity of the emissive part of the material.
  59607. * This helps controlling the emissive effect without modifying the emissive color.
  59608. */
  59609. emissiveIntensity: number;
  59610. /**
  59611. * Intensity of the environment e.g. how much the environment will light the object
  59612. * either through harmonics for rough material or through the refelction for shiny ones.
  59613. */
  59614. environmentIntensity: number;
  59615. /**
  59616. * This is a special control allowing the reduction of the specular highlights coming from the
  59617. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59618. */
  59619. specularIntensity: number;
  59620. /**
  59621. * Debug Control allowing disabling the bump map on this material.
  59622. */
  59623. disableBumpMap: boolean;
  59624. /**
  59625. * AKA Diffuse Texture in standard nomenclature.
  59626. */
  59627. albedoTexture: BaseTexture;
  59628. /**
  59629. * AKA Occlusion Texture in other nomenclature.
  59630. */
  59631. ambientTexture: BaseTexture;
  59632. /**
  59633. * AKA Occlusion Texture Intensity in other nomenclature.
  59634. */
  59635. ambientTextureStrength: number;
  59636. /**
  59637. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59638. * 1 means it completely occludes it
  59639. * 0 mean it has no impact
  59640. */
  59641. ambientTextureImpactOnAnalyticalLights: number;
  59642. /**
  59643. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59644. */
  59645. opacityTexture: BaseTexture;
  59646. /**
  59647. * Stores the reflection values in a texture.
  59648. */
  59649. reflectionTexture: Nullable<BaseTexture>;
  59650. /**
  59651. * Stores the emissive values in a texture.
  59652. */
  59653. emissiveTexture: BaseTexture;
  59654. /**
  59655. * AKA Specular texture in other nomenclature.
  59656. */
  59657. reflectivityTexture: BaseTexture;
  59658. /**
  59659. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59660. */
  59661. metallicTexture: BaseTexture;
  59662. /**
  59663. * Specifies the metallic scalar of the metallic/roughness workflow.
  59664. * Can also be used to scale the metalness values of the metallic texture.
  59665. */
  59666. metallic: Nullable<number>;
  59667. /**
  59668. * Specifies the roughness scalar of the metallic/roughness workflow.
  59669. * Can also be used to scale the roughness values of the metallic texture.
  59670. */
  59671. roughness: Nullable<number>;
  59672. /**
  59673. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59674. * By default the indexOfrefraction is used to compute F0;
  59675. *
  59676. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59677. *
  59678. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59679. * F90 = metallicReflectanceColor;
  59680. */
  59681. metallicF0Factor: number;
  59682. /**
  59683. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59684. * By default the F90 is always 1;
  59685. *
  59686. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59687. *
  59688. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59689. * F90 = metallicReflectanceColor;
  59690. */
  59691. metallicReflectanceColor: Color3;
  59692. /**
  59693. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59694. * This is multiply against the scalar values defined in the material.
  59695. */
  59696. metallicReflectanceTexture: Nullable<BaseTexture>;
  59697. /**
  59698. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59699. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59700. */
  59701. microSurfaceTexture: BaseTexture;
  59702. /**
  59703. * Stores surface normal data used to displace a mesh in a texture.
  59704. */
  59705. bumpTexture: BaseTexture;
  59706. /**
  59707. * Stores the pre-calculated light information of a mesh in a texture.
  59708. */
  59709. lightmapTexture: BaseTexture;
  59710. /**
  59711. * Stores the refracted light information in a texture.
  59712. */
  59713. get refractionTexture(): Nullable<BaseTexture>;
  59714. set refractionTexture(value: Nullable<BaseTexture>);
  59715. /**
  59716. * The color of a material in ambient lighting.
  59717. */
  59718. ambientColor: Color3;
  59719. /**
  59720. * AKA Diffuse Color in other nomenclature.
  59721. */
  59722. albedoColor: Color3;
  59723. /**
  59724. * AKA Specular Color in other nomenclature.
  59725. */
  59726. reflectivityColor: Color3;
  59727. /**
  59728. * The color reflected from the material.
  59729. */
  59730. reflectionColor: Color3;
  59731. /**
  59732. * The color emitted from the material.
  59733. */
  59734. emissiveColor: Color3;
  59735. /**
  59736. * AKA Glossiness in other nomenclature.
  59737. */
  59738. microSurface: number;
  59739. /**
  59740. * Index of refraction of the material base layer.
  59741. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59742. *
  59743. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59744. *
  59745. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59746. */
  59747. get indexOfRefraction(): number;
  59748. set indexOfRefraction(value: number);
  59749. /**
  59750. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59751. */
  59752. get invertRefractionY(): boolean;
  59753. set invertRefractionY(value: boolean);
  59754. /**
  59755. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59756. * Materials half opaque for instance using refraction could benefit from this control.
  59757. */
  59758. get linkRefractionWithTransparency(): boolean;
  59759. set linkRefractionWithTransparency(value: boolean);
  59760. /**
  59761. * If true, the light map contains occlusion information instead of lighting info.
  59762. */
  59763. useLightmapAsShadowmap: boolean;
  59764. /**
  59765. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59766. */
  59767. useAlphaFromAlbedoTexture: boolean;
  59768. /**
  59769. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59770. */
  59771. forceAlphaTest: boolean;
  59772. /**
  59773. * Defines the alpha limits in alpha test mode.
  59774. */
  59775. alphaCutOff: number;
  59776. /**
  59777. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59778. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59779. */
  59780. useSpecularOverAlpha: boolean;
  59781. /**
  59782. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59783. */
  59784. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59785. /**
  59786. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59787. */
  59788. useRoughnessFromMetallicTextureAlpha: boolean;
  59789. /**
  59790. * Specifies if the metallic texture contains the roughness information in its green channel.
  59791. */
  59792. useRoughnessFromMetallicTextureGreen: boolean;
  59793. /**
  59794. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59795. */
  59796. useMetallnessFromMetallicTextureBlue: boolean;
  59797. /**
  59798. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59799. */
  59800. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59801. /**
  59802. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59803. */
  59804. useAmbientInGrayScale: boolean;
  59805. /**
  59806. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59807. * The material will try to infer what glossiness each pixel should be.
  59808. */
  59809. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59810. /**
  59811. * BJS is using an harcoded light falloff based on a manually sets up range.
  59812. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59813. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59814. */
  59815. get usePhysicalLightFalloff(): boolean;
  59816. /**
  59817. * BJS is using an harcoded light falloff based on a manually sets up range.
  59818. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59819. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59820. */
  59821. set usePhysicalLightFalloff(value: boolean);
  59822. /**
  59823. * In order to support the falloff compatibility with gltf, a special mode has been added
  59824. * to reproduce the gltf light falloff.
  59825. */
  59826. get useGLTFLightFalloff(): boolean;
  59827. /**
  59828. * In order to support the falloff compatibility with gltf, a special mode has been added
  59829. * to reproduce the gltf light falloff.
  59830. */
  59831. set useGLTFLightFalloff(value: boolean);
  59832. /**
  59833. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59834. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59835. */
  59836. useRadianceOverAlpha: boolean;
  59837. /**
  59838. * Allows using an object space normal map (instead of tangent space).
  59839. */
  59840. useObjectSpaceNormalMap: boolean;
  59841. /**
  59842. * Allows using the bump map in parallax mode.
  59843. */
  59844. useParallax: boolean;
  59845. /**
  59846. * Allows using the bump map in parallax occlusion mode.
  59847. */
  59848. useParallaxOcclusion: boolean;
  59849. /**
  59850. * Controls the scale bias of the parallax mode.
  59851. */
  59852. parallaxScaleBias: number;
  59853. /**
  59854. * If sets to true, disables all the lights affecting the material.
  59855. */
  59856. disableLighting: boolean;
  59857. /**
  59858. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59859. */
  59860. forceIrradianceInFragment: boolean;
  59861. /**
  59862. * Number of Simultaneous lights allowed on the material.
  59863. */
  59864. maxSimultaneousLights: number;
  59865. /**
  59866. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59867. */
  59868. invertNormalMapX: boolean;
  59869. /**
  59870. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59871. */
  59872. invertNormalMapY: boolean;
  59873. /**
  59874. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59875. */
  59876. twoSidedLighting: boolean;
  59877. /**
  59878. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59879. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59880. */
  59881. useAlphaFresnel: boolean;
  59882. /**
  59883. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59884. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59885. */
  59886. useLinearAlphaFresnel: boolean;
  59887. /**
  59888. * Let user defines the brdf lookup texture used for IBL.
  59889. * A default 8bit version is embedded but you could point at :
  59890. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59891. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59892. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59893. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59894. */
  59895. environmentBRDFTexture: Nullable<BaseTexture>;
  59896. /**
  59897. * Force normal to face away from face.
  59898. */
  59899. forceNormalForward: boolean;
  59900. /**
  59901. * Enables specular anti aliasing in the PBR shader.
  59902. * It will both interacts on the Geometry for analytical and IBL lighting.
  59903. * It also prefilter the roughness map based on the bump values.
  59904. */
  59905. enableSpecularAntiAliasing: boolean;
  59906. /**
  59907. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59908. * makes the reflect vector face the model (under horizon).
  59909. */
  59910. useHorizonOcclusion: boolean;
  59911. /**
  59912. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59913. * too much the area relying on ambient texture to define their ambient occlusion.
  59914. */
  59915. useRadianceOcclusion: boolean;
  59916. /**
  59917. * If set to true, no lighting calculations will be applied.
  59918. */
  59919. unlit: boolean;
  59920. /**
  59921. * Gets the image processing configuration used either in this material.
  59922. */
  59923. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59924. /**
  59925. * Sets the Default image processing configuration used either in the this material.
  59926. *
  59927. * If sets to null, the scene one is in use.
  59928. */
  59929. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59930. /**
  59931. * Gets wether the color curves effect is enabled.
  59932. */
  59933. get cameraColorCurvesEnabled(): boolean;
  59934. /**
  59935. * Sets wether the color curves effect is enabled.
  59936. */
  59937. set cameraColorCurvesEnabled(value: boolean);
  59938. /**
  59939. * Gets wether the color grading effect is enabled.
  59940. */
  59941. get cameraColorGradingEnabled(): boolean;
  59942. /**
  59943. * Gets wether the color grading effect is enabled.
  59944. */
  59945. set cameraColorGradingEnabled(value: boolean);
  59946. /**
  59947. * Gets wether tonemapping is enabled or not.
  59948. */
  59949. get cameraToneMappingEnabled(): boolean;
  59950. /**
  59951. * Sets wether tonemapping is enabled or not
  59952. */
  59953. set cameraToneMappingEnabled(value: boolean);
  59954. /**
  59955. * The camera exposure used on this material.
  59956. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59957. * This corresponds to a photographic exposure.
  59958. */
  59959. get cameraExposure(): number;
  59960. /**
  59961. * The camera exposure used on this material.
  59962. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59963. * This corresponds to a photographic exposure.
  59964. */
  59965. set cameraExposure(value: number);
  59966. /**
  59967. * Gets The camera contrast used on this material.
  59968. */
  59969. get cameraContrast(): number;
  59970. /**
  59971. * Sets The camera contrast used on this material.
  59972. */
  59973. set cameraContrast(value: number);
  59974. /**
  59975. * Gets the Color Grading 2D Lookup Texture.
  59976. */
  59977. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59978. /**
  59979. * Sets the Color Grading 2D Lookup Texture.
  59980. */
  59981. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59982. /**
  59983. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59984. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59985. * 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;
  59986. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59987. */
  59988. get cameraColorCurves(): Nullable<ColorCurves>;
  59989. /**
  59990. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59991. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59992. * 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;
  59993. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59994. */
  59995. set cameraColorCurves(value: Nullable<ColorCurves>);
  59996. /**
  59997. * Instantiates a new PBRMaterial instance.
  59998. *
  59999. * @param name The material name
  60000. * @param scene The scene the material will be use in.
  60001. */
  60002. constructor(name: string, scene: Scene);
  60003. /**
  60004. * Returns the name of this material class.
  60005. */
  60006. getClassName(): string;
  60007. /**
  60008. * Makes a duplicate of the current material.
  60009. * @param name - name to use for the new material.
  60010. */
  60011. clone(name: string): PBRMaterial;
  60012. /**
  60013. * Serializes this PBR Material.
  60014. * @returns - An object with the serialized material.
  60015. */
  60016. serialize(): any;
  60017. /**
  60018. * Parses a PBR Material from a serialized object.
  60019. * @param source - Serialized object.
  60020. * @param scene - BJS scene instance.
  60021. * @param rootUrl - url for the scene object
  60022. * @returns - PBRMaterial
  60023. */
  60024. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  60025. }
  60026. }
  60027. declare module "babylonjs/Misc/dds" {
  60028. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  60029. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60030. import { Nullable } from "babylonjs/types";
  60031. import { Scene } from "babylonjs/scene";
  60032. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  60033. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60034. /**
  60035. * Direct draw surface info
  60036. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  60037. */
  60038. export interface DDSInfo {
  60039. /**
  60040. * Width of the texture
  60041. */
  60042. width: number;
  60043. /**
  60044. * Width of the texture
  60045. */
  60046. height: number;
  60047. /**
  60048. * Number of Mipmaps for the texture
  60049. * @see https://en.wikipedia.org/wiki/Mipmap
  60050. */
  60051. mipmapCount: number;
  60052. /**
  60053. * If the textures format is a known fourCC format
  60054. * @see https://www.fourcc.org/
  60055. */
  60056. isFourCC: boolean;
  60057. /**
  60058. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  60059. */
  60060. isRGB: boolean;
  60061. /**
  60062. * If the texture is a lumincance format
  60063. */
  60064. isLuminance: boolean;
  60065. /**
  60066. * If this is a cube texture
  60067. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  60068. */
  60069. isCube: boolean;
  60070. /**
  60071. * If the texture is a compressed format eg. FOURCC_DXT1
  60072. */
  60073. isCompressed: boolean;
  60074. /**
  60075. * The dxgiFormat of the texture
  60076. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  60077. */
  60078. dxgiFormat: number;
  60079. /**
  60080. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60081. */
  60082. textureType: number;
  60083. /**
  60084. * Sphericle polynomial created for the dds texture
  60085. */
  60086. sphericalPolynomial?: SphericalPolynomial;
  60087. }
  60088. /**
  60089. * Class used to provide DDS decompression tools
  60090. */
  60091. export class DDSTools {
  60092. /**
  60093. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60094. */
  60095. static StoreLODInAlphaChannel: boolean;
  60096. /**
  60097. * Gets DDS information from an array buffer
  60098. * @param data defines the array buffer view to read data from
  60099. * @returns the DDS information
  60100. */
  60101. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60102. private static _FloatView;
  60103. private static _Int32View;
  60104. private static _ToHalfFloat;
  60105. private static _FromHalfFloat;
  60106. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60107. private static _GetHalfFloatRGBAArrayBuffer;
  60108. private static _GetFloatRGBAArrayBuffer;
  60109. private static _GetFloatAsUIntRGBAArrayBuffer;
  60110. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60111. private static _GetRGBAArrayBuffer;
  60112. private static _ExtractLongWordOrder;
  60113. private static _GetRGBArrayBuffer;
  60114. private static _GetLuminanceArrayBuffer;
  60115. /**
  60116. * Uploads DDS Levels to a Babylon Texture
  60117. * @hidden
  60118. */
  60119. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60120. }
  60121. module "babylonjs/Engines/thinEngine" {
  60122. interface ThinEngine {
  60123. /**
  60124. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60125. * @param rootUrl defines the url where the file to load is located
  60126. * @param scene defines the current scene
  60127. * @param lodScale defines scale to apply to the mip map selection
  60128. * @param lodOffset defines offset to apply to the mip map selection
  60129. * @param onLoad defines an optional callback raised when the texture is loaded
  60130. * @param onError defines an optional callback raised if there is an issue to load the texture
  60131. * @param format defines the format of the data
  60132. * @param forcedExtension defines the extension to use to pick the right loader
  60133. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60134. * @returns the cube texture as an InternalTexture
  60135. */
  60136. 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;
  60137. }
  60138. }
  60139. }
  60140. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60141. import { Nullable } from "babylonjs/types";
  60142. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60143. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60144. /**
  60145. * Implementation of the DDS Texture Loader.
  60146. * @hidden
  60147. */
  60148. export class _DDSTextureLoader implements IInternalTextureLoader {
  60149. /**
  60150. * Defines wether the loader supports cascade loading the different faces.
  60151. */
  60152. readonly supportCascades: boolean;
  60153. /**
  60154. * This returns if the loader support the current file information.
  60155. * @param extension defines the file extension of the file being loaded
  60156. * @returns true if the loader can load the specified file
  60157. */
  60158. canLoad(extension: string): boolean;
  60159. /**
  60160. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60161. * @param data contains the texture data
  60162. * @param texture defines the BabylonJS internal texture
  60163. * @param createPolynomials will be true if polynomials have been requested
  60164. * @param onLoad defines the callback to trigger once the texture is ready
  60165. * @param onError defines the callback to trigger in case of error
  60166. */
  60167. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60168. /**
  60169. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60170. * @param data contains the texture data
  60171. * @param texture defines the BabylonJS internal texture
  60172. * @param callback defines the method to call once ready to upload
  60173. */
  60174. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60175. }
  60176. }
  60177. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60178. import { Nullable } from "babylonjs/types";
  60179. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60180. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60181. /**
  60182. * Implementation of the ENV Texture Loader.
  60183. * @hidden
  60184. */
  60185. export class _ENVTextureLoader implements IInternalTextureLoader {
  60186. /**
  60187. * Defines wether the loader supports cascade loading the different faces.
  60188. */
  60189. readonly supportCascades: boolean;
  60190. /**
  60191. * This returns if the loader support the current file information.
  60192. * @param extension defines the file extension of the file being loaded
  60193. * @returns true if the loader can load the specified file
  60194. */
  60195. canLoad(extension: string): boolean;
  60196. /**
  60197. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60198. * @param data contains the texture data
  60199. * @param texture defines the BabylonJS internal texture
  60200. * @param createPolynomials will be true if polynomials have been requested
  60201. * @param onLoad defines the callback to trigger once the texture is ready
  60202. * @param onError defines the callback to trigger in case of error
  60203. */
  60204. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60205. /**
  60206. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60207. * @param data contains the texture data
  60208. * @param texture defines the BabylonJS internal texture
  60209. * @param callback defines the method to call once ready to upload
  60210. */
  60211. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60212. }
  60213. }
  60214. declare module "babylonjs/Misc/khronosTextureContainer" {
  60215. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60216. /**
  60217. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60218. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60219. */
  60220. export class KhronosTextureContainer {
  60221. /** contents of the KTX container file */
  60222. data: ArrayBufferView;
  60223. private static HEADER_LEN;
  60224. private static COMPRESSED_2D;
  60225. private static COMPRESSED_3D;
  60226. private static TEX_2D;
  60227. private static TEX_3D;
  60228. /**
  60229. * Gets the openGL type
  60230. */
  60231. glType: number;
  60232. /**
  60233. * Gets the openGL type size
  60234. */
  60235. glTypeSize: number;
  60236. /**
  60237. * Gets the openGL format
  60238. */
  60239. glFormat: number;
  60240. /**
  60241. * Gets the openGL internal format
  60242. */
  60243. glInternalFormat: number;
  60244. /**
  60245. * Gets the base internal format
  60246. */
  60247. glBaseInternalFormat: number;
  60248. /**
  60249. * Gets image width in pixel
  60250. */
  60251. pixelWidth: number;
  60252. /**
  60253. * Gets image height in pixel
  60254. */
  60255. pixelHeight: number;
  60256. /**
  60257. * Gets image depth in pixels
  60258. */
  60259. pixelDepth: number;
  60260. /**
  60261. * Gets the number of array elements
  60262. */
  60263. numberOfArrayElements: number;
  60264. /**
  60265. * Gets the number of faces
  60266. */
  60267. numberOfFaces: number;
  60268. /**
  60269. * Gets the number of mipmap levels
  60270. */
  60271. numberOfMipmapLevels: number;
  60272. /**
  60273. * Gets the bytes of key value data
  60274. */
  60275. bytesOfKeyValueData: number;
  60276. /**
  60277. * Gets the load type
  60278. */
  60279. loadType: number;
  60280. /**
  60281. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60282. */
  60283. isInvalid: boolean;
  60284. /**
  60285. * Creates a new KhronosTextureContainer
  60286. * @param data contents of the KTX container file
  60287. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60288. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60289. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60290. */
  60291. constructor(
  60292. /** contents of the KTX container file */
  60293. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60294. /**
  60295. * Uploads KTX content to a Babylon Texture.
  60296. * It is assumed that the texture has already been created & is currently bound
  60297. * @hidden
  60298. */
  60299. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60300. private _upload2DCompressedLevels;
  60301. /**
  60302. * Checks if the given data starts with a KTX file identifier.
  60303. * @param data the data to check
  60304. * @returns true if the data is a KTX file or false otherwise
  60305. */
  60306. static IsValid(data: ArrayBufferView): boolean;
  60307. }
  60308. }
  60309. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60310. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60311. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60312. /**
  60313. * Class for loading KTX2 files
  60314. * !!! Experimental Extension Subject to Changes !!!
  60315. * @hidden
  60316. */
  60317. export class KhronosTextureContainer2 {
  60318. private static _ModulePromise;
  60319. private static _TranscodeFormat;
  60320. constructor(engine: ThinEngine);
  60321. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60322. private _determineTranscodeFormat;
  60323. /**
  60324. * Checks if the given data starts with a KTX2 file identifier.
  60325. * @param data the data to check
  60326. * @returns true if the data is a KTX2 file or false otherwise
  60327. */
  60328. static IsValid(data: ArrayBufferView): boolean;
  60329. }
  60330. }
  60331. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60332. import { Nullable } from "babylonjs/types";
  60333. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60334. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60335. /**
  60336. * Implementation of the KTX Texture Loader.
  60337. * @hidden
  60338. */
  60339. export class _KTXTextureLoader implements IInternalTextureLoader {
  60340. /**
  60341. * Defines wether the loader supports cascade loading the different faces.
  60342. */
  60343. readonly supportCascades: boolean;
  60344. /**
  60345. * This returns if the loader support the current file information.
  60346. * @param extension defines the file extension of the file being loaded
  60347. * @param mimeType defines the optional mime type of the file being loaded
  60348. * @returns true if the loader can load the specified file
  60349. */
  60350. canLoad(extension: string, mimeType?: string): boolean;
  60351. /**
  60352. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60353. * @param data contains the texture data
  60354. * @param texture defines the BabylonJS internal texture
  60355. * @param createPolynomials will be true if polynomials have been requested
  60356. * @param onLoad defines the callback to trigger once the texture is ready
  60357. * @param onError defines the callback to trigger in case of error
  60358. */
  60359. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60360. /**
  60361. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60362. * @param data contains the texture data
  60363. * @param texture defines the BabylonJS internal texture
  60364. * @param callback defines the method to call once ready to upload
  60365. */
  60366. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60367. }
  60368. }
  60369. declare module "babylonjs/Helpers/sceneHelpers" {
  60370. import { Nullable } from "babylonjs/types";
  60371. import { Mesh } from "babylonjs/Meshes/mesh";
  60372. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60373. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60374. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60375. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60376. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60377. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60378. import "babylonjs/Meshes/Builders/boxBuilder";
  60379. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60380. /** @hidden */
  60381. export var _forceSceneHelpersToBundle: boolean;
  60382. module "babylonjs/scene" {
  60383. interface Scene {
  60384. /**
  60385. * Creates a default light for the scene.
  60386. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60387. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60388. */
  60389. createDefaultLight(replace?: boolean): void;
  60390. /**
  60391. * Creates a default camera for the scene.
  60392. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60393. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60394. * @param replace has default false, when true replaces the active camera in the scene
  60395. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60396. */
  60397. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60398. /**
  60399. * Creates a default camera and a default light.
  60400. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60401. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60402. * @param replace has the default false, when true replaces the active camera/light in the scene
  60403. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60404. */
  60405. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60406. /**
  60407. * Creates a new sky box
  60408. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60409. * @param environmentTexture defines the texture to use as environment texture
  60410. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60411. * @param scale defines the overall scale of the skybox
  60412. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60413. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60414. * @returns a new mesh holding the sky box
  60415. */
  60416. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60417. /**
  60418. * Creates a new environment
  60419. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60420. * @param options defines the options you can use to configure the environment
  60421. * @returns the new EnvironmentHelper
  60422. */
  60423. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60424. /**
  60425. * Creates a new VREXperienceHelper
  60426. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60427. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60428. * @returns a new VREXperienceHelper
  60429. */
  60430. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60431. /**
  60432. * Creates a new WebXRDefaultExperience
  60433. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60434. * @param options experience options
  60435. * @returns a promise for a new WebXRDefaultExperience
  60436. */
  60437. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60438. }
  60439. }
  60440. }
  60441. declare module "babylonjs/Helpers/videoDome" {
  60442. import { Scene } from "babylonjs/scene";
  60443. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60444. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60445. /**
  60446. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60447. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60448. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60449. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60450. */
  60451. export class VideoDome extends TextureDome<VideoTexture> {
  60452. /**
  60453. * Define the video source as a Monoscopic panoramic 360 video.
  60454. */
  60455. static readonly MODE_MONOSCOPIC: number;
  60456. /**
  60457. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60458. */
  60459. static readonly MODE_TOPBOTTOM: number;
  60460. /**
  60461. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60462. */
  60463. static readonly MODE_SIDEBYSIDE: number;
  60464. /**
  60465. * Get the video texture associated with this video dome
  60466. */
  60467. get videoTexture(): VideoTexture;
  60468. /**
  60469. * Get the video mode of this dome
  60470. */
  60471. get videoMode(): number;
  60472. /**
  60473. * Set the video mode of this dome.
  60474. * @see textureMode
  60475. */
  60476. set videoMode(value: number);
  60477. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60478. }
  60479. }
  60480. declare module "babylonjs/Helpers/index" {
  60481. export * from "babylonjs/Helpers/environmentHelper";
  60482. export * from "babylonjs/Helpers/photoDome";
  60483. export * from "babylonjs/Helpers/sceneHelpers";
  60484. export * from "babylonjs/Helpers/videoDome";
  60485. }
  60486. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60487. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60488. import { IDisposable } from "babylonjs/scene";
  60489. import { Engine } from "babylonjs/Engines/engine";
  60490. /**
  60491. * This class can be used to get instrumentation data from a Babylon engine
  60492. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60493. */
  60494. export class EngineInstrumentation implements IDisposable {
  60495. /**
  60496. * Define the instrumented engine.
  60497. */
  60498. engine: Engine;
  60499. private _captureGPUFrameTime;
  60500. private _gpuFrameTimeToken;
  60501. private _gpuFrameTime;
  60502. private _captureShaderCompilationTime;
  60503. private _shaderCompilationTime;
  60504. private _onBeginFrameObserver;
  60505. private _onEndFrameObserver;
  60506. private _onBeforeShaderCompilationObserver;
  60507. private _onAfterShaderCompilationObserver;
  60508. /**
  60509. * Gets the perf counter used for GPU frame time
  60510. */
  60511. get gpuFrameTimeCounter(): PerfCounter;
  60512. /**
  60513. * Gets the GPU frame time capture status
  60514. */
  60515. get captureGPUFrameTime(): boolean;
  60516. /**
  60517. * Enable or disable the GPU frame time capture
  60518. */
  60519. set captureGPUFrameTime(value: boolean);
  60520. /**
  60521. * Gets the perf counter used for shader compilation time
  60522. */
  60523. get shaderCompilationTimeCounter(): PerfCounter;
  60524. /**
  60525. * Gets the shader compilation time capture status
  60526. */
  60527. get captureShaderCompilationTime(): boolean;
  60528. /**
  60529. * Enable or disable the shader compilation time capture
  60530. */
  60531. set captureShaderCompilationTime(value: boolean);
  60532. /**
  60533. * Instantiates a new engine instrumentation.
  60534. * This class can be used to get instrumentation data from a Babylon engine
  60535. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60536. * @param engine Defines the engine to instrument
  60537. */
  60538. constructor(
  60539. /**
  60540. * Define the instrumented engine.
  60541. */
  60542. engine: Engine);
  60543. /**
  60544. * Dispose and release associated resources.
  60545. */
  60546. dispose(): void;
  60547. }
  60548. }
  60549. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60550. import { Scene, IDisposable } from "babylonjs/scene";
  60551. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60552. /**
  60553. * This class can be used to get instrumentation data from a Babylon engine
  60554. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60555. */
  60556. export class SceneInstrumentation implements IDisposable {
  60557. /**
  60558. * Defines the scene to instrument
  60559. */
  60560. scene: Scene;
  60561. private _captureActiveMeshesEvaluationTime;
  60562. private _activeMeshesEvaluationTime;
  60563. private _captureRenderTargetsRenderTime;
  60564. private _renderTargetsRenderTime;
  60565. private _captureFrameTime;
  60566. private _frameTime;
  60567. private _captureRenderTime;
  60568. private _renderTime;
  60569. private _captureInterFrameTime;
  60570. private _interFrameTime;
  60571. private _captureParticlesRenderTime;
  60572. private _particlesRenderTime;
  60573. private _captureSpritesRenderTime;
  60574. private _spritesRenderTime;
  60575. private _capturePhysicsTime;
  60576. private _physicsTime;
  60577. private _captureAnimationsTime;
  60578. private _animationsTime;
  60579. private _captureCameraRenderTime;
  60580. private _cameraRenderTime;
  60581. private _onBeforeActiveMeshesEvaluationObserver;
  60582. private _onAfterActiveMeshesEvaluationObserver;
  60583. private _onBeforeRenderTargetsRenderObserver;
  60584. private _onAfterRenderTargetsRenderObserver;
  60585. private _onAfterRenderObserver;
  60586. private _onBeforeDrawPhaseObserver;
  60587. private _onAfterDrawPhaseObserver;
  60588. private _onBeforeAnimationsObserver;
  60589. private _onBeforeParticlesRenderingObserver;
  60590. private _onAfterParticlesRenderingObserver;
  60591. private _onBeforeSpritesRenderingObserver;
  60592. private _onAfterSpritesRenderingObserver;
  60593. private _onBeforePhysicsObserver;
  60594. private _onAfterPhysicsObserver;
  60595. private _onAfterAnimationsObserver;
  60596. private _onBeforeCameraRenderObserver;
  60597. private _onAfterCameraRenderObserver;
  60598. /**
  60599. * Gets the perf counter used for active meshes evaluation time
  60600. */
  60601. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60602. /**
  60603. * Gets the active meshes evaluation time capture status
  60604. */
  60605. get captureActiveMeshesEvaluationTime(): boolean;
  60606. /**
  60607. * Enable or disable the active meshes evaluation time capture
  60608. */
  60609. set captureActiveMeshesEvaluationTime(value: boolean);
  60610. /**
  60611. * Gets the perf counter used for render targets render time
  60612. */
  60613. get renderTargetsRenderTimeCounter(): PerfCounter;
  60614. /**
  60615. * Gets the render targets render time capture status
  60616. */
  60617. get captureRenderTargetsRenderTime(): boolean;
  60618. /**
  60619. * Enable or disable the render targets render time capture
  60620. */
  60621. set captureRenderTargetsRenderTime(value: boolean);
  60622. /**
  60623. * Gets the perf counter used for particles render time
  60624. */
  60625. get particlesRenderTimeCounter(): PerfCounter;
  60626. /**
  60627. * Gets the particles render time capture status
  60628. */
  60629. get captureParticlesRenderTime(): boolean;
  60630. /**
  60631. * Enable or disable the particles render time capture
  60632. */
  60633. set captureParticlesRenderTime(value: boolean);
  60634. /**
  60635. * Gets the perf counter used for sprites render time
  60636. */
  60637. get spritesRenderTimeCounter(): PerfCounter;
  60638. /**
  60639. * Gets the sprites render time capture status
  60640. */
  60641. get captureSpritesRenderTime(): boolean;
  60642. /**
  60643. * Enable or disable the sprites render time capture
  60644. */
  60645. set captureSpritesRenderTime(value: boolean);
  60646. /**
  60647. * Gets the perf counter used for physics time
  60648. */
  60649. get physicsTimeCounter(): PerfCounter;
  60650. /**
  60651. * Gets the physics time capture status
  60652. */
  60653. get capturePhysicsTime(): boolean;
  60654. /**
  60655. * Enable or disable the physics time capture
  60656. */
  60657. set capturePhysicsTime(value: boolean);
  60658. /**
  60659. * Gets the perf counter used for animations time
  60660. */
  60661. get animationsTimeCounter(): PerfCounter;
  60662. /**
  60663. * Gets the animations time capture status
  60664. */
  60665. get captureAnimationsTime(): boolean;
  60666. /**
  60667. * Enable or disable the animations time capture
  60668. */
  60669. set captureAnimationsTime(value: boolean);
  60670. /**
  60671. * Gets the perf counter used for frame time capture
  60672. */
  60673. get frameTimeCounter(): PerfCounter;
  60674. /**
  60675. * Gets the frame time capture status
  60676. */
  60677. get captureFrameTime(): boolean;
  60678. /**
  60679. * Enable or disable the frame time capture
  60680. */
  60681. set captureFrameTime(value: boolean);
  60682. /**
  60683. * Gets the perf counter used for inter-frames time capture
  60684. */
  60685. get interFrameTimeCounter(): PerfCounter;
  60686. /**
  60687. * Gets the inter-frames time capture status
  60688. */
  60689. get captureInterFrameTime(): boolean;
  60690. /**
  60691. * Enable or disable the inter-frames time capture
  60692. */
  60693. set captureInterFrameTime(value: boolean);
  60694. /**
  60695. * Gets the perf counter used for render time capture
  60696. */
  60697. get renderTimeCounter(): PerfCounter;
  60698. /**
  60699. * Gets the render time capture status
  60700. */
  60701. get captureRenderTime(): boolean;
  60702. /**
  60703. * Enable or disable the render time capture
  60704. */
  60705. set captureRenderTime(value: boolean);
  60706. /**
  60707. * Gets the perf counter used for camera render time capture
  60708. */
  60709. get cameraRenderTimeCounter(): PerfCounter;
  60710. /**
  60711. * Gets the camera render time capture status
  60712. */
  60713. get captureCameraRenderTime(): boolean;
  60714. /**
  60715. * Enable or disable the camera render time capture
  60716. */
  60717. set captureCameraRenderTime(value: boolean);
  60718. /**
  60719. * Gets the perf counter used for draw calls
  60720. */
  60721. get drawCallsCounter(): PerfCounter;
  60722. /**
  60723. * Instantiates a new scene instrumentation.
  60724. * This class can be used to get instrumentation data from a Babylon engine
  60725. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60726. * @param scene Defines the scene to instrument
  60727. */
  60728. constructor(
  60729. /**
  60730. * Defines the scene to instrument
  60731. */
  60732. scene: Scene);
  60733. /**
  60734. * Dispose and release associated resources.
  60735. */
  60736. dispose(): void;
  60737. }
  60738. }
  60739. declare module "babylonjs/Instrumentation/index" {
  60740. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60741. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60742. export * from "babylonjs/Instrumentation/timeToken";
  60743. }
  60744. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60745. /** @hidden */
  60746. export var glowMapGenerationPixelShader: {
  60747. name: string;
  60748. shader: string;
  60749. };
  60750. }
  60751. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60752. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60753. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60754. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60755. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60756. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60757. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60758. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60759. /** @hidden */
  60760. export var glowMapGenerationVertexShader: {
  60761. name: string;
  60762. shader: string;
  60763. };
  60764. }
  60765. declare module "babylonjs/Layers/effectLayer" {
  60766. import { Observable } from "babylonjs/Misc/observable";
  60767. import { Nullable } from "babylonjs/types";
  60768. import { Camera } from "babylonjs/Cameras/camera";
  60769. import { Scene } from "babylonjs/scene";
  60770. import { ISize } from "babylonjs/Maths/math.size";
  60771. import { Color4 } from "babylonjs/Maths/math.color";
  60772. import { Engine } from "babylonjs/Engines/engine";
  60773. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60774. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60775. import { Mesh } from "babylonjs/Meshes/mesh";
  60776. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60777. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60778. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60779. import { Effect } from "babylonjs/Materials/effect";
  60780. import { Material } from "babylonjs/Materials/material";
  60781. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60782. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60783. /**
  60784. * Effect layer options. This helps customizing the behaviour
  60785. * of the effect layer.
  60786. */
  60787. export interface IEffectLayerOptions {
  60788. /**
  60789. * Multiplication factor apply to the canvas size to compute the render target size
  60790. * used to generated the objects (the smaller the faster).
  60791. */
  60792. mainTextureRatio: number;
  60793. /**
  60794. * Enforces a fixed size texture to ensure effect stability across devices.
  60795. */
  60796. mainTextureFixedSize?: number;
  60797. /**
  60798. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60799. */
  60800. alphaBlendingMode: number;
  60801. /**
  60802. * The camera attached to the layer.
  60803. */
  60804. camera: Nullable<Camera>;
  60805. /**
  60806. * The rendering group to draw the layer in.
  60807. */
  60808. renderingGroupId: number;
  60809. }
  60810. /**
  60811. * The effect layer Helps adding post process effect blended with the main pass.
  60812. *
  60813. * This can be for instance use to generate glow or higlight effects on the scene.
  60814. *
  60815. * The effect layer class can not be used directly and is intented to inherited from to be
  60816. * customized per effects.
  60817. */
  60818. export abstract class EffectLayer {
  60819. private _vertexBuffers;
  60820. private _indexBuffer;
  60821. private _cachedDefines;
  60822. private _effectLayerMapGenerationEffect;
  60823. private _effectLayerOptions;
  60824. private _mergeEffect;
  60825. protected _scene: Scene;
  60826. protected _engine: Engine;
  60827. protected _maxSize: number;
  60828. protected _mainTextureDesiredSize: ISize;
  60829. protected _mainTexture: RenderTargetTexture;
  60830. protected _shouldRender: boolean;
  60831. protected _postProcesses: PostProcess[];
  60832. protected _textures: BaseTexture[];
  60833. protected _emissiveTextureAndColor: {
  60834. texture: Nullable<BaseTexture>;
  60835. color: Color4;
  60836. };
  60837. /**
  60838. * The name of the layer
  60839. */
  60840. name: string;
  60841. /**
  60842. * The clear color of the texture used to generate the glow map.
  60843. */
  60844. neutralColor: Color4;
  60845. /**
  60846. * Specifies whether the highlight layer is enabled or not.
  60847. */
  60848. isEnabled: boolean;
  60849. /**
  60850. * Gets the camera attached to the layer.
  60851. */
  60852. get camera(): Nullable<Camera>;
  60853. /**
  60854. * Gets the rendering group id the layer should render in.
  60855. */
  60856. get renderingGroupId(): number;
  60857. set renderingGroupId(renderingGroupId: number);
  60858. /**
  60859. * An event triggered when the effect layer has been disposed.
  60860. */
  60861. onDisposeObservable: Observable<EffectLayer>;
  60862. /**
  60863. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60864. */
  60865. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60866. /**
  60867. * An event triggered when the generated texture is being merged in the scene.
  60868. */
  60869. onBeforeComposeObservable: Observable<EffectLayer>;
  60870. /**
  60871. * An event triggered when the mesh is rendered into the effect render target.
  60872. */
  60873. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60874. /**
  60875. * An event triggered after the mesh has been rendered into the effect render target.
  60876. */
  60877. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60878. /**
  60879. * An event triggered when the generated texture has been merged in the scene.
  60880. */
  60881. onAfterComposeObservable: Observable<EffectLayer>;
  60882. /**
  60883. * An event triggered when the efffect layer changes its size.
  60884. */
  60885. onSizeChangedObservable: Observable<EffectLayer>;
  60886. /** @hidden */
  60887. static _SceneComponentInitialization: (scene: Scene) => void;
  60888. /**
  60889. * Instantiates a new effect Layer and references it in the scene.
  60890. * @param name The name of the layer
  60891. * @param scene The scene to use the layer in
  60892. */
  60893. constructor(
  60894. /** The Friendly of the effect in the scene */
  60895. name: string, scene: Scene);
  60896. /**
  60897. * Get the effect name of the layer.
  60898. * @return The effect name
  60899. */
  60900. abstract getEffectName(): string;
  60901. /**
  60902. * Checks for the readiness of the element composing the layer.
  60903. * @param subMesh the mesh to check for
  60904. * @param useInstances specify whether or not to use instances to render the mesh
  60905. * @return true if ready otherwise, false
  60906. */
  60907. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60908. /**
  60909. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60910. * @returns true if the effect requires stencil during the main canvas render pass.
  60911. */
  60912. abstract needStencil(): boolean;
  60913. /**
  60914. * Create the merge effect. This is the shader use to blit the information back
  60915. * to the main canvas at the end of the scene rendering.
  60916. * @returns The effect containing the shader used to merge the effect on the main canvas
  60917. */
  60918. protected abstract _createMergeEffect(): Effect;
  60919. /**
  60920. * Creates the render target textures and post processes used in the effect layer.
  60921. */
  60922. protected abstract _createTextureAndPostProcesses(): void;
  60923. /**
  60924. * Implementation specific of rendering the generating effect on the main canvas.
  60925. * @param effect The effect used to render through
  60926. */
  60927. protected abstract _internalRender(effect: Effect): void;
  60928. /**
  60929. * Sets the required values for both the emissive texture and and the main color.
  60930. */
  60931. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60932. /**
  60933. * Free any resources and references associated to a mesh.
  60934. * Internal use
  60935. * @param mesh The mesh to free.
  60936. */
  60937. abstract _disposeMesh(mesh: Mesh): void;
  60938. /**
  60939. * Serializes this layer (Glow or Highlight for example)
  60940. * @returns a serialized layer object
  60941. */
  60942. abstract serialize?(): any;
  60943. /**
  60944. * Initializes the effect layer with the required options.
  60945. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60946. */
  60947. protected _init(options: Partial<IEffectLayerOptions>): void;
  60948. /**
  60949. * Generates the index buffer of the full screen quad blending to the main canvas.
  60950. */
  60951. private _generateIndexBuffer;
  60952. /**
  60953. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60954. */
  60955. private _generateVertexBuffer;
  60956. /**
  60957. * Sets the main texture desired size which is the closest power of two
  60958. * of the engine canvas size.
  60959. */
  60960. private _setMainTextureSize;
  60961. /**
  60962. * Creates the main texture for the effect layer.
  60963. */
  60964. protected _createMainTexture(): void;
  60965. /**
  60966. * Adds specific effects defines.
  60967. * @param defines The defines to add specifics to.
  60968. */
  60969. protected _addCustomEffectDefines(defines: string[]): void;
  60970. /**
  60971. * Checks for the readiness of the element composing the layer.
  60972. * @param subMesh the mesh to check for
  60973. * @param useInstances specify whether or not to use instances to render the mesh
  60974. * @param emissiveTexture the associated emissive texture used to generate the glow
  60975. * @return true if ready otherwise, false
  60976. */
  60977. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60978. /**
  60979. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60980. */
  60981. render(): void;
  60982. /**
  60983. * Determine if a given mesh will be used in the current effect.
  60984. * @param mesh mesh to test
  60985. * @returns true if the mesh will be used
  60986. */
  60987. hasMesh(mesh: AbstractMesh): boolean;
  60988. /**
  60989. * Returns true if the layer contains information to display, otherwise false.
  60990. * @returns true if the glow layer should be rendered
  60991. */
  60992. shouldRender(): boolean;
  60993. /**
  60994. * Returns true if the mesh should render, otherwise false.
  60995. * @param mesh The mesh to render
  60996. * @returns true if it should render otherwise false
  60997. */
  60998. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60999. /**
  61000. * Returns true if the mesh can be rendered, otherwise false.
  61001. * @param mesh The mesh to render
  61002. * @param material The material used on the mesh
  61003. * @returns true if it can be rendered otherwise false
  61004. */
  61005. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61006. /**
  61007. * Returns true if the mesh should render, otherwise false.
  61008. * @param mesh The mesh to render
  61009. * @returns true if it should render otherwise false
  61010. */
  61011. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  61012. /**
  61013. * Renders the submesh passed in parameter to the generation map.
  61014. */
  61015. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  61016. /**
  61017. * Defines whether the current material of the mesh should be use to render the effect.
  61018. * @param mesh defines the current mesh to render
  61019. */
  61020. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61021. /**
  61022. * Rebuild the required buffers.
  61023. * @hidden Internal use only.
  61024. */
  61025. _rebuild(): void;
  61026. /**
  61027. * Dispose only the render target textures and post process.
  61028. */
  61029. private _disposeTextureAndPostProcesses;
  61030. /**
  61031. * Dispose the highlight layer and free resources.
  61032. */
  61033. dispose(): void;
  61034. /**
  61035. * Gets the class name of the effect layer
  61036. * @returns the string with the class name of the effect layer
  61037. */
  61038. getClassName(): string;
  61039. /**
  61040. * Creates an effect layer from parsed effect layer data
  61041. * @param parsedEffectLayer defines effect layer data
  61042. * @param scene defines the current scene
  61043. * @param rootUrl defines the root URL containing the effect layer information
  61044. * @returns a parsed effect Layer
  61045. */
  61046. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  61047. }
  61048. }
  61049. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  61050. import { Scene } from "babylonjs/scene";
  61051. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61052. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61053. import { AbstractScene } from "babylonjs/abstractScene";
  61054. module "babylonjs/abstractScene" {
  61055. interface AbstractScene {
  61056. /**
  61057. * The list of effect layers (highlights/glow) added to the scene
  61058. * @see https://doc.babylonjs.com/how_to/highlight_layer
  61059. * @see https://doc.babylonjs.com/how_to/glow_layer
  61060. */
  61061. effectLayers: Array<EffectLayer>;
  61062. /**
  61063. * Removes the given effect layer from this scene.
  61064. * @param toRemove defines the effect layer to remove
  61065. * @returns the index of the removed effect layer
  61066. */
  61067. removeEffectLayer(toRemove: EffectLayer): number;
  61068. /**
  61069. * Adds the given effect layer to this scene
  61070. * @param newEffectLayer defines the effect layer to add
  61071. */
  61072. addEffectLayer(newEffectLayer: EffectLayer): void;
  61073. }
  61074. }
  61075. /**
  61076. * Defines the layer scene component responsible to manage any effect layers
  61077. * in a given scene.
  61078. */
  61079. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  61080. /**
  61081. * The component name helpfull to identify the component in the list of scene components.
  61082. */
  61083. readonly name: string;
  61084. /**
  61085. * The scene the component belongs to.
  61086. */
  61087. scene: Scene;
  61088. private _engine;
  61089. private _renderEffects;
  61090. private _needStencil;
  61091. private _previousStencilState;
  61092. /**
  61093. * Creates a new instance of the component for the given scene
  61094. * @param scene Defines the scene to register the component in
  61095. */
  61096. constructor(scene: Scene);
  61097. /**
  61098. * Registers the component in a given scene
  61099. */
  61100. register(): void;
  61101. /**
  61102. * Rebuilds the elements related to this component in case of
  61103. * context lost for instance.
  61104. */
  61105. rebuild(): void;
  61106. /**
  61107. * Serializes the component data to the specified json object
  61108. * @param serializationObject The object to serialize to
  61109. */
  61110. serialize(serializationObject: any): void;
  61111. /**
  61112. * Adds all the elements from the container to the scene
  61113. * @param container the container holding the elements
  61114. */
  61115. addFromContainer(container: AbstractScene): void;
  61116. /**
  61117. * Removes all the elements in the container from the scene
  61118. * @param container contains the elements to remove
  61119. * @param dispose if the removed element should be disposed (default: false)
  61120. */
  61121. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61122. /**
  61123. * Disposes the component and the associated ressources.
  61124. */
  61125. dispose(): void;
  61126. private _isReadyForMesh;
  61127. private _renderMainTexture;
  61128. private _setStencil;
  61129. private _setStencilBack;
  61130. private _draw;
  61131. private _drawCamera;
  61132. private _drawRenderingGroup;
  61133. }
  61134. }
  61135. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61136. /** @hidden */
  61137. export var glowMapMergePixelShader: {
  61138. name: string;
  61139. shader: string;
  61140. };
  61141. }
  61142. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61143. /** @hidden */
  61144. export var glowMapMergeVertexShader: {
  61145. name: string;
  61146. shader: string;
  61147. };
  61148. }
  61149. declare module "babylonjs/Layers/glowLayer" {
  61150. import { Nullable } from "babylonjs/types";
  61151. import { Camera } from "babylonjs/Cameras/camera";
  61152. import { Scene } from "babylonjs/scene";
  61153. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61154. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61155. import { Mesh } from "babylonjs/Meshes/mesh";
  61156. import { Texture } from "babylonjs/Materials/Textures/texture";
  61157. import { Effect } from "babylonjs/Materials/effect";
  61158. import { Material } from "babylonjs/Materials/material";
  61159. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61160. import { Color4 } from "babylonjs/Maths/math.color";
  61161. import "babylonjs/Shaders/glowMapMerge.fragment";
  61162. import "babylonjs/Shaders/glowMapMerge.vertex";
  61163. import "babylonjs/Layers/effectLayerSceneComponent";
  61164. module "babylonjs/abstractScene" {
  61165. interface AbstractScene {
  61166. /**
  61167. * Return a the first highlight layer of the scene with a given name.
  61168. * @param name The name of the highlight layer to look for.
  61169. * @return The highlight layer if found otherwise null.
  61170. */
  61171. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61172. }
  61173. }
  61174. /**
  61175. * Glow layer options. This helps customizing the behaviour
  61176. * of the glow layer.
  61177. */
  61178. export interface IGlowLayerOptions {
  61179. /**
  61180. * Multiplication factor apply to the canvas size to compute the render target size
  61181. * used to generated the glowing objects (the smaller the faster).
  61182. */
  61183. mainTextureRatio: number;
  61184. /**
  61185. * Enforces a fixed size texture to ensure resize independant blur.
  61186. */
  61187. mainTextureFixedSize?: number;
  61188. /**
  61189. * How big is the kernel of the blur texture.
  61190. */
  61191. blurKernelSize: number;
  61192. /**
  61193. * The camera attached to the layer.
  61194. */
  61195. camera: Nullable<Camera>;
  61196. /**
  61197. * Enable MSAA by chosing the number of samples.
  61198. */
  61199. mainTextureSamples?: number;
  61200. /**
  61201. * The rendering group to draw the layer in.
  61202. */
  61203. renderingGroupId: number;
  61204. }
  61205. /**
  61206. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61207. *
  61208. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61209. *
  61210. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61211. */
  61212. export class GlowLayer extends EffectLayer {
  61213. /**
  61214. * Effect Name of the layer.
  61215. */
  61216. static readonly EffectName: string;
  61217. /**
  61218. * The default blur kernel size used for the glow.
  61219. */
  61220. static DefaultBlurKernelSize: number;
  61221. /**
  61222. * The default texture size ratio used for the glow.
  61223. */
  61224. static DefaultTextureRatio: number;
  61225. /**
  61226. * Sets the kernel size of the blur.
  61227. */
  61228. set blurKernelSize(value: number);
  61229. /**
  61230. * Gets the kernel size of the blur.
  61231. */
  61232. get blurKernelSize(): number;
  61233. /**
  61234. * Sets the glow intensity.
  61235. */
  61236. set intensity(value: number);
  61237. /**
  61238. * Gets the glow intensity.
  61239. */
  61240. get intensity(): number;
  61241. private _options;
  61242. private _intensity;
  61243. private _horizontalBlurPostprocess1;
  61244. private _verticalBlurPostprocess1;
  61245. private _horizontalBlurPostprocess2;
  61246. private _verticalBlurPostprocess2;
  61247. private _blurTexture1;
  61248. private _blurTexture2;
  61249. private _postProcesses1;
  61250. private _postProcesses2;
  61251. private _includedOnlyMeshes;
  61252. private _excludedMeshes;
  61253. private _meshesUsingTheirOwnMaterials;
  61254. /**
  61255. * Callback used to let the user override the color selection on a per mesh basis
  61256. */
  61257. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61258. /**
  61259. * Callback used to let the user override the texture selection on a per mesh basis
  61260. */
  61261. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61262. /**
  61263. * Instantiates a new glow Layer and references it to the scene.
  61264. * @param name The name of the layer
  61265. * @param scene The scene to use the layer in
  61266. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61267. */
  61268. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61269. /**
  61270. * Get the effect name of the layer.
  61271. * @return The effect name
  61272. */
  61273. getEffectName(): string;
  61274. /**
  61275. * Create the merge effect. This is the shader use to blit the information back
  61276. * to the main canvas at the end of the scene rendering.
  61277. */
  61278. protected _createMergeEffect(): Effect;
  61279. /**
  61280. * Creates the render target textures and post processes used in the glow layer.
  61281. */
  61282. protected _createTextureAndPostProcesses(): void;
  61283. /**
  61284. * Checks for the readiness of the element composing the layer.
  61285. * @param subMesh the mesh to check for
  61286. * @param useInstances specify wether or not to use instances to render the mesh
  61287. * @param emissiveTexture the associated emissive texture used to generate the glow
  61288. * @return true if ready otherwise, false
  61289. */
  61290. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61291. /**
  61292. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61293. */
  61294. needStencil(): boolean;
  61295. /**
  61296. * Returns true if the mesh can be rendered, otherwise false.
  61297. * @param mesh The mesh to render
  61298. * @param material The material used on the mesh
  61299. * @returns true if it can be rendered otherwise false
  61300. */
  61301. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61302. /**
  61303. * Implementation specific of rendering the generating effect on the main canvas.
  61304. * @param effect The effect used to render through
  61305. */
  61306. protected _internalRender(effect: Effect): void;
  61307. /**
  61308. * Sets the required values for both the emissive texture and and the main color.
  61309. */
  61310. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61311. /**
  61312. * Returns true if the mesh should render, otherwise false.
  61313. * @param mesh The mesh to render
  61314. * @returns true if it should render otherwise false
  61315. */
  61316. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61317. /**
  61318. * Adds specific effects defines.
  61319. * @param defines The defines to add specifics to.
  61320. */
  61321. protected _addCustomEffectDefines(defines: string[]): void;
  61322. /**
  61323. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61324. * @param mesh The mesh to exclude from the glow layer
  61325. */
  61326. addExcludedMesh(mesh: Mesh): void;
  61327. /**
  61328. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61329. * @param mesh The mesh to remove
  61330. */
  61331. removeExcludedMesh(mesh: Mesh): void;
  61332. /**
  61333. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61334. * @param mesh The mesh to include in the glow layer
  61335. */
  61336. addIncludedOnlyMesh(mesh: Mesh): void;
  61337. /**
  61338. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61339. * @param mesh The mesh to remove
  61340. */
  61341. removeIncludedOnlyMesh(mesh: Mesh): void;
  61342. /**
  61343. * Determine if a given mesh will be used in the glow layer
  61344. * @param mesh The mesh to test
  61345. * @returns true if the mesh will be highlighted by the current glow layer
  61346. */
  61347. hasMesh(mesh: AbstractMesh): boolean;
  61348. /**
  61349. * Defines whether the current material of the mesh should be use to render the effect.
  61350. * @param mesh defines the current mesh to render
  61351. */
  61352. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61353. /**
  61354. * Add a mesh to be rendered through its own material and not with emissive only.
  61355. * @param mesh The mesh for which we need to use its material
  61356. */
  61357. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61358. /**
  61359. * Remove a mesh from being rendered through its own material and not with emissive only.
  61360. * @param mesh The mesh for which we need to not use its material
  61361. */
  61362. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61363. /**
  61364. * Free any resources and references associated to a mesh.
  61365. * Internal use
  61366. * @param mesh The mesh to free.
  61367. * @hidden
  61368. */
  61369. _disposeMesh(mesh: Mesh): void;
  61370. /**
  61371. * Gets the class name of the effect layer
  61372. * @returns the string with the class name of the effect layer
  61373. */
  61374. getClassName(): string;
  61375. /**
  61376. * Serializes this glow layer
  61377. * @returns a serialized glow layer object
  61378. */
  61379. serialize(): any;
  61380. /**
  61381. * Creates a Glow Layer from parsed glow layer data
  61382. * @param parsedGlowLayer defines glow layer data
  61383. * @param scene defines the current scene
  61384. * @param rootUrl defines the root URL containing the glow layer information
  61385. * @returns a parsed Glow Layer
  61386. */
  61387. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61388. }
  61389. }
  61390. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61391. /** @hidden */
  61392. export var glowBlurPostProcessPixelShader: {
  61393. name: string;
  61394. shader: string;
  61395. };
  61396. }
  61397. declare module "babylonjs/Layers/highlightLayer" {
  61398. import { Observable } from "babylonjs/Misc/observable";
  61399. import { Nullable } from "babylonjs/types";
  61400. import { Camera } from "babylonjs/Cameras/camera";
  61401. import { Scene } from "babylonjs/scene";
  61402. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61403. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61404. import { Mesh } from "babylonjs/Meshes/mesh";
  61405. import { Effect } from "babylonjs/Materials/effect";
  61406. import { Material } from "babylonjs/Materials/material";
  61407. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61408. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61409. import "babylonjs/Shaders/glowMapMerge.fragment";
  61410. import "babylonjs/Shaders/glowMapMerge.vertex";
  61411. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61412. module "babylonjs/abstractScene" {
  61413. interface AbstractScene {
  61414. /**
  61415. * Return a the first highlight layer of the scene with a given name.
  61416. * @param name The name of the highlight layer to look for.
  61417. * @return The highlight layer if found otherwise null.
  61418. */
  61419. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61420. }
  61421. }
  61422. /**
  61423. * Highlight layer options. This helps customizing the behaviour
  61424. * of the highlight layer.
  61425. */
  61426. export interface IHighlightLayerOptions {
  61427. /**
  61428. * Multiplication factor apply to the canvas size to compute the render target size
  61429. * used to generated the glowing objects (the smaller the faster).
  61430. */
  61431. mainTextureRatio: number;
  61432. /**
  61433. * Enforces a fixed size texture to ensure resize independant blur.
  61434. */
  61435. mainTextureFixedSize?: number;
  61436. /**
  61437. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61438. * of the picture to blur (the smaller the faster).
  61439. */
  61440. blurTextureSizeRatio: number;
  61441. /**
  61442. * How big in texel of the blur texture is the vertical blur.
  61443. */
  61444. blurVerticalSize: number;
  61445. /**
  61446. * How big in texel of the blur texture is the horizontal blur.
  61447. */
  61448. blurHorizontalSize: number;
  61449. /**
  61450. * Alpha blending mode used to apply the blur. Default is combine.
  61451. */
  61452. alphaBlendingMode: number;
  61453. /**
  61454. * The camera attached to the layer.
  61455. */
  61456. camera: Nullable<Camera>;
  61457. /**
  61458. * Should we display highlight as a solid stroke?
  61459. */
  61460. isStroke?: boolean;
  61461. /**
  61462. * The rendering group to draw the layer in.
  61463. */
  61464. renderingGroupId: number;
  61465. }
  61466. /**
  61467. * The highlight layer Helps adding a glow effect around a mesh.
  61468. *
  61469. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61470. * glowy meshes to your scene.
  61471. *
  61472. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61473. */
  61474. export class HighlightLayer extends EffectLayer {
  61475. name: string;
  61476. /**
  61477. * Effect Name of the highlight layer.
  61478. */
  61479. static readonly EffectName: string;
  61480. /**
  61481. * The neutral color used during the preparation of the glow effect.
  61482. * This is black by default as the blend operation is a blend operation.
  61483. */
  61484. static NeutralColor: Color4;
  61485. /**
  61486. * Stencil value used for glowing meshes.
  61487. */
  61488. static GlowingMeshStencilReference: number;
  61489. /**
  61490. * Stencil value used for the other meshes in the scene.
  61491. */
  61492. static NormalMeshStencilReference: number;
  61493. /**
  61494. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61495. */
  61496. innerGlow: boolean;
  61497. /**
  61498. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61499. */
  61500. outerGlow: boolean;
  61501. /**
  61502. * Specifies the horizontal size of the blur.
  61503. */
  61504. set blurHorizontalSize(value: number);
  61505. /**
  61506. * Specifies the vertical size of the blur.
  61507. */
  61508. set blurVerticalSize(value: number);
  61509. /**
  61510. * Gets the horizontal size of the blur.
  61511. */
  61512. get blurHorizontalSize(): number;
  61513. /**
  61514. * Gets the vertical size of the blur.
  61515. */
  61516. get blurVerticalSize(): number;
  61517. /**
  61518. * An event triggered when the highlight layer is being blurred.
  61519. */
  61520. onBeforeBlurObservable: Observable<HighlightLayer>;
  61521. /**
  61522. * An event triggered when the highlight layer has been blurred.
  61523. */
  61524. onAfterBlurObservable: Observable<HighlightLayer>;
  61525. private _instanceGlowingMeshStencilReference;
  61526. private _options;
  61527. private _downSamplePostprocess;
  61528. private _horizontalBlurPostprocess;
  61529. private _verticalBlurPostprocess;
  61530. private _blurTexture;
  61531. private _meshes;
  61532. private _excludedMeshes;
  61533. /**
  61534. * Instantiates a new highlight Layer and references it to the scene..
  61535. * @param name The name of the layer
  61536. * @param scene The scene to use the layer in
  61537. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61538. */
  61539. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61540. /**
  61541. * Get the effect name of the layer.
  61542. * @return The effect name
  61543. */
  61544. getEffectName(): string;
  61545. /**
  61546. * Create the merge effect. This is the shader use to blit the information back
  61547. * to the main canvas at the end of the scene rendering.
  61548. */
  61549. protected _createMergeEffect(): Effect;
  61550. /**
  61551. * Creates the render target textures and post processes used in the highlight layer.
  61552. */
  61553. protected _createTextureAndPostProcesses(): void;
  61554. /**
  61555. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61556. */
  61557. needStencil(): boolean;
  61558. /**
  61559. * Checks for the readiness of the element composing the layer.
  61560. * @param subMesh the mesh to check for
  61561. * @param useInstances specify wether or not to use instances to render the mesh
  61562. * @param emissiveTexture the associated emissive texture used to generate the glow
  61563. * @return true if ready otherwise, false
  61564. */
  61565. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61566. /**
  61567. * Implementation specific of rendering the generating effect on the main canvas.
  61568. * @param effect The effect used to render through
  61569. */
  61570. protected _internalRender(effect: Effect): void;
  61571. /**
  61572. * Returns true if the layer contains information to display, otherwise false.
  61573. */
  61574. shouldRender(): boolean;
  61575. /**
  61576. * Returns true if the mesh should render, otherwise false.
  61577. * @param mesh The mesh to render
  61578. * @returns true if it should render otherwise false
  61579. */
  61580. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61581. /**
  61582. * Returns true if the mesh can be rendered, otherwise false.
  61583. * @param mesh The mesh to render
  61584. * @param material The material used on the mesh
  61585. * @returns true if it can be rendered otherwise false
  61586. */
  61587. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61588. /**
  61589. * Adds specific effects defines.
  61590. * @param defines The defines to add specifics to.
  61591. */
  61592. protected _addCustomEffectDefines(defines: string[]): void;
  61593. /**
  61594. * Sets the required values for both the emissive texture and and the main color.
  61595. */
  61596. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61597. /**
  61598. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61599. * @param mesh The mesh to exclude from the highlight layer
  61600. */
  61601. addExcludedMesh(mesh: Mesh): void;
  61602. /**
  61603. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61604. * @param mesh The mesh to highlight
  61605. */
  61606. removeExcludedMesh(mesh: Mesh): void;
  61607. /**
  61608. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61609. * @param mesh mesh to test
  61610. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61611. */
  61612. hasMesh(mesh: AbstractMesh): boolean;
  61613. /**
  61614. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61615. * @param mesh The mesh to highlight
  61616. * @param color The color of the highlight
  61617. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61618. */
  61619. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61620. /**
  61621. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61622. * @param mesh The mesh to highlight
  61623. */
  61624. removeMesh(mesh: Mesh): void;
  61625. /**
  61626. * Remove all the meshes currently referenced in the highlight layer
  61627. */
  61628. removeAllMeshes(): void;
  61629. /**
  61630. * Force the stencil to the normal expected value for none glowing parts
  61631. */
  61632. private _defaultStencilReference;
  61633. /**
  61634. * Free any resources and references associated to a mesh.
  61635. * Internal use
  61636. * @param mesh The mesh to free.
  61637. * @hidden
  61638. */
  61639. _disposeMesh(mesh: Mesh): void;
  61640. /**
  61641. * Dispose the highlight layer and free resources.
  61642. */
  61643. dispose(): void;
  61644. /**
  61645. * Gets the class name of the effect layer
  61646. * @returns the string with the class name of the effect layer
  61647. */
  61648. getClassName(): string;
  61649. /**
  61650. * Serializes this Highlight layer
  61651. * @returns a serialized Highlight layer object
  61652. */
  61653. serialize(): any;
  61654. /**
  61655. * Creates a Highlight layer from parsed Highlight layer data
  61656. * @param parsedHightlightLayer defines the Highlight layer data
  61657. * @param scene defines the current scene
  61658. * @param rootUrl defines the root URL containing the Highlight layer information
  61659. * @returns a parsed Highlight layer
  61660. */
  61661. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61662. }
  61663. }
  61664. declare module "babylonjs/Layers/layerSceneComponent" {
  61665. import { Scene } from "babylonjs/scene";
  61666. import { ISceneComponent } from "babylonjs/sceneComponent";
  61667. import { Layer } from "babylonjs/Layers/layer";
  61668. import { AbstractScene } from "babylonjs/abstractScene";
  61669. module "babylonjs/abstractScene" {
  61670. interface AbstractScene {
  61671. /**
  61672. * The list of layers (background and foreground) of the scene
  61673. */
  61674. layers: Array<Layer>;
  61675. }
  61676. }
  61677. /**
  61678. * Defines the layer scene component responsible to manage any layers
  61679. * in a given scene.
  61680. */
  61681. export class LayerSceneComponent implements ISceneComponent {
  61682. /**
  61683. * The component name helpfull to identify the component in the list of scene components.
  61684. */
  61685. readonly name: string;
  61686. /**
  61687. * The scene the component belongs to.
  61688. */
  61689. scene: Scene;
  61690. private _engine;
  61691. /**
  61692. * Creates a new instance of the component for the given scene
  61693. * @param scene Defines the scene to register the component in
  61694. */
  61695. constructor(scene: Scene);
  61696. /**
  61697. * Registers the component in a given scene
  61698. */
  61699. register(): void;
  61700. /**
  61701. * Rebuilds the elements related to this component in case of
  61702. * context lost for instance.
  61703. */
  61704. rebuild(): void;
  61705. /**
  61706. * Disposes the component and the associated ressources.
  61707. */
  61708. dispose(): void;
  61709. private _draw;
  61710. private _drawCameraPredicate;
  61711. private _drawCameraBackground;
  61712. private _drawCameraForeground;
  61713. private _drawRenderTargetPredicate;
  61714. private _drawRenderTargetBackground;
  61715. private _drawRenderTargetForeground;
  61716. /**
  61717. * Adds all the elements from the container to the scene
  61718. * @param container the container holding the elements
  61719. */
  61720. addFromContainer(container: AbstractScene): void;
  61721. /**
  61722. * Removes all the elements in the container from the scene
  61723. * @param container contains the elements to remove
  61724. * @param dispose if the removed element should be disposed (default: false)
  61725. */
  61726. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61727. }
  61728. }
  61729. declare module "babylonjs/Shaders/layer.fragment" {
  61730. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61731. /** @hidden */
  61732. export var layerPixelShader: {
  61733. name: string;
  61734. shader: string;
  61735. };
  61736. }
  61737. declare module "babylonjs/Shaders/layer.vertex" {
  61738. /** @hidden */
  61739. export var layerVertexShader: {
  61740. name: string;
  61741. shader: string;
  61742. };
  61743. }
  61744. declare module "babylonjs/Layers/layer" {
  61745. import { Observable } from "babylonjs/Misc/observable";
  61746. import { Nullable } from "babylonjs/types";
  61747. import { Scene } from "babylonjs/scene";
  61748. import { Vector2 } from "babylonjs/Maths/math.vector";
  61749. import { Color4 } from "babylonjs/Maths/math.color";
  61750. import { Texture } from "babylonjs/Materials/Textures/texture";
  61751. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61752. import "babylonjs/Shaders/layer.fragment";
  61753. import "babylonjs/Shaders/layer.vertex";
  61754. /**
  61755. * This represents a full screen 2d layer.
  61756. * This can be useful to display a picture in the background of your scene for instance.
  61757. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61758. */
  61759. export class Layer {
  61760. /**
  61761. * Define the name of the layer.
  61762. */
  61763. name: string;
  61764. /**
  61765. * Define the texture the layer should display.
  61766. */
  61767. texture: Nullable<Texture>;
  61768. /**
  61769. * Is the layer in background or foreground.
  61770. */
  61771. isBackground: boolean;
  61772. /**
  61773. * Define the color of the layer (instead of texture).
  61774. */
  61775. color: Color4;
  61776. /**
  61777. * Define the scale of the layer in order to zoom in out of the texture.
  61778. */
  61779. scale: Vector2;
  61780. /**
  61781. * Define an offset for the layer in order to shift the texture.
  61782. */
  61783. offset: Vector2;
  61784. /**
  61785. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61786. */
  61787. alphaBlendingMode: number;
  61788. /**
  61789. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61790. * Alpha test will not mix with the background color in case of transparency.
  61791. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61792. */
  61793. alphaTest: boolean;
  61794. /**
  61795. * Define a mask to restrict the layer to only some of the scene cameras.
  61796. */
  61797. layerMask: number;
  61798. /**
  61799. * Define the list of render target the layer is visible into.
  61800. */
  61801. renderTargetTextures: RenderTargetTexture[];
  61802. /**
  61803. * Define if the layer is only used in renderTarget or if it also
  61804. * renders in the main frame buffer of the canvas.
  61805. */
  61806. renderOnlyInRenderTargetTextures: boolean;
  61807. private _scene;
  61808. private _vertexBuffers;
  61809. private _indexBuffer;
  61810. private _effect;
  61811. private _previousDefines;
  61812. /**
  61813. * An event triggered when the layer is disposed.
  61814. */
  61815. onDisposeObservable: Observable<Layer>;
  61816. private _onDisposeObserver;
  61817. /**
  61818. * Back compatibility with callback before the onDisposeObservable existed.
  61819. * The set callback will be triggered when the layer has been disposed.
  61820. */
  61821. set onDispose(callback: () => void);
  61822. /**
  61823. * An event triggered before rendering the scene
  61824. */
  61825. onBeforeRenderObservable: Observable<Layer>;
  61826. private _onBeforeRenderObserver;
  61827. /**
  61828. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61829. * The set callback will be triggered just before rendering the layer.
  61830. */
  61831. set onBeforeRender(callback: () => void);
  61832. /**
  61833. * An event triggered after rendering the scene
  61834. */
  61835. onAfterRenderObservable: Observable<Layer>;
  61836. private _onAfterRenderObserver;
  61837. /**
  61838. * Back compatibility with callback before the onAfterRenderObservable existed.
  61839. * The set callback will be triggered just after rendering the layer.
  61840. */
  61841. set onAfterRender(callback: () => void);
  61842. /**
  61843. * Instantiates a new layer.
  61844. * This represents a full screen 2d layer.
  61845. * This can be useful to display a picture in the background of your scene for instance.
  61846. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61847. * @param name Define the name of the layer in the scene
  61848. * @param imgUrl Define the url of the texture to display in the layer
  61849. * @param scene Define the scene the layer belongs to
  61850. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61851. * @param color Defines a color for the layer
  61852. */
  61853. constructor(
  61854. /**
  61855. * Define the name of the layer.
  61856. */
  61857. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61858. private _createIndexBuffer;
  61859. /** @hidden */
  61860. _rebuild(): void;
  61861. /**
  61862. * Renders the layer in the scene.
  61863. */
  61864. render(): void;
  61865. /**
  61866. * Disposes and releases the associated ressources.
  61867. */
  61868. dispose(): void;
  61869. }
  61870. }
  61871. declare module "babylonjs/Layers/index" {
  61872. export * from "babylonjs/Layers/effectLayer";
  61873. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61874. export * from "babylonjs/Layers/glowLayer";
  61875. export * from "babylonjs/Layers/highlightLayer";
  61876. export * from "babylonjs/Layers/layer";
  61877. export * from "babylonjs/Layers/layerSceneComponent";
  61878. }
  61879. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61880. /** @hidden */
  61881. export var lensFlarePixelShader: {
  61882. name: string;
  61883. shader: string;
  61884. };
  61885. }
  61886. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61887. /** @hidden */
  61888. export var lensFlareVertexShader: {
  61889. name: string;
  61890. shader: string;
  61891. };
  61892. }
  61893. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61894. import { Scene } from "babylonjs/scene";
  61895. import { Vector3 } from "babylonjs/Maths/math.vector";
  61896. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61897. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61898. import "babylonjs/Shaders/lensFlare.fragment";
  61899. import "babylonjs/Shaders/lensFlare.vertex";
  61900. import { Viewport } from "babylonjs/Maths/math.viewport";
  61901. /**
  61902. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61903. * It is usually composed of several `lensFlare`.
  61904. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61905. */
  61906. export class LensFlareSystem {
  61907. /**
  61908. * Define the name of the lens flare system
  61909. */
  61910. name: string;
  61911. /**
  61912. * List of lens flares used in this system.
  61913. */
  61914. lensFlares: LensFlare[];
  61915. /**
  61916. * Define a limit from the border the lens flare can be visible.
  61917. */
  61918. borderLimit: number;
  61919. /**
  61920. * Define a viewport border we do not want to see the lens flare in.
  61921. */
  61922. viewportBorder: number;
  61923. /**
  61924. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61925. */
  61926. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61927. /**
  61928. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61929. */
  61930. layerMask: number;
  61931. /**
  61932. * Define the id of the lens flare system in the scene.
  61933. * (equal to name by default)
  61934. */
  61935. id: string;
  61936. private _scene;
  61937. private _emitter;
  61938. private _vertexBuffers;
  61939. private _indexBuffer;
  61940. private _effect;
  61941. private _positionX;
  61942. private _positionY;
  61943. private _isEnabled;
  61944. /** @hidden */
  61945. static _SceneComponentInitialization: (scene: Scene) => void;
  61946. /**
  61947. * Instantiates a lens flare system.
  61948. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61949. * It is usually composed of several `lensFlare`.
  61950. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61951. * @param name Define the name of the lens flare system in the scene
  61952. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61953. * @param scene Define the scene the lens flare system belongs to
  61954. */
  61955. constructor(
  61956. /**
  61957. * Define the name of the lens flare system
  61958. */
  61959. name: string, emitter: any, scene: Scene);
  61960. /**
  61961. * Define if the lens flare system is enabled.
  61962. */
  61963. get isEnabled(): boolean;
  61964. set isEnabled(value: boolean);
  61965. /**
  61966. * Get the scene the effects belongs to.
  61967. * @returns the scene holding the lens flare system
  61968. */
  61969. getScene(): Scene;
  61970. /**
  61971. * Get the emitter of the lens flare system.
  61972. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61973. * @returns the emitter of the lens flare system
  61974. */
  61975. getEmitter(): any;
  61976. /**
  61977. * Set the emitter of the lens flare system.
  61978. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61979. * @param newEmitter Define the new emitter of the system
  61980. */
  61981. setEmitter(newEmitter: any): void;
  61982. /**
  61983. * Get the lens flare system emitter position.
  61984. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61985. * @returns the position
  61986. */
  61987. getEmitterPosition(): Vector3;
  61988. /**
  61989. * @hidden
  61990. */
  61991. computeEffectivePosition(globalViewport: Viewport): boolean;
  61992. /** @hidden */
  61993. _isVisible(): boolean;
  61994. /**
  61995. * @hidden
  61996. */
  61997. render(): boolean;
  61998. /**
  61999. * Dispose and release the lens flare with its associated resources.
  62000. */
  62001. dispose(): void;
  62002. /**
  62003. * Parse a lens flare system from a JSON repressentation
  62004. * @param parsedLensFlareSystem Define the JSON to parse
  62005. * @param scene Define the scene the parsed system should be instantiated in
  62006. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  62007. * @returns the parsed system
  62008. */
  62009. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  62010. /**
  62011. * Serialize the current Lens Flare System into a JSON representation.
  62012. * @returns the serialized JSON
  62013. */
  62014. serialize(): any;
  62015. }
  62016. }
  62017. declare module "babylonjs/LensFlares/lensFlare" {
  62018. import { Nullable } from "babylonjs/types";
  62019. import { Color3 } from "babylonjs/Maths/math.color";
  62020. import { Texture } from "babylonjs/Materials/Textures/texture";
  62021. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62022. /**
  62023. * This represents one of the lens effect in a `lensFlareSystem`.
  62024. * It controls one of the indiviual texture used in the effect.
  62025. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62026. */
  62027. export class LensFlare {
  62028. /**
  62029. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62030. */
  62031. size: number;
  62032. /**
  62033. * 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.
  62034. */
  62035. position: number;
  62036. /**
  62037. * Define the lens color.
  62038. */
  62039. color: Color3;
  62040. /**
  62041. * Define the lens texture.
  62042. */
  62043. texture: Nullable<Texture>;
  62044. /**
  62045. * Define the alpha mode to render this particular lens.
  62046. */
  62047. alphaMode: number;
  62048. private _system;
  62049. /**
  62050. * Creates a new Lens Flare.
  62051. * This represents one of the lens effect in a `lensFlareSystem`.
  62052. * It controls one of the indiviual texture used in the effect.
  62053. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62054. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  62055. * @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.
  62056. * @param color Define the lens color
  62057. * @param imgUrl Define the lens texture url
  62058. * @param system Define the `lensFlareSystem` this flare is part of
  62059. * @returns The newly created Lens Flare
  62060. */
  62061. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  62062. /**
  62063. * Instantiates a new Lens Flare.
  62064. * This represents one of the lens effect in a `lensFlareSystem`.
  62065. * It controls one of the indiviual texture used in the effect.
  62066. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62067. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  62068. * @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.
  62069. * @param color Define the lens color
  62070. * @param imgUrl Define the lens texture url
  62071. * @param system Define the `lensFlareSystem` this flare is part of
  62072. */
  62073. constructor(
  62074. /**
  62075. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62076. */
  62077. size: number,
  62078. /**
  62079. * 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.
  62080. */
  62081. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62082. /**
  62083. * Dispose and release the lens flare with its associated resources.
  62084. */
  62085. dispose(): void;
  62086. }
  62087. }
  62088. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62089. import { Nullable } from "babylonjs/types";
  62090. import { Scene } from "babylonjs/scene";
  62091. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62092. import { AbstractScene } from "babylonjs/abstractScene";
  62093. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62094. module "babylonjs/abstractScene" {
  62095. interface AbstractScene {
  62096. /**
  62097. * The list of lens flare system added to the scene
  62098. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62099. */
  62100. lensFlareSystems: Array<LensFlareSystem>;
  62101. /**
  62102. * Removes the given lens flare system from this scene.
  62103. * @param toRemove The lens flare system to remove
  62104. * @returns The index of the removed lens flare system
  62105. */
  62106. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62107. /**
  62108. * Adds the given lens flare system to this scene
  62109. * @param newLensFlareSystem The lens flare system to add
  62110. */
  62111. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62112. /**
  62113. * Gets a lens flare system using its name
  62114. * @param name defines the name to look for
  62115. * @returns the lens flare system or null if not found
  62116. */
  62117. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62118. /**
  62119. * Gets a lens flare system using its id
  62120. * @param id defines the id to look for
  62121. * @returns the lens flare system or null if not found
  62122. */
  62123. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62124. }
  62125. }
  62126. /**
  62127. * Defines the lens flare scene component responsible to manage any lens flares
  62128. * in a given scene.
  62129. */
  62130. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62131. /**
  62132. * The component name helpfull to identify the component in the list of scene components.
  62133. */
  62134. readonly name: string;
  62135. /**
  62136. * The scene the component belongs to.
  62137. */
  62138. scene: Scene;
  62139. /**
  62140. * Creates a new instance of the component for the given scene
  62141. * @param scene Defines the scene to register the component in
  62142. */
  62143. constructor(scene: Scene);
  62144. /**
  62145. * Registers the component in a given scene
  62146. */
  62147. register(): void;
  62148. /**
  62149. * Rebuilds the elements related to this component in case of
  62150. * context lost for instance.
  62151. */
  62152. rebuild(): void;
  62153. /**
  62154. * Adds all the elements from the container to the scene
  62155. * @param container the container holding the elements
  62156. */
  62157. addFromContainer(container: AbstractScene): void;
  62158. /**
  62159. * Removes all the elements in the container from the scene
  62160. * @param container contains the elements to remove
  62161. * @param dispose if the removed element should be disposed (default: false)
  62162. */
  62163. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62164. /**
  62165. * Serializes the component data to the specified json object
  62166. * @param serializationObject The object to serialize to
  62167. */
  62168. serialize(serializationObject: any): void;
  62169. /**
  62170. * Disposes the component and the associated ressources.
  62171. */
  62172. dispose(): void;
  62173. private _draw;
  62174. }
  62175. }
  62176. declare module "babylonjs/LensFlares/index" {
  62177. export * from "babylonjs/LensFlares/lensFlare";
  62178. export * from "babylonjs/LensFlares/lensFlareSystem";
  62179. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62180. }
  62181. declare module "babylonjs/Shaders/depth.fragment" {
  62182. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62183. /** @hidden */
  62184. export var depthPixelShader: {
  62185. name: string;
  62186. shader: string;
  62187. };
  62188. }
  62189. declare module "babylonjs/Shaders/depth.vertex" {
  62190. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62191. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62192. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62193. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62194. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62195. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62196. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62197. /** @hidden */
  62198. export var depthVertexShader: {
  62199. name: string;
  62200. shader: string;
  62201. };
  62202. }
  62203. declare module "babylonjs/Rendering/depthRenderer" {
  62204. import { Nullable } from "babylonjs/types";
  62205. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62206. import { Scene } from "babylonjs/scene";
  62207. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62208. import { Camera } from "babylonjs/Cameras/camera";
  62209. import "babylonjs/Shaders/depth.fragment";
  62210. import "babylonjs/Shaders/depth.vertex";
  62211. /**
  62212. * This represents a depth renderer in Babylon.
  62213. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62214. */
  62215. export class DepthRenderer {
  62216. private _scene;
  62217. private _depthMap;
  62218. private _effect;
  62219. private readonly _storeNonLinearDepth;
  62220. private readonly _clearColor;
  62221. /** Get if the depth renderer is using packed depth or not */
  62222. readonly isPacked: boolean;
  62223. private _cachedDefines;
  62224. private _camera;
  62225. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62226. enabled: boolean;
  62227. /**
  62228. * Specifiess that the depth renderer will only be used within
  62229. * the camera it is created for.
  62230. * This can help forcing its rendering during the camera processing.
  62231. */
  62232. useOnlyInActiveCamera: boolean;
  62233. /** @hidden */
  62234. static _SceneComponentInitialization: (scene: Scene) => void;
  62235. /**
  62236. * Instantiates a depth renderer
  62237. * @param scene The scene the renderer belongs to
  62238. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62239. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62240. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62241. */
  62242. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62243. /**
  62244. * Creates the depth rendering effect and checks if the effect is ready.
  62245. * @param subMesh The submesh to be used to render the depth map of
  62246. * @param useInstances If multiple world instances should be used
  62247. * @returns if the depth renderer is ready to render the depth map
  62248. */
  62249. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62250. /**
  62251. * Gets the texture which the depth map will be written to.
  62252. * @returns The depth map texture
  62253. */
  62254. getDepthMap(): RenderTargetTexture;
  62255. /**
  62256. * Disposes of the depth renderer.
  62257. */
  62258. dispose(): void;
  62259. }
  62260. }
  62261. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62262. /** @hidden */
  62263. export var minmaxReduxPixelShader: {
  62264. name: string;
  62265. shader: string;
  62266. };
  62267. }
  62268. declare module "babylonjs/Misc/minMaxReducer" {
  62269. import { Nullable } from "babylonjs/types";
  62270. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62271. import { Camera } from "babylonjs/Cameras/camera";
  62272. import { Observer } from "babylonjs/Misc/observable";
  62273. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62274. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62275. import { Observable } from "babylonjs/Misc/observable";
  62276. import "babylonjs/Shaders/minmaxRedux.fragment";
  62277. /**
  62278. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62279. * and maximum values from all values of the texture.
  62280. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62281. * The source values are read from the red channel of the texture.
  62282. */
  62283. export class MinMaxReducer {
  62284. /**
  62285. * Observable triggered when the computation has been performed
  62286. */
  62287. onAfterReductionPerformed: Observable<{
  62288. min: number;
  62289. max: number;
  62290. }>;
  62291. protected _camera: Camera;
  62292. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62293. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62294. protected _postProcessManager: PostProcessManager;
  62295. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62296. protected _forceFullscreenViewport: boolean;
  62297. /**
  62298. * Creates a min/max reducer
  62299. * @param camera The camera to use for the post processes
  62300. */
  62301. constructor(camera: Camera);
  62302. /**
  62303. * Gets the texture used to read the values from.
  62304. */
  62305. get sourceTexture(): Nullable<RenderTargetTexture>;
  62306. /**
  62307. * Sets the source texture to read the values from.
  62308. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62309. * because in such textures '1' value must not be taken into account to compute the maximum
  62310. * as this value is used to clear the texture.
  62311. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62312. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62313. * @param depthRedux Indicates if the texture is a depth texture or not
  62314. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62315. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62316. */
  62317. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62318. /**
  62319. * Defines the refresh rate of the computation.
  62320. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62321. */
  62322. get refreshRate(): number;
  62323. set refreshRate(value: number);
  62324. protected _activated: boolean;
  62325. /**
  62326. * Gets the activation status of the reducer
  62327. */
  62328. get activated(): boolean;
  62329. /**
  62330. * Activates the reduction computation.
  62331. * When activated, the observers registered in onAfterReductionPerformed are
  62332. * called after the compuation is performed
  62333. */
  62334. activate(): void;
  62335. /**
  62336. * Deactivates the reduction computation.
  62337. */
  62338. deactivate(): void;
  62339. /**
  62340. * Disposes the min/max reducer
  62341. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  62342. */
  62343. dispose(disposeAll?: boolean): void;
  62344. }
  62345. }
  62346. declare module "babylonjs/Misc/depthReducer" {
  62347. import { Nullable } from "babylonjs/types";
  62348. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62349. import { Camera } from "babylonjs/Cameras/camera";
  62350. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62351. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62352. /**
  62353. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62354. */
  62355. export class DepthReducer extends MinMaxReducer {
  62356. private _depthRenderer;
  62357. private _depthRendererId;
  62358. /**
  62359. * Gets the depth renderer used for the computation.
  62360. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62361. */
  62362. get depthRenderer(): Nullable<DepthRenderer>;
  62363. /**
  62364. * Creates a depth reducer
  62365. * @param camera The camera used to render the depth texture
  62366. */
  62367. constructor(camera: Camera);
  62368. /**
  62369. * Sets the depth renderer to use to generate the depth map
  62370. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62371. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62372. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62373. */
  62374. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62375. /** @hidden */
  62376. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62377. /**
  62378. * Activates the reduction computation.
  62379. * When activated, the observers registered in onAfterReductionPerformed are
  62380. * called after the compuation is performed
  62381. */
  62382. activate(): void;
  62383. /**
  62384. * Deactivates the reduction computation.
  62385. */
  62386. deactivate(): void;
  62387. /**
  62388. * Disposes the depth reducer
  62389. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  62390. */
  62391. dispose(disposeAll?: boolean): void;
  62392. }
  62393. }
  62394. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62395. import { Nullable } from "babylonjs/types";
  62396. import { Scene } from "babylonjs/scene";
  62397. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62398. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62400. import { Effect } from "babylonjs/Materials/effect";
  62401. import "babylonjs/Shaders/shadowMap.fragment";
  62402. import "babylonjs/Shaders/shadowMap.vertex";
  62403. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62404. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62405. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62406. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62407. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62408. /**
  62409. * A CSM implementation allowing casting shadows on large scenes.
  62410. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62411. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62412. */
  62413. export class CascadedShadowGenerator extends ShadowGenerator {
  62414. private static readonly frustumCornersNDCSpace;
  62415. /**
  62416. * Name of the CSM class
  62417. */
  62418. static CLASSNAME: string;
  62419. /**
  62420. * Defines the default number of cascades used by the CSM.
  62421. */
  62422. static readonly DEFAULT_CASCADES_COUNT: number;
  62423. /**
  62424. * Defines the minimum number of cascades used by the CSM.
  62425. */
  62426. static readonly MIN_CASCADES_COUNT: number;
  62427. /**
  62428. * Defines the maximum number of cascades used by the CSM.
  62429. */
  62430. static readonly MAX_CASCADES_COUNT: number;
  62431. protected _validateFilter(filter: number): number;
  62432. /**
  62433. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62434. */
  62435. penumbraDarkness: number;
  62436. private _numCascades;
  62437. /**
  62438. * Gets or set the number of cascades used by the CSM.
  62439. */
  62440. get numCascades(): number;
  62441. set numCascades(value: number);
  62442. /**
  62443. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62444. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62445. */
  62446. stabilizeCascades: boolean;
  62447. private _freezeShadowCastersBoundingInfo;
  62448. private _freezeShadowCastersBoundingInfoObservable;
  62449. /**
  62450. * Enables or disables the shadow casters bounding info computation.
  62451. * If your shadow casters don't move, you can disable this feature.
  62452. * If it is enabled, the bounding box computation is done every frame.
  62453. */
  62454. get freezeShadowCastersBoundingInfo(): boolean;
  62455. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62456. private _scbiMin;
  62457. private _scbiMax;
  62458. protected _computeShadowCastersBoundingInfo(): void;
  62459. protected _shadowCastersBoundingInfo: BoundingInfo;
  62460. /**
  62461. * Gets or sets the shadow casters bounding info.
  62462. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62463. * so that the system won't overwrite the bounds you provide
  62464. */
  62465. get shadowCastersBoundingInfo(): BoundingInfo;
  62466. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62467. protected _breaksAreDirty: boolean;
  62468. protected _minDistance: number;
  62469. protected _maxDistance: number;
  62470. /**
  62471. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62472. *
  62473. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62474. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62475. * @param min minimal distance for the breaks (default to 0.)
  62476. * @param max maximal distance for the breaks (default to 1.)
  62477. */
  62478. setMinMaxDistance(min: number, max: number): void;
  62479. /** Gets the minimal distance used in the cascade break computation */
  62480. get minDistance(): number;
  62481. /** Gets the maximal distance used in the cascade break computation */
  62482. get maxDistance(): number;
  62483. /**
  62484. * Gets the class name of that object
  62485. * @returns "CascadedShadowGenerator"
  62486. */
  62487. getClassName(): string;
  62488. private _cascadeMinExtents;
  62489. private _cascadeMaxExtents;
  62490. /**
  62491. * Gets a cascade minimum extents
  62492. * @param cascadeIndex index of the cascade
  62493. * @returns the minimum cascade extents
  62494. */
  62495. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62496. /**
  62497. * Gets a cascade maximum extents
  62498. * @param cascadeIndex index of the cascade
  62499. * @returns the maximum cascade extents
  62500. */
  62501. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62502. private _cascades;
  62503. private _currentLayer;
  62504. private _viewSpaceFrustumsZ;
  62505. private _viewMatrices;
  62506. private _projectionMatrices;
  62507. private _transformMatrices;
  62508. private _transformMatricesAsArray;
  62509. private _frustumLengths;
  62510. private _lightSizeUVCorrection;
  62511. private _depthCorrection;
  62512. private _frustumCornersWorldSpace;
  62513. private _frustumCenter;
  62514. private _shadowCameraPos;
  62515. private _shadowMaxZ;
  62516. /**
  62517. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62518. * It defaults to camera.maxZ
  62519. */
  62520. get shadowMaxZ(): number;
  62521. /**
  62522. * Sets the shadow max z distance.
  62523. */
  62524. set shadowMaxZ(value: number);
  62525. protected _debug: boolean;
  62526. /**
  62527. * Gets or sets the debug flag.
  62528. * When enabled, the cascades are materialized by different colors on the screen.
  62529. */
  62530. get debug(): boolean;
  62531. set debug(dbg: boolean);
  62532. private _depthClamp;
  62533. /**
  62534. * Gets or sets the depth clamping value.
  62535. *
  62536. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62537. * to account for the shadow casters far away.
  62538. *
  62539. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62540. */
  62541. get depthClamp(): boolean;
  62542. set depthClamp(value: boolean);
  62543. private _cascadeBlendPercentage;
  62544. /**
  62545. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62546. * It defaults to 0.1 (10% blending).
  62547. */
  62548. get cascadeBlendPercentage(): number;
  62549. set cascadeBlendPercentage(value: number);
  62550. private _lambda;
  62551. /**
  62552. * Gets or set the lambda parameter.
  62553. * This parameter is used to split the camera frustum and create the cascades.
  62554. * It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split.
  62555. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62556. */
  62557. get lambda(): number;
  62558. set lambda(value: number);
  62559. /**
  62560. * Gets the view matrix corresponding to a given cascade
  62561. * @param cascadeNum cascade to retrieve the view matrix from
  62562. * @returns the cascade view matrix
  62563. */
  62564. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62565. /**
  62566. * Gets the projection matrix corresponding to a given cascade
  62567. * @param cascadeNum cascade to retrieve the projection matrix from
  62568. * @returns the cascade projection matrix
  62569. */
  62570. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62571. /**
  62572. * Gets the transformation matrix corresponding to a given cascade
  62573. * @param cascadeNum cascade to retrieve the transformation matrix from
  62574. * @returns the cascade transformation matrix
  62575. */
  62576. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62577. private _depthRenderer;
  62578. /**
  62579. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62580. *
  62581. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62582. *
  62583. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62584. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62585. * @param depthRenderer The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created
  62586. */
  62587. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62588. private _depthReducer;
  62589. private _autoCalcDepthBounds;
  62590. /**
  62591. * Gets or sets the autoCalcDepthBounds property.
  62592. *
  62593. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62594. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62595. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62596. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62597. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62598. */
  62599. get autoCalcDepthBounds(): boolean;
  62600. set autoCalcDepthBounds(value: boolean);
  62601. /**
  62602. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62603. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62604. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62605. * for setting the refresh rate on the renderer yourself!
  62606. */
  62607. get autoCalcDepthBoundsRefreshRate(): number;
  62608. set autoCalcDepthBoundsRefreshRate(value: number);
  62609. /**
  62610. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62611. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62612. * you change the camera near/far planes!
  62613. */
  62614. splitFrustum(): void;
  62615. private _splitFrustum;
  62616. private _computeMatrices;
  62617. private _computeFrustumInWorldSpace;
  62618. private _computeCascadeFrustum;
  62619. /**
  62620. * Support test.
  62621. */
  62622. static get IsSupported(): boolean;
  62623. /** @hidden */
  62624. static _SceneComponentInitialization: (scene: Scene) => void;
  62625. /**
  62626. * Creates a Cascaded Shadow Generator object.
  62627. * A ShadowGenerator is the required tool to use the shadows.
  62628. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62629. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62630. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62631. * @param light The directional light object generating the shadows.
  62632. * @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.
  62633. */
  62634. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62635. protected _initializeGenerator(): void;
  62636. protected _createTargetRenderTexture(): void;
  62637. protected _initializeShadowMap(): void;
  62638. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62639. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62640. /**
  62641. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62642. * @param defines Defines of the material we want to update
  62643. * @param lightIndex Index of the light in the enabled light list of the material
  62644. */
  62645. prepareDefines(defines: any, lightIndex: number): void;
  62646. /**
  62647. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62648. * defined in the generator but impacting the effect).
  62649. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62650. * @param effect The effect we are binfing the information for
  62651. */
  62652. bindShadowLight(lightIndex: string, effect: Effect): void;
  62653. /**
  62654. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62655. * (eq to view projection * shadow projection matrices)
  62656. * @returns The transform matrix used to create the shadow map
  62657. */
  62658. getTransformMatrix(): Matrix;
  62659. /**
  62660. * Disposes the ShadowGenerator.
  62661. * Returns nothing.
  62662. */
  62663. dispose(): void;
  62664. /**
  62665. * Serializes the shadow generator setup to a json object.
  62666. * @returns The serialized JSON object
  62667. */
  62668. serialize(): any;
  62669. /**
  62670. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62671. * @param parsedShadowGenerator The JSON object to parse
  62672. * @param scene The scene to create the shadow map for
  62673. * @returns The parsed shadow generator
  62674. */
  62675. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62676. }
  62677. }
  62678. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62679. import { Scene } from "babylonjs/scene";
  62680. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62681. import { AbstractScene } from "babylonjs/abstractScene";
  62682. /**
  62683. * Defines the shadow generator component responsible to manage any shadow generators
  62684. * in a given scene.
  62685. */
  62686. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62687. /**
  62688. * The component name helpfull to identify the component in the list of scene components.
  62689. */
  62690. readonly name: string;
  62691. /**
  62692. * The scene the component belongs to.
  62693. */
  62694. scene: Scene;
  62695. /**
  62696. * Creates a new instance of the component for the given scene
  62697. * @param scene Defines the scene to register the component in
  62698. */
  62699. constructor(scene: Scene);
  62700. /**
  62701. * Registers the component in a given scene
  62702. */
  62703. register(): void;
  62704. /**
  62705. * Rebuilds the elements related to this component in case of
  62706. * context lost for instance.
  62707. */
  62708. rebuild(): void;
  62709. /**
  62710. * Serializes the component data to the specified json object
  62711. * @param serializationObject The object to serialize to
  62712. */
  62713. serialize(serializationObject: any): void;
  62714. /**
  62715. * Adds all the elements from the container to the scene
  62716. * @param container the container holding the elements
  62717. */
  62718. addFromContainer(container: AbstractScene): void;
  62719. /**
  62720. * Removes all the elements in the container from the scene
  62721. * @param container contains the elements to remove
  62722. * @param dispose if the removed element should be disposed (default: false)
  62723. */
  62724. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62725. /**
  62726. * Rebuilds the elements related to this component in case of
  62727. * context lost for instance.
  62728. */
  62729. dispose(): void;
  62730. private _gatherRenderTargets;
  62731. }
  62732. }
  62733. declare module "babylonjs/Lights/Shadows/index" {
  62734. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62735. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62736. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62737. }
  62738. declare module "babylonjs/Lights/pointLight" {
  62739. import { Scene } from "babylonjs/scene";
  62740. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62742. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62743. import { Effect } from "babylonjs/Materials/effect";
  62744. /**
  62745. * A point light is a light defined by an unique point in world space.
  62746. * The light is emitted in every direction from this point.
  62747. * A good example of a point light is a standard light bulb.
  62748. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62749. */
  62750. export class PointLight extends ShadowLight {
  62751. private _shadowAngle;
  62752. /**
  62753. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62754. * This specifies what angle the shadow will use to be created.
  62755. *
  62756. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62757. */
  62758. get shadowAngle(): number;
  62759. /**
  62760. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62761. * This specifies what angle the shadow will use to be created.
  62762. *
  62763. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62764. */
  62765. set shadowAngle(value: number);
  62766. /**
  62767. * Gets the direction if it has been set.
  62768. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62769. */
  62770. get direction(): Vector3;
  62771. /**
  62772. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62773. */
  62774. set direction(value: Vector3);
  62775. /**
  62776. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62777. * A PointLight emits the light in every direction.
  62778. * It can cast shadows.
  62779. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62780. * ```javascript
  62781. * var pointLight = new PointLight("pl", camera.position, scene);
  62782. * ```
  62783. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62784. * @param name The light friendly name
  62785. * @param position The position of the point light in the scene
  62786. * @param scene The scene the lights belongs to
  62787. */
  62788. constructor(name: string, position: Vector3, scene: Scene);
  62789. /**
  62790. * Returns the string "PointLight"
  62791. * @returns the class name
  62792. */
  62793. getClassName(): string;
  62794. /**
  62795. * Returns the integer 0.
  62796. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62797. */
  62798. getTypeID(): number;
  62799. /**
  62800. * Specifies wether or not the shadowmap should be a cube texture.
  62801. * @returns true if the shadowmap needs to be a cube texture.
  62802. */
  62803. needCube(): boolean;
  62804. /**
  62805. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62806. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62807. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62808. */
  62809. getShadowDirection(faceIndex?: number): Vector3;
  62810. /**
  62811. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62812. * - fov = PI / 2
  62813. * - aspect ratio : 1.0
  62814. * - z-near and far equal to the active camera minZ and maxZ.
  62815. * Returns the PointLight.
  62816. */
  62817. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62818. protected _buildUniformLayout(): void;
  62819. /**
  62820. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62821. * @param effect The effect to update
  62822. * @param lightIndex The index of the light in the effect to update
  62823. * @returns The point light
  62824. */
  62825. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62826. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62827. /**
  62828. * Prepares the list of defines specific to the light type.
  62829. * @param defines the list of defines
  62830. * @param lightIndex defines the index of the light for the effect
  62831. */
  62832. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62833. }
  62834. }
  62835. declare module "babylonjs/Lights/index" {
  62836. export * from "babylonjs/Lights/light";
  62837. export * from "babylonjs/Lights/shadowLight";
  62838. export * from "babylonjs/Lights/Shadows/index";
  62839. export * from "babylonjs/Lights/directionalLight";
  62840. export * from "babylonjs/Lights/hemisphericLight";
  62841. export * from "babylonjs/Lights/pointLight";
  62842. export * from "babylonjs/Lights/spotLight";
  62843. }
  62844. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62845. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62846. /**
  62847. * Header information of HDR texture files.
  62848. */
  62849. export interface HDRInfo {
  62850. /**
  62851. * The height of the texture in pixels.
  62852. */
  62853. height: number;
  62854. /**
  62855. * The width of the texture in pixels.
  62856. */
  62857. width: number;
  62858. /**
  62859. * The index of the beginning of the data in the binary file.
  62860. */
  62861. dataPosition: number;
  62862. }
  62863. /**
  62864. * This groups tools to convert HDR texture to native colors array.
  62865. */
  62866. export class HDRTools {
  62867. private static Ldexp;
  62868. private static Rgbe2float;
  62869. private static readStringLine;
  62870. /**
  62871. * Reads header information from an RGBE texture stored in a native array.
  62872. * More information on this format are available here:
  62873. * https://en.wikipedia.org/wiki/RGBE_image_format
  62874. *
  62875. * @param uint8array The binary file stored in native array.
  62876. * @return The header information.
  62877. */
  62878. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62879. /**
  62880. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62881. * This RGBE texture needs to store the information as a panorama.
  62882. *
  62883. * More information on this format are available here:
  62884. * https://en.wikipedia.org/wiki/RGBE_image_format
  62885. *
  62886. * @param buffer The binary file stored in an array buffer.
  62887. * @param size The expected size of the extracted cubemap.
  62888. * @return The Cube Map information.
  62889. */
  62890. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62891. /**
  62892. * Returns the pixels data extracted from an RGBE texture.
  62893. * This pixels will be stored left to right up to down in the R G B order in one array.
  62894. *
  62895. * More information on this format are available here:
  62896. * https://en.wikipedia.org/wiki/RGBE_image_format
  62897. *
  62898. * @param uint8array The binary file stored in an array buffer.
  62899. * @param hdrInfo The header information of the file.
  62900. * @return The pixels data in RGB right to left up to down order.
  62901. */
  62902. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62903. private static RGBE_ReadPixels_RLE;
  62904. private static RGBE_ReadPixels_NOT_RLE;
  62905. }
  62906. }
  62907. declare module "babylonjs/Materials/effectRenderer" {
  62908. import { Nullable } from "babylonjs/types";
  62909. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62910. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62911. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62912. import { Viewport } from "babylonjs/Maths/math.viewport";
  62913. import { Observable } from "babylonjs/Misc/observable";
  62914. import { Effect } from "babylonjs/Materials/effect";
  62915. import "babylonjs/Shaders/postprocess.vertex";
  62916. /**
  62917. * Effect Render Options
  62918. */
  62919. export interface IEffectRendererOptions {
  62920. /**
  62921. * Defines the vertices positions.
  62922. */
  62923. positions?: number[];
  62924. /**
  62925. * Defines the indices.
  62926. */
  62927. indices?: number[];
  62928. }
  62929. /**
  62930. * Helper class to render one or more effects.
  62931. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62932. */
  62933. export class EffectRenderer {
  62934. private engine;
  62935. private static _DefaultOptions;
  62936. private _vertexBuffers;
  62937. private _indexBuffer;
  62938. private _fullscreenViewport;
  62939. /**
  62940. * Creates an effect renderer
  62941. * @param engine the engine to use for rendering
  62942. * @param options defines the options of the effect renderer
  62943. */
  62944. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62945. /**
  62946. * Sets the current viewport in normalized coordinates 0-1
  62947. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62948. */
  62949. setViewport(viewport?: Viewport): void;
  62950. /**
  62951. * Binds the embedded attributes buffer to the effect.
  62952. * @param effect Defines the effect to bind the attributes for
  62953. */
  62954. bindBuffers(effect: Effect): void;
  62955. /**
  62956. * Sets the current effect wrapper to use during draw.
  62957. * The effect needs to be ready before calling this api.
  62958. * This also sets the default full screen position attribute.
  62959. * @param effectWrapper Defines the effect to draw with
  62960. */
  62961. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62962. /**
  62963. * Restores engine states
  62964. */
  62965. restoreStates(): void;
  62966. /**
  62967. * Draws a full screen quad.
  62968. */
  62969. draw(): void;
  62970. private isRenderTargetTexture;
  62971. /**
  62972. * renders one or more effects to a specified texture
  62973. * @param effectWrapper the effect to renderer
  62974. * @param outputTexture texture to draw to, if null it will render to the screen.
  62975. */
  62976. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62977. /**
  62978. * Disposes of the effect renderer
  62979. */
  62980. dispose(): void;
  62981. }
  62982. /**
  62983. * Options to create an EffectWrapper
  62984. */
  62985. interface EffectWrapperCreationOptions {
  62986. /**
  62987. * Engine to use to create the effect
  62988. */
  62989. engine: ThinEngine;
  62990. /**
  62991. * Fragment shader for the effect
  62992. */
  62993. fragmentShader: string;
  62994. /**
  62995. * Use the shader store instead of direct source code
  62996. */
  62997. useShaderStore?: boolean;
  62998. /**
  62999. * Vertex shader for the effect
  63000. */
  63001. vertexShader?: string;
  63002. /**
  63003. * Attributes to use in the shader
  63004. */
  63005. attributeNames?: Array<string>;
  63006. /**
  63007. * Uniforms to use in the shader
  63008. */
  63009. uniformNames?: Array<string>;
  63010. /**
  63011. * Texture sampler names to use in the shader
  63012. */
  63013. samplerNames?: Array<string>;
  63014. /**
  63015. * Defines to use in the shader
  63016. */
  63017. defines?: Array<string>;
  63018. /**
  63019. * Callback when effect is compiled
  63020. */
  63021. onCompiled?: Nullable<(effect: Effect) => void>;
  63022. /**
  63023. * The friendly name of the effect displayed in Spector.
  63024. */
  63025. name?: string;
  63026. }
  63027. /**
  63028. * Wraps an effect to be used for rendering
  63029. */
  63030. export class EffectWrapper {
  63031. /**
  63032. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  63033. */
  63034. onApplyObservable: Observable<{}>;
  63035. /**
  63036. * The underlying effect
  63037. */
  63038. effect: Effect;
  63039. /**
  63040. * Creates an effect to be renderer
  63041. * @param creationOptions options to create the effect
  63042. */
  63043. constructor(creationOptions: EffectWrapperCreationOptions);
  63044. /**
  63045. * Disposes of the effect wrapper
  63046. */
  63047. dispose(): void;
  63048. }
  63049. }
  63050. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  63051. /** @hidden */
  63052. export var hdrFilteringVertexShader: {
  63053. name: string;
  63054. shader: string;
  63055. };
  63056. }
  63057. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  63058. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63059. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  63060. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  63061. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  63062. /** @hidden */
  63063. export var hdrFilteringPixelShader: {
  63064. name: string;
  63065. shader: string;
  63066. };
  63067. }
  63068. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  63069. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63070. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63071. import { Nullable } from "babylonjs/types";
  63072. import "babylonjs/Shaders/hdrFiltering.vertex";
  63073. import "babylonjs/Shaders/hdrFiltering.fragment";
  63074. /**
  63075. * Options for texture filtering
  63076. */
  63077. interface IHDRFilteringOptions {
  63078. /**
  63079. * Scales pixel intensity for the input HDR map.
  63080. */
  63081. hdrScale?: number;
  63082. /**
  63083. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63084. */
  63085. quality?: number;
  63086. }
  63087. /**
  63088. * Filters HDR maps to get correct renderings of PBR reflections
  63089. */
  63090. export class HDRFiltering {
  63091. private _engine;
  63092. private _effectRenderer;
  63093. private _effectWrapper;
  63094. private _lodGenerationOffset;
  63095. private _lodGenerationScale;
  63096. /**
  63097. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63098. * you care about baking speed.
  63099. */
  63100. quality: number;
  63101. /**
  63102. * Scales pixel intensity for the input HDR map.
  63103. */
  63104. hdrScale: number;
  63105. /**
  63106. * Instantiates HDR filter for reflection maps
  63107. *
  63108. * @param engine Thin engine
  63109. * @param options Options
  63110. */
  63111. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63112. private _createRenderTarget;
  63113. private _prefilterInternal;
  63114. private _createEffect;
  63115. /**
  63116. * Get a value indicating if the filter is ready to be used
  63117. * @param texture Texture to filter
  63118. * @returns true if the filter is ready
  63119. */
  63120. isReady(texture: BaseTexture): boolean;
  63121. /**
  63122. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63123. * Prefiltering will be invoked at the end of next rendering pass.
  63124. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63125. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63126. * @param texture Texture to filter
  63127. * @param onFinished Callback when filtering is done
  63128. * @return Promise called when prefiltering is done
  63129. */
  63130. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63131. }
  63132. }
  63133. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63134. import { Nullable } from "babylonjs/types";
  63135. import { Scene } from "babylonjs/scene";
  63136. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63137. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63138. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63139. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63140. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63141. /**
  63142. * This represents a texture coming from an HDR input.
  63143. *
  63144. * The only supported format is currently panorama picture stored in RGBE format.
  63145. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63146. */
  63147. export class HDRCubeTexture extends BaseTexture {
  63148. private static _facesMapping;
  63149. private _generateHarmonics;
  63150. private _noMipmap;
  63151. private _prefilterOnLoad;
  63152. private _textureMatrix;
  63153. private _size;
  63154. private _onLoad;
  63155. private _onError;
  63156. /**
  63157. * The texture URL.
  63158. */
  63159. url: string;
  63160. protected _isBlocking: boolean;
  63161. /**
  63162. * Sets wether or not the texture is blocking during loading.
  63163. */
  63164. set isBlocking(value: boolean);
  63165. /**
  63166. * Gets wether or not the texture is blocking during loading.
  63167. */
  63168. get isBlocking(): boolean;
  63169. protected _rotationY: number;
  63170. /**
  63171. * Sets texture matrix rotation angle around Y axis in radians.
  63172. */
  63173. set rotationY(value: number);
  63174. /**
  63175. * Gets texture matrix rotation angle around Y axis radians.
  63176. */
  63177. get rotationY(): number;
  63178. /**
  63179. * Gets or sets the center of the bounding box associated with the cube texture
  63180. * It must define where the camera used to render the texture was set
  63181. */
  63182. boundingBoxPosition: Vector3;
  63183. private _boundingBoxSize;
  63184. /**
  63185. * Gets or sets the size of the bounding box associated with the cube texture
  63186. * When defined, the cubemap will switch to local mode
  63187. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63188. * @example https://www.babylonjs-playground.com/#RNASML
  63189. */
  63190. set boundingBoxSize(value: Vector3);
  63191. get boundingBoxSize(): Vector3;
  63192. /**
  63193. * Instantiates an HDRTexture from the following parameters.
  63194. *
  63195. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63196. * @param sceneOrEngine The scene or engine the texture will be used in
  63197. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63198. * @param noMipmap Forces to not generate the mipmap if true
  63199. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63200. * @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)
  63201. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63202. */
  63203. constructor(url: string, sceneOrEngine: Scene | ThinEngine, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, prefilterOnLoad?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  63204. /**
  63205. * Get the current class name of the texture useful for serialization or dynamic coding.
  63206. * @returns "HDRCubeTexture"
  63207. */
  63208. getClassName(): string;
  63209. /**
  63210. * Occurs when the file is raw .hdr file.
  63211. */
  63212. private loadTexture;
  63213. clone(): HDRCubeTexture;
  63214. delayLoad(): void;
  63215. /**
  63216. * Get the texture reflection matrix used to rotate/transform the reflection.
  63217. * @returns the reflection matrix
  63218. */
  63219. getReflectionTextureMatrix(): Matrix;
  63220. /**
  63221. * Set the texture reflection matrix used to rotate/transform the reflection.
  63222. * @param value Define the reflection matrix to set
  63223. */
  63224. setReflectionTextureMatrix(value: Matrix): void;
  63225. /**
  63226. * Parses a JSON representation of an HDR Texture in order to create the texture
  63227. * @param parsedTexture Define the JSON representation
  63228. * @param scene Define the scene the texture should be created in
  63229. * @param rootUrl Define the root url in case we need to load relative dependencies
  63230. * @returns the newly created texture after parsing
  63231. */
  63232. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63233. serialize(): any;
  63234. }
  63235. }
  63236. declare module "babylonjs/Physics/physicsEngine" {
  63237. import { Nullable } from "babylonjs/types";
  63238. import { Vector3 } from "babylonjs/Maths/math.vector";
  63239. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63240. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63241. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63242. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63243. /**
  63244. * Class used to control physics engine
  63245. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63246. */
  63247. export class PhysicsEngine implements IPhysicsEngine {
  63248. private _physicsPlugin;
  63249. /**
  63250. * Global value used to control the smallest number supported by the simulation
  63251. */
  63252. static Epsilon: number;
  63253. private _impostors;
  63254. private _joints;
  63255. private _subTimeStep;
  63256. /**
  63257. * Gets the gravity vector used by the simulation
  63258. */
  63259. gravity: Vector3;
  63260. /**
  63261. * Factory used to create the default physics plugin.
  63262. * @returns The default physics plugin
  63263. */
  63264. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63265. /**
  63266. * Creates a new Physics Engine
  63267. * @param gravity defines the gravity vector used by the simulation
  63268. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63269. */
  63270. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63271. /**
  63272. * Sets the gravity vector used by the simulation
  63273. * @param gravity defines the gravity vector to use
  63274. */
  63275. setGravity(gravity: Vector3): void;
  63276. /**
  63277. * Set the time step of the physics engine.
  63278. * Default is 1/60.
  63279. * To slow it down, enter 1/600 for example.
  63280. * To speed it up, 1/30
  63281. * @param newTimeStep defines the new timestep to apply to this world.
  63282. */
  63283. setTimeStep(newTimeStep?: number): void;
  63284. /**
  63285. * Get the time step of the physics engine.
  63286. * @returns the current time step
  63287. */
  63288. getTimeStep(): number;
  63289. /**
  63290. * Set the sub time step of the physics engine.
  63291. * Default is 0 meaning there is no sub steps
  63292. * To increase physics resolution precision, set a small value (like 1 ms)
  63293. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63294. */
  63295. setSubTimeStep(subTimeStep?: number): void;
  63296. /**
  63297. * Get the sub time step of the physics engine.
  63298. * @returns the current sub time step
  63299. */
  63300. getSubTimeStep(): number;
  63301. /**
  63302. * Release all resources
  63303. */
  63304. dispose(): void;
  63305. /**
  63306. * Gets the name of the current physics plugin
  63307. * @returns the name of the plugin
  63308. */
  63309. getPhysicsPluginName(): string;
  63310. /**
  63311. * Adding a new impostor for the impostor tracking.
  63312. * This will be done by the impostor itself.
  63313. * @param impostor the impostor to add
  63314. */
  63315. addImpostor(impostor: PhysicsImpostor): void;
  63316. /**
  63317. * Remove an impostor from the engine.
  63318. * This impostor and its mesh will not longer be updated by the physics engine.
  63319. * @param impostor the impostor to remove
  63320. */
  63321. removeImpostor(impostor: PhysicsImpostor): void;
  63322. /**
  63323. * Add a joint to the physics engine
  63324. * @param mainImpostor defines the main impostor to which the joint is added.
  63325. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63326. * @param joint defines the joint that will connect both impostors.
  63327. */
  63328. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63329. /**
  63330. * Removes a joint from the simulation
  63331. * @param mainImpostor defines the impostor used with the joint
  63332. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63333. * @param joint defines the joint to remove
  63334. */
  63335. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63336. /**
  63337. * Called by the scene. No need to call it.
  63338. * @param delta defines the timespam between frames
  63339. */
  63340. _step(delta: number): void;
  63341. /**
  63342. * Gets the current plugin used to run the simulation
  63343. * @returns current plugin
  63344. */
  63345. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63346. /**
  63347. * Gets the list of physic impostors
  63348. * @returns an array of PhysicsImpostor
  63349. */
  63350. getImpostors(): Array<PhysicsImpostor>;
  63351. /**
  63352. * Gets the impostor for a physics enabled object
  63353. * @param object defines the object impersonated by the impostor
  63354. * @returns the PhysicsImpostor or null if not found
  63355. */
  63356. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63357. /**
  63358. * Gets the impostor for a physics body object
  63359. * @param body defines physics body used by the impostor
  63360. * @returns the PhysicsImpostor or null if not found
  63361. */
  63362. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63363. /**
  63364. * Does a raycast in the physics world
  63365. * @param from when should the ray start?
  63366. * @param to when should the ray end?
  63367. * @returns PhysicsRaycastResult
  63368. */
  63369. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63370. }
  63371. }
  63372. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63373. import { Nullable } from "babylonjs/types";
  63374. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63375. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63376. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63377. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63378. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63379. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63380. /** @hidden */
  63381. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63382. private _useDeltaForWorldStep;
  63383. world: any;
  63384. name: string;
  63385. private _physicsMaterials;
  63386. private _fixedTimeStep;
  63387. private _cannonRaycastResult;
  63388. private _raycastResult;
  63389. private _physicsBodysToRemoveAfterStep;
  63390. private _firstFrame;
  63391. BJSCANNON: any;
  63392. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63393. setGravity(gravity: Vector3): void;
  63394. setTimeStep(timeStep: number): void;
  63395. getTimeStep(): number;
  63396. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63397. private _removeMarkedPhysicsBodiesFromWorld;
  63398. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63399. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63400. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63401. private _processChildMeshes;
  63402. removePhysicsBody(impostor: PhysicsImpostor): void;
  63403. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63404. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63405. private _addMaterial;
  63406. private _checkWithEpsilon;
  63407. private _createShape;
  63408. private _createHeightmap;
  63409. private _minus90X;
  63410. private _plus90X;
  63411. private _tmpPosition;
  63412. private _tmpDeltaPosition;
  63413. private _tmpUnityRotation;
  63414. private _updatePhysicsBodyTransformation;
  63415. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63416. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63417. isSupported(): boolean;
  63418. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63419. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63420. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63421. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63422. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63423. getBodyMass(impostor: PhysicsImpostor): number;
  63424. getBodyFriction(impostor: PhysicsImpostor): number;
  63425. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63426. getBodyRestitution(impostor: PhysicsImpostor): number;
  63427. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63428. sleepBody(impostor: PhysicsImpostor): void;
  63429. wakeUpBody(impostor: PhysicsImpostor): void;
  63430. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63431. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63432. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63433. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63434. getRadius(impostor: PhysicsImpostor): number;
  63435. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63436. dispose(): void;
  63437. private _extendNamespace;
  63438. /**
  63439. * Does a raycast in the physics world
  63440. * @param from when should the ray start?
  63441. * @param to when should the ray end?
  63442. * @returns PhysicsRaycastResult
  63443. */
  63444. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63445. }
  63446. }
  63447. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63448. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63449. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63450. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63451. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63452. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63453. import { Nullable } from "babylonjs/types";
  63454. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63455. /** @hidden */
  63456. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63457. private _useDeltaForWorldStep;
  63458. world: any;
  63459. name: string;
  63460. BJSOIMO: any;
  63461. private _raycastResult;
  63462. private _fixedTimeStep;
  63463. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63464. setGravity(gravity: Vector3): void;
  63465. setTimeStep(timeStep: number): void;
  63466. getTimeStep(): number;
  63467. private _tmpImpostorsArray;
  63468. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63469. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63470. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63471. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63472. private _tmpPositionVector;
  63473. removePhysicsBody(impostor: PhysicsImpostor): void;
  63474. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63475. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63476. isSupported(): boolean;
  63477. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63478. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63479. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63480. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63481. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63482. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63483. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63484. getBodyMass(impostor: PhysicsImpostor): number;
  63485. getBodyFriction(impostor: PhysicsImpostor): number;
  63486. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63487. getBodyRestitution(impostor: PhysicsImpostor): number;
  63488. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63489. sleepBody(impostor: PhysicsImpostor): void;
  63490. wakeUpBody(impostor: PhysicsImpostor): void;
  63491. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63492. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63493. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63494. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63495. getRadius(impostor: PhysicsImpostor): number;
  63496. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63497. dispose(): void;
  63498. /**
  63499. * Does a raycast in the physics world
  63500. * @param from when should the ray start?
  63501. * @param to when should the ray end?
  63502. * @returns PhysicsRaycastResult
  63503. */
  63504. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63505. }
  63506. }
  63507. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63508. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63509. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63510. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63511. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63512. import { Nullable } from "babylonjs/types";
  63513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63514. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63515. /**
  63516. * AmmoJS Physics plugin
  63517. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63518. * @see https://github.com/kripken/ammo.js/
  63519. */
  63520. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63521. private _useDeltaForWorldStep;
  63522. /**
  63523. * Reference to the Ammo library
  63524. */
  63525. bjsAMMO: any;
  63526. /**
  63527. * Created ammoJS world which physics bodies are added to
  63528. */
  63529. world: any;
  63530. /**
  63531. * Name of the plugin
  63532. */
  63533. name: string;
  63534. private _timeStep;
  63535. private _fixedTimeStep;
  63536. private _maxSteps;
  63537. private _tmpQuaternion;
  63538. private _tmpAmmoTransform;
  63539. private _tmpAmmoQuaternion;
  63540. private _tmpAmmoConcreteContactResultCallback;
  63541. private _collisionConfiguration;
  63542. private _dispatcher;
  63543. private _overlappingPairCache;
  63544. private _solver;
  63545. private _softBodySolver;
  63546. private _tmpAmmoVectorA;
  63547. private _tmpAmmoVectorB;
  63548. private _tmpAmmoVectorC;
  63549. private _tmpAmmoVectorD;
  63550. private _tmpContactCallbackResult;
  63551. private _tmpAmmoVectorRCA;
  63552. private _tmpAmmoVectorRCB;
  63553. private _raycastResult;
  63554. private static readonly DISABLE_COLLISION_FLAG;
  63555. private static readonly KINEMATIC_FLAG;
  63556. private static readonly DISABLE_DEACTIVATION_FLAG;
  63557. /**
  63558. * Initializes the ammoJS plugin
  63559. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63560. * @param ammoInjection can be used to inject your own ammo reference
  63561. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63562. */
  63563. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63564. /**
  63565. * Sets the gravity of the physics world (m/(s^2))
  63566. * @param gravity Gravity to set
  63567. */
  63568. setGravity(gravity: Vector3): void;
  63569. /**
  63570. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63571. * @param timeStep timestep to use in seconds
  63572. */
  63573. setTimeStep(timeStep: number): void;
  63574. /**
  63575. * 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)
  63576. * @param fixedTimeStep fixedTimeStep to use in seconds
  63577. */
  63578. setFixedTimeStep(fixedTimeStep: number): void;
  63579. /**
  63580. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63581. * @param maxSteps the maximum number of steps by the physics engine per frame
  63582. */
  63583. setMaxSteps(maxSteps: number): void;
  63584. /**
  63585. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63586. * @returns the current timestep in seconds
  63587. */
  63588. getTimeStep(): number;
  63589. /**
  63590. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63591. */
  63592. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63593. private _isImpostorInContact;
  63594. private _isImpostorPairInContact;
  63595. private _stepSimulation;
  63596. /**
  63597. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63598. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63599. * After the step the babylon meshes are set to the position of the physics imposters
  63600. * @param delta amount of time to step forward
  63601. * @param impostors array of imposters to update before/after the step
  63602. */
  63603. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63604. /**
  63605. * Update babylon mesh to match physics world object
  63606. * @param impostor imposter to match
  63607. */
  63608. private _afterSoftStep;
  63609. /**
  63610. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63611. * @param impostor imposter to match
  63612. */
  63613. private _ropeStep;
  63614. /**
  63615. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63616. * @param impostor imposter to match
  63617. */
  63618. private _softbodyOrClothStep;
  63619. private _tmpMatrix;
  63620. /**
  63621. * Applies an impulse on the imposter
  63622. * @param impostor imposter to apply impulse to
  63623. * @param force amount of force to be applied to the imposter
  63624. * @param contactPoint the location to apply the impulse on the imposter
  63625. */
  63626. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63627. /**
  63628. * Applies a force on the imposter
  63629. * @param impostor imposter to apply force
  63630. * @param force amount of force to be applied to the imposter
  63631. * @param contactPoint the location to apply the force on the imposter
  63632. */
  63633. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63634. /**
  63635. * Creates a physics body using the plugin
  63636. * @param impostor the imposter to create the physics body on
  63637. */
  63638. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63639. /**
  63640. * Removes the physics body from the imposter and disposes of the body's memory
  63641. * @param impostor imposter to remove the physics body from
  63642. */
  63643. removePhysicsBody(impostor: PhysicsImpostor): void;
  63644. /**
  63645. * Generates a joint
  63646. * @param impostorJoint the imposter joint to create the joint with
  63647. */
  63648. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63649. /**
  63650. * Removes a joint
  63651. * @param impostorJoint the imposter joint to remove the joint from
  63652. */
  63653. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63654. private _addMeshVerts;
  63655. /**
  63656. * Initialise the soft body vertices to match its object's (mesh) vertices
  63657. * Softbody vertices (nodes) are in world space and to match this
  63658. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63659. * @param impostor to create the softbody for
  63660. */
  63661. private _softVertexData;
  63662. /**
  63663. * Create an impostor's soft body
  63664. * @param impostor to create the softbody for
  63665. */
  63666. private _createSoftbody;
  63667. /**
  63668. * Create cloth for an impostor
  63669. * @param impostor to create the softbody for
  63670. */
  63671. private _createCloth;
  63672. /**
  63673. * Create rope for an impostor
  63674. * @param impostor to create the softbody for
  63675. */
  63676. private _createRope;
  63677. /**
  63678. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63679. * @param impostor to create the custom physics shape for
  63680. */
  63681. private _createCustom;
  63682. private _addHullVerts;
  63683. private _createShape;
  63684. /**
  63685. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63686. * @param impostor imposter containing the physics body and babylon object
  63687. */
  63688. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63689. /**
  63690. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63691. * @param impostor imposter containing the physics body and babylon object
  63692. * @param newPosition new position
  63693. * @param newRotation new rotation
  63694. */
  63695. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63696. /**
  63697. * If this plugin is supported
  63698. * @returns true if its supported
  63699. */
  63700. isSupported(): boolean;
  63701. /**
  63702. * Sets the linear velocity of the physics body
  63703. * @param impostor imposter to set the velocity on
  63704. * @param velocity velocity to set
  63705. */
  63706. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63707. /**
  63708. * Sets the angular velocity of the physics body
  63709. * @param impostor imposter to set the velocity on
  63710. * @param velocity velocity to set
  63711. */
  63712. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63713. /**
  63714. * gets the linear velocity
  63715. * @param impostor imposter to get linear velocity from
  63716. * @returns linear velocity
  63717. */
  63718. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63719. /**
  63720. * gets the angular velocity
  63721. * @param impostor imposter to get angular velocity from
  63722. * @returns angular velocity
  63723. */
  63724. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63725. /**
  63726. * Sets the mass of physics body
  63727. * @param impostor imposter to set the mass on
  63728. * @param mass mass to set
  63729. */
  63730. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63731. /**
  63732. * Gets the mass of the physics body
  63733. * @param impostor imposter to get the mass from
  63734. * @returns mass
  63735. */
  63736. getBodyMass(impostor: PhysicsImpostor): number;
  63737. /**
  63738. * Gets friction of the impostor
  63739. * @param impostor impostor to get friction from
  63740. * @returns friction value
  63741. */
  63742. getBodyFriction(impostor: PhysicsImpostor): number;
  63743. /**
  63744. * Sets friction of the impostor
  63745. * @param impostor impostor to set friction on
  63746. * @param friction friction value
  63747. */
  63748. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63749. /**
  63750. * Gets restitution of the impostor
  63751. * @param impostor impostor to get restitution from
  63752. * @returns restitution value
  63753. */
  63754. getBodyRestitution(impostor: PhysicsImpostor): number;
  63755. /**
  63756. * Sets resitution of the impostor
  63757. * @param impostor impostor to set resitution on
  63758. * @param restitution resitution value
  63759. */
  63760. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63761. /**
  63762. * Gets pressure inside the impostor
  63763. * @param impostor impostor to get pressure from
  63764. * @returns pressure value
  63765. */
  63766. getBodyPressure(impostor: PhysicsImpostor): number;
  63767. /**
  63768. * Sets pressure inside a soft body impostor
  63769. * Cloth and rope must remain 0 pressure
  63770. * @param impostor impostor to set pressure on
  63771. * @param pressure pressure value
  63772. */
  63773. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63774. /**
  63775. * Gets stiffness of the impostor
  63776. * @param impostor impostor to get stiffness from
  63777. * @returns pressure value
  63778. */
  63779. getBodyStiffness(impostor: PhysicsImpostor): number;
  63780. /**
  63781. * Sets stiffness of the impostor
  63782. * @param impostor impostor to set stiffness on
  63783. * @param stiffness stiffness value from 0 to 1
  63784. */
  63785. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63786. /**
  63787. * Gets velocityIterations of the impostor
  63788. * @param impostor impostor to get velocity iterations from
  63789. * @returns velocityIterations value
  63790. */
  63791. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63792. /**
  63793. * Sets velocityIterations of the impostor
  63794. * @param impostor impostor to set velocity iterations on
  63795. * @param velocityIterations velocityIterations value
  63796. */
  63797. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63798. /**
  63799. * Gets positionIterations of the impostor
  63800. * @param impostor impostor to get position iterations from
  63801. * @returns positionIterations value
  63802. */
  63803. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63804. /**
  63805. * Sets positionIterations of the impostor
  63806. * @param impostor impostor to set position on
  63807. * @param positionIterations positionIterations value
  63808. */
  63809. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63810. /**
  63811. * Append an anchor to a cloth object
  63812. * @param impostor is the cloth impostor to add anchor to
  63813. * @param otherImpostor is the rigid impostor to anchor to
  63814. * @param width ratio across width from 0 to 1
  63815. * @param height ratio up height from 0 to 1
  63816. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63817. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63818. */
  63819. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63820. /**
  63821. * Append an hook to a rope object
  63822. * @param impostor is the rope impostor to add hook to
  63823. * @param otherImpostor is the rigid impostor to hook to
  63824. * @param length ratio along the rope from 0 to 1
  63825. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63826. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63827. */
  63828. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63829. /**
  63830. * Sleeps the physics body and stops it from being active
  63831. * @param impostor impostor to sleep
  63832. */
  63833. sleepBody(impostor: PhysicsImpostor): void;
  63834. /**
  63835. * Activates the physics body
  63836. * @param impostor impostor to activate
  63837. */
  63838. wakeUpBody(impostor: PhysicsImpostor): void;
  63839. /**
  63840. * Updates the distance parameters of the joint
  63841. * @param joint joint to update
  63842. * @param maxDistance maximum distance of the joint
  63843. * @param minDistance minimum distance of the joint
  63844. */
  63845. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63846. /**
  63847. * Sets a motor on the joint
  63848. * @param joint joint to set motor on
  63849. * @param speed speed of the motor
  63850. * @param maxForce maximum force of the motor
  63851. * @param motorIndex index of the motor
  63852. */
  63853. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63854. /**
  63855. * Sets the motors limit
  63856. * @param joint joint to set limit on
  63857. * @param upperLimit upper limit
  63858. * @param lowerLimit lower limit
  63859. */
  63860. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63861. /**
  63862. * Syncs the position and rotation of a mesh with the impostor
  63863. * @param mesh mesh to sync
  63864. * @param impostor impostor to update the mesh with
  63865. */
  63866. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63867. /**
  63868. * Gets the radius of the impostor
  63869. * @param impostor impostor to get radius from
  63870. * @returns the radius
  63871. */
  63872. getRadius(impostor: PhysicsImpostor): number;
  63873. /**
  63874. * Gets the box size of the impostor
  63875. * @param impostor impostor to get box size from
  63876. * @param result the resulting box size
  63877. */
  63878. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63879. /**
  63880. * Disposes of the impostor
  63881. */
  63882. dispose(): void;
  63883. /**
  63884. * Does a raycast in the physics world
  63885. * @param from when should the ray start?
  63886. * @param to when should the ray end?
  63887. * @returns PhysicsRaycastResult
  63888. */
  63889. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63890. }
  63891. }
  63892. declare module "babylonjs/Probes/reflectionProbe" {
  63893. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63894. import { Vector3 } from "babylonjs/Maths/math.vector";
  63895. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63896. import { Nullable } from "babylonjs/types";
  63897. import { Scene } from "babylonjs/scene";
  63898. module "babylonjs/abstractScene" {
  63899. interface AbstractScene {
  63900. /**
  63901. * The list of reflection probes added to the scene
  63902. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63903. */
  63904. reflectionProbes: Array<ReflectionProbe>;
  63905. /**
  63906. * Removes the given reflection probe from this scene.
  63907. * @param toRemove The reflection probe to remove
  63908. * @returns The index of the removed reflection probe
  63909. */
  63910. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63911. /**
  63912. * Adds the given reflection probe to this scene.
  63913. * @param newReflectionProbe The reflection probe to add
  63914. */
  63915. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63916. }
  63917. }
  63918. /**
  63919. * Class used to generate realtime reflection / refraction cube textures
  63920. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63921. */
  63922. export class ReflectionProbe {
  63923. /** defines the name of the probe */
  63924. name: string;
  63925. private _scene;
  63926. private _renderTargetTexture;
  63927. private _projectionMatrix;
  63928. private _viewMatrix;
  63929. private _target;
  63930. private _add;
  63931. private _attachedMesh;
  63932. private _invertYAxis;
  63933. /** Gets or sets probe position (center of the cube map) */
  63934. position: Vector3;
  63935. /**
  63936. * Creates a new reflection probe
  63937. * @param name defines the name of the probe
  63938. * @param size defines the texture resolution (for each face)
  63939. * @param scene defines the hosting scene
  63940. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63941. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63942. */
  63943. constructor(
  63944. /** defines the name of the probe */
  63945. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63946. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63947. get samples(): number;
  63948. set samples(value: number);
  63949. /** Gets or sets the refresh rate to use (on every frame by default) */
  63950. get refreshRate(): number;
  63951. set refreshRate(value: number);
  63952. /**
  63953. * Gets the hosting scene
  63954. * @returns a Scene
  63955. */
  63956. getScene(): Scene;
  63957. /** Gets the internal CubeTexture used to render to */
  63958. get cubeTexture(): RenderTargetTexture;
  63959. /** Gets the list of meshes to render */
  63960. get renderList(): Nullable<AbstractMesh[]>;
  63961. /**
  63962. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63963. * @param mesh defines the mesh to attach to
  63964. */
  63965. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63966. /**
  63967. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63968. * @param renderingGroupId The rendering group id corresponding to its index
  63969. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63970. */
  63971. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63972. /**
  63973. * Clean all associated resources
  63974. */
  63975. dispose(): void;
  63976. /**
  63977. * Converts the reflection probe information to a readable string for debug purpose.
  63978. * @param fullDetails Supports for multiple levels of logging within scene loading
  63979. * @returns the human readable reflection probe info
  63980. */
  63981. toString(fullDetails?: boolean): string;
  63982. /**
  63983. * Get the class name of the relfection probe.
  63984. * @returns "ReflectionProbe"
  63985. */
  63986. getClassName(): string;
  63987. /**
  63988. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63989. * @returns The JSON representation of the texture
  63990. */
  63991. serialize(): any;
  63992. /**
  63993. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63994. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63995. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63996. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63997. * @returns The parsed reflection probe if successful
  63998. */
  63999. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  64000. }
  64001. }
  64002. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  64003. /** @hidden */
  64004. export var _BabylonLoaderRegistered: boolean;
  64005. /**
  64006. * Helps setting up some configuration for the babylon file loader.
  64007. */
  64008. export class BabylonFileLoaderConfiguration {
  64009. /**
  64010. * The loader does not allow injecting custom physix engine into the plugins.
  64011. * Unfortunately in ES6, we need to manually inject them into the plugin.
  64012. * So you could set this variable to your engine import to make it work.
  64013. */
  64014. static LoaderInjectedPhysicsEngine: any;
  64015. }
  64016. }
  64017. declare module "babylonjs/Loading/Plugins/index" {
  64018. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  64019. }
  64020. declare module "babylonjs/Loading/index" {
  64021. export * from "babylonjs/Loading/loadingScreen";
  64022. export * from "babylonjs/Loading/Plugins/index";
  64023. export * from "babylonjs/Loading/sceneLoader";
  64024. export * from "babylonjs/Loading/sceneLoaderFlags";
  64025. }
  64026. declare module "babylonjs/Materials/Background/index" {
  64027. export * from "babylonjs/Materials/Background/backgroundMaterial";
  64028. }
  64029. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  64030. import { Scene } from "babylonjs/scene";
  64031. import { Color3 } from "babylonjs/Maths/math.color";
  64032. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64033. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64034. /**
  64035. * The Physically based simple base material of BJS.
  64036. *
  64037. * This enables better naming and convention enforcements on top of the pbrMaterial.
  64038. * It is used as the base class for both the specGloss and metalRough conventions.
  64039. */
  64040. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  64041. /**
  64042. * Number of Simultaneous lights allowed on the material.
  64043. */
  64044. maxSimultaneousLights: number;
  64045. /**
  64046. * If sets to true, disables all the lights affecting the material.
  64047. */
  64048. disableLighting: boolean;
  64049. /**
  64050. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  64051. */
  64052. environmentTexture: BaseTexture;
  64053. /**
  64054. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  64055. */
  64056. invertNormalMapX: boolean;
  64057. /**
  64058. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  64059. */
  64060. invertNormalMapY: boolean;
  64061. /**
  64062. * Normal map used in the model.
  64063. */
  64064. normalTexture: BaseTexture;
  64065. /**
  64066. * Emissivie color used to self-illuminate the model.
  64067. */
  64068. emissiveColor: Color3;
  64069. /**
  64070. * Emissivie texture used to self-illuminate the model.
  64071. */
  64072. emissiveTexture: BaseTexture;
  64073. /**
  64074. * Occlusion Channel Strenght.
  64075. */
  64076. occlusionStrength: number;
  64077. /**
  64078. * Occlusion Texture of the material (adding extra occlusion effects).
  64079. */
  64080. occlusionTexture: BaseTexture;
  64081. /**
  64082. * Defines the alpha limits in alpha test mode.
  64083. */
  64084. alphaCutOff: number;
  64085. /**
  64086. * Gets the current double sided mode.
  64087. */
  64088. get doubleSided(): boolean;
  64089. /**
  64090. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64091. */
  64092. set doubleSided(value: boolean);
  64093. /**
  64094. * Stores the pre-calculated light information of a mesh in a texture.
  64095. */
  64096. lightmapTexture: BaseTexture;
  64097. /**
  64098. * If true, the light map contains occlusion information instead of lighting info.
  64099. */
  64100. useLightmapAsShadowmap: boolean;
  64101. /**
  64102. * Instantiates a new PBRMaterial instance.
  64103. *
  64104. * @param name The material name
  64105. * @param scene The scene the material will be use in.
  64106. */
  64107. constructor(name: string, scene: Scene);
  64108. getClassName(): string;
  64109. }
  64110. }
  64111. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64112. import { Scene } from "babylonjs/scene";
  64113. import { Color3 } from "babylonjs/Maths/math.color";
  64114. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64115. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64116. /**
  64117. * The PBR material of BJS following the metal roughness convention.
  64118. *
  64119. * This fits to the PBR convention in the GLTF definition:
  64120. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64121. */
  64122. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64123. /**
  64124. * The base color has two different interpretations depending on the value of metalness.
  64125. * When the material is a metal, the base color is the specific measured reflectance value
  64126. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64127. * of the material.
  64128. */
  64129. baseColor: Color3;
  64130. /**
  64131. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64132. * well as opacity information in the alpha channel.
  64133. */
  64134. baseTexture: BaseTexture;
  64135. /**
  64136. * Specifies the metallic scalar value of the material.
  64137. * Can also be used to scale the metalness values of the metallic texture.
  64138. */
  64139. metallic: number;
  64140. /**
  64141. * Specifies the roughness scalar value of the material.
  64142. * Can also be used to scale the roughness values of the metallic texture.
  64143. */
  64144. roughness: number;
  64145. /**
  64146. * Texture containing both the metallic value in the B channel and the
  64147. * roughness value in the G channel to keep better precision.
  64148. */
  64149. metallicRoughnessTexture: BaseTexture;
  64150. /**
  64151. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64152. *
  64153. * @param name The material name
  64154. * @param scene The scene the material will be use in.
  64155. */
  64156. constructor(name: string, scene: Scene);
  64157. /**
  64158. * Return the currrent class name of the material.
  64159. */
  64160. getClassName(): string;
  64161. /**
  64162. * Makes a duplicate of the current material.
  64163. * @param name - name to use for the new material.
  64164. */
  64165. clone(name: string): PBRMetallicRoughnessMaterial;
  64166. /**
  64167. * Serialize the material to a parsable JSON object.
  64168. */
  64169. serialize(): any;
  64170. /**
  64171. * Parses a JSON object correponding to the serialize function.
  64172. */
  64173. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64174. }
  64175. }
  64176. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64177. import { Scene } from "babylonjs/scene";
  64178. import { Color3 } from "babylonjs/Maths/math.color";
  64179. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64180. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64181. /**
  64182. * The PBR material of BJS following the specular glossiness convention.
  64183. *
  64184. * This fits to the PBR convention in the GLTF definition:
  64185. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64186. */
  64187. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64188. /**
  64189. * Specifies the diffuse color of the material.
  64190. */
  64191. diffuseColor: Color3;
  64192. /**
  64193. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64194. * channel.
  64195. */
  64196. diffuseTexture: BaseTexture;
  64197. /**
  64198. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64199. */
  64200. specularColor: Color3;
  64201. /**
  64202. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64203. */
  64204. glossiness: number;
  64205. /**
  64206. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64207. */
  64208. specularGlossinessTexture: BaseTexture;
  64209. /**
  64210. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64211. *
  64212. * @param name The material name
  64213. * @param scene The scene the material will be use in.
  64214. */
  64215. constructor(name: string, scene: Scene);
  64216. /**
  64217. * Return the currrent class name of the material.
  64218. */
  64219. getClassName(): string;
  64220. /**
  64221. * Makes a duplicate of the current material.
  64222. * @param name - name to use for the new material.
  64223. */
  64224. clone(name: string): PBRSpecularGlossinessMaterial;
  64225. /**
  64226. * Serialize the material to a parsable JSON object.
  64227. */
  64228. serialize(): any;
  64229. /**
  64230. * Parses a JSON object correponding to the serialize function.
  64231. */
  64232. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64233. }
  64234. }
  64235. declare module "babylonjs/Materials/PBR/index" {
  64236. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64237. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64238. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64239. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64240. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64241. }
  64242. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64243. import { Nullable } from "babylonjs/types";
  64244. import { Scene } from "babylonjs/scene";
  64245. import { Matrix } from "babylonjs/Maths/math.vector";
  64246. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64247. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64248. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64249. /**
  64250. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64251. * It can help converting any input color in a desired output one. This can then be used to create effects
  64252. * from sepia, black and white to sixties or futuristic rendering...
  64253. *
  64254. * The only supported format is currently 3dl.
  64255. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64256. */
  64257. export class ColorGradingTexture extends BaseTexture {
  64258. /**
  64259. * The texture URL.
  64260. */
  64261. url: string;
  64262. /**
  64263. * Empty line regex stored for GC.
  64264. */
  64265. private static _noneEmptyLineRegex;
  64266. private _textureMatrix;
  64267. private _onLoad;
  64268. /**
  64269. * Instantiates a ColorGradingTexture from the following parameters.
  64270. *
  64271. * @param url The location of the color gradind data (currently only supporting 3dl)
  64272. * @param sceneOrEngine The scene or engine the texture will be used in
  64273. * @param onLoad defines a callback triggered when the texture has been loaded
  64274. */
  64275. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64276. /**
  64277. * Fires the onload event from the constructor if requested.
  64278. */
  64279. private _triggerOnLoad;
  64280. /**
  64281. * Returns the texture matrix used in most of the material.
  64282. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64283. */
  64284. getTextureMatrix(): Matrix;
  64285. /**
  64286. * Occurs when the file being loaded is a .3dl LUT file.
  64287. */
  64288. private load3dlTexture;
  64289. /**
  64290. * Starts the loading process of the texture.
  64291. */
  64292. private loadTexture;
  64293. /**
  64294. * Clones the color gradind texture.
  64295. */
  64296. clone(): ColorGradingTexture;
  64297. /**
  64298. * Called during delayed load for textures.
  64299. */
  64300. delayLoad(): void;
  64301. /**
  64302. * Parses a color grading texture serialized by Babylon.
  64303. * @param parsedTexture The texture information being parsedTexture
  64304. * @param scene The scene to load the texture in
  64305. * @param rootUrl The root url of the data assets to load
  64306. * @return A color gradind texture
  64307. */
  64308. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64309. /**
  64310. * Serializes the LUT texture to json format.
  64311. */
  64312. serialize(): any;
  64313. }
  64314. }
  64315. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64316. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64317. import { Scene } from "babylonjs/scene";
  64318. import { Nullable } from "babylonjs/types";
  64319. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64320. /**
  64321. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64322. */
  64323. export class EquiRectangularCubeTexture extends BaseTexture {
  64324. /** The six faces of the cube. */
  64325. private static _FacesMapping;
  64326. private _noMipmap;
  64327. private _onLoad;
  64328. private _onError;
  64329. /** The size of the cubemap. */
  64330. private _size;
  64331. /** The buffer of the image. */
  64332. private _buffer;
  64333. /** The width of the input image. */
  64334. private _width;
  64335. /** The height of the input image. */
  64336. private _height;
  64337. /** The URL to the image. */
  64338. url: string;
  64339. /**
  64340. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64341. * @param url The location of the image
  64342. * @param scene The scene the texture will be used in
  64343. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64344. * @param noMipmap Forces to not generate the mipmap if true
  64345. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64346. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64347. * @param onLoad — defines a callback called when texture is loaded
  64348. * @param onError — defines a callback called if there is an error
  64349. */
  64350. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64351. /**
  64352. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64353. */
  64354. private loadImage;
  64355. /**
  64356. * Convert the image buffer into a cubemap and create a CubeTexture.
  64357. */
  64358. private loadTexture;
  64359. /**
  64360. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64361. * @param buffer The ArrayBuffer that should be converted.
  64362. * @returns The buffer as Float32Array.
  64363. */
  64364. private getFloat32ArrayFromArrayBuffer;
  64365. /**
  64366. * Get the current class name of the texture useful for serialization or dynamic coding.
  64367. * @returns "EquiRectangularCubeTexture"
  64368. */
  64369. getClassName(): string;
  64370. /**
  64371. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64372. * @returns A clone of the current EquiRectangularCubeTexture.
  64373. */
  64374. clone(): EquiRectangularCubeTexture;
  64375. }
  64376. }
  64377. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64378. import { Nullable } from "babylonjs/types";
  64379. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64380. import { Matrix } from "babylonjs/Maths/math.vector";
  64381. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64382. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64383. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64384. import { Scene } from "babylonjs/scene";
  64385. /**
  64386. * Defines the options related to the creation of an HtmlElementTexture
  64387. */
  64388. export interface IHtmlElementTextureOptions {
  64389. /**
  64390. * Defines wether mip maps should be created or not.
  64391. */
  64392. generateMipMaps?: boolean;
  64393. /**
  64394. * Defines the sampling mode of the texture.
  64395. */
  64396. samplingMode?: number;
  64397. /**
  64398. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64399. */
  64400. engine: Nullable<ThinEngine>;
  64401. /**
  64402. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64403. */
  64404. scene: Nullable<Scene>;
  64405. }
  64406. /**
  64407. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64408. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64409. * is automatically managed.
  64410. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64411. * in your application.
  64412. *
  64413. * As the update is not automatic, you need to call them manually.
  64414. */
  64415. export class HtmlElementTexture extends BaseTexture {
  64416. /**
  64417. * The texture URL.
  64418. */
  64419. element: HTMLVideoElement | HTMLCanvasElement;
  64420. private static readonly DefaultOptions;
  64421. private _textureMatrix;
  64422. private _isVideo;
  64423. private _generateMipMaps;
  64424. private _samplingMode;
  64425. /**
  64426. * Instantiates a HtmlElementTexture from the following parameters.
  64427. *
  64428. * @param name Defines the name of the texture
  64429. * @param element Defines the video or canvas the texture is filled with
  64430. * @param options Defines the other none mandatory texture creation options
  64431. */
  64432. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64433. private _createInternalTexture;
  64434. /**
  64435. * Returns the texture matrix used in most of the material.
  64436. */
  64437. getTextureMatrix(): Matrix;
  64438. /**
  64439. * Updates the content of the texture.
  64440. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64441. */
  64442. update(invertY?: Nullable<boolean>): void;
  64443. }
  64444. }
  64445. declare module "babylonjs/Misc/tga" {
  64446. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64447. /**
  64448. * Based on jsTGALoader - Javascript loader for TGA file
  64449. * By Vincent Thibault
  64450. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64451. */
  64452. export class TGATools {
  64453. private static _TYPE_INDEXED;
  64454. private static _TYPE_RGB;
  64455. private static _TYPE_GREY;
  64456. private static _TYPE_RLE_INDEXED;
  64457. private static _TYPE_RLE_RGB;
  64458. private static _TYPE_RLE_GREY;
  64459. private static _ORIGIN_MASK;
  64460. private static _ORIGIN_SHIFT;
  64461. private static _ORIGIN_BL;
  64462. private static _ORIGIN_BR;
  64463. private static _ORIGIN_UL;
  64464. private static _ORIGIN_UR;
  64465. /**
  64466. * Gets the header of a TGA file
  64467. * @param data defines the TGA data
  64468. * @returns the header
  64469. */
  64470. static GetTGAHeader(data: Uint8Array): any;
  64471. /**
  64472. * Uploads TGA content to a Babylon Texture
  64473. * @hidden
  64474. */
  64475. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64476. /** @hidden */
  64477. 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;
  64478. /** @hidden */
  64479. 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;
  64480. /** @hidden */
  64481. 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;
  64482. /** @hidden */
  64483. 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;
  64484. /** @hidden */
  64485. 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;
  64486. /** @hidden */
  64487. 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;
  64488. }
  64489. }
  64490. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64491. import { Nullable } from "babylonjs/types";
  64492. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64493. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64494. /**
  64495. * Implementation of the TGA Texture Loader.
  64496. * @hidden
  64497. */
  64498. export class _TGATextureLoader implements IInternalTextureLoader {
  64499. /**
  64500. * Defines wether the loader supports cascade loading the different faces.
  64501. */
  64502. readonly supportCascades: boolean;
  64503. /**
  64504. * This returns if the loader support the current file information.
  64505. * @param extension defines the file extension of the file being loaded
  64506. * @returns true if the loader can load the specified file
  64507. */
  64508. canLoad(extension: string): boolean;
  64509. /**
  64510. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64511. * @param data contains the texture data
  64512. * @param texture defines the BabylonJS internal texture
  64513. * @param createPolynomials will be true if polynomials have been requested
  64514. * @param onLoad defines the callback to trigger once the texture is ready
  64515. * @param onError defines the callback to trigger in case of error
  64516. */
  64517. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64518. /**
  64519. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64520. * @param data contains the texture data
  64521. * @param texture defines the BabylonJS internal texture
  64522. * @param callback defines the method to call once ready to upload
  64523. */
  64524. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64525. }
  64526. }
  64527. declare module "babylonjs/Misc/basis" {
  64528. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64529. /**
  64530. * Info about the .basis files
  64531. */
  64532. class BasisFileInfo {
  64533. /**
  64534. * If the file has alpha
  64535. */
  64536. hasAlpha: boolean;
  64537. /**
  64538. * Info about each image of the basis file
  64539. */
  64540. images: Array<{
  64541. levels: Array<{
  64542. width: number;
  64543. height: number;
  64544. transcodedPixels: ArrayBufferView;
  64545. }>;
  64546. }>;
  64547. }
  64548. /**
  64549. * Result of transcoding a basis file
  64550. */
  64551. class TranscodeResult {
  64552. /**
  64553. * Info about the .basis file
  64554. */
  64555. fileInfo: BasisFileInfo;
  64556. /**
  64557. * Format to use when loading the file
  64558. */
  64559. format: number;
  64560. }
  64561. /**
  64562. * Configuration options for the Basis transcoder
  64563. */
  64564. export class BasisTranscodeConfiguration {
  64565. /**
  64566. * Supported compression formats used to determine the supported output format of the transcoder
  64567. */
  64568. supportedCompressionFormats?: {
  64569. /**
  64570. * etc1 compression format
  64571. */
  64572. etc1?: boolean;
  64573. /**
  64574. * s3tc compression format
  64575. */
  64576. s3tc?: boolean;
  64577. /**
  64578. * pvrtc compression format
  64579. */
  64580. pvrtc?: boolean;
  64581. /**
  64582. * etc2 compression format
  64583. */
  64584. etc2?: boolean;
  64585. };
  64586. /**
  64587. * If mipmap levels should be loaded for transcoded images (Default: true)
  64588. */
  64589. loadMipmapLevels?: boolean;
  64590. /**
  64591. * Index of a single image to load (Default: all images)
  64592. */
  64593. loadSingleImage?: number;
  64594. }
  64595. /**
  64596. * Used to load .Basis files
  64597. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64598. */
  64599. export class BasisTools {
  64600. private static _IgnoreSupportedFormats;
  64601. /**
  64602. * URL to use when loading the basis transcoder
  64603. */
  64604. static JSModuleURL: string;
  64605. /**
  64606. * URL to use when loading the wasm module for the transcoder
  64607. */
  64608. static WasmModuleURL: string;
  64609. /**
  64610. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64611. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64612. * @returns internal format corresponding to the Basis format
  64613. */
  64614. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64615. private static _WorkerPromise;
  64616. private static _Worker;
  64617. private static _actionId;
  64618. private static _CreateWorkerAsync;
  64619. /**
  64620. * Transcodes a loaded image file to compressed pixel data
  64621. * @param data image data to transcode
  64622. * @param config configuration options for the transcoding
  64623. * @returns a promise resulting in the transcoded image
  64624. */
  64625. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64626. /**
  64627. * Loads a texture from the transcode result
  64628. * @param texture texture load to
  64629. * @param transcodeResult the result of transcoding the basis file to load from
  64630. */
  64631. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64632. }
  64633. }
  64634. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64635. import { Nullable } from "babylonjs/types";
  64636. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64637. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64638. /**
  64639. * Loader for .basis file format
  64640. */
  64641. export class _BasisTextureLoader implements IInternalTextureLoader {
  64642. /**
  64643. * Defines whether the loader supports cascade loading the different faces.
  64644. */
  64645. readonly supportCascades: boolean;
  64646. /**
  64647. * This returns if the loader support the current file information.
  64648. * @param extension defines the file extension of the file being loaded
  64649. * @returns true if the loader can load the specified file
  64650. */
  64651. canLoad(extension: string): boolean;
  64652. /**
  64653. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64654. * @param data contains the texture data
  64655. * @param texture defines the BabylonJS internal texture
  64656. * @param createPolynomials will be true if polynomials have been requested
  64657. * @param onLoad defines the callback to trigger once the texture is ready
  64658. * @param onError defines the callback to trigger in case of error
  64659. */
  64660. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64661. /**
  64662. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64663. * @param data contains the texture data
  64664. * @param texture defines the BabylonJS internal texture
  64665. * @param callback defines the method to call once ready to upload
  64666. */
  64667. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64668. }
  64669. }
  64670. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64671. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64672. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64673. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64674. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64675. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64676. }
  64677. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64678. import { Vector2 } from "babylonjs/Maths/math.vector";
  64679. /**
  64680. * Defines the basic options interface of a TexturePacker Frame
  64681. */
  64682. export interface ITexturePackerFrame {
  64683. /**
  64684. * The frame ID
  64685. */
  64686. id: number;
  64687. /**
  64688. * The frames Scale
  64689. */
  64690. scale: Vector2;
  64691. /**
  64692. * The Frames offset
  64693. */
  64694. offset: Vector2;
  64695. }
  64696. /**
  64697. * This is a support class for frame Data on texture packer sets.
  64698. */
  64699. export class TexturePackerFrame implements ITexturePackerFrame {
  64700. /**
  64701. * The frame ID
  64702. */
  64703. id: number;
  64704. /**
  64705. * The frames Scale
  64706. */
  64707. scale: Vector2;
  64708. /**
  64709. * The Frames offset
  64710. */
  64711. offset: Vector2;
  64712. /**
  64713. * Initializes a texture package frame.
  64714. * @param id The numerical frame identifier
  64715. * @param scale Scalar Vector2 for UV frame
  64716. * @param offset Vector2 for the frame position in UV units.
  64717. * @returns TexturePackerFrame
  64718. */
  64719. constructor(id: number, scale: Vector2, offset: Vector2);
  64720. }
  64721. }
  64722. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64723. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64724. import { Scene } from "babylonjs/scene";
  64725. import { Nullable } from "babylonjs/types";
  64726. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64727. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64728. /**
  64729. * Defines the basic options interface of a TexturePacker
  64730. */
  64731. export interface ITexturePackerOptions {
  64732. /**
  64733. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64734. */
  64735. map?: string[];
  64736. /**
  64737. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64738. */
  64739. uvsIn?: string;
  64740. /**
  64741. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64742. */
  64743. uvsOut?: string;
  64744. /**
  64745. * number representing the layout style. Defaults to LAYOUT_STRIP
  64746. */
  64747. layout?: number;
  64748. /**
  64749. * number of columns if using custom column count layout(2). This defaults to 4.
  64750. */
  64751. colnum?: number;
  64752. /**
  64753. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64754. */
  64755. updateInputMeshes?: boolean;
  64756. /**
  64757. * boolean flag to dispose all the source textures. Defaults to true.
  64758. */
  64759. disposeSources?: boolean;
  64760. /**
  64761. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64762. */
  64763. fillBlanks?: boolean;
  64764. /**
  64765. * string value representing the context fill style color. Defaults to 'black'.
  64766. */
  64767. customFillColor?: string;
  64768. /**
  64769. * Width and Height Value of each Frame in the TexturePacker Sets
  64770. */
  64771. frameSize?: number;
  64772. /**
  64773. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64774. */
  64775. paddingRatio?: number;
  64776. /**
  64777. * Number that declares the fill method for the padding gutter.
  64778. */
  64779. paddingMode?: number;
  64780. /**
  64781. * If in SUBUV_COLOR padding mode what color to use.
  64782. */
  64783. paddingColor?: Color3 | Color4;
  64784. }
  64785. /**
  64786. * Defines the basic interface of a TexturePacker JSON File
  64787. */
  64788. export interface ITexturePackerJSON {
  64789. /**
  64790. * The frame ID
  64791. */
  64792. name: string;
  64793. /**
  64794. * The base64 channel data
  64795. */
  64796. sets: any;
  64797. /**
  64798. * The options of the Packer
  64799. */
  64800. options: ITexturePackerOptions;
  64801. /**
  64802. * The frame data of the Packer
  64803. */
  64804. frames: Array<number>;
  64805. }
  64806. /**
  64807. * This is a support class that generates a series of packed texture sets.
  64808. * @see https://doc.babylonjs.com/babylon101/materials
  64809. */
  64810. export class TexturePacker {
  64811. /** Packer Layout Constant 0 */
  64812. static readonly LAYOUT_STRIP: number;
  64813. /** Packer Layout Constant 1 */
  64814. static readonly LAYOUT_POWER2: number;
  64815. /** Packer Layout Constant 2 */
  64816. static readonly LAYOUT_COLNUM: number;
  64817. /** Packer Layout Constant 0 */
  64818. static readonly SUBUV_WRAP: number;
  64819. /** Packer Layout Constant 1 */
  64820. static readonly SUBUV_EXTEND: number;
  64821. /** Packer Layout Constant 2 */
  64822. static readonly SUBUV_COLOR: number;
  64823. /** The Name of the Texture Package */
  64824. name: string;
  64825. /** The scene scope of the TexturePacker */
  64826. scene: Scene;
  64827. /** The Meshes to target */
  64828. meshes: AbstractMesh[];
  64829. /** Arguments passed with the Constructor */
  64830. options: ITexturePackerOptions;
  64831. /** The promise that is started upon initialization */
  64832. promise: Nullable<Promise<TexturePacker | string>>;
  64833. /** The Container object for the channel sets that are generated */
  64834. sets: object;
  64835. /** The Container array for the frames that are generated */
  64836. frames: TexturePackerFrame[];
  64837. /** The expected number of textures the system is parsing. */
  64838. private _expecting;
  64839. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64840. private _paddingValue;
  64841. /**
  64842. * Initializes a texture package series from an array of meshes or a single mesh.
  64843. * @param name The name of the package
  64844. * @param meshes The target meshes to compose the package from
  64845. * @param options The arguments that texture packer should follow while building.
  64846. * @param scene The scene which the textures are scoped to.
  64847. * @returns TexturePacker
  64848. */
  64849. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64850. /**
  64851. * Starts the package process
  64852. * @param resolve The promises resolution function
  64853. * @returns TexturePacker
  64854. */
  64855. private _createFrames;
  64856. /**
  64857. * Calculates the Size of the Channel Sets
  64858. * @returns Vector2
  64859. */
  64860. private _calculateSize;
  64861. /**
  64862. * Calculates the UV data for the frames.
  64863. * @param baseSize the base frameSize
  64864. * @param padding the base frame padding
  64865. * @param dtSize size of the Dynamic Texture for that channel
  64866. * @param dtUnits is 1/dtSize
  64867. * @param update flag to update the input meshes
  64868. */
  64869. private _calculateMeshUVFrames;
  64870. /**
  64871. * Calculates the frames Offset.
  64872. * @param index of the frame
  64873. * @returns Vector2
  64874. */
  64875. private _getFrameOffset;
  64876. /**
  64877. * Updates a Mesh to the frame data
  64878. * @param mesh that is the target
  64879. * @param frameID or the frame index
  64880. */
  64881. private _updateMeshUV;
  64882. /**
  64883. * Updates a Meshes materials to use the texture packer channels
  64884. * @param m is the mesh to target
  64885. * @param force all channels on the packer to be set.
  64886. */
  64887. private _updateTextureReferences;
  64888. /**
  64889. * Public method to set a Mesh to a frame
  64890. * @param m that is the target
  64891. * @param frameID or the frame index
  64892. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64893. */
  64894. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64895. /**
  64896. * Starts the async promise to compile the texture packer.
  64897. * @returns Promise<void>
  64898. */
  64899. processAsync(): Promise<void>;
  64900. /**
  64901. * Disposes all textures associated with this packer
  64902. */
  64903. dispose(): void;
  64904. /**
  64905. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64906. * @param imageType is the image type to use.
  64907. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64908. */
  64909. download(imageType?: string, quality?: number): void;
  64910. /**
  64911. * Public method to load a texturePacker JSON file.
  64912. * @param data of the JSON file in string format.
  64913. */
  64914. updateFromJSON(data: string): void;
  64915. }
  64916. }
  64917. declare module "babylonjs/Materials/Textures/Packer/index" {
  64918. export * from "babylonjs/Materials/Textures/Packer/packer";
  64919. export * from "babylonjs/Materials/Textures/Packer/frame";
  64920. }
  64921. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64922. import { Scene } from "babylonjs/scene";
  64923. import { Texture } from "babylonjs/Materials/Textures/texture";
  64924. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64925. /**
  64926. * 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.
  64927. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64928. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64929. */
  64930. export class CustomProceduralTexture extends ProceduralTexture {
  64931. private _animate;
  64932. private _time;
  64933. private _config;
  64934. private _texturePath;
  64935. /**
  64936. * Instantiates a new Custom Procedural Texture.
  64937. * 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.
  64938. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64939. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64940. * @param name Define the name of the texture
  64941. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64942. * @param size Define the size of the texture to create
  64943. * @param scene Define the scene the texture belongs to
  64944. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64945. * @param generateMipMaps Define if the texture should creates mip maps or not
  64946. */
  64947. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64948. private _loadJson;
  64949. /**
  64950. * Is the texture ready to be used ? (rendered at least once)
  64951. * @returns true if ready, otherwise, false.
  64952. */
  64953. isReady(): boolean;
  64954. /**
  64955. * Render the texture to its associated render target.
  64956. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64957. */
  64958. render(useCameraPostProcess?: boolean): void;
  64959. /**
  64960. * Update the list of dependant textures samplers in the shader.
  64961. */
  64962. updateTextures(): void;
  64963. /**
  64964. * Update the uniform values of the procedural texture in the shader.
  64965. */
  64966. updateShaderUniforms(): void;
  64967. /**
  64968. * Define if the texture animates or not.
  64969. */
  64970. get animate(): boolean;
  64971. set animate(value: boolean);
  64972. }
  64973. }
  64974. declare module "babylonjs/Shaders/noise.fragment" {
  64975. /** @hidden */
  64976. export var noisePixelShader: {
  64977. name: string;
  64978. shader: string;
  64979. };
  64980. }
  64981. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64982. import { Nullable } from "babylonjs/types";
  64983. import { Scene } from "babylonjs/scene";
  64984. import { Texture } from "babylonjs/Materials/Textures/texture";
  64985. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64986. import "babylonjs/Shaders/noise.fragment";
  64987. /**
  64988. * Class used to generate noise procedural textures
  64989. */
  64990. export class NoiseProceduralTexture extends ProceduralTexture {
  64991. /** Gets or sets the start time (default is 0) */
  64992. time: number;
  64993. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64994. brightness: number;
  64995. /** Defines the number of octaves to process */
  64996. octaves: number;
  64997. /** Defines the level of persistence (0.8 by default) */
  64998. persistence: number;
  64999. /** Gets or sets animation speed factor (default is 1) */
  65000. animationSpeedFactor: number;
  65001. /**
  65002. * Creates a new NoiseProceduralTexture
  65003. * @param name defines the name fo the texture
  65004. * @param size defines the size of the texture (default is 256)
  65005. * @param scene defines the hosting scene
  65006. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  65007. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  65008. */
  65009. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65010. private _updateShaderUniforms;
  65011. protected _getDefines(): string;
  65012. /** Generate the current state of the procedural texture */
  65013. render(useCameraPostProcess?: boolean): void;
  65014. /**
  65015. * Serializes this noise procedural texture
  65016. * @returns a serialized noise procedural texture object
  65017. */
  65018. serialize(): any;
  65019. /**
  65020. * Clone the texture.
  65021. * @returns the cloned texture
  65022. */
  65023. clone(): NoiseProceduralTexture;
  65024. /**
  65025. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  65026. * @param parsedTexture defines parsed texture data
  65027. * @param scene defines the current scene
  65028. * @param rootUrl defines the root URL containing noise procedural texture information
  65029. * @returns a parsed NoiseProceduralTexture
  65030. */
  65031. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  65032. }
  65033. }
  65034. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  65035. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  65036. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  65037. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65038. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  65039. }
  65040. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  65041. import { Nullable } from "babylonjs/types";
  65042. import { Scene } from "babylonjs/scene";
  65043. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  65044. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65045. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65046. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65047. /**
  65048. * Raw cube texture where the raw buffers are passed in
  65049. */
  65050. export class RawCubeTexture extends CubeTexture {
  65051. /**
  65052. * Creates a cube texture where the raw buffers are passed in.
  65053. * @param scene defines the scene the texture is attached to
  65054. * @param data defines the array of data to use to create each face
  65055. * @param size defines the size of the textures
  65056. * @param format defines the format of the data
  65057. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  65058. * @param generateMipMaps defines if the engine should generate the mip levels
  65059. * @param invertY defines if data must be stored with Y axis inverted
  65060. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  65061. * @param compression defines the compression used (null by default)
  65062. */
  65063. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  65064. /**
  65065. * Updates the raw cube texture.
  65066. * @param data defines the data to store
  65067. * @param format defines the data format
  65068. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65069. * @param invertY defines if data must be stored with Y axis inverted
  65070. * @param compression defines the compression used (null by default)
  65071. * @param level defines which level of the texture to update
  65072. */
  65073. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  65074. /**
  65075. * Updates a raw cube texture with RGBD encoded data.
  65076. * @param data defines the array of data [mipmap][face] to use to create each face
  65077. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  65078. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  65079. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  65080. * @returns a promsie that resolves when the operation is complete
  65081. */
  65082. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65083. /**
  65084. * Clones the raw cube texture.
  65085. * @return a new cube texture
  65086. */
  65087. clone(): CubeTexture;
  65088. /** @hidden */
  65089. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65090. }
  65091. }
  65092. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65093. import { Scene } from "babylonjs/scene";
  65094. import { Texture } from "babylonjs/Materials/Textures/texture";
  65095. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65096. /**
  65097. * Class used to store 2D array textures containing user data
  65098. */
  65099. export class RawTexture2DArray extends Texture {
  65100. /** Gets or sets the texture format to use */
  65101. format: number;
  65102. /**
  65103. * Create a new RawTexture2DArray
  65104. * @param data defines the data of the texture
  65105. * @param width defines the width of the texture
  65106. * @param height defines the height of the texture
  65107. * @param depth defines the number of layers of the texture
  65108. * @param format defines the texture format to use
  65109. * @param scene defines the hosting scene
  65110. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65111. * @param invertY defines if texture must be stored with Y axis inverted
  65112. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65113. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65114. */
  65115. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65116. /** Gets or sets the texture format to use */
  65117. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65118. /**
  65119. * Update the texture with new data
  65120. * @param data defines the data to store in the texture
  65121. */
  65122. update(data: ArrayBufferView): void;
  65123. }
  65124. }
  65125. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65126. import { Scene } from "babylonjs/scene";
  65127. import { Texture } from "babylonjs/Materials/Textures/texture";
  65128. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65129. /**
  65130. * Class used to store 3D textures containing user data
  65131. */
  65132. export class RawTexture3D extends Texture {
  65133. /** Gets or sets the texture format to use */
  65134. format: number;
  65135. /**
  65136. * Create a new RawTexture3D
  65137. * @param data defines the data of the texture
  65138. * @param width defines the width of the texture
  65139. * @param height defines the height of the texture
  65140. * @param depth defines the depth of the texture
  65141. * @param format defines the texture format to use
  65142. * @param scene defines the hosting scene
  65143. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65144. * @param invertY defines if texture must be stored with Y axis inverted
  65145. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65146. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65147. */
  65148. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65149. /** Gets or sets the texture format to use */
  65150. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65151. /**
  65152. * Update the texture with new data
  65153. * @param data defines the data to store in the texture
  65154. */
  65155. update(data: ArrayBufferView): void;
  65156. }
  65157. }
  65158. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65159. import { Scene } from "babylonjs/scene";
  65160. import { Plane } from "babylonjs/Maths/math.plane";
  65161. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65162. /**
  65163. * Creates a refraction texture used by refraction channel of the standard material.
  65164. * It is like a mirror but to see through a material.
  65165. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65166. */
  65167. export class RefractionTexture extends RenderTargetTexture {
  65168. /**
  65169. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65170. * 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.
  65171. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65172. */
  65173. refractionPlane: Plane;
  65174. /**
  65175. * Define how deep under the surface we should see.
  65176. */
  65177. depth: number;
  65178. /**
  65179. * Creates a refraction texture used by refraction channel of the standard material.
  65180. * It is like a mirror but to see through a material.
  65181. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65182. * @param name Define the texture name
  65183. * @param size Define the size of the underlying texture
  65184. * @param scene Define the scene the refraction belongs to
  65185. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65186. */
  65187. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65188. /**
  65189. * Clone the refraction texture.
  65190. * @returns the cloned texture
  65191. */
  65192. clone(): RefractionTexture;
  65193. /**
  65194. * Serialize the texture to a JSON representation you could use in Parse later on
  65195. * @returns the serialized JSON representation
  65196. */
  65197. serialize(): any;
  65198. }
  65199. }
  65200. declare module "babylonjs/Materials/Textures/index" {
  65201. export * from "babylonjs/Materials/Textures/baseTexture";
  65202. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65203. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65204. export * from "babylonjs/Materials/Textures/cubeTexture";
  65205. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65206. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65207. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65208. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65209. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65210. export * from "babylonjs/Materials/Textures/internalTexture";
  65211. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65212. export * from "babylonjs/Materials/Textures/Loaders/index";
  65213. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65214. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65215. export * from "babylonjs/Materials/Textures/Packer/index";
  65216. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65217. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65218. export * from "babylonjs/Materials/Textures/rawTexture";
  65219. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65220. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65221. export * from "babylonjs/Materials/Textures/refractionTexture";
  65222. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65223. export * from "babylonjs/Materials/Textures/texture";
  65224. export * from "babylonjs/Materials/Textures/videoTexture";
  65225. }
  65226. declare module "babylonjs/Materials/Node/Enums/index" {
  65227. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65228. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65229. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65230. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65231. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65232. }
  65233. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65234. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65235. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65236. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65237. import { Mesh } from "babylonjs/Meshes/mesh";
  65238. import { Effect } from "babylonjs/Materials/effect";
  65239. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65240. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65241. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65242. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65243. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65244. /**
  65245. * Block used to add support for vertex skinning (bones)
  65246. */
  65247. export class BonesBlock extends NodeMaterialBlock {
  65248. /**
  65249. * Creates a new BonesBlock
  65250. * @param name defines the block name
  65251. */
  65252. constructor(name: string);
  65253. /**
  65254. * Initialize the block and prepare the context for build
  65255. * @param state defines the state that will be used for the build
  65256. */
  65257. initialize(state: NodeMaterialBuildState): void;
  65258. /**
  65259. * Gets the current class name
  65260. * @returns the class name
  65261. */
  65262. getClassName(): string;
  65263. /**
  65264. * Gets the matrix indices input component
  65265. */
  65266. get matricesIndices(): NodeMaterialConnectionPoint;
  65267. /**
  65268. * Gets the matrix weights input component
  65269. */
  65270. get matricesWeights(): NodeMaterialConnectionPoint;
  65271. /**
  65272. * Gets the extra matrix indices input component
  65273. */
  65274. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65275. /**
  65276. * Gets the extra matrix weights input component
  65277. */
  65278. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65279. /**
  65280. * Gets the world input component
  65281. */
  65282. get world(): NodeMaterialConnectionPoint;
  65283. /**
  65284. * Gets the output component
  65285. */
  65286. get output(): NodeMaterialConnectionPoint;
  65287. autoConfigure(material: NodeMaterial): void;
  65288. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65289. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65290. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65291. protected _buildBlock(state: NodeMaterialBuildState): this;
  65292. }
  65293. }
  65294. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65295. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65296. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65297. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65298. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65299. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65300. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65301. /**
  65302. * Block used to add support for instances
  65303. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65304. */
  65305. export class InstancesBlock extends NodeMaterialBlock {
  65306. /**
  65307. * Creates a new InstancesBlock
  65308. * @param name defines the block name
  65309. */
  65310. constructor(name: string);
  65311. /**
  65312. * Gets the current class name
  65313. * @returns the class name
  65314. */
  65315. getClassName(): string;
  65316. /**
  65317. * Gets the first world row input component
  65318. */
  65319. get world0(): NodeMaterialConnectionPoint;
  65320. /**
  65321. * Gets the second world row input component
  65322. */
  65323. get world1(): NodeMaterialConnectionPoint;
  65324. /**
  65325. * Gets the third world row input component
  65326. */
  65327. get world2(): NodeMaterialConnectionPoint;
  65328. /**
  65329. * Gets the forth world row input component
  65330. */
  65331. get world3(): NodeMaterialConnectionPoint;
  65332. /**
  65333. * Gets the world input component
  65334. */
  65335. get world(): NodeMaterialConnectionPoint;
  65336. /**
  65337. * Gets the output component
  65338. */
  65339. get output(): NodeMaterialConnectionPoint;
  65340. /**
  65341. * Gets the isntanceID component
  65342. */
  65343. get instanceID(): NodeMaterialConnectionPoint;
  65344. autoConfigure(material: NodeMaterial): void;
  65345. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65346. protected _buildBlock(state: NodeMaterialBuildState): this;
  65347. }
  65348. }
  65349. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65350. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65351. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65352. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65353. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65354. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65355. import { Effect } from "babylonjs/Materials/effect";
  65356. import { Mesh } from "babylonjs/Meshes/mesh";
  65357. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65358. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65359. /**
  65360. * Block used to add morph targets support to vertex shader
  65361. */
  65362. export class MorphTargetsBlock extends NodeMaterialBlock {
  65363. private _repeatableContentAnchor;
  65364. /**
  65365. * Create a new MorphTargetsBlock
  65366. * @param name defines the block name
  65367. */
  65368. constructor(name: string);
  65369. /**
  65370. * Gets the current class name
  65371. * @returns the class name
  65372. */
  65373. getClassName(): string;
  65374. /**
  65375. * Gets the position input component
  65376. */
  65377. get position(): NodeMaterialConnectionPoint;
  65378. /**
  65379. * Gets the normal input component
  65380. */
  65381. get normal(): NodeMaterialConnectionPoint;
  65382. /**
  65383. * Gets the tangent input component
  65384. */
  65385. get tangent(): NodeMaterialConnectionPoint;
  65386. /**
  65387. * Gets the tangent input component
  65388. */
  65389. get uv(): NodeMaterialConnectionPoint;
  65390. /**
  65391. * Gets the position output component
  65392. */
  65393. get positionOutput(): NodeMaterialConnectionPoint;
  65394. /**
  65395. * Gets the normal output component
  65396. */
  65397. get normalOutput(): NodeMaterialConnectionPoint;
  65398. /**
  65399. * Gets the tangent output component
  65400. */
  65401. get tangentOutput(): NodeMaterialConnectionPoint;
  65402. /**
  65403. * Gets the tangent output component
  65404. */
  65405. get uvOutput(): NodeMaterialConnectionPoint;
  65406. initialize(state: NodeMaterialBuildState): void;
  65407. autoConfigure(material: NodeMaterial): void;
  65408. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65409. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65410. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65411. protected _buildBlock(state: NodeMaterialBuildState): this;
  65412. }
  65413. }
  65414. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65415. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65416. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65417. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65418. import { Nullable } from "babylonjs/types";
  65419. import { Scene } from "babylonjs/scene";
  65420. import { Effect } from "babylonjs/Materials/effect";
  65421. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65422. import { Mesh } from "babylonjs/Meshes/mesh";
  65423. import { Light } from "babylonjs/Lights/light";
  65424. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65425. /**
  65426. * Block used to get data information from a light
  65427. */
  65428. export class LightInformationBlock extends NodeMaterialBlock {
  65429. private _lightDataUniformName;
  65430. private _lightColorUniformName;
  65431. private _lightTypeDefineName;
  65432. /**
  65433. * Gets or sets the light associated with this block
  65434. */
  65435. light: Nullable<Light>;
  65436. /**
  65437. * Creates a new LightInformationBlock
  65438. * @param name defines the block name
  65439. */
  65440. constructor(name: string);
  65441. /**
  65442. * Gets the current class name
  65443. * @returns the class name
  65444. */
  65445. getClassName(): string;
  65446. /**
  65447. * Gets the world position input component
  65448. */
  65449. get worldPosition(): NodeMaterialConnectionPoint;
  65450. /**
  65451. * Gets the direction output component
  65452. */
  65453. get direction(): NodeMaterialConnectionPoint;
  65454. /**
  65455. * Gets the direction output component
  65456. */
  65457. get color(): NodeMaterialConnectionPoint;
  65458. /**
  65459. * Gets the direction output component
  65460. */
  65461. get intensity(): NodeMaterialConnectionPoint;
  65462. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65463. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65464. protected _buildBlock(state: NodeMaterialBuildState): this;
  65465. serialize(): any;
  65466. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65467. }
  65468. }
  65469. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65470. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65471. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65472. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65473. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65474. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65475. }
  65476. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65477. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65478. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65479. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65480. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65481. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65482. import { Effect } from "babylonjs/Materials/effect";
  65483. import { Mesh } from "babylonjs/Meshes/mesh";
  65484. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65485. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65486. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65487. /**
  65488. * Block used to add image processing support to fragment shader
  65489. */
  65490. export class ImageProcessingBlock extends NodeMaterialBlock {
  65491. /**
  65492. * Create a new ImageProcessingBlock
  65493. * @param name defines the block name
  65494. */
  65495. constructor(name: string);
  65496. /**
  65497. * Gets the current class name
  65498. * @returns the class name
  65499. */
  65500. getClassName(): string;
  65501. /**
  65502. * Gets the color input component
  65503. */
  65504. get color(): NodeMaterialConnectionPoint;
  65505. /**
  65506. * Gets the output component
  65507. */
  65508. get output(): NodeMaterialConnectionPoint;
  65509. /**
  65510. * Initialize the block and prepare the context for build
  65511. * @param state defines the state that will be used for the build
  65512. */
  65513. initialize(state: NodeMaterialBuildState): void;
  65514. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65515. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65516. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65517. protected _buildBlock(state: NodeMaterialBuildState): this;
  65518. }
  65519. }
  65520. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65521. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65522. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65523. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65524. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65525. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65526. import { Effect } from "babylonjs/Materials/effect";
  65527. import { Mesh } from "babylonjs/Meshes/mesh";
  65528. import { Scene } from "babylonjs/scene";
  65529. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65530. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65531. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65532. /**
  65533. * Block used to pertub normals based on a normal map
  65534. */
  65535. export class PerturbNormalBlock extends NodeMaterialBlock {
  65536. private _tangentSpaceParameterName;
  65537. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65538. invertX: boolean;
  65539. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65540. invertY: boolean;
  65541. /**
  65542. * Create a new PerturbNormalBlock
  65543. * @param name defines the block name
  65544. */
  65545. constructor(name: string);
  65546. /**
  65547. * Gets the current class name
  65548. * @returns the class name
  65549. */
  65550. getClassName(): string;
  65551. /**
  65552. * Gets the world position input component
  65553. */
  65554. get worldPosition(): NodeMaterialConnectionPoint;
  65555. /**
  65556. * Gets the world normal input component
  65557. */
  65558. get worldNormal(): NodeMaterialConnectionPoint;
  65559. /**
  65560. * Gets the world tangent input component
  65561. */
  65562. get worldTangent(): NodeMaterialConnectionPoint;
  65563. /**
  65564. * Gets the uv input component
  65565. */
  65566. get uv(): NodeMaterialConnectionPoint;
  65567. /**
  65568. * Gets the normal map color input component
  65569. */
  65570. get normalMapColor(): NodeMaterialConnectionPoint;
  65571. /**
  65572. * Gets the strength input component
  65573. */
  65574. get strength(): NodeMaterialConnectionPoint;
  65575. /**
  65576. * Gets the output component
  65577. */
  65578. get output(): NodeMaterialConnectionPoint;
  65579. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65580. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65581. autoConfigure(material: NodeMaterial): void;
  65582. protected _buildBlock(state: NodeMaterialBuildState): this;
  65583. protected _dumpPropertiesCode(): string;
  65584. serialize(): any;
  65585. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65586. }
  65587. }
  65588. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65590. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65592. /**
  65593. * Block used to discard a pixel if a value is smaller than a cutoff
  65594. */
  65595. export class DiscardBlock extends NodeMaterialBlock {
  65596. /**
  65597. * Create a new DiscardBlock
  65598. * @param name defines the block name
  65599. */
  65600. constructor(name: string);
  65601. /**
  65602. * Gets the current class name
  65603. * @returns the class name
  65604. */
  65605. getClassName(): string;
  65606. /**
  65607. * Gets the color input component
  65608. */
  65609. get value(): NodeMaterialConnectionPoint;
  65610. /**
  65611. * Gets the cutoff input component
  65612. */
  65613. get cutoff(): NodeMaterialConnectionPoint;
  65614. protected _buildBlock(state: NodeMaterialBuildState): this;
  65615. }
  65616. }
  65617. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65618. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65619. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65620. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65621. /**
  65622. * Block used to test if the fragment shader is front facing
  65623. */
  65624. export class FrontFacingBlock extends NodeMaterialBlock {
  65625. /**
  65626. * Creates a new FrontFacingBlock
  65627. * @param name defines the block name
  65628. */
  65629. constructor(name: string);
  65630. /**
  65631. * Gets the current class name
  65632. * @returns the class name
  65633. */
  65634. getClassName(): string;
  65635. /**
  65636. * Gets the output component
  65637. */
  65638. get output(): NodeMaterialConnectionPoint;
  65639. protected _buildBlock(state: NodeMaterialBuildState): this;
  65640. }
  65641. }
  65642. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65643. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65644. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65645. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65646. /**
  65647. * Block used to get the derivative value on x and y of a given input
  65648. */
  65649. export class DerivativeBlock extends NodeMaterialBlock {
  65650. /**
  65651. * Create a new DerivativeBlock
  65652. * @param name defines the block name
  65653. */
  65654. constructor(name: string);
  65655. /**
  65656. * Gets the current class name
  65657. * @returns the class name
  65658. */
  65659. getClassName(): string;
  65660. /**
  65661. * Gets the input component
  65662. */
  65663. get input(): NodeMaterialConnectionPoint;
  65664. /**
  65665. * Gets the derivative output on x
  65666. */
  65667. get dx(): NodeMaterialConnectionPoint;
  65668. /**
  65669. * Gets the derivative output on y
  65670. */
  65671. get dy(): NodeMaterialConnectionPoint;
  65672. protected _buildBlock(state: NodeMaterialBuildState): this;
  65673. }
  65674. }
  65675. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65676. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65677. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65678. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65679. /**
  65680. * Block used to make gl_FragCoord available
  65681. */
  65682. export class FragCoordBlock extends NodeMaterialBlock {
  65683. /**
  65684. * Creates a new FragCoordBlock
  65685. * @param name defines the block name
  65686. */
  65687. constructor(name: string);
  65688. /**
  65689. * Gets the current class name
  65690. * @returns the class name
  65691. */
  65692. getClassName(): string;
  65693. /**
  65694. * Gets the xy component
  65695. */
  65696. get xy(): NodeMaterialConnectionPoint;
  65697. /**
  65698. * Gets the xyz component
  65699. */
  65700. get xyz(): NodeMaterialConnectionPoint;
  65701. /**
  65702. * Gets the xyzw component
  65703. */
  65704. get xyzw(): NodeMaterialConnectionPoint;
  65705. /**
  65706. * Gets the x component
  65707. */
  65708. get x(): NodeMaterialConnectionPoint;
  65709. /**
  65710. * Gets the y component
  65711. */
  65712. get y(): NodeMaterialConnectionPoint;
  65713. /**
  65714. * Gets the z component
  65715. */
  65716. get z(): NodeMaterialConnectionPoint;
  65717. /**
  65718. * Gets the w component
  65719. */
  65720. get output(): NodeMaterialConnectionPoint;
  65721. protected writeOutputs(state: NodeMaterialBuildState): string;
  65722. protected _buildBlock(state: NodeMaterialBuildState): this;
  65723. }
  65724. }
  65725. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65726. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65727. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65728. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65729. import { Effect } from "babylonjs/Materials/effect";
  65730. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65731. import { Mesh } from "babylonjs/Meshes/mesh";
  65732. /**
  65733. * Block used to get the screen sizes
  65734. */
  65735. export class ScreenSizeBlock extends NodeMaterialBlock {
  65736. private _varName;
  65737. private _scene;
  65738. /**
  65739. * Creates a new ScreenSizeBlock
  65740. * @param name defines the block name
  65741. */
  65742. constructor(name: string);
  65743. /**
  65744. * Gets the current class name
  65745. * @returns the class name
  65746. */
  65747. getClassName(): string;
  65748. /**
  65749. * Gets the xy component
  65750. */
  65751. get xy(): NodeMaterialConnectionPoint;
  65752. /**
  65753. * Gets the x component
  65754. */
  65755. get x(): NodeMaterialConnectionPoint;
  65756. /**
  65757. * Gets the y component
  65758. */
  65759. get y(): NodeMaterialConnectionPoint;
  65760. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65761. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65762. protected _buildBlock(state: NodeMaterialBuildState): this;
  65763. }
  65764. }
  65765. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65766. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65767. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65768. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65769. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65770. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65771. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65772. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65773. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65774. }
  65775. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65776. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65777. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65778. import { Mesh } from "babylonjs/Meshes/mesh";
  65779. import { Effect } from "babylonjs/Materials/effect";
  65780. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65781. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65782. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65783. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65784. /**
  65785. * Block used to add support for scene fog
  65786. */
  65787. export class FogBlock extends NodeMaterialBlock {
  65788. private _fogDistanceName;
  65789. private _fogParameters;
  65790. /**
  65791. * Create a new FogBlock
  65792. * @param name defines the block name
  65793. */
  65794. constructor(name: string);
  65795. /**
  65796. * Gets the current class name
  65797. * @returns the class name
  65798. */
  65799. getClassName(): string;
  65800. /**
  65801. * Gets the world position input component
  65802. */
  65803. get worldPosition(): NodeMaterialConnectionPoint;
  65804. /**
  65805. * Gets the view input component
  65806. */
  65807. get view(): NodeMaterialConnectionPoint;
  65808. /**
  65809. * Gets the color input component
  65810. */
  65811. get input(): NodeMaterialConnectionPoint;
  65812. /**
  65813. * Gets the fog color input component
  65814. */
  65815. get fogColor(): NodeMaterialConnectionPoint;
  65816. /**
  65817. * Gets the output component
  65818. */
  65819. get output(): NodeMaterialConnectionPoint;
  65820. autoConfigure(material: NodeMaterial): void;
  65821. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65822. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65823. protected _buildBlock(state: NodeMaterialBuildState): this;
  65824. }
  65825. }
  65826. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65827. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65828. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65829. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65830. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65831. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65832. import { Effect } from "babylonjs/Materials/effect";
  65833. import { Mesh } from "babylonjs/Meshes/mesh";
  65834. import { Light } from "babylonjs/Lights/light";
  65835. import { Nullable } from "babylonjs/types";
  65836. import { Scene } from "babylonjs/scene";
  65837. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65838. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65839. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65840. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65841. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65842. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65843. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65844. /**
  65845. * Block used to add light in the fragment shader
  65846. */
  65847. export class LightBlock extends NodeMaterialBlock {
  65848. private _lightId;
  65849. /**
  65850. * Gets or sets the light associated with this block
  65851. */
  65852. light: Nullable<Light>;
  65853. /**
  65854. * Create a new LightBlock
  65855. * @param name defines the block name
  65856. */
  65857. constructor(name: string);
  65858. /**
  65859. * Gets the current class name
  65860. * @returns the class name
  65861. */
  65862. getClassName(): string;
  65863. /**
  65864. * Gets the world position input component
  65865. */
  65866. get worldPosition(): NodeMaterialConnectionPoint;
  65867. /**
  65868. * Gets the world normal input component
  65869. */
  65870. get worldNormal(): NodeMaterialConnectionPoint;
  65871. /**
  65872. * Gets the camera (or eye) position component
  65873. */
  65874. get cameraPosition(): NodeMaterialConnectionPoint;
  65875. /**
  65876. * Gets the glossiness component
  65877. */
  65878. get glossiness(): NodeMaterialConnectionPoint;
  65879. /**
  65880. * Gets the glossinness power component
  65881. */
  65882. get glossPower(): NodeMaterialConnectionPoint;
  65883. /**
  65884. * Gets the diffuse color component
  65885. */
  65886. get diffuseColor(): NodeMaterialConnectionPoint;
  65887. /**
  65888. * Gets the specular color component
  65889. */
  65890. get specularColor(): NodeMaterialConnectionPoint;
  65891. /**
  65892. * Gets the diffuse output component
  65893. */
  65894. get diffuseOutput(): NodeMaterialConnectionPoint;
  65895. /**
  65896. * Gets the specular output component
  65897. */
  65898. get specularOutput(): NodeMaterialConnectionPoint;
  65899. /**
  65900. * Gets the shadow output component
  65901. */
  65902. get shadow(): NodeMaterialConnectionPoint;
  65903. autoConfigure(material: NodeMaterial): void;
  65904. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65905. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65906. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65907. private _injectVertexCode;
  65908. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65909. serialize(): any;
  65910. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65911. }
  65912. }
  65913. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65916. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65917. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65918. /**
  65919. * Block used to read a reflection texture from a sampler
  65920. */
  65921. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65922. /**
  65923. * Create a new ReflectionTextureBlock
  65924. * @param name defines the block name
  65925. */
  65926. constructor(name: string);
  65927. /**
  65928. * Gets the current class name
  65929. * @returns the class name
  65930. */
  65931. getClassName(): string;
  65932. /**
  65933. * Gets the world position input component
  65934. */
  65935. get position(): NodeMaterialConnectionPoint;
  65936. /**
  65937. * Gets the world position input component
  65938. */
  65939. get worldPosition(): NodeMaterialConnectionPoint;
  65940. /**
  65941. * Gets the world normal input component
  65942. */
  65943. get worldNormal(): NodeMaterialConnectionPoint;
  65944. /**
  65945. * Gets the world input component
  65946. */
  65947. get world(): NodeMaterialConnectionPoint;
  65948. /**
  65949. * Gets the camera (or eye) position component
  65950. */
  65951. get cameraPosition(): NodeMaterialConnectionPoint;
  65952. /**
  65953. * Gets the view input component
  65954. */
  65955. get view(): NodeMaterialConnectionPoint;
  65956. /**
  65957. * Gets the rgb output component
  65958. */
  65959. get rgb(): NodeMaterialConnectionPoint;
  65960. /**
  65961. * Gets the rgba output component
  65962. */
  65963. get rgba(): NodeMaterialConnectionPoint;
  65964. /**
  65965. * Gets the r output component
  65966. */
  65967. get r(): NodeMaterialConnectionPoint;
  65968. /**
  65969. * Gets the g output component
  65970. */
  65971. get g(): NodeMaterialConnectionPoint;
  65972. /**
  65973. * Gets the b output component
  65974. */
  65975. get b(): NodeMaterialConnectionPoint;
  65976. /**
  65977. * Gets the a output component
  65978. */
  65979. get a(): NodeMaterialConnectionPoint;
  65980. autoConfigure(material: NodeMaterial): void;
  65981. protected _buildBlock(state: NodeMaterialBuildState): this;
  65982. }
  65983. }
  65984. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65985. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65986. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65987. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65988. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65989. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65990. }
  65991. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65992. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65993. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65994. }
  65995. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65996. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65997. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65998. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65999. /**
  66000. * Block used to add 2 vectors
  66001. */
  66002. export class AddBlock extends NodeMaterialBlock {
  66003. /**
  66004. * Creates a new AddBlock
  66005. * @param name defines the block name
  66006. */
  66007. constructor(name: string);
  66008. /**
  66009. * Gets the current class name
  66010. * @returns the class name
  66011. */
  66012. getClassName(): string;
  66013. /**
  66014. * Gets the left operand input component
  66015. */
  66016. get left(): NodeMaterialConnectionPoint;
  66017. /**
  66018. * Gets the right operand input component
  66019. */
  66020. get right(): NodeMaterialConnectionPoint;
  66021. /**
  66022. * Gets the output component
  66023. */
  66024. get output(): NodeMaterialConnectionPoint;
  66025. protected _buildBlock(state: NodeMaterialBuildState): this;
  66026. }
  66027. }
  66028. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  66029. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66030. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66031. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66032. /**
  66033. * Block used to scale a vector by a float
  66034. */
  66035. export class ScaleBlock extends NodeMaterialBlock {
  66036. /**
  66037. * Creates a new ScaleBlock
  66038. * @param name defines the block name
  66039. */
  66040. constructor(name: string);
  66041. /**
  66042. * Gets the current class name
  66043. * @returns the class name
  66044. */
  66045. getClassName(): string;
  66046. /**
  66047. * Gets the input component
  66048. */
  66049. get input(): NodeMaterialConnectionPoint;
  66050. /**
  66051. * Gets the factor input component
  66052. */
  66053. get factor(): NodeMaterialConnectionPoint;
  66054. /**
  66055. * Gets the output component
  66056. */
  66057. get output(): NodeMaterialConnectionPoint;
  66058. protected _buildBlock(state: NodeMaterialBuildState): this;
  66059. }
  66060. }
  66061. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  66062. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66063. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66064. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66065. import { Scene } from "babylonjs/scene";
  66066. /**
  66067. * Block used to clamp a float
  66068. */
  66069. export class ClampBlock extends NodeMaterialBlock {
  66070. /** Gets or sets the minimum range */
  66071. minimum: number;
  66072. /** Gets or sets the maximum range */
  66073. maximum: number;
  66074. /**
  66075. * Creates a new ClampBlock
  66076. * @param name defines the block name
  66077. */
  66078. constructor(name: string);
  66079. /**
  66080. * Gets the current class name
  66081. * @returns the class name
  66082. */
  66083. getClassName(): string;
  66084. /**
  66085. * Gets the value input component
  66086. */
  66087. get value(): NodeMaterialConnectionPoint;
  66088. /**
  66089. * Gets the output component
  66090. */
  66091. get output(): NodeMaterialConnectionPoint;
  66092. protected _buildBlock(state: NodeMaterialBuildState): this;
  66093. protected _dumpPropertiesCode(): string;
  66094. serialize(): any;
  66095. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66096. }
  66097. }
  66098. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66099. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66100. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66101. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66102. /**
  66103. * Block used to apply a cross product between 2 vectors
  66104. */
  66105. export class CrossBlock extends NodeMaterialBlock {
  66106. /**
  66107. * Creates a new CrossBlock
  66108. * @param name defines the block name
  66109. */
  66110. constructor(name: string);
  66111. /**
  66112. * Gets the current class name
  66113. * @returns the class name
  66114. */
  66115. getClassName(): string;
  66116. /**
  66117. * Gets the left operand input component
  66118. */
  66119. get left(): NodeMaterialConnectionPoint;
  66120. /**
  66121. * Gets the right operand input component
  66122. */
  66123. get right(): NodeMaterialConnectionPoint;
  66124. /**
  66125. * Gets the output component
  66126. */
  66127. get output(): NodeMaterialConnectionPoint;
  66128. protected _buildBlock(state: NodeMaterialBuildState): this;
  66129. }
  66130. }
  66131. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66132. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66133. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66134. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66135. /**
  66136. * Block used to apply a dot product between 2 vectors
  66137. */
  66138. export class DotBlock extends NodeMaterialBlock {
  66139. /**
  66140. * Creates a new DotBlock
  66141. * @param name defines the block name
  66142. */
  66143. constructor(name: string);
  66144. /**
  66145. * Gets the current class name
  66146. * @returns the class name
  66147. */
  66148. getClassName(): string;
  66149. /**
  66150. * Gets the left operand input component
  66151. */
  66152. get left(): NodeMaterialConnectionPoint;
  66153. /**
  66154. * Gets the right operand input component
  66155. */
  66156. get right(): NodeMaterialConnectionPoint;
  66157. /**
  66158. * Gets the output component
  66159. */
  66160. get output(): NodeMaterialConnectionPoint;
  66161. protected _buildBlock(state: NodeMaterialBuildState): this;
  66162. }
  66163. }
  66164. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66165. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66166. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66167. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66168. /**
  66169. * Block used to normalize a vector
  66170. */
  66171. export class NormalizeBlock extends NodeMaterialBlock {
  66172. /**
  66173. * Creates a new NormalizeBlock
  66174. * @param name defines the block name
  66175. */
  66176. constructor(name: string);
  66177. /**
  66178. * Gets the current class name
  66179. * @returns the class name
  66180. */
  66181. getClassName(): string;
  66182. /**
  66183. * Gets the input component
  66184. */
  66185. get input(): NodeMaterialConnectionPoint;
  66186. /**
  66187. * Gets the output component
  66188. */
  66189. get output(): NodeMaterialConnectionPoint;
  66190. protected _buildBlock(state: NodeMaterialBuildState): this;
  66191. }
  66192. }
  66193. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66194. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66195. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66196. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66197. import { Scene } from "babylonjs/scene";
  66198. /**
  66199. * Operations supported by the Trigonometry block
  66200. */
  66201. export enum TrigonometryBlockOperations {
  66202. /** Cos */
  66203. Cos = 0,
  66204. /** Sin */
  66205. Sin = 1,
  66206. /** Abs */
  66207. Abs = 2,
  66208. /** Exp */
  66209. Exp = 3,
  66210. /** Exp2 */
  66211. Exp2 = 4,
  66212. /** Round */
  66213. Round = 5,
  66214. /** Floor */
  66215. Floor = 6,
  66216. /** Ceiling */
  66217. Ceiling = 7,
  66218. /** Square root */
  66219. Sqrt = 8,
  66220. /** Log */
  66221. Log = 9,
  66222. /** Tangent */
  66223. Tan = 10,
  66224. /** Arc tangent */
  66225. ArcTan = 11,
  66226. /** Arc cosinus */
  66227. ArcCos = 12,
  66228. /** Arc sinus */
  66229. ArcSin = 13,
  66230. /** Fraction */
  66231. Fract = 14,
  66232. /** Sign */
  66233. Sign = 15,
  66234. /** To radians (from degrees) */
  66235. Radians = 16,
  66236. /** To degrees (from radians) */
  66237. Degrees = 17
  66238. }
  66239. /**
  66240. * Block used to apply trigonometry operation to floats
  66241. */
  66242. export class TrigonometryBlock extends NodeMaterialBlock {
  66243. /**
  66244. * Gets or sets the operation applied by the block
  66245. */
  66246. operation: TrigonometryBlockOperations;
  66247. /**
  66248. * Creates a new TrigonometryBlock
  66249. * @param name defines the block name
  66250. */
  66251. constructor(name: string);
  66252. /**
  66253. * Gets the current class name
  66254. * @returns the class name
  66255. */
  66256. getClassName(): string;
  66257. /**
  66258. * Gets the input component
  66259. */
  66260. get input(): NodeMaterialConnectionPoint;
  66261. /**
  66262. * Gets the output component
  66263. */
  66264. get output(): NodeMaterialConnectionPoint;
  66265. protected _buildBlock(state: NodeMaterialBuildState): this;
  66266. serialize(): any;
  66267. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66268. protected _dumpPropertiesCode(): string;
  66269. }
  66270. }
  66271. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66272. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66273. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66274. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66275. /**
  66276. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66277. */
  66278. export class ColorMergerBlock extends NodeMaterialBlock {
  66279. /**
  66280. * Create a new ColorMergerBlock
  66281. * @param name defines the block name
  66282. */
  66283. constructor(name: string);
  66284. /**
  66285. * Gets the current class name
  66286. * @returns the class name
  66287. */
  66288. getClassName(): string;
  66289. /**
  66290. * Gets the rgb component (input)
  66291. */
  66292. get rgbIn(): NodeMaterialConnectionPoint;
  66293. /**
  66294. * Gets the r component (input)
  66295. */
  66296. get r(): NodeMaterialConnectionPoint;
  66297. /**
  66298. * Gets the g component (input)
  66299. */
  66300. get g(): NodeMaterialConnectionPoint;
  66301. /**
  66302. * Gets the b component (input)
  66303. */
  66304. get b(): NodeMaterialConnectionPoint;
  66305. /**
  66306. * Gets the a component (input)
  66307. */
  66308. get a(): NodeMaterialConnectionPoint;
  66309. /**
  66310. * Gets the rgba component (output)
  66311. */
  66312. get rgba(): NodeMaterialConnectionPoint;
  66313. /**
  66314. * Gets the rgb component (output)
  66315. */
  66316. get rgbOut(): NodeMaterialConnectionPoint;
  66317. /**
  66318. * Gets the rgb component (output)
  66319. * @deprecated Please use rgbOut instead.
  66320. */
  66321. get rgb(): NodeMaterialConnectionPoint;
  66322. protected _buildBlock(state: NodeMaterialBuildState): this;
  66323. }
  66324. }
  66325. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66329. /**
  66330. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66331. */
  66332. export class VectorSplitterBlock extends NodeMaterialBlock {
  66333. /**
  66334. * Create a new VectorSplitterBlock
  66335. * @param name defines the block name
  66336. */
  66337. constructor(name: string);
  66338. /**
  66339. * Gets the current class name
  66340. * @returns the class name
  66341. */
  66342. getClassName(): string;
  66343. /**
  66344. * Gets the xyzw component (input)
  66345. */
  66346. get xyzw(): NodeMaterialConnectionPoint;
  66347. /**
  66348. * Gets the xyz component (input)
  66349. */
  66350. get xyzIn(): NodeMaterialConnectionPoint;
  66351. /**
  66352. * Gets the xy component (input)
  66353. */
  66354. get xyIn(): NodeMaterialConnectionPoint;
  66355. /**
  66356. * Gets the xyz component (output)
  66357. */
  66358. get xyzOut(): NodeMaterialConnectionPoint;
  66359. /**
  66360. * Gets the xy component (output)
  66361. */
  66362. get xyOut(): NodeMaterialConnectionPoint;
  66363. /**
  66364. * Gets the x component (output)
  66365. */
  66366. get x(): NodeMaterialConnectionPoint;
  66367. /**
  66368. * Gets the y component (output)
  66369. */
  66370. get y(): NodeMaterialConnectionPoint;
  66371. /**
  66372. * Gets the z component (output)
  66373. */
  66374. get z(): NodeMaterialConnectionPoint;
  66375. /**
  66376. * Gets the w component (output)
  66377. */
  66378. get w(): NodeMaterialConnectionPoint;
  66379. protected _inputRename(name: string): string;
  66380. protected _outputRename(name: string): string;
  66381. protected _buildBlock(state: NodeMaterialBuildState): this;
  66382. }
  66383. }
  66384. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66385. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66386. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66387. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66388. /**
  66389. * Block used to lerp between 2 values
  66390. */
  66391. export class LerpBlock extends NodeMaterialBlock {
  66392. /**
  66393. * Creates a new LerpBlock
  66394. * @param name defines the block name
  66395. */
  66396. constructor(name: string);
  66397. /**
  66398. * Gets the current class name
  66399. * @returns the class name
  66400. */
  66401. getClassName(): string;
  66402. /**
  66403. * Gets the left operand input component
  66404. */
  66405. get left(): NodeMaterialConnectionPoint;
  66406. /**
  66407. * Gets the right operand input component
  66408. */
  66409. get right(): NodeMaterialConnectionPoint;
  66410. /**
  66411. * Gets the gradient operand input component
  66412. */
  66413. get gradient(): NodeMaterialConnectionPoint;
  66414. /**
  66415. * Gets the output component
  66416. */
  66417. get output(): NodeMaterialConnectionPoint;
  66418. protected _buildBlock(state: NodeMaterialBuildState): this;
  66419. }
  66420. }
  66421. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66422. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66423. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66424. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66425. /**
  66426. * Block used to divide 2 vectors
  66427. */
  66428. export class DivideBlock extends NodeMaterialBlock {
  66429. /**
  66430. * Creates a new DivideBlock
  66431. * @param name defines the block name
  66432. */
  66433. constructor(name: string);
  66434. /**
  66435. * Gets the current class name
  66436. * @returns the class name
  66437. */
  66438. getClassName(): string;
  66439. /**
  66440. * Gets the left operand input component
  66441. */
  66442. get left(): NodeMaterialConnectionPoint;
  66443. /**
  66444. * Gets the right operand input component
  66445. */
  66446. get right(): NodeMaterialConnectionPoint;
  66447. /**
  66448. * Gets the output component
  66449. */
  66450. get output(): NodeMaterialConnectionPoint;
  66451. protected _buildBlock(state: NodeMaterialBuildState): this;
  66452. }
  66453. }
  66454. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66455. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66456. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66457. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66458. /**
  66459. * Block used to subtract 2 vectors
  66460. */
  66461. export class SubtractBlock extends NodeMaterialBlock {
  66462. /**
  66463. * Creates a new SubtractBlock
  66464. * @param name defines the block name
  66465. */
  66466. constructor(name: string);
  66467. /**
  66468. * Gets the current class name
  66469. * @returns the class name
  66470. */
  66471. getClassName(): string;
  66472. /**
  66473. * Gets the left operand input component
  66474. */
  66475. get left(): NodeMaterialConnectionPoint;
  66476. /**
  66477. * Gets the right operand input component
  66478. */
  66479. get right(): NodeMaterialConnectionPoint;
  66480. /**
  66481. * Gets the output component
  66482. */
  66483. get output(): NodeMaterialConnectionPoint;
  66484. protected _buildBlock(state: NodeMaterialBuildState): this;
  66485. }
  66486. }
  66487. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66488. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66489. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66490. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66491. /**
  66492. * Block used to step a value
  66493. */
  66494. export class StepBlock extends NodeMaterialBlock {
  66495. /**
  66496. * Creates a new StepBlock
  66497. * @param name defines the block name
  66498. */
  66499. constructor(name: string);
  66500. /**
  66501. * Gets the current class name
  66502. * @returns the class name
  66503. */
  66504. getClassName(): string;
  66505. /**
  66506. * Gets the value operand input component
  66507. */
  66508. get value(): NodeMaterialConnectionPoint;
  66509. /**
  66510. * Gets the edge operand input component
  66511. */
  66512. get edge(): NodeMaterialConnectionPoint;
  66513. /**
  66514. * Gets the output component
  66515. */
  66516. get output(): NodeMaterialConnectionPoint;
  66517. protected _buildBlock(state: NodeMaterialBuildState): this;
  66518. }
  66519. }
  66520. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66521. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66522. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66523. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66524. /**
  66525. * Block used to get the opposite (1 - x) of a value
  66526. */
  66527. export class OneMinusBlock extends NodeMaterialBlock {
  66528. /**
  66529. * Creates a new OneMinusBlock
  66530. * @param name defines the block name
  66531. */
  66532. constructor(name: string);
  66533. /**
  66534. * Gets the current class name
  66535. * @returns the class name
  66536. */
  66537. getClassName(): string;
  66538. /**
  66539. * Gets the input component
  66540. */
  66541. get input(): NodeMaterialConnectionPoint;
  66542. /**
  66543. * Gets the output component
  66544. */
  66545. get output(): NodeMaterialConnectionPoint;
  66546. protected _buildBlock(state: NodeMaterialBuildState): this;
  66547. }
  66548. }
  66549. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66550. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66551. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66552. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66553. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66554. /**
  66555. * Block used to get the view direction
  66556. */
  66557. export class ViewDirectionBlock extends NodeMaterialBlock {
  66558. /**
  66559. * Creates a new ViewDirectionBlock
  66560. * @param name defines the block name
  66561. */
  66562. constructor(name: string);
  66563. /**
  66564. * Gets the current class name
  66565. * @returns the class name
  66566. */
  66567. getClassName(): string;
  66568. /**
  66569. * Gets the world position component
  66570. */
  66571. get worldPosition(): NodeMaterialConnectionPoint;
  66572. /**
  66573. * Gets the camera position component
  66574. */
  66575. get cameraPosition(): NodeMaterialConnectionPoint;
  66576. /**
  66577. * Gets the output component
  66578. */
  66579. get output(): NodeMaterialConnectionPoint;
  66580. autoConfigure(material: NodeMaterial): void;
  66581. protected _buildBlock(state: NodeMaterialBuildState): this;
  66582. }
  66583. }
  66584. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66585. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66586. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66587. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66588. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66589. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66590. /**
  66591. * Block used to compute fresnel value
  66592. */
  66593. export class FresnelBlock extends NodeMaterialBlock {
  66594. /**
  66595. * Create a new FresnelBlock
  66596. * @param name defines the block name
  66597. */
  66598. constructor(name: string);
  66599. /**
  66600. * Gets the current class name
  66601. * @returns the class name
  66602. */
  66603. getClassName(): string;
  66604. /**
  66605. * Gets the world normal input component
  66606. */
  66607. get worldNormal(): NodeMaterialConnectionPoint;
  66608. /**
  66609. * Gets the view direction input component
  66610. */
  66611. get viewDirection(): NodeMaterialConnectionPoint;
  66612. /**
  66613. * Gets the bias input component
  66614. */
  66615. get bias(): NodeMaterialConnectionPoint;
  66616. /**
  66617. * Gets the camera (or eye) position component
  66618. */
  66619. get power(): NodeMaterialConnectionPoint;
  66620. /**
  66621. * Gets the fresnel output component
  66622. */
  66623. get fresnel(): NodeMaterialConnectionPoint;
  66624. autoConfigure(material: NodeMaterial): void;
  66625. protected _buildBlock(state: NodeMaterialBuildState): this;
  66626. }
  66627. }
  66628. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66629. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66630. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66631. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66632. /**
  66633. * Block used to get the max of 2 values
  66634. */
  66635. export class MaxBlock extends NodeMaterialBlock {
  66636. /**
  66637. * Creates a new MaxBlock
  66638. * @param name defines the block name
  66639. */
  66640. constructor(name: string);
  66641. /**
  66642. * Gets the current class name
  66643. * @returns the class name
  66644. */
  66645. getClassName(): string;
  66646. /**
  66647. * Gets the left operand input component
  66648. */
  66649. get left(): NodeMaterialConnectionPoint;
  66650. /**
  66651. * Gets the right operand input component
  66652. */
  66653. get right(): NodeMaterialConnectionPoint;
  66654. /**
  66655. * Gets the output component
  66656. */
  66657. get output(): NodeMaterialConnectionPoint;
  66658. protected _buildBlock(state: NodeMaterialBuildState): this;
  66659. }
  66660. }
  66661. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66662. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66663. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66664. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66665. /**
  66666. * Block used to get the min of 2 values
  66667. */
  66668. export class MinBlock extends NodeMaterialBlock {
  66669. /**
  66670. * Creates a new MinBlock
  66671. * @param name defines the block name
  66672. */
  66673. constructor(name: string);
  66674. /**
  66675. * Gets the current class name
  66676. * @returns the class name
  66677. */
  66678. getClassName(): string;
  66679. /**
  66680. * Gets the left operand input component
  66681. */
  66682. get left(): NodeMaterialConnectionPoint;
  66683. /**
  66684. * Gets the right operand input component
  66685. */
  66686. get right(): NodeMaterialConnectionPoint;
  66687. /**
  66688. * Gets the output component
  66689. */
  66690. get output(): NodeMaterialConnectionPoint;
  66691. protected _buildBlock(state: NodeMaterialBuildState): this;
  66692. }
  66693. }
  66694. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66695. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66696. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66697. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66698. /**
  66699. * Block used to get the distance between 2 values
  66700. */
  66701. export class DistanceBlock extends NodeMaterialBlock {
  66702. /**
  66703. * Creates a new DistanceBlock
  66704. * @param name defines the block name
  66705. */
  66706. constructor(name: string);
  66707. /**
  66708. * Gets the current class name
  66709. * @returns the class name
  66710. */
  66711. getClassName(): string;
  66712. /**
  66713. * Gets the left operand input component
  66714. */
  66715. get left(): NodeMaterialConnectionPoint;
  66716. /**
  66717. * Gets the right operand input component
  66718. */
  66719. get right(): NodeMaterialConnectionPoint;
  66720. /**
  66721. * Gets the output component
  66722. */
  66723. get output(): NodeMaterialConnectionPoint;
  66724. protected _buildBlock(state: NodeMaterialBuildState): this;
  66725. }
  66726. }
  66727. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66728. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66729. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66730. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66731. /**
  66732. * Block used to get the length of a vector
  66733. */
  66734. export class LengthBlock extends NodeMaterialBlock {
  66735. /**
  66736. * Creates a new LengthBlock
  66737. * @param name defines the block name
  66738. */
  66739. constructor(name: string);
  66740. /**
  66741. * Gets the current class name
  66742. * @returns the class name
  66743. */
  66744. getClassName(): string;
  66745. /**
  66746. * Gets the value input component
  66747. */
  66748. get value(): NodeMaterialConnectionPoint;
  66749. /**
  66750. * Gets the output component
  66751. */
  66752. get output(): NodeMaterialConnectionPoint;
  66753. protected _buildBlock(state: NodeMaterialBuildState): this;
  66754. }
  66755. }
  66756. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66757. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66758. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66759. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66760. /**
  66761. * Block used to get negative version of a value (i.e. x * -1)
  66762. */
  66763. export class NegateBlock extends NodeMaterialBlock {
  66764. /**
  66765. * Creates a new NegateBlock
  66766. * @param name defines the block name
  66767. */
  66768. constructor(name: string);
  66769. /**
  66770. * Gets the current class name
  66771. * @returns the class name
  66772. */
  66773. getClassName(): string;
  66774. /**
  66775. * Gets the value input component
  66776. */
  66777. get value(): NodeMaterialConnectionPoint;
  66778. /**
  66779. * Gets the output component
  66780. */
  66781. get output(): NodeMaterialConnectionPoint;
  66782. protected _buildBlock(state: NodeMaterialBuildState): this;
  66783. }
  66784. }
  66785. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66786. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66787. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66788. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66789. /**
  66790. * Block used to get the value of the first parameter raised to the power of the second
  66791. */
  66792. export class PowBlock extends NodeMaterialBlock {
  66793. /**
  66794. * Creates a new PowBlock
  66795. * @param name defines the block name
  66796. */
  66797. constructor(name: string);
  66798. /**
  66799. * Gets the current class name
  66800. * @returns the class name
  66801. */
  66802. getClassName(): string;
  66803. /**
  66804. * Gets the value operand input component
  66805. */
  66806. get value(): NodeMaterialConnectionPoint;
  66807. /**
  66808. * Gets the power operand input component
  66809. */
  66810. get power(): NodeMaterialConnectionPoint;
  66811. /**
  66812. * Gets the output component
  66813. */
  66814. get output(): NodeMaterialConnectionPoint;
  66815. protected _buildBlock(state: NodeMaterialBuildState): this;
  66816. }
  66817. }
  66818. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66819. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66820. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66821. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66822. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66823. /**
  66824. * Block used to get a random number
  66825. */
  66826. export class RandomNumberBlock extends NodeMaterialBlock {
  66827. /**
  66828. * Creates a new RandomNumberBlock
  66829. * @param name defines the block name
  66830. */
  66831. constructor(name: string);
  66832. /**
  66833. * Gets the current class name
  66834. * @returns the class name
  66835. */
  66836. getClassName(): string;
  66837. /**
  66838. * Gets the seed input component
  66839. */
  66840. get seed(): NodeMaterialConnectionPoint;
  66841. /**
  66842. * Gets the output component
  66843. */
  66844. get output(): NodeMaterialConnectionPoint;
  66845. protected _buildBlock(state: NodeMaterialBuildState): this;
  66846. }
  66847. }
  66848. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66849. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66850. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66851. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66852. /**
  66853. * Block used to compute arc tangent of 2 values
  66854. */
  66855. export class ArcTan2Block extends NodeMaterialBlock {
  66856. /**
  66857. * Creates a new ArcTan2Block
  66858. * @param name defines the block name
  66859. */
  66860. constructor(name: string);
  66861. /**
  66862. * Gets the current class name
  66863. * @returns the class name
  66864. */
  66865. getClassName(): string;
  66866. /**
  66867. * Gets the x operand input component
  66868. */
  66869. get x(): NodeMaterialConnectionPoint;
  66870. /**
  66871. * Gets the y operand input component
  66872. */
  66873. get y(): NodeMaterialConnectionPoint;
  66874. /**
  66875. * Gets the output component
  66876. */
  66877. get output(): NodeMaterialConnectionPoint;
  66878. protected _buildBlock(state: NodeMaterialBuildState): this;
  66879. }
  66880. }
  66881. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66882. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66883. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66884. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66885. /**
  66886. * Block used to smooth step a value
  66887. */
  66888. export class SmoothStepBlock extends NodeMaterialBlock {
  66889. /**
  66890. * Creates a new SmoothStepBlock
  66891. * @param name defines the block name
  66892. */
  66893. constructor(name: string);
  66894. /**
  66895. * Gets the current class name
  66896. * @returns the class name
  66897. */
  66898. getClassName(): string;
  66899. /**
  66900. * Gets the value operand input component
  66901. */
  66902. get value(): NodeMaterialConnectionPoint;
  66903. /**
  66904. * Gets the first edge operand input component
  66905. */
  66906. get edge0(): NodeMaterialConnectionPoint;
  66907. /**
  66908. * Gets the second edge operand input component
  66909. */
  66910. get edge1(): NodeMaterialConnectionPoint;
  66911. /**
  66912. * Gets the output component
  66913. */
  66914. get output(): NodeMaterialConnectionPoint;
  66915. protected _buildBlock(state: NodeMaterialBuildState): this;
  66916. }
  66917. }
  66918. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66922. /**
  66923. * Block used to get the reciprocal (1 / x) of a value
  66924. */
  66925. export class ReciprocalBlock extends NodeMaterialBlock {
  66926. /**
  66927. * Creates a new ReciprocalBlock
  66928. * @param name defines the block name
  66929. */
  66930. constructor(name: string);
  66931. /**
  66932. * Gets the current class name
  66933. * @returns the class name
  66934. */
  66935. getClassName(): string;
  66936. /**
  66937. * Gets the input component
  66938. */
  66939. get input(): NodeMaterialConnectionPoint;
  66940. /**
  66941. * Gets the output component
  66942. */
  66943. get output(): NodeMaterialConnectionPoint;
  66944. protected _buildBlock(state: NodeMaterialBuildState): this;
  66945. }
  66946. }
  66947. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66948. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66949. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66950. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66951. /**
  66952. * Block used to replace a color by another one
  66953. */
  66954. export class ReplaceColorBlock extends NodeMaterialBlock {
  66955. /**
  66956. * Creates a new ReplaceColorBlock
  66957. * @param name defines the block name
  66958. */
  66959. constructor(name: string);
  66960. /**
  66961. * Gets the current class name
  66962. * @returns the class name
  66963. */
  66964. getClassName(): string;
  66965. /**
  66966. * Gets the value input component
  66967. */
  66968. get value(): NodeMaterialConnectionPoint;
  66969. /**
  66970. * Gets the reference input component
  66971. */
  66972. get reference(): NodeMaterialConnectionPoint;
  66973. /**
  66974. * Gets the distance input component
  66975. */
  66976. get distance(): NodeMaterialConnectionPoint;
  66977. /**
  66978. * Gets the replacement input component
  66979. */
  66980. get replacement(): NodeMaterialConnectionPoint;
  66981. /**
  66982. * Gets the output component
  66983. */
  66984. get output(): NodeMaterialConnectionPoint;
  66985. protected _buildBlock(state: NodeMaterialBuildState): this;
  66986. }
  66987. }
  66988. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66989. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66990. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66991. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66992. /**
  66993. * Block used to posterize a value
  66994. * @see https://en.wikipedia.org/wiki/Posterization
  66995. */
  66996. export class PosterizeBlock extends NodeMaterialBlock {
  66997. /**
  66998. * Creates a new PosterizeBlock
  66999. * @param name defines the block name
  67000. */
  67001. constructor(name: string);
  67002. /**
  67003. * Gets the current class name
  67004. * @returns the class name
  67005. */
  67006. getClassName(): string;
  67007. /**
  67008. * Gets the value input component
  67009. */
  67010. get value(): NodeMaterialConnectionPoint;
  67011. /**
  67012. * Gets the steps input component
  67013. */
  67014. get steps(): NodeMaterialConnectionPoint;
  67015. /**
  67016. * Gets the output component
  67017. */
  67018. get output(): NodeMaterialConnectionPoint;
  67019. protected _buildBlock(state: NodeMaterialBuildState): this;
  67020. }
  67021. }
  67022. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  67023. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67024. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67025. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67026. import { Scene } from "babylonjs/scene";
  67027. /**
  67028. * Operations supported by the Wave block
  67029. */
  67030. export enum WaveBlockKind {
  67031. /** SawTooth */
  67032. SawTooth = 0,
  67033. /** Square */
  67034. Square = 1,
  67035. /** Triangle */
  67036. Triangle = 2
  67037. }
  67038. /**
  67039. * Block used to apply wave operation to floats
  67040. */
  67041. export class WaveBlock extends NodeMaterialBlock {
  67042. /**
  67043. * Gets or sets the kibnd of wave to be applied by the block
  67044. */
  67045. kind: WaveBlockKind;
  67046. /**
  67047. * Creates a new WaveBlock
  67048. * @param name defines the block name
  67049. */
  67050. constructor(name: string);
  67051. /**
  67052. * Gets the current class name
  67053. * @returns the class name
  67054. */
  67055. getClassName(): string;
  67056. /**
  67057. * Gets the input component
  67058. */
  67059. get input(): NodeMaterialConnectionPoint;
  67060. /**
  67061. * Gets the output component
  67062. */
  67063. get output(): NodeMaterialConnectionPoint;
  67064. protected _buildBlock(state: NodeMaterialBuildState): this;
  67065. serialize(): any;
  67066. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67067. }
  67068. }
  67069. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  67070. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67071. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67072. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67073. import { Color3 } from "babylonjs/Maths/math.color";
  67074. import { Scene } from "babylonjs/scene";
  67075. /**
  67076. * Class used to store a color step for the GradientBlock
  67077. */
  67078. export class GradientBlockColorStep {
  67079. /**
  67080. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67081. */
  67082. step: number;
  67083. /**
  67084. * Gets or sets the color associated with this step
  67085. */
  67086. color: Color3;
  67087. /**
  67088. * Creates a new GradientBlockColorStep
  67089. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67090. * @param color defines the color associated with this step
  67091. */
  67092. constructor(
  67093. /**
  67094. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  67095. */
  67096. step: number,
  67097. /**
  67098. * Gets or sets the color associated with this step
  67099. */
  67100. color: Color3);
  67101. }
  67102. /**
  67103. * Block used to return a color from a gradient based on an input value between 0 and 1
  67104. */
  67105. export class GradientBlock extends NodeMaterialBlock {
  67106. /**
  67107. * Gets or sets the list of color steps
  67108. */
  67109. colorSteps: GradientBlockColorStep[];
  67110. /**
  67111. * Creates a new GradientBlock
  67112. * @param name defines the block name
  67113. */
  67114. constructor(name: string);
  67115. /**
  67116. * Gets the current class name
  67117. * @returns the class name
  67118. */
  67119. getClassName(): string;
  67120. /**
  67121. * Gets the gradient input component
  67122. */
  67123. get gradient(): NodeMaterialConnectionPoint;
  67124. /**
  67125. * Gets the output component
  67126. */
  67127. get output(): NodeMaterialConnectionPoint;
  67128. private _writeColorConstant;
  67129. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67130. serialize(): any;
  67131. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67132. protected _dumpPropertiesCode(): string;
  67133. }
  67134. }
  67135. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67136. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67137. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67138. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67139. /**
  67140. * Block used to normalize lerp between 2 values
  67141. */
  67142. export class NLerpBlock extends NodeMaterialBlock {
  67143. /**
  67144. * Creates a new NLerpBlock
  67145. * @param name defines the block name
  67146. */
  67147. constructor(name: string);
  67148. /**
  67149. * Gets the current class name
  67150. * @returns the class name
  67151. */
  67152. getClassName(): string;
  67153. /**
  67154. * Gets the left operand input component
  67155. */
  67156. get left(): NodeMaterialConnectionPoint;
  67157. /**
  67158. * Gets the right operand input component
  67159. */
  67160. get right(): NodeMaterialConnectionPoint;
  67161. /**
  67162. * Gets the gradient operand input component
  67163. */
  67164. get gradient(): NodeMaterialConnectionPoint;
  67165. /**
  67166. * Gets the output component
  67167. */
  67168. get output(): NodeMaterialConnectionPoint;
  67169. protected _buildBlock(state: NodeMaterialBuildState): this;
  67170. }
  67171. }
  67172. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67173. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67174. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67175. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67176. import { Scene } from "babylonjs/scene";
  67177. /**
  67178. * block used to Generate a Worley Noise 3D Noise Pattern
  67179. */
  67180. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67181. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67182. manhattanDistance: boolean;
  67183. /**
  67184. * Creates a new WorleyNoise3DBlock
  67185. * @param name defines the block name
  67186. */
  67187. constructor(name: string);
  67188. /**
  67189. * Gets the current class name
  67190. * @returns the class name
  67191. */
  67192. getClassName(): string;
  67193. /**
  67194. * Gets the seed input component
  67195. */
  67196. get seed(): NodeMaterialConnectionPoint;
  67197. /**
  67198. * Gets the jitter input component
  67199. */
  67200. get jitter(): NodeMaterialConnectionPoint;
  67201. /**
  67202. * Gets the output component
  67203. */
  67204. get output(): NodeMaterialConnectionPoint;
  67205. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67206. /**
  67207. * Exposes the properties to the UI?
  67208. */
  67209. protected _dumpPropertiesCode(): string;
  67210. /**
  67211. * Exposes the properties to the Seralize?
  67212. */
  67213. serialize(): any;
  67214. /**
  67215. * Exposes the properties to the deseralize?
  67216. */
  67217. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67218. }
  67219. }
  67220. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67221. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67222. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67223. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67224. /**
  67225. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67226. */
  67227. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67228. /**
  67229. * Creates a new SimplexPerlin3DBlock
  67230. * @param name defines the block name
  67231. */
  67232. constructor(name: string);
  67233. /**
  67234. * Gets the current class name
  67235. * @returns the class name
  67236. */
  67237. getClassName(): string;
  67238. /**
  67239. * Gets the seed operand input component
  67240. */
  67241. get seed(): NodeMaterialConnectionPoint;
  67242. /**
  67243. * Gets the output component
  67244. */
  67245. get output(): NodeMaterialConnectionPoint;
  67246. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67247. }
  67248. }
  67249. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67250. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67251. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67252. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67253. /**
  67254. * Block used to blend normals
  67255. */
  67256. export class NormalBlendBlock extends NodeMaterialBlock {
  67257. /**
  67258. * Creates a new NormalBlendBlock
  67259. * @param name defines the block name
  67260. */
  67261. constructor(name: string);
  67262. /**
  67263. * Gets the current class name
  67264. * @returns the class name
  67265. */
  67266. getClassName(): string;
  67267. /**
  67268. * Gets the first input component
  67269. */
  67270. get normalMap0(): NodeMaterialConnectionPoint;
  67271. /**
  67272. * Gets the second input component
  67273. */
  67274. get normalMap1(): NodeMaterialConnectionPoint;
  67275. /**
  67276. * Gets the output component
  67277. */
  67278. get output(): NodeMaterialConnectionPoint;
  67279. protected _buildBlock(state: NodeMaterialBuildState): this;
  67280. }
  67281. }
  67282. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67283. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67284. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67285. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67286. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67287. /**
  67288. * Block used to rotate a 2d vector by a given angle
  67289. */
  67290. export class Rotate2dBlock extends NodeMaterialBlock {
  67291. /**
  67292. * Creates a new Rotate2dBlock
  67293. * @param name defines the block name
  67294. */
  67295. constructor(name: string);
  67296. /**
  67297. * Gets the current class name
  67298. * @returns the class name
  67299. */
  67300. getClassName(): string;
  67301. /**
  67302. * Gets the input vector
  67303. */
  67304. get input(): NodeMaterialConnectionPoint;
  67305. /**
  67306. * Gets the input angle
  67307. */
  67308. get angle(): NodeMaterialConnectionPoint;
  67309. /**
  67310. * Gets the output component
  67311. */
  67312. get output(): NodeMaterialConnectionPoint;
  67313. autoConfigure(material: NodeMaterial): void;
  67314. protected _buildBlock(state: NodeMaterialBuildState): this;
  67315. }
  67316. }
  67317. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67318. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67319. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67320. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67321. /**
  67322. * Block used to get the reflected vector from a direction and a normal
  67323. */
  67324. export class ReflectBlock extends NodeMaterialBlock {
  67325. /**
  67326. * Creates a new ReflectBlock
  67327. * @param name defines the block name
  67328. */
  67329. constructor(name: string);
  67330. /**
  67331. * Gets the current class name
  67332. * @returns the class name
  67333. */
  67334. getClassName(): string;
  67335. /**
  67336. * Gets the incident component
  67337. */
  67338. get incident(): NodeMaterialConnectionPoint;
  67339. /**
  67340. * Gets the normal component
  67341. */
  67342. get normal(): NodeMaterialConnectionPoint;
  67343. /**
  67344. * Gets the output component
  67345. */
  67346. get output(): NodeMaterialConnectionPoint;
  67347. protected _buildBlock(state: NodeMaterialBuildState): this;
  67348. }
  67349. }
  67350. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67351. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67352. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67353. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67354. /**
  67355. * Block used to get the refracted vector from a direction and a normal
  67356. */
  67357. export class RefractBlock extends NodeMaterialBlock {
  67358. /**
  67359. * Creates a new RefractBlock
  67360. * @param name defines the block name
  67361. */
  67362. constructor(name: string);
  67363. /**
  67364. * Gets the current class name
  67365. * @returns the class name
  67366. */
  67367. getClassName(): string;
  67368. /**
  67369. * Gets the incident component
  67370. */
  67371. get incident(): NodeMaterialConnectionPoint;
  67372. /**
  67373. * Gets the normal component
  67374. */
  67375. get normal(): NodeMaterialConnectionPoint;
  67376. /**
  67377. * Gets the index of refraction component
  67378. */
  67379. get ior(): NodeMaterialConnectionPoint;
  67380. /**
  67381. * Gets the output component
  67382. */
  67383. get output(): NodeMaterialConnectionPoint;
  67384. protected _buildBlock(state: NodeMaterialBuildState): this;
  67385. }
  67386. }
  67387. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67388. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67389. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67390. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67391. /**
  67392. * Block used to desaturate a color
  67393. */
  67394. export class DesaturateBlock extends NodeMaterialBlock {
  67395. /**
  67396. * Creates a new DesaturateBlock
  67397. * @param name defines the block name
  67398. */
  67399. constructor(name: string);
  67400. /**
  67401. * Gets the current class name
  67402. * @returns the class name
  67403. */
  67404. getClassName(): string;
  67405. /**
  67406. * Gets the color operand input component
  67407. */
  67408. get color(): NodeMaterialConnectionPoint;
  67409. /**
  67410. * Gets the level operand input component
  67411. */
  67412. get level(): NodeMaterialConnectionPoint;
  67413. /**
  67414. * Gets the output component
  67415. */
  67416. get output(): NodeMaterialConnectionPoint;
  67417. protected _buildBlock(state: NodeMaterialBuildState): this;
  67418. }
  67419. }
  67420. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67421. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67422. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67423. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67424. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67425. import { Nullable } from "babylonjs/types";
  67426. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67427. import { Scene } from "babylonjs/scene";
  67428. /**
  67429. * Block used to implement the ambient occlusion module of the PBR material
  67430. */
  67431. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67432. /**
  67433. * Create a new AmbientOcclusionBlock
  67434. * @param name defines the block name
  67435. */
  67436. constructor(name: string);
  67437. /**
  67438. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67439. */
  67440. useAmbientInGrayScale: boolean;
  67441. /**
  67442. * Initialize the block and prepare the context for build
  67443. * @param state defines the state that will be used for the build
  67444. */
  67445. initialize(state: NodeMaterialBuildState): void;
  67446. /**
  67447. * Gets the current class name
  67448. * @returns the class name
  67449. */
  67450. getClassName(): string;
  67451. /**
  67452. * Gets the texture input component
  67453. */
  67454. get texture(): NodeMaterialConnectionPoint;
  67455. /**
  67456. * Gets the texture intensity component
  67457. */
  67458. get intensity(): NodeMaterialConnectionPoint;
  67459. /**
  67460. * Gets the direct light intensity input component
  67461. */
  67462. get directLightIntensity(): NodeMaterialConnectionPoint;
  67463. /**
  67464. * Gets the ambient occlusion object output component
  67465. */
  67466. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67467. /**
  67468. * Gets the main code of the block (fragment side)
  67469. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67470. * @returns the shader code
  67471. */
  67472. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67473. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67474. protected _buildBlock(state: NodeMaterialBuildState): this;
  67475. protected _dumpPropertiesCode(): string;
  67476. serialize(): any;
  67477. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67478. }
  67479. }
  67480. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67481. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67482. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67483. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67484. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67486. import { Nullable } from "babylonjs/types";
  67487. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67488. import { Mesh } from "babylonjs/Meshes/mesh";
  67489. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67490. import { Effect } from "babylonjs/Materials/effect";
  67491. import { Scene } from "babylonjs/scene";
  67492. /**
  67493. * Block used to implement the reflection module of the PBR material
  67494. */
  67495. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67496. /** @hidden */
  67497. _defineLODReflectionAlpha: string;
  67498. /** @hidden */
  67499. _defineLinearSpecularReflection: string;
  67500. private _vEnvironmentIrradianceName;
  67501. /** @hidden */
  67502. _vReflectionMicrosurfaceInfosName: string;
  67503. /** @hidden */
  67504. _vReflectionInfosName: string;
  67505. /** @hidden */
  67506. _vReflectionFilteringInfoName: string;
  67507. private _scene;
  67508. /**
  67509. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67510. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67511. * It's less burden on the user side in the editor part.
  67512. */
  67513. /** @hidden */
  67514. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67515. /** @hidden */
  67516. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67517. /** @hidden */
  67518. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67519. /**
  67520. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67521. * diffuse part of the IBL.
  67522. */
  67523. useSphericalHarmonics: boolean;
  67524. /**
  67525. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67526. */
  67527. forceIrradianceInFragment: boolean;
  67528. /**
  67529. * Create a new ReflectionBlock
  67530. * @param name defines the block name
  67531. */
  67532. constructor(name: string);
  67533. /**
  67534. * Gets the current class name
  67535. * @returns the class name
  67536. */
  67537. getClassName(): string;
  67538. /**
  67539. * Gets the position input component
  67540. */
  67541. get position(): NodeMaterialConnectionPoint;
  67542. /**
  67543. * Gets the world position input component
  67544. */
  67545. get worldPosition(): NodeMaterialConnectionPoint;
  67546. /**
  67547. * Gets the world normal input component
  67548. */
  67549. get worldNormal(): NodeMaterialConnectionPoint;
  67550. /**
  67551. * Gets the world input component
  67552. */
  67553. get world(): NodeMaterialConnectionPoint;
  67554. /**
  67555. * Gets the camera (or eye) position component
  67556. */
  67557. get cameraPosition(): NodeMaterialConnectionPoint;
  67558. /**
  67559. * Gets the view input component
  67560. */
  67561. get view(): NodeMaterialConnectionPoint;
  67562. /**
  67563. * Gets the color input component
  67564. */
  67565. get color(): NodeMaterialConnectionPoint;
  67566. /**
  67567. * Gets the reflection object output component
  67568. */
  67569. get reflection(): NodeMaterialConnectionPoint;
  67570. /**
  67571. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67572. */
  67573. get hasTexture(): boolean;
  67574. /**
  67575. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67576. */
  67577. get reflectionColor(): string;
  67578. protected _getTexture(): Nullable<BaseTexture>;
  67579. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67580. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67581. /**
  67582. * Gets the code to inject in the vertex shader
  67583. * @param state current state of the node material building
  67584. * @returns the shader code
  67585. */
  67586. handleVertexSide(state: NodeMaterialBuildState): string;
  67587. /**
  67588. * Gets the main code of the block (fragment side)
  67589. * @param state current state of the node material building
  67590. * @param normalVarName name of the existing variable corresponding to the normal
  67591. * @returns the shader code
  67592. */
  67593. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67594. protected _buildBlock(state: NodeMaterialBuildState): this;
  67595. protected _dumpPropertiesCode(): string;
  67596. serialize(): any;
  67597. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67598. }
  67599. }
  67600. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67601. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67602. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67603. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67604. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67605. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67606. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67607. import { Scene } from "babylonjs/scene";
  67608. import { Nullable } from "babylonjs/types";
  67609. /**
  67610. * Block used to implement the sheen module of the PBR material
  67611. */
  67612. export class SheenBlock extends NodeMaterialBlock {
  67613. /**
  67614. * Create a new SheenBlock
  67615. * @param name defines the block name
  67616. */
  67617. constructor(name: string);
  67618. /**
  67619. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67620. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67621. * making it easier to setup and tweak the effect
  67622. */
  67623. albedoScaling: boolean;
  67624. /**
  67625. * Defines if the sheen is linked to the sheen color.
  67626. */
  67627. linkSheenWithAlbedo: boolean;
  67628. /**
  67629. * Initialize the block and prepare the context for build
  67630. * @param state defines the state that will be used for the build
  67631. */
  67632. initialize(state: NodeMaterialBuildState): void;
  67633. /**
  67634. * Gets the current class name
  67635. * @returns the class name
  67636. */
  67637. getClassName(): string;
  67638. /**
  67639. * Gets the intensity input component
  67640. */
  67641. get intensity(): NodeMaterialConnectionPoint;
  67642. /**
  67643. * Gets the color input component
  67644. */
  67645. get color(): NodeMaterialConnectionPoint;
  67646. /**
  67647. * Gets the roughness input component
  67648. */
  67649. get roughness(): NodeMaterialConnectionPoint;
  67650. /**
  67651. * Gets the sheen object output component
  67652. */
  67653. get sheen(): NodeMaterialConnectionPoint;
  67654. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67655. /**
  67656. * Gets the main code of the block (fragment side)
  67657. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67658. * @returns the shader code
  67659. */
  67660. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67661. protected _buildBlock(state: NodeMaterialBuildState): this;
  67662. protected _dumpPropertiesCode(): string;
  67663. serialize(): any;
  67664. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67665. }
  67666. }
  67667. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67668. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67669. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67670. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67671. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67672. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67673. import { Scene } from "babylonjs/scene";
  67674. import { Nullable } from "babylonjs/types";
  67675. import { Mesh } from "babylonjs/Meshes/mesh";
  67676. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67677. import { Effect } from "babylonjs/Materials/effect";
  67678. /**
  67679. * Block used to implement the reflectivity module of the PBR material
  67680. */
  67681. export class ReflectivityBlock extends NodeMaterialBlock {
  67682. private _metallicReflectanceColor;
  67683. private _metallicF0Factor;
  67684. /** @hidden */
  67685. _vMetallicReflectanceFactorsName: string;
  67686. /**
  67687. * The property below is set by the main PBR block prior to calling methods of this class.
  67688. */
  67689. /** @hidden */
  67690. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67691. /**
  67692. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67693. */
  67694. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67695. /**
  67696. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67697. */
  67698. useMetallnessFromMetallicTextureBlue: boolean;
  67699. /**
  67700. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67701. */
  67702. useRoughnessFromMetallicTextureAlpha: boolean;
  67703. /**
  67704. * Specifies if the metallic texture contains the roughness information in its green channel.
  67705. */
  67706. useRoughnessFromMetallicTextureGreen: boolean;
  67707. /**
  67708. * Create a new ReflectivityBlock
  67709. * @param name defines the block name
  67710. */
  67711. constructor(name: string);
  67712. /**
  67713. * Initialize the block and prepare the context for build
  67714. * @param state defines the state that will be used for the build
  67715. */
  67716. initialize(state: NodeMaterialBuildState): void;
  67717. /**
  67718. * Gets the current class name
  67719. * @returns the class name
  67720. */
  67721. getClassName(): string;
  67722. /**
  67723. * Gets the metallic input component
  67724. */
  67725. get metallic(): NodeMaterialConnectionPoint;
  67726. /**
  67727. * Gets the roughness input component
  67728. */
  67729. get roughness(): NodeMaterialConnectionPoint;
  67730. /**
  67731. * Gets the texture input component
  67732. */
  67733. get texture(): NodeMaterialConnectionPoint;
  67734. /**
  67735. * Gets the reflectivity object output component
  67736. */
  67737. get reflectivity(): NodeMaterialConnectionPoint;
  67738. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67739. /**
  67740. * Gets the main code of the block (fragment side)
  67741. * @param state current state of the node material building
  67742. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67743. * @returns the shader code
  67744. */
  67745. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67746. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67747. protected _buildBlock(state: NodeMaterialBuildState): this;
  67748. protected _dumpPropertiesCode(): string;
  67749. serialize(): any;
  67750. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67751. }
  67752. }
  67753. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67754. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67758. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67759. /**
  67760. * Block used to implement the anisotropy module of the PBR material
  67761. */
  67762. export class AnisotropyBlock extends NodeMaterialBlock {
  67763. /**
  67764. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67765. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67766. * It's less burden on the user side in the editor part.
  67767. */
  67768. /** @hidden */
  67769. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67770. /** @hidden */
  67771. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67772. /**
  67773. * Create a new AnisotropyBlock
  67774. * @param name defines the block name
  67775. */
  67776. constructor(name: string);
  67777. /**
  67778. * Initialize the block and prepare the context for build
  67779. * @param state defines the state that will be used for the build
  67780. */
  67781. initialize(state: NodeMaterialBuildState): void;
  67782. /**
  67783. * Gets the current class name
  67784. * @returns the class name
  67785. */
  67786. getClassName(): string;
  67787. /**
  67788. * Gets the intensity input component
  67789. */
  67790. get intensity(): NodeMaterialConnectionPoint;
  67791. /**
  67792. * Gets the direction input component
  67793. */
  67794. get direction(): NodeMaterialConnectionPoint;
  67795. /**
  67796. * Gets the texture input component
  67797. */
  67798. get texture(): NodeMaterialConnectionPoint;
  67799. /**
  67800. * Gets the uv input component
  67801. */
  67802. get uv(): NodeMaterialConnectionPoint;
  67803. /**
  67804. * Gets the worldTangent input component
  67805. */
  67806. get worldTangent(): NodeMaterialConnectionPoint;
  67807. /**
  67808. * Gets the anisotropy object output component
  67809. */
  67810. get anisotropy(): NodeMaterialConnectionPoint;
  67811. private _generateTBNSpace;
  67812. /**
  67813. * Gets the main code of the block (fragment side)
  67814. * @param state current state of the node material building
  67815. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67816. * @returns the shader code
  67817. */
  67818. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67819. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67820. protected _buildBlock(state: NodeMaterialBuildState): this;
  67821. }
  67822. }
  67823. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67824. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67825. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67826. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67827. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67828. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67829. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67830. import { Nullable } from "babylonjs/types";
  67831. import { Mesh } from "babylonjs/Meshes/mesh";
  67832. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67833. import { Effect } from "babylonjs/Materials/effect";
  67834. /**
  67835. * Block used to implement the clear coat module of the PBR material
  67836. */
  67837. export class ClearCoatBlock extends NodeMaterialBlock {
  67838. private _scene;
  67839. /**
  67840. * Create a new ClearCoatBlock
  67841. * @param name defines the block name
  67842. */
  67843. constructor(name: string);
  67844. /**
  67845. * Initialize the block and prepare the context for build
  67846. * @param state defines the state that will be used for the build
  67847. */
  67848. initialize(state: NodeMaterialBuildState): void;
  67849. /**
  67850. * Gets the current class name
  67851. * @returns the class name
  67852. */
  67853. getClassName(): string;
  67854. /**
  67855. * Gets the intensity input component
  67856. */
  67857. get intensity(): NodeMaterialConnectionPoint;
  67858. /**
  67859. * Gets the roughness input component
  67860. */
  67861. get roughness(): NodeMaterialConnectionPoint;
  67862. /**
  67863. * Gets the ior input component
  67864. */
  67865. get ior(): NodeMaterialConnectionPoint;
  67866. /**
  67867. * Gets the texture input component
  67868. */
  67869. get texture(): NodeMaterialConnectionPoint;
  67870. /**
  67871. * Gets the bump texture input component
  67872. */
  67873. get bumpTexture(): NodeMaterialConnectionPoint;
  67874. /**
  67875. * Gets the uv input component
  67876. */
  67877. get uv(): NodeMaterialConnectionPoint;
  67878. /**
  67879. * Gets the tint color input component
  67880. */
  67881. get tintColor(): NodeMaterialConnectionPoint;
  67882. /**
  67883. * Gets the tint "at distance" input component
  67884. */
  67885. get tintAtDistance(): NodeMaterialConnectionPoint;
  67886. /**
  67887. * Gets the tint thickness input component
  67888. */
  67889. get tintThickness(): NodeMaterialConnectionPoint;
  67890. /**
  67891. * Gets the world tangent input component
  67892. */
  67893. get worldTangent(): NodeMaterialConnectionPoint;
  67894. /**
  67895. * Gets the clear coat object output component
  67896. */
  67897. get clearcoat(): NodeMaterialConnectionPoint;
  67898. autoConfigure(material: NodeMaterial): void;
  67899. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67900. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67901. private _generateTBNSpace;
  67902. /**
  67903. * Gets the main code of the block (fragment side)
  67904. * @param state current state of the node material building
  67905. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67906. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67907. * @param worldPosVarName name of the variable holding the world position
  67908. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67909. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67910. * @param worldNormalVarName name of the variable holding the world normal
  67911. * @returns the shader code
  67912. */
  67913. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67914. protected _buildBlock(state: NodeMaterialBuildState): this;
  67915. }
  67916. }
  67917. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67921. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67923. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67924. import { Nullable } from "babylonjs/types";
  67925. /**
  67926. * Block used to implement the sub surface module of the PBR material
  67927. */
  67928. export class SubSurfaceBlock extends NodeMaterialBlock {
  67929. /**
  67930. * Create a new SubSurfaceBlock
  67931. * @param name defines the block name
  67932. */
  67933. constructor(name: string);
  67934. /**
  67935. * Stores the intensity of the different subsurface effects in the thickness texture.
  67936. * * the green channel is the translucency intensity.
  67937. * * the blue channel is the scattering intensity.
  67938. * * the alpha channel is the refraction intensity.
  67939. */
  67940. useMaskFromThicknessTexture: boolean;
  67941. /**
  67942. * Initialize the block and prepare the context for build
  67943. * @param state defines the state that will be used for the build
  67944. */
  67945. initialize(state: NodeMaterialBuildState): void;
  67946. /**
  67947. * Gets the current class name
  67948. * @returns the class name
  67949. */
  67950. getClassName(): string;
  67951. /**
  67952. * Gets the min thickness input component
  67953. */
  67954. get minThickness(): NodeMaterialConnectionPoint;
  67955. /**
  67956. * Gets the max thickness input component
  67957. */
  67958. get maxThickness(): NodeMaterialConnectionPoint;
  67959. /**
  67960. * Gets the thickness texture component
  67961. */
  67962. get thicknessTexture(): NodeMaterialConnectionPoint;
  67963. /**
  67964. * Gets the tint color input component
  67965. */
  67966. get tintColor(): NodeMaterialConnectionPoint;
  67967. /**
  67968. * Gets the translucency intensity input component
  67969. */
  67970. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67971. /**
  67972. * Gets the translucency diffusion distance input component
  67973. */
  67974. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67975. /**
  67976. * Gets the refraction object parameters
  67977. */
  67978. get refraction(): NodeMaterialConnectionPoint;
  67979. /**
  67980. * Gets the sub surface object output component
  67981. */
  67982. get subsurface(): NodeMaterialConnectionPoint;
  67983. autoConfigure(material: NodeMaterial): void;
  67984. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67985. /**
  67986. * Gets the main code of the block (fragment side)
  67987. * @param state current state of the node material building
  67988. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67989. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67990. * @param worldPosVarName name of the variable holding the world position
  67991. * @returns the shader code
  67992. */
  67993. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67994. protected _buildBlock(state: NodeMaterialBuildState): this;
  67995. }
  67996. }
  67997. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67998. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67999. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68001. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68002. import { Light } from "babylonjs/Lights/light";
  68003. import { Nullable } from "babylonjs/types";
  68004. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68005. import { Effect } from "babylonjs/Materials/effect";
  68006. import { Mesh } from "babylonjs/Meshes/mesh";
  68007. import { Scene } from "babylonjs/scene";
  68008. /**
  68009. * Block used to implement the PBR metallic/roughness model
  68010. */
  68011. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  68012. /**
  68013. * Gets or sets the light associated with this block
  68014. */
  68015. light: Nullable<Light>;
  68016. private _lightId;
  68017. private _scene;
  68018. private _environmentBRDFTexture;
  68019. private _environmentBrdfSamplerName;
  68020. private _vNormalWName;
  68021. private _invertNormalName;
  68022. /**
  68023. * Create a new ReflectionBlock
  68024. * @param name defines the block name
  68025. */
  68026. constructor(name: string);
  68027. /**
  68028. * Intensity of the direct lights e.g. the four lights available in your scene.
  68029. * This impacts both the direct diffuse and specular highlights.
  68030. */
  68031. directIntensity: number;
  68032. /**
  68033. * Intensity of the environment e.g. how much the environment will light the object
  68034. * either through harmonics for rough material or through the refelction for shiny ones.
  68035. */
  68036. environmentIntensity: number;
  68037. /**
  68038. * This is a special control allowing the reduction of the specular highlights coming from the
  68039. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  68040. */
  68041. specularIntensity: number;
  68042. /**
  68043. * Defines the falloff type used in this material.
  68044. * It by default is Physical.
  68045. */
  68046. lightFalloff: number;
  68047. /**
  68048. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  68049. */
  68050. useAlphaFromAlbedoTexture: boolean;
  68051. /**
  68052. * Specifies that alpha test should be used
  68053. */
  68054. useAlphaTest: boolean;
  68055. /**
  68056. * Defines the alpha limits in alpha test mode.
  68057. */
  68058. alphaTestCutoff: number;
  68059. /**
  68060. * Specifies that alpha blending should be used
  68061. */
  68062. useAlphaBlending: boolean;
  68063. /**
  68064. * Defines if the alpha value should be determined via the rgb values.
  68065. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  68066. */
  68067. opacityRGB: boolean;
  68068. /**
  68069. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  68070. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  68071. */
  68072. useRadianceOverAlpha: boolean;
  68073. /**
  68074. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  68075. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  68076. */
  68077. useSpecularOverAlpha: boolean;
  68078. /**
  68079. * Enables specular anti aliasing in the PBR shader.
  68080. * It will both interacts on the Geometry for analytical and IBL lighting.
  68081. * It also prefilter the roughness map based on the bump values.
  68082. */
  68083. enableSpecularAntiAliasing: boolean;
  68084. /**
  68085. * Enables realtime filtering on the texture.
  68086. */
  68087. realTimeFiltering: boolean;
  68088. /**
  68089. * Quality switch for realtime filtering
  68090. */
  68091. realTimeFilteringQuality: number;
  68092. /**
  68093. * Defines if the material uses energy conservation.
  68094. */
  68095. useEnergyConservation: boolean;
  68096. /**
  68097. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68098. * too much the area relying on ambient texture to define their ambient occlusion.
  68099. */
  68100. useRadianceOcclusion: boolean;
  68101. /**
  68102. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68103. * makes the reflect vector face the model (under horizon).
  68104. */
  68105. useHorizonOcclusion: boolean;
  68106. /**
  68107. * If set to true, no lighting calculations will be applied.
  68108. */
  68109. unlit: boolean;
  68110. /**
  68111. * Force normal to face away from face.
  68112. */
  68113. forceNormalForward: boolean;
  68114. /**
  68115. * Defines the material debug mode.
  68116. * It helps seeing only some components of the material while troubleshooting.
  68117. */
  68118. debugMode: number;
  68119. /**
  68120. * Specify from where on screen the debug mode should start.
  68121. * The value goes from -1 (full screen) to 1 (not visible)
  68122. * It helps with side by side comparison against the final render
  68123. * This defaults to 0
  68124. */
  68125. debugLimit: number;
  68126. /**
  68127. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68128. * You can use the factor to better multiply the final value.
  68129. */
  68130. debugFactor: number;
  68131. /**
  68132. * Initialize the block and prepare the context for build
  68133. * @param state defines the state that will be used for the build
  68134. */
  68135. initialize(state: NodeMaterialBuildState): void;
  68136. /**
  68137. * Gets the current class name
  68138. * @returns the class name
  68139. */
  68140. getClassName(): string;
  68141. /**
  68142. * Gets the world position input component
  68143. */
  68144. get worldPosition(): NodeMaterialConnectionPoint;
  68145. /**
  68146. * Gets the world normal input component
  68147. */
  68148. get worldNormal(): NodeMaterialConnectionPoint;
  68149. /**
  68150. * Gets the perturbed normal input component
  68151. */
  68152. get perturbedNormal(): NodeMaterialConnectionPoint;
  68153. /**
  68154. * Gets the camera position input component
  68155. */
  68156. get cameraPosition(): NodeMaterialConnectionPoint;
  68157. /**
  68158. * Gets the base color input component
  68159. */
  68160. get baseColor(): NodeMaterialConnectionPoint;
  68161. /**
  68162. * Gets the opacity texture input component
  68163. */
  68164. get opacityTexture(): NodeMaterialConnectionPoint;
  68165. /**
  68166. * Gets the ambient color input component
  68167. */
  68168. get ambientColor(): NodeMaterialConnectionPoint;
  68169. /**
  68170. * Gets the reflectivity object parameters
  68171. */
  68172. get reflectivity(): NodeMaterialConnectionPoint;
  68173. /**
  68174. * Gets the ambient occlusion object parameters
  68175. */
  68176. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68177. /**
  68178. * Gets the reflection object parameters
  68179. */
  68180. get reflection(): NodeMaterialConnectionPoint;
  68181. /**
  68182. * Gets the sheen object parameters
  68183. */
  68184. get sheen(): NodeMaterialConnectionPoint;
  68185. /**
  68186. * Gets the clear coat object parameters
  68187. */
  68188. get clearcoat(): NodeMaterialConnectionPoint;
  68189. /**
  68190. * Gets the sub surface object parameters
  68191. */
  68192. get subsurface(): NodeMaterialConnectionPoint;
  68193. /**
  68194. * Gets the anisotropy object parameters
  68195. */
  68196. get anisotropy(): NodeMaterialConnectionPoint;
  68197. /**
  68198. * Gets the ambient output component
  68199. */
  68200. get ambient(): NodeMaterialConnectionPoint;
  68201. /**
  68202. * Gets the diffuse output component
  68203. */
  68204. get diffuse(): NodeMaterialConnectionPoint;
  68205. /**
  68206. * Gets the specular output component
  68207. */
  68208. get specular(): NodeMaterialConnectionPoint;
  68209. /**
  68210. * Gets the sheen output component
  68211. */
  68212. get sheenDir(): NodeMaterialConnectionPoint;
  68213. /**
  68214. * Gets the clear coat output component
  68215. */
  68216. get clearcoatDir(): NodeMaterialConnectionPoint;
  68217. /**
  68218. * Gets the indirect diffuse output component
  68219. */
  68220. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68221. /**
  68222. * Gets the indirect specular output component
  68223. */
  68224. get specularIndirect(): NodeMaterialConnectionPoint;
  68225. /**
  68226. * Gets the indirect sheen output component
  68227. */
  68228. get sheenIndirect(): NodeMaterialConnectionPoint;
  68229. /**
  68230. * Gets the indirect clear coat output component
  68231. */
  68232. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68233. /**
  68234. * Gets the refraction output component
  68235. */
  68236. get refraction(): NodeMaterialConnectionPoint;
  68237. /**
  68238. * Gets the global lighting output component
  68239. */
  68240. get lighting(): NodeMaterialConnectionPoint;
  68241. /**
  68242. * Gets the shadow output component
  68243. */
  68244. get shadow(): NodeMaterialConnectionPoint;
  68245. /**
  68246. * Gets the alpha output component
  68247. */
  68248. get alpha(): NodeMaterialConnectionPoint;
  68249. autoConfigure(material: NodeMaterial): void;
  68250. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68251. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68252. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68253. private _injectVertexCode;
  68254. /**
  68255. * Gets the code corresponding to the albedo/opacity module
  68256. * @returns the shader code
  68257. */
  68258. getAlbedoOpacityCode(): string;
  68259. protected _buildBlock(state: NodeMaterialBuildState): this;
  68260. protected _dumpPropertiesCode(): string;
  68261. serialize(): any;
  68262. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68263. }
  68264. }
  68265. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68266. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68267. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68268. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68269. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68270. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68271. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68272. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68273. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68274. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68275. }
  68276. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68277. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68278. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68279. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68280. }
  68281. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68282. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68283. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68284. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68285. /**
  68286. * Block used to compute value of one parameter modulo another
  68287. */
  68288. export class ModBlock extends NodeMaterialBlock {
  68289. /**
  68290. * Creates a new ModBlock
  68291. * @param name defines the block name
  68292. */
  68293. constructor(name: string);
  68294. /**
  68295. * Gets the current class name
  68296. * @returns the class name
  68297. */
  68298. getClassName(): string;
  68299. /**
  68300. * Gets the left operand input component
  68301. */
  68302. get left(): NodeMaterialConnectionPoint;
  68303. /**
  68304. * Gets the right operand input component
  68305. */
  68306. get right(): NodeMaterialConnectionPoint;
  68307. /**
  68308. * Gets the output component
  68309. */
  68310. get output(): NodeMaterialConnectionPoint;
  68311. protected _buildBlock(state: NodeMaterialBuildState): this;
  68312. }
  68313. }
  68314. declare module "babylonjs/Materials/Node/Blocks/index" {
  68315. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68316. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68317. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68318. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68319. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68320. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68321. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68322. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68323. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68324. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68325. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68326. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68327. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68328. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68329. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68330. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68331. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68332. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68333. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68334. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68335. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68336. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68337. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68338. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68339. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68340. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68341. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68342. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68343. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68344. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68345. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68346. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68347. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68348. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68349. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68350. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68351. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68352. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68353. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68354. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68355. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68356. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68357. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68358. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68359. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68360. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68361. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68362. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68363. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68364. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68365. }
  68366. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68367. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68368. }
  68369. declare module "babylonjs/Materials/Node/index" {
  68370. export * from "babylonjs/Materials/Node/Enums/index";
  68371. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68372. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68373. export * from "babylonjs/Materials/Node/nodeMaterial";
  68374. export * from "babylonjs/Materials/Node/Blocks/index";
  68375. export * from "babylonjs/Materials/Node/Optimizers/index";
  68376. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68377. }
  68378. declare module "babylonjs/Materials/index" {
  68379. export * from "babylonjs/Materials/Background/index";
  68380. export * from "babylonjs/Materials/colorCurves";
  68381. export * from "babylonjs/Materials/iEffectFallbacks";
  68382. export * from "babylonjs/Materials/effectFallbacks";
  68383. export * from "babylonjs/Materials/effect";
  68384. export * from "babylonjs/Materials/fresnelParameters";
  68385. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68386. export * from "babylonjs/Materials/material";
  68387. export * from "babylonjs/Materials/materialDefines";
  68388. export * from "babylonjs/Materials/thinMaterialHelper";
  68389. export * from "babylonjs/Materials/materialHelper";
  68390. export * from "babylonjs/Materials/multiMaterial";
  68391. export * from "babylonjs/Materials/PBR/index";
  68392. export * from "babylonjs/Materials/pushMaterial";
  68393. export * from "babylonjs/Materials/shaderMaterial";
  68394. export * from "babylonjs/Materials/standardMaterial";
  68395. export * from "babylonjs/Materials/Textures/index";
  68396. export * from "babylonjs/Materials/uniformBuffer";
  68397. export * from "babylonjs/Materials/materialFlags";
  68398. export * from "babylonjs/Materials/Node/index";
  68399. export * from "babylonjs/Materials/effectRenderer";
  68400. export * from "babylonjs/Materials/shadowDepthWrapper";
  68401. }
  68402. declare module "babylonjs/Maths/index" {
  68403. export * from "babylonjs/Maths/math.scalar";
  68404. export * from "babylonjs/Maths/math";
  68405. export * from "babylonjs/Maths/sphericalPolynomial";
  68406. }
  68407. declare module "babylonjs/Misc/workerPool" {
  68408. import { IDisposable } from "babylonjs/scene";
  68409. /**
  68410. * Helper class to push actions to a pool of workers.
  68411. */
  68412. export class WorkerPool implements IDisposable {
  68413. private _workerInfos;
  68414. private _pendingActions;
  68415. /**
  68416. * Constructor
  68417. * @param workers Array of workers to use for actions
  68418. */
  68419. constructor(workers: Array<Worker>);
  68420. /**
  68421. * Terminates all workers and clears any pending actions.
  68422. */
  68423. dispose(): void;
  68424. /**
  68425. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68426. * pended until a worker has completed its action.
  68427. * @param action The action to perform. Call onComplete when the action is complete.
  68428. */
  68429. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68430. private _execute;
  68431. }
  68432. }
  68433. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68434. import { IDisposable } from "babylonjs/scene";
  68435. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68436. /**
  68437. * Configuration for Draco compression
  68438. */
  68439. export interface IDracoCompressionConfiguration {
  68440. /**
  68441. * Configuration for the decoder.
  68442. */
  68443. decoder: {
  68444. /**
  68445. * The url to the WebAssembly module.
  68446. */
  68447. wasmUrl?: string;
  68448. /**
  68449. * The url to the WebAssembly binary.
  68450. */
  68451. wasmBinaryUrl?: string;
  68452. /**
  68453. * The url to the fallback JavaScript module.
  68454. */
  68455. fallbackUrl?: string;
  68456. };
  68457. }
  68458. /**
  68459. * Draco compression (https://google.github.io/draco/)
  68460. *
  68461. * This class wraps the Draco module.
  68462. *
  68463. * **Encoder**
  68464. *
  68465. * The encoder is not currently implemented.
  68466. *
  68467. * **Decoder**
  68468. *
  68469. * 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.
  68470. *
  68471. * To update the configuration, use the following code:
  68472. * ```javascript
  68473. * DracoCompression.Configuration = {
  68474. * decoder: {
  68475. * wasmUrl: "<url to the WebAssembly library>",
  68476. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68477. * fallbackUrl: "<url to the fallback JavaScript library>",
  68478. * }
  68479. * };
  68480. * ```
  68481. *
  68482. * 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.
  68483. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68484. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68485. *
  68486. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68487. * ```javascript
  68488. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68489. * ```
  68490. *
  68491. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68492. */
  68493. export class DracoCompression implements IDisposable {
  68494. private _workerPoolPromise?;
  68495. private _decoderModulePromise?;
  68496. /**
  68497. * The configuration. Defaults to the following urls:
  68498. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68499. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68500. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68501. */
  68502. static Configuration: IDracoCompressionConfiguration;
  68503. /**
  68504. * Returns true if the decoder configuration is available.
  68505. */
  68506. static get DecoderAvailable(): boolean;
  68507. /**
  68508. * Default number of workers to create when creating the draco compression object.
  68509. */
  68510. static DefaultNumWorkers: number;
  68511. private static GetDefaultNumWorkers;
  68512. private static _Default;
  68513. /**
  68514. * Default instance for the draco compression object.
  68515. */
  68516. static get Default(): DracoCompression;
  68517. /**
  68518. * Constructor
  68519. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68520. */
  68521. constructor(numWorkers?: number);
  68522. /**
  68523. * Stop all async operations and release resources.
  68524. */
  68525. dispose(): void;
  68526. /**
  68527. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68528. * @returns a promise that resolves when ready
  68529. */
  68530. whenReadyAsync(): Promise<void>;
  68531. /**
  68532. * Decode Draco compressed mesh data to vertex data.
  68533. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68534. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68535. * @returns A promise that resolves with the decoded vertex data
  68536. */
  68537. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68538. [kind: string]: number;
  68539. }): Promise<VertexData>;
  68540. }
  68541. }
  68542. declare module "babylonjs/Meshes/Compression/index" {
  68543. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68544. }
  68545. declare module "babylonjs/Meshes/csg" {
  68546. import { Nullable } from "babylonjs/types";
  68547. import { Scene } from "babylonjs/scene";
  68548. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68549. import { Mesh } from "babylonjs/Meshes/mesh";
  68550. import { Material } from "babylonjs/Materials/material";
  68551. /**
  68552. * Class for building Constructive Solid Geometry
  68553. */
  68554. export class CSG {
  68555. private polygons;
  68556. /**
  68557. * The world matrix
  68558. */
  68559. matrix: Matrix;
  68560. /**
  68561. * Stores the position
  68562. */
  68563. position: Vector3;
  68564. /**
  68565. * Stores the rotation
  68566. */
  68567. rotation: Vector3;
  68568. /**
  68569. * Stores the rotation quaternion
  68570. */
  68571. rotationQuaternion: Nullable<Quaternion>;
  68572. /**
  68573. * Stores the scaling vector
  68574. */
  68575. scaling: Vector3;
  68576. /**
  68577. * Convert the Mesh to CSG
  68578. * @param mesh The Mesh to convert to CSG
  68579. * @returns A new CSG from the Mesh
  68580. */
  68581. static FromMesh(mesh: Mesh): CSG;
  68582. /**
  68583. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68584. * @param polygons Polygons used to construct a CSG solid
  68585. */
  68586. private static FromPolygons;
  68587. /**
  68588. * Clones, or makes a deep copy, of the CSG
  68589. * @returns A new CSG
  68590. */
  68591. clone(): CSG;
  68592. /**
  68593. * Unions this CSG with another CSG
  68594. * @param csg The CSG to union against this CSG
  68595. * @returns The unioned CSG
  68596. */
  68597. union(csg: CSG): CSG;
  68598. /**
  68599. * Unions this CSG with another CSG in place
  68600. * @param csg The CSG to union against this CSG
  68601. */
  68602. unionInPlace(csg: CSG): void;
  68603. /**
  68604. * Subtracts this CSG with another CSG
  68605. * @param csg The CSG to subtract against this CSG
  68606. * @returns A new CSG
  68607. */
  68608. subtract(csg: CSG): CSG;
  68609. /**
  68610. * Subtracts this CSG with another CSG in place
  68611. * @param csg The CSG to subtact against this CSG
  68612. */
  68613. subtractInPlace(csg: CSG): void;
  68614. /**
  68615. * Intersect this CSG with another CSG
  68616. * @param csg The CSG to intersect against this CSG
  68617. * @returns A new CSG
  68618. */
  68619. intersect(csg: CSG): CSG;
  68620. /**
  68621. * Intersects this CSG with another CSG in place
  68622. * @param csg The CSG to intersect against this CSG
  68623. */
  68624. intersectInPlace(csg: CSG): void;
  68625. /**
  68626. * Return a new CSG solid with solid and empty space switched. This solid is
  68627. * not modified.
  68628. * @returns A new CSG solid with solid and empty space switched
  68629. */
  68630. inverse(): CSG;
  68631. /**
  68632. * Inverses the CSG in place
  68633. */
  68634. inverseInPlace(): void;
  68635. /**
  68636. * This is used to keep meshes transformations so they can be restored
  68637. * when we build back a Babylon Mesh
  68638. * NB : All CSG operations are performed in world coordinates
  68639. * @param csg The CSG to copy the transform attributes from
  68640. * @returns This CSG
  68641. */
  68642. copyTransformAttributes(csg: CSG): CSG;
  68643. /**
  68644. * Build Raw mesh from CSG
  68645. * Coordinates here are in world space
  68646. * @param name The name of the mesh geometry
  68647. * @param scene The Scene
  68648. * @param keepSubMeshes Specifies if the submeshes should be kept
  68649. * @returns A new Mesh
  68650. */
  68651. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68652. /**
  68653. * Build Mesh from CSG taking material and transforms into account
  68654. * @param name The name of the Mesh
  68655. * @param material The material of the Mesh
  68656. * @param scene The Scene
  68657. * @param keepSubMeshes Specifies if submeshes should be kept
  68658. * @returns The new Mesh
  68659. */
  68660. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68661. }
  68662. }
  68663. declare module "babylonjs/Meshes/trailMesh" {
  68664. import { Mesh } from "babylonjs/Meshes/mesh";
  68665. import { Scene } from "babylonjs/scene";
  68666. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68667. /**
  68668. * Class used to create a trail following a mesh
  68669. */
  68670. export class TrailMesh extends Mesh {
  68671. private _generator;
  68672. private _autoStart;
  68673. private _running;
  68674. private _diameter;
  68675. private _length;
  68676. private _sectionPolygonPointsCount;
  68677. private _sectionVectors;
  68678. private _sectionNormalVectors;
  68679. private _beforeRenderObserver;
  68680. /**
  68681. * @constructor
  68682. * @param name The value used by scene.getMeshByName() to do a lookup.
  68683. * @param generator The mesh or transform node to generate a trail.
  68684. * @param scene The scene to add this mesh to.
  68685. * @param diameter Diameter of trailing mesh. Default is 1.
  68686. * @param length Length of trailing mesh. Default is 60.
  68687. * @param autoStart Automatically start trailing mesh. Default true.
  68688. */
  68689. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68690. /**
  68691. * "TrailMesh"
  68692. * @returns "TrailMesh"
  68693. */
  68694. getClassName(): string;
  68695. private _createMesh;
  68696. /**
  68697. * Start trailing mesh.
  68698. */
  68699. start(): void;
  68700. /**
  68701. * Stop trailing mesh.
  68702. */
  68703. stop(): void;
  68704. /**
  68705. * Update trailing mesh geometry.
  68706. */
  68707. update(): void;
  68708. /**
  68709. * Returns a new TrailMesh object.
  68710. * @param name is a string, the name given to the new mesh
  68711. * @param newGenerator use new generator object for cloned trail mesh
  68712. * @returns a new mesh
  68713. */
  68714. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68715. /**
  68716. * Serializes this trail mesh
  68717. * @param serializationObject object to write serialization to
  68718. */
  68719. serialize(serializationObject: any): void;
  68720. /**
  68721. * Parses a serialized trail mesh
  68722. * @param parsedMesh the serialized mesh
  68723. * @param scene the scene to create the trail mesh in
  68724. * @returns the created trail mesh
  68725. */
  68726. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68727. }
  68728. }
  68729. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68730. import { Nullable } from "babylonjs/types";
  68731. import { Scene } from "babylonjs/scene";
  68732. import { Vector4 } from "babylonjs/Maths/math.vector";
  68733. import { Color4 } from "babylonjs/Maths/math.color";
  68734. import { Mesh } from "babylonjs/Meshes/mesh";
  68735. /**
  68736. * Class containing static functions to help procedurally build meshes
  68737. */
  68738. export class TiledBoxBuilder {
  68739. /**
  68740. * Creates a box mesh
  68741. * 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)
  68742. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68743. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68744. * * 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
  68745. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68746. * @param name defines the name of the mesh
  68747. * @param options defines the options used to create the mesh
  68748. * @param scene defines the hosting scene
  68749. * @returns the box mesh
  68750. */
  68751. static CreateTiledBox(name: string, options: {
  68752. pattern?: number;
  68753. width?: number;
  68754. height?: number;
  68755. depth?: number;
  68756. tileSize?: number;
  68757. tileWidth?: number;
  68758. tileHeight?: number;
  68759. alignHorizontal?: number;
  68760. alignVertical?: number;
  68761. faceUV?: Vector4[];
  68762. faceColors?: Color4[];
  68763. sideOrientation?: number;
  68764. updatable?: boolean;
  68765. }, scene?: Nullable<Scene>): Mesh;
  68766. }
  68767. }
  68768. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68769. import { Vector4 } from "babylonjs/Maths/math.vector";
  68770. import { Mesh } from "babylonjs/Meshes/mesh";
  68771. /**
  68772. * Class containing static functions to help procedurally build meshes
  68773. */
  68774. export class TorusKnotBuilder {
  68775. /**
  68776. * Creates a torus knot mesh
  68777. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68778. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68779. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68780. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68781. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68782. * * 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
  68783. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68784. * @param name defines the name of the mesh
  68785. * @param options defines the options used to create the mesh
  68786. * @param scene defines the hosting scene
  68787. * @returns the torus knot mesh
  68788. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68789. */
  68790. static CreateTorusKnot(name: string, options: {
  68791. radius?: number;
  68792. tube?: number;
  68793. radialSegments?: number;
  68794. tubularSegments?: number;
  68795. p?: number;
  68796. q?: number;
  68797. updatable?: boolean;
  68798. sideOrientation?: number;
  68799. frontUVs?: Vector4;
  68800. backUVs?: Vector4;
  68801. }, scene: any): Mesh;
  68802. }
  68803. }
  68804. declare module "babylonjs/Meshes/polygonMesh" {
  68805. import { Scene } from "babylonjs/scene";
  68806. import { Vector2 } from "babylonjs/Maths/math.vector";
  68807. import { Mesh } from "babylonjs/Meshes/mesh";
  68808. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68809. import { Path2 } from "babylonjs/Maths/math.path";
  68810. /**
  68811. * Polygon
  68812. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68813. */
  68814. export class Polygon {
  68815. /**
  68816. * Creates a rectangle
  68817. * @param xmin bottom X coord
  68818. * @param ymin bottom Y coord
  68819. * @param xmax top X coord
  68820. * @param ymax top Y coord
  68821. * @returns points that make the resulting rectation
  68822. */
  68823. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68824. /**
  68825. * Creates a circle
  68826. * @param radius radius of circle
  68827. * @param cx scale in x
  68828. * @param cy scale in y
  68829. * @param numberOfSides number of sides that make up the circle
  68830. * @returns points that make the resulting circle
  68831. */
  68832. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68833. /**
  68834. * Creates a polygon from input string
  68835. * @param input Input polygon data
  68836. * @returns the parsed points
  68837. */
  68838. static Parse(input: string): Vector2[];
  68839. /**
  68840. * Starts building a polygon from x and y coordinates
  68841. * @param x x coordinate
  68842. * @param y y coordinate
  68843. * @returns the started path2
  68844. */
  68845. static StartingAt(x: number, y: number): Path2;
  68846. }
  68847. /**
  68848. * Builds a polygon
  68849. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68850. */
  68851. export class PolygonMeshBuilder {
  68852. private _points;
  68853. private _outlinepoints;
  68854. private _holes;
  68855. private _name;
  68856. private _scene;
  68857. private _epoints;
  68858. private _eholes;
  68859. private _addToepoint;
  68860. /**
  68861. * Babylon reference to the earcut plugin.
  68862. */
  68863. bjsEarcut: any;
  68864. /**
  68865. * Creates a PolygonMeshBuilder
  68866. * @param name name of the builder
  68867. * @param contours Path of the polygon
  68868. * @param scene scene to add to when creating the mesh
  68869. * @param earcutInjection can be used to inject your own earcut reference
  68870. */
  68871. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68872. /**
  68873. * Adds a whole within the polygon
  68874. * @param hole Array of points defining the hole
  68875. * @returns this
  68876. */
  68877. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68878. /**
  68879. * Creates the polygon
  68880. * @param updatable If the mesh should be updatable
  68881. * @param depth The depth of the mesh created
  68882. * @returns the created mesh
  68883. */
  68884. build(updatable?: boolean, depth?: number): Mesh;
  68885. /**
  68886. * Creates the polygon
  68887. * @param depth The depth of the mesh created
  68888. * @returns the created VertexData
  68889. */
  68890. buildVertexData(depth?: number): VertexData;
  68891. /**
  68892. * Adds a side to the polygon
  68893. * @param positions points that make the polygon
  68894. * @param normals normals of the polygon
  68895. * @param uvs uvs of the polygon
  68896. * @param indices indices of the polygon
  68897. * @param bounds bounds of the polygon
  68898. * @param points points of the polygon
  68899. * @param depth depth of the polygon
  68900. * @param flip flip of the polygon
  68901. */
  68902. private addSide;
  68903. }
  68904. }
  68905. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68906. import { Scene } from "babylonjs/scene";
  68907. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68908. import { Color4 } from "babylonjs/Maths/math.color";
  68909. import { Mesh } from "babylonjs/Meshes/mesh";
  68910. import { Nullable } from "babylonjs/types";
  68911. /**
  68912. * Class containing static functions to help procedurally build meshes
  68913. */
  68914. export class PolygonBuilder {
  68915. /**
  68916. * Creates a polygon mesh
  68917. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68918. * * 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
  68919. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68920. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68921. * * 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)
  68922. * * Remember you can only change the shape positions, not their number when updating a polygon
  68923. * @param name defines the name of the mesh
  68924. * @param options defines the options used to create the mesh
  68925. * @param scene defines the hosting scene
  68926. * @param earcutInjection can be used to inject your own earcut reference
  68927. * @returns the polygon mesh
  68928. */
  68929. static CreatePolygon(name: string, options: {
  68930. shape: Vector3[];
  68931. holes?: Vector3[][];
  68932. depth?: number;
  68933. faceUV?: Vector4[];
  68934. faceColors?: Color4[];
  68935. updatable?: boolean;
  68936. sideOrientation?: number;
  68937. frontUVs?: Vector4;
  68938. backUVs?: Vector4;
  68939. wrap?: boolean;
  68940. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68941. /**
  68942. * Creates an extruded polygon mesh, with depth in the Y direction.
  68943. * * 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)
  68944. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68945. * @param name defines the name of the mesh
  68946. * @param options defines the options used to create the mesh
  68947. * @param scene defines the hosting scene
  68948. * @param earcutInjection can be used to inject your own earcut reference
  68949. * @returns the polygon mesh
  68950. */
  68951. static ExtrudePolygon(name: string, options: {
  68952. shape: Vector3[];
  68953. holes?: Vector3[][];
  68954. depth?: number;
  68955. faceUV?: Vector4[];
  68956. faceColors?: Color4[];
  68957. updatable?: boolean;
  68958. sideOrientation?: number;
  68959. frontUVs?: Vector4;
  68960. backUVs?: Vector4;
  68961. wrap?: boolean;
  68962. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68963. }
  68964. }
  68965. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68966. import { Scene } from "babylonjs/scene";
  68967. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68968. import { Mesh } from "babylonjs/Meshes/mesh";
  68969. import { Nullable } from "babylonjs/types";
  68970. /**
  68971. * Class containing static functions to help procedurally build meshes
  68972. */
  68973. export class LatheBuilder {
  68974. /**
  68975. * Creates lathe mesh.
  68976. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68977. * * 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
  68978. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68979. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68980. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68981. * * 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
  68982. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68983. * * 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
  68984. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68985. * * 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
  68986. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68987. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68988. * @param name defines the name of the mesh
  68989. * @param options defines the options used to create the mesh
  68990. * @param scene defines the hosting scene
  68991. * @returns the lathe mesh
  68992. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68993. */
  68994. static CreateLathe(name: string, options: {
  68995. shape: Vector3[];
  68996. radius?: number;
  68997. tessellation?: number;
  68998. clip?: number;
  68999. arc?: number;
  69000. closed?: boolean;
  69001. updatable?: boolean;
  69002. sideOrientation?: number;
  69003. frontUVs?: Vector4;
  69004. backUVs?: Vector4;
  69005. cap?: number;
  69006. invertUV?: boolean;
  69007. }, scene?: Nullable<Scene>): Mesh;
  69008. }
  69009. }
  69010. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  69011. import { Nullable } from "babylonjs/types";
  69012. import { Scene } from "babylonjs/scene";
  69013. import { Vector4 } from "babylonjs/Maths/math.vector";
  69014. import { Mesh } from "babylonjs/Meshes/mesh";
  69015. /**
  69016. * Class containing static functions to help procedurally build meshes
  69017. */
  69018. export class TiledPlaneBuilder {
  69019. /**
  69020. * Creates a tiled plane mesh
  69021. * * The parameter `pattern` will, depending on value, do nothing or
  69022. * * * flip (reflect about central vertical) alternate tiles across and up
  69023. * * * flip every tile on alternate rows
  69024. * * * rotate (180 degs) alternate tiles across and up
  69025. * * * rotate every tile on alternate rows
  69026. * * * flip and rotate alternate tiles across and up
  69027. * * * flip and rotate every tile on alternate rows
  69028. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  69029. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  69030. * * 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
  69031. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69032. * * 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)
  69033. * * 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)
  69034. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69035. * @param name defines the name of the mesh
  69036. * @param options defines the options used to create the mesh
  69037. * @param scene defines the hosting scene
  69038. * @returns the box mesh
  69039. */
  69040. static CreateTiledPlane(name: string, options: {
  69041. pattern?: number;
  69042. tileSize?: number;
  69043. tileWidth?: number;
  69044. tileHeight?: number;
  69045. size?: number;
  69046. width?: number;
  69047. height?: number;
  69048. alignHorizontal?: number;
  69049. alignVertical?: number;
  69050. sideOrientation?: number;
  69051. frontUVs?: Vector4;
  69052. backUVs?: Vector4;
  69053. updatable?: boolean;
  69054. }, scene?: Nullable<Scene>): Mesh;
  69055. }
  69056. }
  69057. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  69058. import { Nullable } from "babylonjs/types";
  69059. import { Scene } from "babylonjs/scene";
  69060. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69061. import { Mesh } from "babylonjs/Meshes/mesh";
  69062. /**
  69063. * Class containing static functions to help procedurally build meshes
  69064. */
  69065. export class TubeBuilder {
  69066. /**
  69067. * Creates a tube mesh.
  69068. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69069. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69070. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69071. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69072. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69073. * * 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)
  69074. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69075. * * 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
  69076. * * 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
  69077. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69078. * * 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
  69079. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69080. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69081. * @param name defines the name of the mesh
  69082. * @param options defines the options used to create the mesh
  69083. * @param scene defines the hosting scene
  69084. * @returns the tube mesh
  69085. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69086. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69087. */
  69088. static CreateTube(name: string, options: {
  69089. path: Vector3[];
  69090. radius?: number;
  69091. tessellation?: number;
  69092. radiusFunction?: {
  69093. (i: number, distance: number): number;
  69094. };
  69095. cap?: number;
  69096. arc?: number;
  69097. updatable?: boolean;
  69098. sideOrientation?: number;
  69099. frontUVs?: Vector4;
  69100. backUVs?: Vector4;
  69101. instance?: Mesh;
  69102. invertUV?: boolean;
  69103. }, scene?: Nullable<Scene>): Mesh;
  69104. }
  69105. }
  69106. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69107. import { Scene } from "babylonjs/scene";
  69108. import { Vector4 } from "babylonjs/Maths/math.vector";
  69109. import { Mesh } from "babylonjs/Meshes/mesh";
  69110. import { Nullable } from "babylonjs/types";
  69111. /**
  69112. * Class containing static functions to help procedurally build meshes
  69113. */
  69114. export class IcoSphereBuilder {
  69115. /**
  69116. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69117. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69118. * * 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`)
  69119. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69120. * * 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
  69121. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69122. * * 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
  69123. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69124. * @param name defines the name of the mesh
  69125. * @param options defines the options used to create the mesh
  69126. * @param scene defines the hosting scene
  69127. * @returns the icosahedron mesh
  69128. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69129. */
  69130. static CreateIcoSphere(name: string, options: {
  69131. radius?: number;
  69132. radiusX?: number;
  69133. radiusY?: number;
  69134. radiusZ?: number;
  69135. flat?: boolean;
  69136. subdivisions?: number;
  69137. sideOrientation?: number;
  69138. frontUVs?: Vector4;
  69139. backUVs?: Vector4;
  69140. updatable?: boolean;
  69141. }, scene?: Nullable<Scene>): Mesh;
  69142. }
  69143. }
  69144. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69145. import { Vector3 } from "babylonjs/Maths/math.vector";
  69146. import { Mesh } from "babylonjs/Meshes/mesh";
  69147. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69148. /**
  69149. * Class containing static functions to help procedurally build meshes
  69150. */
  69151. export class DecalBuilder {
  69152. /**
  69153. * Creates a decal mesh.
  69154. * 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
  69155. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69156. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69157. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69158. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69159. * @param name defines the name of the mesh
  69160. * @param sourceMesh defines the mesh where the decal must be applied
  69161. * @param options defines the options used to create the mesh
  69162. * @param scene defines the hosting scene
  69163. * @returns the decal mesh
  69164. * @see https://doc.babylonjs.com/how_to/decals
  69165. */
  69166. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69167. position?: Vector3;
  69168. normal?: Vector3;
  69169. size?: Vector3;
  69170. angle?: number;
  69171. }): Mesh;
  69172. }
  69173. }
  69174. declare module "babylonjs/Meshes/meshBuilder" {
  69175. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69176. import { Nullable } from "babylonjs/types";
  69177. import { Scene } from "babylonjs/scene";
  69178. import { Mesh } from "babylonjs/Meshes/mesh";
  69179. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69180. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69181. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69182. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69183. import { Plane } from "babylonjs/Maths/math.plane";
  69184. /**
  69185. * Class containing static functions to help procedurally build meshes
  69186. */
  69187. export class MeshBuilder {
  69188. /**
  69189. * Creates a box mesh
  69190. * * The parameter `size` sets the size (float) of each box side (default 1)
  69191. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69192. * * 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)
  69193. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69194. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69195. * * 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
  69196. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69197. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69198. * @param name defines the name of the mesh
  69199. * @param options defines the options used to create the mesh
  69200. * @param scene defines the hosting scene
  69201. * @returns the box mesh
  69202. */
  69203. static CreateBox(name: string, options: {
  69204. size?: number;
  69205. width?: number;
  69206. height?: number;
  69207. depth?: number;
  69208. faceUV?: Vector4[];
  69209. faceColors?: Color4[];
  69210. sideOrientation?: number;
  69211. frontUVs?: Vector4;
  69212. backUVs?: Vector4;
  69213. wrap?: boolean;
  69214. topBaseAt?: number;
  69215. bottomBaseAt?: number;
  69216. updatable?: boolean;
  69217. }, scene?: Nullable<Scene>): Mesh;
  69218. /**
  69219. * Creates a tiled box mesh
  69220. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69221. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69222. * @param name defines the name of the mesh
  69223. * @param options defines the options used to create the mesh
  69224. * @param scene defines the hosting scene
  69225. * @returns the tiled box mesh
  69226. */
  69227. static CreateTiledBox(name: string, options: {
  69228. pattern?: number;
  69229. size?: number;
  69230. width?: number;
  69231. height?: number;
  69232. depth: number;
  69233. tileSize?: number;
  69234. tileWidth?: number;
  69235. tileHeight?: number;
  69236. faceUV?: Vector4[];
  69237. faceColors?: Color4[];
  69238. alignHorizontal?: number;
  69239. alignVertical?: number;
  69240. sideOrientation?: number;
  69241. updatable?: boolean;
  69242. }, scene?: Nullable<Scene>): Mesh;
  69243. /**
  69244. * Creates a sphere mesh
  69245. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69246. * * 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`)
  69247. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69248. * * 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
  69249. * * 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)
  69250. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69251. * * 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
  69252. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69253. * @param name defines the name of the mesh
  69254. * @param options defines the options used to create the mesh
  69255. * @param scene defines the hosting scene
  69256. * @returns the sphere mesh
  69257. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69258. */
  69259. static CreateSphere(name: string, options: {
  69260. segments?: number;
  69261. diameter?: number;
  69262. diameterX?: number;
  69263. diameterY?: number;
  69264. diameterZ?: number;
  69265. arc?: number;
  69266. slice?: number;
  69267. sideOrientation?: number;
  69268. frontUVs?: Vector4;
  69269. backUVs?: Vector4;
  69270. updatable?: boolean;
  69271. }, scene?: Nullable<Scene>): Mesh;
  69272. /**
  69273. * Creates a plane polygonal mesh. By default, this is a disc
  69274. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69275. * * 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
  69276. * * 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
  69277. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69278. * * 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
  69279. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69280. * @param name defines the name of the mesh
  69281. * @param options defines the options used to create the mesh
  69282. * @param scene defines the hosting scene
  69283. * @returns the plane polygonal mesh
  69284. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69285. */
  69286. static CreateDisc(name: string, options: {
  69287. radius?: number;
  69288. tessellation?: number;
  69289. arc?: number;
  69290. updatable?: boolean;
  69291. sideOrientation?: number;
  69292. frontUVs?: Vector4;
  69293. backUVs?: Vector4;
  69294. }, scene?: Nullable<Scene>): Mesh;
  69295. /**
  69296. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69297. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69298. * * 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`)
  69299. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69300. * * 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
  69301. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69302. * * 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
  69303. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69304. * @param name defines the name of the mesh
  69305. * @param options defines the options used to create the mesh
  69306. * @param scene defines the hosting scene
  69307. * @returns the icosahedron mesh
  69308. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69309. */
  69310. static CreateIcoSphere(name: string, options: {
  69311. radius?: number;
  69312. radiusX?: number;
  69313. radiusY?: number;
  69314. radiusZ?: number;
  69315. flat?: boolean;
  69316. subdivisions?: number;
  69317. sideOrientation?: number;
  69318. frontUVs?: Vector4;
  69319. backUVs?: Vector4;
  69320. updatable?: boolean;
  69321. }, scene?: Nullable<Scene>): Mesh;
  69322. /**
  69323. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69324. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69325. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69326. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69327. * * 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
  69328. * * 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
  69329. * * 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
  69330. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69331. * * 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
  69332. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69333. * * 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
  69334. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69335. * * 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
  69336. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69337. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69338. * @param name defines the name of the mesh
  69339. * @param options defines the options used to create the mesh
  69340. * @param scene defines the hosting scene
  69341. * @returns the ribbon mesh
  69342. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69343. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69344. */
  69345. static CreateRibbon(name: string, options: {
  69346. pathArray: Vector3[][];
  69347. closeArray?: boolean;
  69348. closePath?: boolean;
  69349. offset?: number;
  69350. updatable?: boolean;
  69351. sideOrientation?: number;
  69352. frontUVs?: Vector4;
  69353. backUVs?: Vector4;
  69354. instance?: Mesh;
  69355. invertUV?: boolean;
  69356. uvs?: Vector2[];
  69357. colors?: Color4[];
  69358. }, scene?: Nullable<Scene>): Mesh;
  69359. /**
  69360. * Creates a cylinder or a cone mesh
  69361. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69362. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69363. * * 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.
  69364. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69365. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69366. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69367. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69368. * * 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).
  69369. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69370. * * 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).
  69371. * * 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
  69372. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69373. * * 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
  69374. * * 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.
  69375. * * If `enclose` is false, a ring surface is one element.
  69376. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69377. * * 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
  69378. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69379. * * 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
  69380. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69381. * @param name defines the name of the mesh
  69382. * @param options defines the options used to create the mesh
  69383. * @param scene defines the hosting scene
  69384. * @returns the cylinder mesh
  69385. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69386. */
  69387. static CreateCylinder(name: string, options: {
  69388. height?: number;
  69389. diameterTop?: number;
  69390. diameterBottom?: number;
  69391. diameter?: number;
  69392. tessellation?: number;
  69393. subdivisions?: number;
  69394. arc?: number;
  69395. faceColors?: Color4[];
  69396. faceUV?: Vector4[];
  69397. updatable?: boolean;
  69398. hasRings?: boolean;
  69399. enclose?: boolean;
  69400. cap?: number;
  69401. sideOrientation?: number;
  69402. frontUVs?: Vector4;
  69403. backUVs?: Vector4;
  69404. }, scene?: Nullable<Scene>): Mesh;
  69405. /**
  69406. * Creates a torus mesh
  69407. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69408. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69409. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69410. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69411. * * 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
  69412. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69413. * @param name defines the name of the mesh
  69414. * @param options defines the options used to create the mesh
  69415. * @param scene defines the hosting scene
  69416. * @returns the torus mesh
  69417. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69418. */
  69419. static CreateTorus(name: string, options: {
  69420. diameter?: number;
  69421. thickness?: number;
  69422. tessellation?: number;
  69423. updatable?: boolean;
  69424. sideOrientation?: number;
  69425. frontUVs?: Vector4;
  69426. backUVs?: Vector4;
  69427. }, scene?: Nullable<Scene>): Mesh;
  69428. /**
  69429. * Creates a torus knot mesh
  69430. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69431. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69432. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69433. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69434. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69435. * * 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
  69436. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69437. * @param name defines the name of the mesh
  69438. * @param options defines the options used to create the mesh
  69439. * @param scene defines the hosting scene
  69440. * @returns the torus knot mesh
  69441. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69442. */
  69443. static CreateTorusKnot(name: string, options: {
  69444. radius?: number;
  69445. tube?: number;
  69446. radialSegments?: number;
  69447. tubularSegments?: number;
  69448. p?: number;
  69449. q?: number;
  69450. updatable?: boolean;
  69451. sideOrientation?: number;
  69452. frontUVs?: Vector4;
  69453. backUVs?: Vector4;
  69454. }, scene?: Nullable<Scene>): Mesh;
  69455. /**
  69456. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69457. * * 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
  69458. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69459. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69460. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69461. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69462. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69463. * * 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
  69464. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69465. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69466. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69467. * @param name defines the name of the new line system
  69468. * @param options defines the options used to create the line system
  69469. * @param scene defines the hosting scene
  69470. * @returns a new line system mesh
  69471. */
  69472. static CreateLineSystem(name: string, options: {
  69473. lines: Vector3[][];
  69474. updatable?: boolean;
  69475. instance?: Nullable<LinesMesh>;
  69476. colors?: Nullable<Color4[][]>;
  69477. useVertexAlpha?: boolean;
  69478. }, scene: Nullable<Scene>): LinesMesh;
  69479. /**
  69480. * Creates a line mesh
  69481. * 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
  69482. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69483. * * The parameter `points` is an array successive Vector3
  69484. * * 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
  69485. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69486. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69487. * * When updating an instance, remember that only point positions can change, not the number of points
  69488. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69489. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69490. * @param name defines the name of the new line system
  69491. * @param options defines the options used to create the line system
  69492. * @param scene defines the hosting scene
  69493. * @returns a new line mesh
  69494. */
  69495. static CreateLines(name: string, options: {
  69496. points: Vector3[];
  69497. updatable?: boolean;
  69498. instance?: Nullable<LinesMesh>;
  69499. colors?: Color4[];
  69500. useVertexAlpha?: boolean;
  69501. }, scene?: Nullable<Scene>): LinesMesh;
  69502. /**
  69503. * Creates a dashed line mesh
  69504. * * 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
  69505. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69506. * * The parameter `points` is an array successive Vector3
  69507. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69508. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69509. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69510. * * 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
  69511. * * When updating an instance, remember that only point positions can change, not the number of points
  69512. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69513. * @param name defines the name of the mesh
  69514. * @param options defines the options used to create the mesh
  69515. * @param scene defines the hosting scene
  69516. * @returns the dashed line mesh
  69517. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69518. */
  69519. static CreateDashedLines(name: string, options: {
  69520. points: Vector3[];
  69521. dashSize?: number;
  69522. gapSize?: number;
  69523. dashNb?: number;
  69524. updatable?: boolean;
  69525. instance?: LinesMesh;
  69526. }, scene?: Nullable<Scene>): LinesMesh;
  69527. /**
  69528. * 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.
  69529. * * 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.
  69530. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69531. * * 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.
  69532. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69533. * * 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
  69534. * * 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
  69535. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69536. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69537. * * 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
  69538. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69539. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69540. * @param name defines the name of the mesh
  69541. * @param options defines the options used to create the mesh
  69542. * @param scene defines the hosting scene
  69543. * @returns the extruded shape mesh
  69544. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69545. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69546. */
  69547. static ExtrudeShape(name: string, options: {
  69548. shape: Vector3[];
  69549. path: Vector3[];
  69550. scale?: number;
  69551. rotation?: number;
  69552. cap?: number;
  69553. updatable?: boolean;
  69554. sideOrientation?: number;
  69555. frontUVs?: Vector4;
  69556. backUVs?: Vector4;
  69557. instance?: Mesh;
  69558. invertUV?: boolean;
  69559. }, scene?: Nullable<Scene>): Mesh;
  69560. /**
  69561. * Creates an custom extruded shape mesh.
  69562. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69563. * * 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.
  69564. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69565. * * 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
  69566. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69567. * * 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
  69568. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69569. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69570. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69571. * * 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
  69572. * * 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
  69573. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69574. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69575. * * 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
  69576. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69577. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69578. * @param name defines the name of the mesh
  69579. * @param options defines the options used to create the mesh
  69580. * @param scene defines the hosting scene
  69581. * @returns the custom extruded shape mesh
  69582. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69583. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69584. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69585. */
  69586. static ExtrudeShapeCustom(name: string, options: {
  69587. shape: Vector3[];
  69588. path: Vector3[];
  69589. scaleFunction?: any;
  69590. rotationFunction?: any;
  69591. ribbonCloseArray?: boolean;
  69592. ribbonClosePath?: boolean;
  69593. cap?: number;
  69594. updatable?: boolean;
  69595. sideOrientation?: number;
  69596. frontUVs?: Vector4;
  69597. backUVs?: Vector4;
  69598. instance?: Mesh;
  69599. invertUV?: boolean;
  69600. }, scene?: Nullable<Scene>): Mesh;
  69601. /**
  69602. * Creates lathe mesh.
  69603. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69604. * * 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
  69605. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69606. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69607. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69608. * * 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
  69609. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69610. * * 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
  69611. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69612. * * 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
  69613. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69614. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69615. * @param name defines the name of the mesh
  69616. * @param options defines the options used to create the mesh
  69617. * @param scene defines the hosting scene
  69618. * @returns the lathe mesh
  69619. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69620. */
  69621. static CreateLathe(name: string, options: {
  69622. shape: Vector3[];
  69623. radius?: number;
  69624. tessellation?: number;
  69625. clip?: number;
  69626. arc?: number;
  69627. closed?: boolean;
  69628. updatable?: boolean;
  69629. sideOrientation?: number;
  69630. frontUVs?: Vector4;
  69631. backUVs?: Vector4;
  69632. cap?: number;
  69633. invertUV?: boolean;
  69634. }, scene?: Nullable<Scene>): Mesh;
  69635. /**
  69636. * Creates a tiled plane mesh
  69637. * * You can set a limited pattern arrangement with the tiles
  69638. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69639. * * 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
  69640. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69641. * @param name defines the name of the mesh
  69642. * @param options defines the options used to create the mesh
  69643. * @param scene defines the hosting scene
  69644. * @returns the plane mesh
  69645. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69646. */
  69647. static CreateTiledPlane(name: string, options: {
  69648. pattern?: number;
  69649. tileSize?: number;
  69650. tileWidth?: number;
  69651. tileHeight?: number;
  69652. size?: number;
  69653. width?: number;
  69654. height?: number;
  69655. alignHorizontal?: number;
  69656. alignVertical?: number;
  69657. sideOrientation?: number;
  69658. frontUVs?: Vector4;
  69659. backUVs?: Vector4;
  69660. updatable?: boolean;
  69661. }, scene?: Nullable<Scene>): Mesh;
  69662. /**
  69663. * Creates a plane mesh
  69664. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69665. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69666. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69667. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69668. * * 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
  69669. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69670. * @param name defines the name of the mesh
  69671. * @param options defines the options used to create the mesh
  69672. * @param scene defines the hosting scene
  69673. * @returns the plane mesh
  69674. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69675. */
  69676. static CreatePlane(name: string, options: {
  69677. size?: number;
  69678. width?: number;
  69679. height?: number;
  69680. sideOrientation?: number;
  69681. frontUVs?: Vector4;
  69682. backUVs?: Vector4;
  69683. updatable?: boolean;
  69684. sourcePlane?: Plane;
  69685. }, scene?: Nullable<Scene>): Mesh;
  69686. /**
  69687. * Creates a ground mesh
  69688. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69689. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69690. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69691. * @param name defines the name of the mesh
  69692. * @param options defines the options used to create the mesh
  69693. * @param scene defines the hosting scene
  69694. * @returns the ground mesh
  69695. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69696. */
  69697. static CreateGround(name: string, options: {
  69698. width?: number;
  69699. height?: number;
  69700. subdivisions?: number;
  69701. subdivisionsX?: number;
  69702. subdivisionsY?: number;
  69703. updatable?: boolean;
  69704. }, scene?: Nullable<Scene>): Mesh;
  69705. /**
  69706. * Creates a tiled ground mesh
  69707. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69708. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69709. * * 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
  69710. * * 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
  69711. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69712. * @param name defines the name of the mesh
  69713. * @param options defines the options used to create the mesh
  69714. * @param scene defines the hosting scene
  69715. * @returns the tiled ground mesh
  69716. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69717. */
  69718. static CreateTiledGround(name: string, options: {
  69719. xmin: number;
  69720. zmin: number;
  69721. xmax: number;
  69722. zmax: number;
  69723. subdivisions?: {
  69724. w: number;
  69725. h: number;
  69726. };
  69727. precision?: {
  69728. w: number;
  69729. h: number;
  69730. };
  69731. updatable?: boolean;
  69732. }, scene?: Nullable<Scene>): Mesh;
  69733. /**
  69734. * Creates a ground mesh from a height map
  69735. * * The parameter `url` sets the URL of the height map image resource.
  69736. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69737. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69738. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69739. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69740. * * 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.
  69741. * * 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).
  69742. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69743. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69744. * @param name defines the name of the mesh
  69745. * @param url defines the url to the height map
  69746. * @param options defines the options used to create the mesh
  69747. * @param scene defines the hosting scene
  69748. * @returns the ground mesh
  69749. * @see https://doc.babylonjs.com/babylon101/height_map
  69750. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69751. */
  69752. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69753. width?: number;
  69754. height?: number;
  69755. subdivisions?: number;
  69756. minHeight?: number;
  69757. maxHeight?: number;
  69758. colorFilter?: Color3;
  69759. alphaFilter?: number;
  69760. updatable?: boolean;
  69761. onReady?: (mesh: GroundMesh) => void;
  69762. }, scene?: Nullable<Scene>): GroundMesh;
  69763. /**
  69764. * Creates a polygon mesh
  69765. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69766. * * 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
  69767. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69768. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69769. * * 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)
  69770. * * Remember you can only change the shape positions, not their number when updating a polygon
  69771. * @param name defines the name of the mesh
  69772. * @param options defines the options used to create the mesh
  69773. * @param scene defines the hosting scene
  69774. * @param earcutInjection can be used to inject your own earcut reference
  69775. * @returns the polygon mesh
  69776. */
  69777. static CreatePolygon(name: string, options: {
  69778. shape: Vector3[];
  69779. holes?: Vector3[][];
  69780. depth?: number;
  69781. faceUV?: Vector4[];
  69782. faceColors?: Color4[];
  69783. updatable?: boolean;
  69784. sideOrientation?: number;
  69785. frontUVs?: Vector4;
  69786. backUVs?: Vector4;
  69787. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69788. /**
  69789. * Creates an extruded polygon mesh, with depth in the Y direction.
  69790. * * 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)
  69791. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69792. * @param name defines the name of the mesh
  69793. * @param options defines the options used to create the mesh
  69794. * @param scene defines the hosting scene
  69795. * @param earcutInjection can be used to inject your own earcut reference
  69796. * @returns the polygon mesh
  69797. */
  69798. static ExtrudePolygon(name: string, options: {
  69799. shape: Vector3[];
  69800. holes?: Vector3[][];
  69801. depth?: number;
  69802. faceUV?: Vector4[];
  69803. faceColors?: Color4[];
  69804. updatable?: boolean;
  69805. sideOrientation?: number;
  69806. frontUVs?: Vector4;
  69807. backUVs?: Vector4;
  69808. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69809. /**
  69810. * Creates a tube mesh.
  69811. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69812. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69813. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69814. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69815. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69816. * * 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)
  69817. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69818. * * 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
  69819. * * 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
  69820. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69821. * * 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
  69822. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69823. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69824. * @param name defines the name of the mesh
  69825. * @param options defines the options used to create the mesh
  69826. * @param scene defines the hosting scene
  69827. * @returns the tube mesh
  69828. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69829. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69830. */
  69831. static CreateTube(name: string, options: {
  69832. path: Vector3[];
  69833. radius?: number;
  69834. tessellation?: number;
  69835. radiusFunction?: {
  69836. (i: number, distance: number): number;
  69837. };
  69838. cap?: number;
  69839. arc?: number;
  69840. updatable?: boolean;
  69841. sideOrientation?: number;
  69842. frontUVs?: Vector4;
  69843. backUVs?: Vector4;
  69844. instance?: Mesh;
  69845. invertUV?: boolean;
  69846. }, scene?: Nullable<Scene>): Mesh;
  69847. /**
  69848. * Creates a polyhedron mesh
  69849. * * 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
  69850. * * The parameter `size` (positive float, default 1) sets the polygon size
  69851. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69852. * * 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`
  69853. * * 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
  69854. * * 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)`)
  69855. * * 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
  69856. * * 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
  69857. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69858. * * 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
  69859. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69860. * @param name defines the name of the mesh
  69861. * @param options defines the options used to create the mesh
  69862. * @param scene defines the hosting scene
  69863. * @returns the polyhedron mesh
  69864. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69865. */
  69866. static CreatePolyhedron(name: string, options: {
  69867. type?: number;
  69868. size?: number;
  69869. sizeX?: number;
  69870. sizeY?: number;
  69871. sizeZ?: number;
  69872. custom?: any;
  69873. faceUV?: Vector4[];
  69874. faceColors?: Color4[];
  69875. flat?: boolean;
  69876. updatable?: boolean;
  69877. sideOrientation?: number;
  69878. frontUVs?: Vector4;
  69879. backUVs?: Vector4;
  69880. }, scene?: Nullable<Scene>): Mesh;
  69881. /**
  69882. * Creates a decal mesh.
  69883. * 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
  69884. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69885. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69886. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69887. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69888. * @param name defines the name of the mesh
  69889. * @param sourceMesh defines the mesh where the decal must be applied
  69890. * @param options defines the options used to create the mesh
  69891. * @param scene defines the hosting scene
  69892. * @returns the decal mesh
  69893. * @see https://doc.babylonjs.com/how_to/decals
  69894. */
  69895. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69896. position?: Vector3;
  69897. normal?: Vector3;
  69898. size?: Vector3;
  69899. angle?: number;
  69900. }): Mesh;
  69901. }
  69902. }
  69903. declare module "babylonjs/Meshes/meshSimplification" {
  69904. import { Mesh } from "babylonjs/Meshes/mesh";
  69905. /**
  69906. * A simplifier interface for future simplification implementations
  69907. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69908. */
  69909. export interface ISimplifier {
  69910. /**
  69911. * Simplification of a given mesh according to the given settings.
  69912. * Since this requires computation, it is assumed that the function runs async.
  69913. * @param settings The settings of the simplification, including quality and distance
  69914. * @param successCallback A callback that will be called after the mesh was simplified.
  69915. * @param errorCallback in case of an error, this callback will be called. optional.
  69916. */
  69917. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69918. }
  69919. /**
  69920. * Expected simplification settings.
  69921. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69922. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69923. */
  69924. export interface ISimplificationSettings {
  69925. /**
  69926. * Gets or sets the expected quality
  69927. */
  69928. quality: number;
  69929. /**
  69930. * Gets or sets the distance when this optimized version should be used
  69931. */
  69932. distance: number;
  69933. /**
  69934. * Gets an already optimized mesh
  69935. */
  69936. optimizeMesh?: boolean;
  69937. }
  69938. /**
  69939. * Class used to specify simplification options
  69940. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69941. */
  69942. export class SimplificationSettings implements ISimplificationSettings {
  69943. /** expected quality */
  69944. quality: number;
  69945. /** distance when this optimized version should be used */
  69946. distance: number;
  69947. /** already optimized mesh */
  69948. optimizeMesh?: boolean | undefined;
  69949. /**
  69950. * Creates a SimplificationSettings
  69951. * @param quality expected quality
  69952. * @param distance distance when this optimized version should be used
  69953. * @param optimizeMesh already optimized mesh
  69954. */
  69955. constructor(
  69956. /** expected quality */
  69957. quality: number,
  69958. /** distance when this optimized version should be used */
  69959. distance: number,
  69960. /** already optimized mesh */
  69961. optimizeMesh?: boolean | undefined);
  69962. }
  69963. /**
  69964. * Interface used to define a simplification task
  69965. */
  69966. export interface ISimplificationTask {
  69967. /**
  69968. * Array of settings
  69969. */
  69970. settings: Array<ISimplificationSettings>;
  69971. /**
  69972. * Simplification type
  69973. */
  69974. simplificationType: SimplificationType;
  69975. /**
  69976. * Mesh to simplify
  69977. */
  69978. mesh: Mesh;
  69979. /**
  69980. * Callback called on success
  69981. */
  69982. successCallback?: () => void;
  69983. /**
  69984. * Defines if parallel processing can be used
  69985. */
  69986. parallelProcessing: boolean;
  69987. }
  69988. /**
  69989. * Queue used to order the simplification tasks
  69990. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69991. */
  69992. export class SimplificationQueue {
  69993. private _simplificationArray;
  69994. /**
  69995. * Gets a boolean indicating that the process is still running
  69996. */
  69997. running: boolean;
  69998. /**
  69999. * Creates a new queue
  70000. */
  70001. constructor();
  70002. /**
  70003. * Adds a new simplification task
  70004. * @param task defines a task to add
  70005. */
  70006. addTask(task: ISimplificationTask): void;
  70007. /**
  70008. * Execute next task
  70009. */
  70010. executeNext(): void;
  70011. /**
  70012. * Execute a simplification task
  70013. * @param task defines the task to run
  70014. */
  70015. runSimplification(task: ISimplificationTask): void;
  70016. private getSimplifier;
  70017. }
  70018. /**
  70019. * The implemented types of simplification
  70020. * At the moment only Quadratic Error Decimation is implemented
  70021. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70022. */
  70023. export enum SimplificationType {
  70024. /** Quadratic error decimation */
  70025. QUADRATIC = 0
  70026. }
  70027. /**
  70028. * An implementation of the Quadratic Error simplification algorithm.
  70029. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  70030. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  70031. * @author RaananW
  70032. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70033. */
  70034. export class QuadraticErrorSimplification implements ISimplifier {
  70035. private _mesh;
  70036. private triangles;
  70037. private vertices;
  70038. private references;
  70039. private _reconstructedMesh;
  70040. /** Gets or sets the number pf sync interations */
  70041. syncIterations: number;
  70042. /** Gets or sets the aggressiveness of the simplifier */
  70043. aggressiveness: number;
  70044. /** Gets or sets the number of allowed iterations for decimation */
  70045. decimationIterations: number;
  70046. /** Gets or sets the espilon to use for bounding box computation */
  70047. boundingBoxEpsilon: number;
  70048. /**
  70049. * Creates a new QuadraticErrorSimplification
  70050. * @param _mesh defines the target mesh
  70051. */
  70052. constructor(_mesh: Mesh);
  70053. /**
  70054. * Simplification of a given mesh according to the given settings.
  70055. * Since this requires computation, it is assumed that the function runs async.
  70056. * @param settings The settings of the simplification, including quality and distance
  70057. * @param successCallback A callback that will be called after the mesh was simplified.
  70058. */
  70059. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  70060. private runDecimation;
  70061. private initWithMesh;
  70062. private init;
  70063. private reconstructMesh;
  70064. private initDecimatedMesh;
  70065. private isFlipped;
  70066. private updateTriangles;
  70067. private identifyBorder;
  70068. private updateMesh;
  70069. private vertexError;
  70070. private calculateError;
  70071. }
  70072. }
  70073. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  70074. import { Scene } from "babylonjs/scene";
  70075. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  70076. import { ISceneComponent } from "babylonjs/sceneComponent";
  70077. module "babylonjs/scene" {
  70078. interface Scene {
  70079. /** @hidden (Backing field) */
  70080. _simplificationQueue: SimplificationQueue;
  70081. /**
  70082. * Gets or sets the simplification queue attached to the scene
  70083. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70084. */
  70085. simplificationQueue: SimplificationQueue;
  70086. }
  70087. }
  70088. module "babylonjs/Meshes/mesh" {
  70089. interface Mesh {
  70090. /**
  70091. * Simplify the mesh according to the given array of settings.
  70092. * Function will return immediately and will simplify async
  70093. * @param settings a collection of simplification settings
  70094. * @param parallelProcessing should all levels calculate parallel or one after the other
  70095. * @param simplificationType the type of simplification to run
  70096. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70097. * @returns the current mesh
  70098. */
  70099. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70100. }
  70101. }
  70102. /**
  70103. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70104. * created in a scene
  70105. */
  70106. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70107. /**
  70108. * The component name helpfull to identify the component in the list of scene components.
  70109. */
  70110. readonly name: string;
  70111. /**
  70112. * The scene the component belongs to.
  70113. */
  70114. scene: Scene;
  70115. /**
  70116. * Creates a new instance of the component for the given scene
  70117. * @param scene Defines the scene to register the component in
  70118. */
  70119. constructor(scene: Scene);
  70120. /**
  70121. * Registers the component in a given scene
  70122. */
  70123. register(): void;
  70124. /**
  70125. * Rebuilds the elements related to this component in case of
  70126. * context lost for instance.
  70127. */
  70128. rebuild(): void;
  70129. /**
  70130. * Disposes the component and the associated ressources
  70131. */
  70132. dispose(): void;
  70133. private _beforeCameraUpdate;
  70134. }
  70135. }
  70136. declare module "babylonjs/Meshes/Builders/index" {
  70137. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70138. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70139. export * from "babylonjs/Meshes/Builders/discBuilder";
  70140. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70141. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70142. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70143. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70144. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70145. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70146. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70147. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70148. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70149. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70150. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70151. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70152. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70153. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70154. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70155. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70156. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70157. }
  70158. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70159. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70160. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70161. import { Matrix } from "babylonjs/Maths/math.vector";
  70162. module "babylonjs/Meshes/mesh" {
  70163. interface Mesh {
  70164. /**
  70165. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70166. */
  70167. thinInstanceEnablePicking: boolean;
  70168. /**
  70169. * Creates a new thin instance
  70170. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70171. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  70172. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70173. */
  70174. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70175. /**
  70176. * Adds the transformation (matrix) of the current mesh as a thin instance
  70177. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  70178. * @returns the thin instance index number
  70179. */
  70180. thinInstanceAddSelf(refresh: boolean): number;
  70181. /**
  70182. * Registers a custom attribute to be used with thin instances
  70183. * @param kind name of the attribute
  70184. * @param stride size in floats of the attribute
  70185. */
  70186. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70187. /**
  70188. * Sets the matrix of a thin instance
  70189. * @param index index of the thin instance
  70190. * @param matrix matrix to set
  70191. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  70192. */
  70193. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70194. /**
  70195. * Sets the value of a custom attribute for a thin instance
  70196. * @param kind name of the attribute
  70197. * @param index index of the thin instance
  70198. * @param value value to set
  70199. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  70200. */
  70201. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70202. /**
  70203. * Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.
  70204. */
  70205. thinInstanceCount: number;
  70206. /**
  70207. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70208. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70209. * @param buffer buffer to set
  70210. * @param stride size in floats of each value of the buffer
  70211. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70212. */
  70213. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70214. /**
  70215. * Gets the list of world matrices
  70216. * @return an array containing all the world matrices from the thin instances
  70217. */
  70218. thinInstanceGetWorldMatrices(): Matrix[];
  70219. /**
  70220. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70221. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70222. */
  70223. thinInstanceBufferUpdated(kind: string): void;
  70224. /**
  70225. * Applies a partial update to a buffer directly on the GPU
  70226. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  70227. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70228. * @param data the data to set in the GPU buffer
  70229. * @param offset the offset in the GPU buffer where to update the data
  70230. */
  70231. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70232. /**
  70233. * Refreshes the bounding info, taking into account all the thin instances defined
  70234. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70235. */
  70236. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70237. /** @hidden */
  70238. _thinInstanceInitializeUserStorage(): void;
  70239. /** @hidden */
  70240. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70241. /** @hidden */
  70242. _userThinInstanceBuffersStorage: {
  70243. data: {
  70244. [key: string]: Float32Array;
  70245. };
  70246. sizes: {
  70247. [key: string]: number;
  70248. };
  70249. vertexBuffers: {
  70250. [key: string]: Nullable<VertexBuffer>;
  70251. };
  70252. strides: {
  70253. [key: string]: number;
  70254. };
  70255. };
  70256. }
  70257. }
  70258. }
  70259. declare module "babylonjs/Meshes/index" {
  70260. export * from "babylonjs/Meshes/abstractMesh";
  70261. export * from "babylonjs/Meshes/buffer";
  70262. export * from "babylonjs/Meshes/Compression/index";
  70263. export * from "babylonjs/Meshes/csg";
  70264. export * from "babylonjs/Meshes/geometry";
  70265. export * from "babylonjs/Meshes/groundMesh";
  70266. export * from "babylonjs/Meshes/trailMesh";
  70267. export * from "babylonjs/Meshes/instancedMesh";
  70268. export * from "babylonjs/Meshes/linesMesh";
  70269. export * from "babylonjs/Meshes/mesh";
  70270. export * from "babylonjs/Meshes/mesh.vertexData";
  70271. export * from "babylonjs/Meshes/meshBuilder";
  70272. export * from "babylonjs/Meshes/meshSimplification";
  70273. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70274. export * from "babylonjs/Meshes/polygonMesh";
  70275. export * from "babylonjs/Meshes/subMesh";
  70276. export * from "babylonjs/Meshes/meshLODLevel";
  70277. export * from "babylonjs/Meshes/transformNode";
  70278. export * from "babylonjs/Meshes/Builders/index";
  70279. export * from "babylonjs/Meshes/dataBuffer";
  70280. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70281. import "babylonjs/Meshes/thinInstanceMesh";
  70282. export * from "babylonjs/Meshes/thinInstanceMesh";
  70283. }
  70284. declare module "babylonjs/Morph/index" {
  70285. export * from "babylonjs/Morph/morphTarget";
  70286. export * from "babylonjs/Morph/morphTargetManager";
  70287. }
  70288. declare module "babylonjs/Navigation/INavigationEngine" {
  70289. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70290. import { Vector3 } from "babylonjs/Maths/math";
  70291. import { Mesh } from "babylonjs/Meshes/mesh";
  70292. import { Scene } from "babylonjs/scene";
  70293. /**
  70294. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70295. */
  70296. export interface INavigationEnginePlugin {
  70297. /**
  70298. * plugin name
  70299. */
  70300. name: string;
  70301. /**
  70302. * Creates a navigation mesh
  70303. * @param meshes array of all the geometry used to compute the navigatio mesh
  70304. * @param parameters bunch of parameters used to filter geometry
  70305. */
  70306. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70307. /**
  70308. * Create a navigation mesh debug mesh
  70309. * @param scene is where the mesh will be added
  70310. * @returns debug display mesh
  70311. */
  70312. createDebugNavMesh(scene: Scene): Mesh;
  70313. /**
  70314. * Get a navigation mesh constrained position, closest to the parameter position
  70315. * @param position world position
  70316. * @returns the closest point to position constrained by the navigation mesh
  70317. */
  70318. getClosestPoint(position: Vector3): Vector3;
  70319. /**
  70320. * Get a navigation mesh constrained position, closest to the parameter position
  70321. * @param position world position
  70322. * @param result output the closest point to position constrained by the navigation mesh
  70323. */
  70324. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70325. /**
  70326. * Get a navigation mesh constrained position, within a particular radius
  70327. * @param position world position
  70328. * @param maxRadius the maximum distance to the constrained world position
  70329. * @returns the closest point to position constrained by the navigation mesh
  70330. */
  70331. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70332. /**
  70333. * Get a navigation mesh constrained position, within a particular radius
  70334. * @param position world position
  70335. * @param maxRadius the maximum distance to the constrained world position
  70336. * @param result output the closest point to position constrained by the navigation mesh
  70337. */
  70338. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70339. /**
  70340. * Compute the final position from a segment made of destination-position
  70341. * @param position world position
  70342. * @param destination world position
  70343. * @returns the resulting point along the navmesh
  70344. */
  70345. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70346. /**
  70347. * Compute the final position from a segment made of destination-position
  70348. * @param position world position
  70349. * @param destination world position
  70350. * @param result output the resulting point along the navmesh
  70351. */
  70352. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70353. /**
  70354. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70355. * @param start world position
  70356. * @param end world position
  70357. * @returns array containing world position composing the path
  70358. */
  70359. computePath(start: Vector3, end: Vector3): Vector3[];
  70360. /**
  70361. * If this plugin is supported
  70362. * @returns true if plugin is supported
  70363. */
  70364. isSupported(): boolean;
  70365. /**
  70366. * Create a new Crowd so you can add agents
  70367. * @param maxAgents the maximum agent count in the crowd
  70368. * @param maxAgentRadius the maximum radius an agent can have
  70369. * @param scene to attach the crowd to
  70370. * @returns the crowd you can add agents to
  70371. */
  70372. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70373. /**
  70374. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70375. * The queries will try to find a solution within those bounds
  70376. * default is (1,1,1)
  70377. * @param extent x,y,z value that define the extent around the queries point of reference
  70378. */
  70379. setDefaultQueryExtent(extent: Vector3): void;
  70380. /**
  70381. * Get the Bounding box extent specified by setDefaultQueryExtent
  70382. * @returns the box extent values
  70383. */
  70384. getDefaultQueryExtent(): Vector3;
  70385. /**
  70386. * build the navmesh from a previously saved state using getNavmeshData
  70387. * @param data the Uint8Array returned by getNavmeshData
  70388. */
  70389. buildFromNavmeshData(data: Uint8Array): void;
  70390. /**
  70391. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70392. * @returns data the Uint8Array that can be saved and reused
  70393. */
  70394. getNavmeshData(): Uint8Array;
  70395. /**
  70396. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70397. * @param result output the box extent values
  70398. */
  70399. getDefaultQueryExtentToRef(result: Vector3): void;
  70400. /**
  70401. * Release all resources
  70402. */
  70403. dispose(): void;
  70404. }
  70405. /**
  70406. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70407. */
  70408. export interface ICrowd {
  70409. /**
  70410. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70411. * You can attach anything to that node. The node position is updated in the scene update tick.
  70412. * @param pos world position that will be constrained by the navigation mesh
  70413. * @param parameters agent parameters
  70414. * @param transform hooked to the agent that will be update by the scene
  70415. * @returns agent index
  70416. */
  70417. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70418. /**
  70419. * Returns the agent position in world space
  70420. * @param index agent index returned by addAgent
  70421. * @returns world space position
  70422. */
  70423. getAgentPosition(index: number): Vector3;
  70424. /**
  70425. * Gets the agent position result in world space
  70426. * @param index agent index returned by addAgent
  70427. * @param result output world space position
  70428. */
  70429. getAgentPositionToRef(index: number, result: Vector3): void;
  70430. /**
  70431. * Gets the agent velocity in world space
  70432. * @param index agent index returned by addAgent
  70433. * @returns world space velocity
  70434. */
  70435. getAgentVelocity(index: number): Vector3;
  70436. /**
  70437. * Gets the agent velocity result in world space
  70438. * @param index agent index returned by addAgent
  70439. * @param result output world space velocity
  70440. */
  70441. getAgentVelocityToRef(index: number, result: Vector3): void;
  70442. /**
  70443. * remove a particular agent previously created
  70444. * @param index agent index returned by addAgent
  70445. */
  70446. removeAgent(index: number): void;
  70447. /**
  70448. * get the list of all agents attached to this crowd
  70449. * @returns list of agent indices
  70450. */
  70451. getAgents(): number[];
  70452. /**
  70453. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70454. * @param deltaTime in seconds
  70455. */
  70456. update(deltaTime: number): void;
  70457. /**
  70458. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70459. * @param index agent index returned by addAgent
  70460. * @param destination targeted world position
  70461. */
  70462. agentGoto(index: number, destination: Vector3): void;
  70463. /**
  70464. * Teleport the agent to a new position
  70465. * @param index agent index returned by addAgent
  70466. * @param destination targeted world position
  70467. */
  70468. agentTeleport(index: number, destination: Vector3): void;
  70469. /**
  70470. * Update agent parameters
  70471. * @param index agent index returned by addAgent
  70472. * @param parameters agent parameters
  70473. */
  70474. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70475. /**
  70476. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70477. * The queries will try to find a solution within those bounds
  70478. * default is (1,1,1)
  70479. * @param extent x,y,z value that define the extent around the queries point of reference
  70480. */
  70481. setDefaultQueryExtent(extent: Vector3): void;
  70482. /**
  70483. * Get the Bounding box extent specified by setDefaultQueryExtent
  70484. * @returns the box extent values
  70485. */
  70486. getDefaultQueryExtent(): Vector3;
  70487. /**
  70488. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70489. * @param result output the box extent values
  70490. */
  70491. getDefaultQueryExtentToRef(result: Vector3): void;
  70492. /**
  70493. * Release all resources
  70494. */
  70495. dispose(): void;
  70496. }
  70497. /**
  70498. * Configures an agent
  70499. */
  70500. export interface IAgentParameters {
  70501. /**
  70502. * Agent radius. [Limit: >= 0]
  70503. */
  70504. radius: number;
  70505. /**
  70506. * Agent height. [Limit: > 0]
  70507. */
  70508. height: number;
  70509. /**
  70510. * Maximum allowed acceleration. [Limit: >= 0]
  70511. */
  70512. maxAcceleration: number;
  70513. /**
  70514. * Maximum allowed speed. [Limit: >= 0]
  70515. */
  70516. maxSpeed: number;
  70517. /**
  70518. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70519. */
  70520. collisionQueryRange: number;
  70521. /**
  70522. * The path visibility optimization range. [Limit: > 0]
  70523. */
  70524. pathOptimizationRange: number;
  70525. /**
  70526. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70527. */
  70528. separationWeight: number;
  70529. }
  70530. /**
  70531. * Configures the navigation mesh creation
  70532. */
  70533. export interface INavMeshParameters {
  70534. /**
  70535. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70536. */
  70537. cs: number;
  70538. /**
  70539. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70540. */
  70541. ch: number;
  70542. /**
  70543. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70544. */
  70545. walkableSlopeAngle: number;
  70546. /**
  70547. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70548. * be considered walkable. [Limit: >= 3] [Units: vx]
  70549. */
  70550. walkableHeight: number;
  70551. /**
  70552. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70553. */
  70554. walkableClimb: number;
  70555. /**
  70556. * The distance to erode/shrink the walkable area of the heightfield away from
  70557. * obstructions. [Limit: >=0] [Units: vx]
  70558. */
  70559. walkableRadius: number;
  70560. /**
  70561. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70562. */
  70563. maxEdgeLen: number;
  70564. /**
  70565. * The maximum distance a simplfied contour's border edges should deviate
  70566. * the original raw contour. [Limit: >=0] [Units: vx]
  70567. */
  70568. maxSimplificationError: number;
  70569. /**
  70570. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70571. */
  70572. minRegionArea: number;
  70573. /**
  70574. * Any regions with a span count smaller than this value will, if possible,
  70575. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70576. */
  70577. mergeRegionArea: number;
  70578. /**
  70579. * The maximum number of vertices allowed for polygons generated during the
  70580. * contour to polygon conversion process. [Limit: >= 3]
  70581. */
  70582. maxVertsPerPoly: number;
  70583. /**
  70584. * Sets the sampling distance to use when generating the detail mesh.
  70585. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70586. */
  70587. detailSampleDist: number;
  70588. /**
  70589. * The maximum distance the detail mesh surface should deviate from heightfield
  70590. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70591. */
  70592. detailSampleMaxError: number;
  70593. }
  70594. }
  70595. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70596. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70597. import { Mesh } from "babylonjs/Meshes/mesh";
  70598. import { Scene } from "babylonjs/scene";
  70599. import { Vector3 } from "babylonjs/Maths/math";
  70600. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70601. /**
  70602. * RecastJS navigation plugin
  70603. */
  70604. export class RecastJSPlugin implements INavigationEnginePlugin {
  70605. /**
  70606. * Reference to the Recast library
  70607. */
  70608. bjsRECAST: any;
  70609. /**
  70610. * plugin name
  70611. */
  70612. name: string;
  70613. /**
  70614. * the first navmesh created. We might extend this to support multiple navmeshes
  70615. */
  70616. navMesh: any;
  70617. /**
  70618. * Initializes the recastJS plugin
  70619. * @param recastInjection can be used to inject your own recast reference
  70620. */
  70621. constructor(recastInjection?: any);
  70622. /**
  70623. * Creates a navigation mesh
  70624. * @param meshes array of all the geometry used to compute the navigatio mesh
  70625. * @param parameters bunch of parameters used to filter geometry
  70626. */
  70627. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70628. /**
  70629. * Create a navigation mesh debug mesh
  70630. * @param scene is where the mesh will be added
  70631. * @returns debug display mesh
  70632. */
  70633. createDebugNavMesh(scene: Scene): Mesh;
  70634. /**
  70635. * Get a navigation mesh constrained position, closest to the parameter position
  70636. * @param position world position
  70637. * @returns the closest point to position constrained by the navigation mesh
  70638. */
  70639. getClosestPoint(position: Vector3): Vector3;
  70640. /**
  70641. * Get a navigation mesh constrained position, closest to the parameter position
  70642. * @param position world position
  70643. * @param result output the closest point to position constrained by the navigation mesh
  70644. */
  70645. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70646. /**
  70647. * Get a navigation mesh constrained position, within a particular radius
  70648. * @param position world position
  70649. * @param maxRadius the maximum distance to the constrained world position
  70650. * @returns the closest point to position constrained by the navigation mesh
  70651. */
  70652. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70653. /**
  70654. * Get a navigation mesh constrained position, within a particular radius
  70655. * @param position world position
  70656. * @param maxRadius the maximum distance to the constrained world position
  70657. * @param result output the closest point to position constrained by the navigation mesh
  70658. */
  70659. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70660. /**
  70661. * Compute the final position from a segment made of destination-position
  70662. * @param position world position
  70663. * @param destination world position
  70664. * @returns the resulting point along the navmesh
  70665. */
  70666. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70667. /**
  70668. * Compute the final position from a segment made of destination-position
  70669. * @param position world position
  70670. * @param destination world position
  70671. * @param result output the resulting point along the navmesh
  70672. */
  70673. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70674. /**
  70675. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70676. * @param start world position
  70677. * @param end world position
  70678. * @returns array containing world position composing the path
  70679. */
  70680. computePath(start: Vector3, end: Vector3): Vector3[];
  70681. /**
  70682. * Create a new Crowd so you can add agents
  70683. * @param maxAgents the maximum agent count in the crowd
  70684. * @param maxAgentRadius the maximum radius an agent can have
  70685. * @param scene to attach the crowd to
  70686. * @returns the crowd you can add agents to
  70687. */
  70688. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70689. /**
  70690. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70691. * The queries will try to find a solution within those bounds
  70692. * default is (1,1,1)
  70693. * @param extent x,y,z value that define the extent around the queries point of reference
  70694. */
  70695. setDefaultQueryExtent(extent: Vector3): void;
  70696. /**
  70697. * Get the Bounding box extent specified by setDefaultQueryExtent
  70698. * @returns the box extent values
  70699. */
  70700. getDefaultQueryExtent(): Vector3;
  70701. /**
  70702. * build the navmesh from a previously saved state using getNavmeshData
  70703. * @param data the Uint8Array returned by getNavmeshData
  70704. */
  70705. buildFromNavmeshData(data: Uint8Array): void;
  70706. /**
  70707. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70708. * @returns data the Uint8Array that can be saved and reused
  70709. */
  70710. getNavmeshData(): Uint8Array;
  70711. /**
  70712. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70713. * @param result output the box extent values
  70714. */
  70715. getDefaultQueryExtentToRef(result: Vector3): void;
  70716. /**
  70717. * Disposes
  70718. */
  70719. dispose(): void;
  70720. /**
  70721. * If this plugin is supported
  70722. * @returns true if plugin is supported
  70723. */
  70724. isSupported(): boolean;
  70725. }
  70726. /**
  70727. * Recast detour crowd implementation
  70728. */
  70729. export class RecastJSCrowd implements ICrowd {
  70730. /**
  70731. * Recast/detour plugin
  70732. */
  70733. bjsRECASTPlugin: RecastJSPlugin;
  70734. /**
  70735. * Link to the detour crowd
  70736. */
  70737. recastCrowd: any;
  70738. /**
  70739. * One transform per agent
  70740. */
  70741. transforms: TransformNode[];
  70742. /**
  70743. * All agents created
  70744. */
  70745. agents: number[];
  70746. /**
  70747. * Link to the scene is kept to unregister the crowd from the scene
  70748. */
  70749. private _scene;
  70750. /**
  70751. * Observer for crowd updates
  70752. */
  70753. private _onBeforeAnimationsObserver;
  70754. /**
  70755. * Constructor
  70756. * @param plugin recastJS plugin
  70757. * @param maxAgents the maximum agent count in the crowd
  70758. * @param maxAgentRadius the maximum radius an agent can have
  70759. * @param scene to attach the crowd to
  70760. * @returns the crowd you can add agents to
  70761. */
  70762. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70763. /**
  70764. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70765. * You can attach anything to that node. The node position is updated in the scene update tick.
  70766. * @param pos world position that will be constrained by the navigation mesh
  70767. * @param parameters agent parameters
  70768. * @param transform hooked to the agent that will be update by the scene
  70769. * @returns agent index
  70770. */
  70771. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70772. /**
  70773. * Returns the agent position in world space
  70774. * @param index agent index returned by addAgent
  70775. * @returns world space position
  70776. */
  70777. getAgentPosition(index: number): Vector3;
  70778. /**
  70779. * Returns the agent position result in world space
  70780. * @param index agent index returned by addAgent
  70781. * @param result output world space position
  70782. */
  70783. getAgentPositionToRef(index: number, result: Vector3): void;
  70784. /**
  70785. * Returns the agent velocity in world space
  70786. * @param index agent index returned by addAgent
  70787. * @returns world space velocity
  70788. */
  70789. getAgentVelocity(index: number): Vector3;
  70790. /**
  70791. * Returns the agent velocity result in world space
  70792. * @param index agent index returned by addAgent
  70793. * @param result output world space velocity
  70794. */
  70795. getAgentVelocityToRef(index: number, result: Vector3): void;
  70796. /**
  70797. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70798. * @param index agent index returned by addAgent
  70799. * @param destination targeted world position
  70800. */
  70801. agentGoto(index: number, destination: Vector3): void;
  70802. /**
  70803. * Teleport the agent to a new position
  70804. * @param index agent index returned by addAgent
  70805. * @param destination targeted world position
  70806. */
  70807. agentTeleport(index: number, destination: Vector3): void;
  70808. /**
  70809. * Update agent parameters
  70810. * @param index agent index returned by addAgent
  70811. * @param parameters agent parameters
  70812. */
  70813. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70814. /**
  70815. * remove a particular agent previously created
  70816. * @param index agent index returned by addAgent
  70817. */
  70818. removeAgent(index: number): void;
  70819. /**
  70820. * get the list of all agents attached to this crowd
  70821. * @returns list of agent indices
  70822. */
  70823. getAgents(): number[];
  70824. /**
  70825. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70826. * @param deltaTime in seconds
  70827. */
  70828. update(deltaTime: number): void;
  70829. /**
  70830. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70831. * The queries will try to find a solution within those bounds
  70832. * default is (1,1,1)
  70833. * @param extent x,y,z value that define the extent around the queries point of reference
  70834. */
  70835. setDefaultQueryExtent(extent: Vector3): void;
  70836. /**
  70837. * Get the Bounding box extent specified by setDefaultQueryExtent
  70838. * @returns the box extent values
  70839. */
  70840. getDefaultQueryExtent(): Vector3;
  70841. /**
  70842. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70843. * @param result output the box extent values
  70844. */
  70845. getDefaultQueryExtentToRef(result: Vector3): void;
  70846. /**
  70847. * Release all resources
  70848. */
  70849. dispose(): void;
  70850. }
  70851. }
  70852. declare module "babylonjs/Navigation/Plugins/index" {
  70853. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70854. }
  70855. declare module "babylonjs/Navigation/index" {
  70856. export * from "babylonjs/Navigation/INavigationEngine";
  70857. export * from "babylonjs/Navigation/Plugins/index";
  70858. }
  70859. declare module "babylonjs/Offline/database" {
  70860. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70861. /**
  70862. * Class used to enable access to IndexedDB
  70863. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70864. */
  70865. export class Database implements IOfflineProvider {
  70866. private _callbackManifestChecked;
  70867. private _currentSceneUrl;
  70868. private _db;
  70869. private _enableSceneOffline;
  70870. private _enableTexturesOffline;
  70871. private _manifestVersionFound;
  70872. private _mustUpdateRessources;
  70873. private _hasReachedQuota;
  70874. private _isSupported;
  70875. private _idbFactory;
  70876. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70877. private static IsUASupportingBlobStorage;
  70878. /**
  70879. * Gets a boolean indicating if Database storate is enabled (off by default)
  70880. */
  70881. static IDBStorageEnabled: boolean;
  70882. /**
  70883. * Gets a boolean indicating if scene must be saved in the database
  70884. */
  70885. get enableSceneOffline(): boolean;
  70886. /**
  70887. * Gets a boolean indicating if textures must be saved in the database
  70888. */
  70889. get enableTexturesOffline(): boolean;
  70890. /**
  70891. * Creates a new Database
  70892. * @param urlToScene defines the url to load the scene
  70893. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70894. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70895. */
  70896. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70897. private static _ParseURL;
  70898. private static _ReturnFullUrlLocation;
  70899. private _checkManifestFile;
  70900. /**
  70901. * Open the database and make it available
  70902. * @param successCallback defines the callback to call on success
  70903. * @param errorCallback defines the callback to call on error
  70904. */
  70905. open(successCallback: () => void, errorCallback: () => void): void;
  70906. /**
  70907. * Loads an image from the database
  70908. * @param url defines the url to load from
  70909. * @param image defines the target DOM image
  70910. */
  70911. loadImage(url: string, image: HTMLImageElement): void;
  70912. private _loadImageFromDBAsync;
  70913. private _saveImageIntoDBAsync;
  70914. private _checkVersionFromDB;
  70915. private _loadVersionFromDBAsync;
  70916. private _saveVersionIntoDBAsync;
  70917. /**
  70918. * Loads a file from database
  70919. * @param url defines the URL to load from
  70920. * @param sceneLoaded defines a callback to call on success
  70921. * @param progressCallBack defines a callback to call when progress changed
  70922. * @param errorCallback defines a callback to call on error
  70923. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70924. */
  70925. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70926. private _loadFileAsync;
  70927. private _saveFileAsync;
  70928. /**
  70929. * Validates if xhr data is correct
  70930. * @param xhr defines the request to validate
  70931. * @param dataType defines the expected data type
  70932. * @returns true if data is correct
  70933. */
  70934. private static _ValidateXHRData;
  70935. }
  70936. }
  70937. declare module "babylonjs/Offline/index" {
  70938. export * from "babylonjs/Offline/database";
  70939. export * from "babylonjs/Offline/IOfflineProvider";
  70940. }
  70941. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70942. /** @hidden */
  70943. export var gpuUpdateParticlesPixelShader: {
  70944. name: string;
  70945. shader: string;
  70946. };
  70947. }
  70948. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70949. /** @hidden */
  70950. export var gpuUpdateParticlesVertexShader: {
  70951. name: string;
  70952. shader: string;
  70953. };
  70954. }
  70955. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70956. /** @hidden */
  70957. export var clipPlaneFragmentDeclaration2: {
  70958. name: string;
  70959. shader: string;
  70960. };
  70961. }
  70962. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70963. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70964. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70965. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70966. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70967. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70968. /** @hidden */
  70969. export var gpuRenderParticlesPixelShader: {
  70970. name: string;
  70971. shader: string;
  70972. };
  70973. }
  70974. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70975. /** @hidden */
  70976. export var clipPlaneVertexDeclaration2: {
  70977. name: string;
  70978. shader: string;
  70979. };
  70980. }
  70981. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70982. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70983. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70984. /** @hidden */
  70985. export var gpuRenderParticlesVertexShader: {
  70986. name: string;
  70987. shader: string;
  70988. };
  70989. }
  70990. declare module "babylonjs/Particles/gpuParticleSystem" {
  70991. import { Nullable } from "babylonjs/types";
  70992. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70993. import { Observable } from "babylonjs/Misc/observable";
  70994. import { Matrix } from "babylonjs/Maths/math.vector";
  70995. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70996. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70997. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70998. import { IDisposable } from "babylonjs/scene";
  70999. import { Effect } from "babylonjs/Materials/effect";
  71000. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  71001. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  71002. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  71003. import { Scene } from "babylonjs/scene";
  71004. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  71005. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  71006. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  71007. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  71008. /**
  71009. * This represents a GPU particle system in Babylon
  71010. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  71011. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  71012. */
  71013. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  71014. /**
  71015. * The layer mask we are rendering the particles through.
  71016. */
  71017. layerMask: number;
  71018. private _capacity;
  71019. private _activeCount;
  71020. private _currentActiveCount;
  71021. private _accumulatedCount;
  71022. private _renderEffect;
  71023. private _updateEffect;
  71024. private _buffer0;
  71025. private _buffer1;
  71026. private _spriteBuffer;
  71027. private _updateVAO;
  71028. private _renderVAO;
  71029. private _targetIndex;
  71030. private _sourceBuffer;
  71031. private _targetBuffer;
  71032. private _currentRenderId;
  71033. private _started;
  71034. private _stopped;
  71035. private _timeDelta;
  71036. private _randomTexture;
  71037. private _randomTexture2;
  71038. private _attributesStrideSize;
  71039. private _updateEffectOptions;
  71040. private _randomTextureSize;
  71041. private _actualFrame;
  71042. private _customEffect;
  71043. private readonly _rawTextureWidth;
  71044. /**
  71045. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  71046. */
  71047. static get IsSupported(): boolean;
  71048. /**
  71049. * An event triggered when the system is disposed.
  71050. */
  71051. onDisposeObservable: Observable<IParticleSystem>;
  71052. /**
  71053. * Gets the maximum number of particles active at the same time.
  71054. * @returns The max number of active particles.
  71055. */
  71056. getCapacity(): number;
  71057. /**
  71058. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  71059. * to override the particles.
  71060. */
  71061. forceDepthWrite: boolean;
  71062. /**
  71063. * Gets or set the number of active particles
  71064. */
  71065. get activeParticleCount(): number;
  71066. set activeParticleCount(value: number);
  71067. private _preWarmDone;
  71068. /**
  71069. * Specifies if the particles are updated in emitter local space or world space.
  71070. */
  71071. isLocal: boolean;
  71072. /** Gets or sets a matrix to use to compute projection */
  71073. defaultProjectionMatrix: Matrix;
  71074. /**
  71075. * Is this system ready to be used/rendered
  71076. * @return true if the system is ready
  71077. */
  71078. isReady(): boolean;
  71079. /**
  71080. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71081. * @returns True if it has been started, otherwise false.
  71082. */
  71083. isStarted(): boolean;
  71084. /**
  71085. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71086. * @returns True if it has been stopped, otherwise false.
  71087. */
  71088. isStopped(): boolean;
  71089. /**
  71090. * Gets a boolean indicating that the system is stopping
  71091. * @returns true if the system is currently stopping
  71092. */
  71093. isStopping(): boolean;
  71094. /**
  71095. * Gets the number of particles active at the same time.
  71096. * @returns The number of active particles.
  71097. */
  71098. getActiveCount(): number;
  71099. /**
  71100. * Starts the particle system and begins to emit
  71101. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71102. */
  71103. start(delay?: number): void;
  71104. /**
  71105. * Stops the particle system.
  71106. */
  71107. stop(): void;
  71108. /**
  71109. * Remove all active particles
  71110. */
  71111. reset(): void;
  71112. /**
  71113. * Returns the string "GPUParticleSystem"
  71114. * @returns a string containing the class name
  71115. */
  71116. getClassName(): string;
  71117. /**
  71118. * Gets the custom effect used to render the particles
  71119. * @param blendMode Blend mode for which the effect should be retrieved
  71120. * @returns The effect
  71121. */
  71122. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71123. /**
  71124. * Sets the custom effect used to render the particles
  71125. * @param effect The effect to set
  71126. * @param blendMode Blend mode for which the effect should be set
  71127. */
  71128. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71129. /** @hidden */
  71130. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71131. /**
  71132. * Observable that will be called just before the particles are drawn
  71133. */
  71134. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71135. /**
  71136. * Gets the name of the particle vertex shader
  71137. */
  71138. get vertexShaderName(): string;
  71139. private _colorGradientsTexture;
  71140. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71141. /**
  71142. * Adds a new color gradient
  71143. * @param gradient defines the gradient to use (between 0 and 1)
  71144. * @param color1 defines the color to affect to the specified gradient
  71145. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71146. * @returns the current particle system
  71147. */
  71148. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71149. private _refreshColorGradient;
  71150. /** Force the system to rebuild all gradients that need to be resync */
  71151. forceRefreshGradients(): void;
  71152. /**
  71153. * Remove a specific color gradient
  71154. * @param gradient defines the gradient to remove
  71155. * @returns the current particle system
  71156. */
  71157. removeColorGradient(gradient: number): GPUParticleSystem;
  71158. private _angularSpeedGradientsTexture;
  71159. private _sizeGradientsTexture;
  71160. private _velocityGradientsTexture;
  71161. private _limitVelocityGradientsTexture;
  71162. private _dragGradientsTexture;
  71163. private _addFactorGradient;
  71164. /**
  71165. * Adds a new size gradient
  71166. * @param gradient defines the gradient to use (between 0 and 1)
  71167. * @param factor defines the size factor to affect to the specified gradient
  71168. * @returns the current particle system
  71169. */
  71170. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71171. /**
  71172. * Remove a specific size gradient
  71173. * @param gradient defines the gradient to remove
  71174. * @returns the current particle system
  71175. */
  71176. removeSizeGradient(gradient: number): GPUParticleSystem;
  71177. private _refreshFactorGradient;
  71178. /**
  71179. * Adds a new angular speed gradient
  71180. * @param gradient defines the gradient to use (between 0 and 1)
  71181. * @param factor defines the angular speed to affect to the specified gradient
  71182. * @returns the current particle system
  71183. */
  71184. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71185. /**
  71186. * Remove a specific angular speed gradient
  71187. * @param gradient defines the gradient to remove
  71188. * @returns the current particle system
  71189. */
  71190. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71191. /**
  71192. * Adds a new velocity gradient
  71193. * @param gradient defines the gradient to use (between 0 and 1)
  71194. * @param factor defines the velocity to affect to the specified gradient
  71195. * @returns the current particle system
  71196. */
  71197. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71198. /**
  71199. * Remove a specific velocity gradient
  71200. * @param gradient defines the gradient to remove
  71201. * @returns the current particle system
  71202. */
  71203. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71204. /**
  71205. * Adds a new limit velocity gradient
  71206. * @param gradient defines the gradient to use (between 0 and 1)
  71207. * @param factor defines the limit velocity value to affect to the specified gradient
  71208. * @returns the current particle system
  71209. */
  71210. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71211. /**
  71212. * Remove a specific limit velocity gradient
  71213. * @param gradient defines the gradient to remove
  71214. * @returns the current particle system
  71215. */
  71216. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71217. /**
  71218. * Adds a new drag gradient
  71219. * @param gradient defines the gradient to use (between 0 and 1)
  71220. * @param factor defines the drag value to affect to the specified gradient
  71221. * @returns the current particle system
  71222. */
  71223. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71224. /**
  71225. * Remove a specific drag gradient
  71226. * @param gradient defines the gradient to remove
  71227. * @returns the current particle system
  71228. */
  71229. removeDragGradient(gradient: number): GPUParticleSystem;
  71230. /**
  71231. * Not supported by GPUParticleSystem
  71232. * @param gradient defines the gradient to use (between 0 and 1)
  71233. * @param factor defines the emit rate value to affect to the specified gradient
  71234. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71235. * @returns the current particle system
  71236. */
  71237. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71238. /**
  71239. * Not supported by GPUParticleSystem
  71240. * @param gradient defines the gradient to remove
  71241. * @returns the current particle system
  71242. */
  71243. removeEmitRateGradient(gradient: number): IParticleSystem;
  71244. /**
  71245. * Not supported by GPUParticleSystem
  71246. * @param gradient defines the gradient to use (between 0 and 1)
  71247. * @param factor defines the start size value to affect to the specified gradient
  71248. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71249. * @returns the current particle system
  71250. */
  71251. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71252. /**
  71253. * Not supported by GPUParticleSystem
  71254. * @param gradient defines the gradient to remove
  71255. * @returns the current particle system
  71256. */
  71257. removeStartSizeGradient(gradient: number): IParticleSystem;
  71258. /**
  71259. * Not supported by GPUParticleSystem
  71260. * @param gradient defines the gradient to use (between 0 and 1)
  71261. * @param min defines the color remap minimal range
  71262. * @param max defines the color remap maximal range
  71263. * @returns the current particle system
  71264. */
  71265. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71266. /**
  71267. * Not supported by GPUParticleSystem
  71268. * @param gradient defines the gradient to remove
  71269. * @returns the current particle system
  71270. */
  71271. removeColorRemapGradient(): IParticleSystem;
  71272. /**
  71273. * Not supported by GPUParticleSystem
  71274. * @param gradient defines the gradient to use (between 0 and 1)
  71275. * @param min defines the alpha remap minimal range
  71276. * @param max defines the alpha remap maximal range
  71277. * @returns the current particle system
  71278. */
  71279. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71280. /**
  71281. * Not supported by GPUParticleSystem
  71282. * @param gradient defines the gradient to remove
  71283. * @returns the current particle system
  71284. */
  71285. removeAlphaRemapGradient(): IParticleSystem;
  71286. /**
  71287. * Not supported by GPUParticleSystem
  71288. * @param gradient defines the gradient to use (between 0 and 1)
  71289. * @param color defines the color to affect to the specified gradient
  71290. * @returns the current particle system
  71291. */
  71292. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71293. /**
  71294. * Not supported by GPUParticleSystem
  71295. * @param gradient defines the gradient to remove
  71296. * @returns the current particle system
  71297. */
  71298. removeRampGradient(): IParticleSystem;
  71299. /**
  71300. * Not supported by GPUParticleSystem
  71301. * @returns the list of ramp gradients
  71302. */
  71303. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71304. /**
  71305. * Not supported by GPUParticleSystem
  71306. * Gets or sets a boolean indicating that ramp gradients must be used
  71307. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71308. */
  71309. get useRampGradients(): boolean;
  71310. set useRampGradients(value: boolean);
  71311. /**
  71312. * Not supported by GPUParticleSystem
  71313. * @param gradient defines the gradient to use (between 0 and 1)
  71314. * @param factor defines the life time factor to affect to the specified gradient
  71315. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71316. * @returns the current particle system
  71317. */
  71318. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71319. /**
  71320. * Not supported by GPUParticleSystem
  71321. * @param gradient defines the gradient to remove
  71322. * @returns the current particle system
  71323. */
  71324. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71325. /**
  71326. * Instantiates a GPU particle system.
  71327. * 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.
  71328. * @param name The name of the particle system
  71329. * @param options The options used to create the system
  71330. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71331. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71332. * @param customEffect a custom effect used to change the way particles are rendered by default
  71333. */
  71334. constructor(name: string, options: Partial<{
  71335. capacity: number;
  71336. randomTextureSize: number;
  71337. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71338. protected _reset(): void;
  71339. private _createUpdateVAO;
  71340. private _createRenderVAO;
  71341. private _initialize;
  71342. /** @hidden */
  71343. _recreateUpdateEffect(): void;
  71344. private _getEffect;
  71345. /**
  71346. * Fill the defines array according to the current settings of the particle system
  71347. * @param defines Array to be updated
  71348. * @param blendMode blend mode to take into account when updating the array
  71349. */
  71350. fillDefines(defines: Array<string>, blendMode?: number): void;
  71351. /**
  71352. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71353. * @param uniforms Uniforms array to fill
  71354. * @param attributes Attributes array to fill
  71355. * @param samplers Samplers array to fill
  71356. */
  71357. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71358. /** @hidden */
  71359. _recreateRenderEffect(): Effect;
  71360. /**
  71361. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71362. * @param preWarm defines if we are in the pre-warmimg phase
  71363. */
  71364. animate(preWarm?: boolean): void;
  71365. private _createFactorGradientTexture;
  71366. private _createSizeGradientTexture;
  71367. private _createAngularSpeedGradientTexture;
  71368. private _createVelocityGradientTexture;
  71369. private _createLimitVelocityGradientTexture;
  71370. private _createDragGradientTexture;
  71371. private _createColorGradientTexture;
  71372. /**
  71373. * Renders the particle system in its current state
  71374. * @param preWarm defines if the system should only update the particles but not render them
  71375. * @returns the current number of particles
  71376. */
  71377. render(preWarm?: boolean): number;
  71378. /**
  71379. * Rebuilds the particle system
  71380. */
  71381. rebuild(): void;
  71382. private _releaseBuffers;
  71383. private _releaseVAOs;
  71384. /**
  71385. * Disposes the particle system and free the associated resources
  71386. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71387. */
  71388. dispose(disposeTexture?: boolean): void;
  71389. /**
  71390. * Clones the particle system.
  71391. * @param name The name of the cloned object
  71392. * @param newEmitter The new emitter to use
  71393. * @returns the cloned particle system
  71394. */
  71395. clone(name: string, newEmitter: any): GPUParticleSystem;
  71396. /**
  71397. * Serializes the particle system to a JSON object
  71398. * @param serializeTexture defines if the texture must be serialized as well
  71399. * @returns the JSON object
  71400. */
  71401. serialize(serializeTexture?: boolean): any;
  71402. /**
  71403. * Parses a JSON object to create a GPU particle system.
  71404. * @param parsedParticleSystem The JSON object to parse
  71405. * @param sceneOrEngine The scene or the engine to create the particle system in
  71406. * @param rootUrl The root url to use to load external dependencies like texture
  71407. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71408. * @returns the parsed GPU particle system
  71409. */
  71410. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71411. }
  71412. }
  71413. declare module "babylonjs/Particles/particleSystemSet" {
  71414. import { Nullable } from "babylonjs/types";
  71415. import { Color3 } from "babylonjs/Maths/math.color";
  71416. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71417. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71418. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71419. import { Scene, IDisposable } from "babylonjs/scene";
  71420. /**
  71421. * Represents a set of particle systems working together to create a specific effect
  71422. */
  71423. export class ParticleSystemSet implements IDisposable {
  71424. /**
  71425. * Gets or sets base Assets URL
  71426. */
  71427. static BaseAssetsUrl: string;
  71428. private _emitterCreationOptions;
  71429. private _emitterNode;
  71430. /**
  71431. * Gets the particle system list
  71432. */
  71433. systems: IParticleSystem[];
  71434. /**
  71435. * Gets the emitter node used with this set
  71436. */
  71437. get emitterNode(): Nullable<TransformNode>;
  71438. /**
  71439. * Creates a new emitter mesh as a sphere
  71440. * @param options defines the options used to create the sphere
  71441. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71442. * @param scene defines the hosting scene
  71443. */
  71444. setEmitterAsSphere(options: {
  71445. diameter: number;
  71446. segments: number;
  71447. color: Color3;
  71448. }, renderingGroupId: number, scene: Scene): void;
  71449. /**
  71450. * Starts all particle systems of the set
  71451. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71452. */
  71453. start(emitter?: AbstractMesh): void;
  71454. /**
  71455. * Release all associated resources
  71456. */
  71457. dispose(): void;
  71458. /**
  71459. * Serialize the set into a JSON compatible object
  71460. * @param serializeTexture defines if the texture must be serialized as well
  71461. * @returns a JSON compatible representation of the set
  71462. */
  71463. serialize(serializeTexture?: boolean): any;
  71464. /**
  71465. * Parse a new ParticleSystemSet from a serialized source
  71466. * @param data defines a JSON compatible representation of the set
  71467. * @param scene defines the hosting scene
  71468. * @param gpu defines if we want GPU particles or CPU particles
  71469. * @returns a new ParticleSystemSet
  71470. */
  71471. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71472. }
  71473. }
  71474. declare module "babylonjs/Particles/particleHelper" {
  71475. import { Nullable } from "babylonjs/types";
  71476. import { Scene } from "babylonjs/scene";
  71477. import { Vector3 } from "babylonjs/Maths/math.vector";
  71478. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71479. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71480. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71481. /**
  71482. * This class is made for on one-liner static method to help creating particle system set.
  71483. */
  71484. export class ParticleHelper {
  71485. /**
  71486. * Gets or sets base Assets URL
  71487. */
  71488. static BaseAssetsUrl: string;
  71489. /** Define the Url to load snippets */
  71490. static SnippetUrl: string;
  71491. /**
  71492. * Create a default particle system that you can tweak
  71493. * @param emitter defines the emitter to use
  71494. * @param capacity defines the system capacity (default is 500 particles)
  71495. * @param scene defines the hosting scene
  71496. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71497. * @returns the new Particle system
  71498. */
  71499. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71500. /**
  71501. * This is the main static method (one-liner) of this helper to create different particle systems
  71502. * @param type This string represents the type to the particle system to create
  71503. * @param scene The scene where the particle system should live
  71504. * @param gpu If the system will use gpu
  71505. * @returns the ParticleSystemSet created
  71506. */
  71507. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71508. /**
  71509. * Static function used to export a particle system to a ParticleSystemSet variable.
  71510. * Please note that the emitter shape is not exported
  71511. * @param systems defines the particle systems to export
  71512. * @returns the created particle system set
  71513. */
  71514. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71515. /**
  71516. * Creates a particle system from a snippet saved in a remote file
  71517. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71518. * @param url defines the url to load from
  71519. * @param scene defines the hosting scene
  71520. * @param gpu If the system will use gpu
  71521. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71522. * @returns a promise that will resolve to the new particle system
  71523. */
  71524. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71525. /**
  71526. * Creates a particle system from a snippet saved by the particle system editor
  71527. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71528. * @param scene defines the hosting scene
  71529. * @param gpu If the system will use gpu
  71530. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71531. * @returns a promise that will resolve to the new particle system
  71532. */
  71533. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71534. }
  71535. }
  71536. declare module "babylonjs/Particles/particleSystemComponent" {
  71537. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71538. import { Effect } from "babylonjs/Materials/effect";
  71539. import "babylonjs/Shaders/particles.vertex";
  71540. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71541. module "babylonjs/Engines/engine" {
  71542. interface Engine {
  71543. /**
  71544. * Create an effect to use with particle systems.
  71545. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71546. * the particle system for which you want to create a custom effect in the last parameter
  71547. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71548. * @param uniformsNames defines a list of attribute names
  71549. * @param samplers defines an array of string used to represent textures
  71550. * @param defines defines the string containing the defines to use to compile the shaders
  71551. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71552. * @param onCompiled defines a function to call when the effect creation is successful
  71553. * @param onError defines a function to call when the effect creation has failed
  71554. * @param particleSystem the particle system you want to create the effect for
  71555. * @returns the new Effect
  71556. */
  71557. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71558. }
  71559. }
  71560. module "babylonjs/Meshes/mesh" {
  71561. interface Mesh {
  71562. /**
  71563. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71564. * @returns an array of IParticleSystem
  71565. */
  71566. getEmittedParticleSystems(): IParticleSystem[];
  71567. /**
  71568. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71569. * @returns an array of IParticleSystem
  71570. */
  71571. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71572. }
  71573. }
  71574. }
  71575. declare module "babylonjs/Particles/pointsCloudSystem" {
  71576. import { Color4 } from "babylonjs/Maths/math";
  71577. import { Mesh } from "babylonjs/Meshes/mesh";
  71578. import { Scene, IDisposable } from "babylonjs/scene";
  71579. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71580. /** Defines the 4 color options */
  71581. export enum PointColor {
  71582. /** color value */
  71583. Color = 2,
  71584. /** uv value */
  71585. UV = 1,
  71586. /** random value */
  71587. Random = 0,
  71588. /** stated value */
  71589. Stated = 3
  71590. }
  71591. /**
  71592. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71593. * 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.
  71594. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71595. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71596. *
  71597. * Full documentation here : TO BE ENTERED
  71598. */
  71599. export class PointsCloudSystem implements IDisposable {
  71600. /**
  71601. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71602. * Example : var p = SPS.particles[i];
  71603. */
  71604. particles: CloudPoint[];
  71605. /**
  71606. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71607. */
  71608. nbParticles: number;
  71609. /**
  71610. * This a counter for your own usage. It's not set by any SPS functions.
  71611. */
  71612. counter: number;
  71613. /**
  71614. * The PCS name. This name is also given to the underlying mesh.
  71615. */
  71616. name: string;
  71617. /**
  71618. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71619. */
  71620. mesh: Mesh;
  71621. /**
  71622. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71623. * Please read :
  71624. */
  71625. vars: any;
  71626. /**
  71627. * @hidden
  71628. */
  71629. _size: number;
  71630. private _scene;
  71631. private _promises;
  71632. private _positions;
  71633. private _indices;
  71634. private _normals;
  71635. private _colors;
  71636. private _uvs;
  71637. private _indices32;
  71638. private _positions32;
  71639. private _colors32;
  71640. private _uvs32;
  71641. private _updatable;
  71642. private _isVisibilityBoxLocked;
  71643. private _alwaysVisible;
  71644. private _groups;
  71645. private _groupCounter;
  71646. private _computeParticleColor;
  71647. private _computeParticleTexture;
  71648. private _computeParticleRotation;
  71649. private _computeBoundingBox;
  71650. private _isReady;
  71651. /**
  71652. * Creates a PCS (Points Cloud System) object
  71653. * @param name (String) is the PCS name, this will be the underlying mesh name
  71654. * @param pointSize (number) is the size for each point
  71655. * @param scene (Scene) is the scene in which the PCS is added
  71656. * @param options defines the options of the PCS e.g.
  71657. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71658. */
  71659. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71660. updatable?: boolean;
  71661. });
  71662. /**
  71663. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71664. * If no points were added to the PCS, the returned mesh is just a single point.
  71665. * @returns a promise for the created mesh
  71666. */
  71667. buildMeshAsync(): Promise<Mesh>;
  71668. /**
  71669. * @hidden
  71670. */
  71671. private _buildMesh;
  71672. private _addParticle;
  71673. private _randomUnitVector;
  71674. private _getColorIndicesForCoord;
  71675. private _setPointsColorOrUV;
  71676. private _colorFromTexture;
  71677. private _calculateDensity;
  71678. /**
  71679. * Adds points to the PCS in random positions within a unit sphere
  71680. * @param nb (positive integer) the number of particles to be created from this model
  71681. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71682. * @returns the number of groups in the system
  71683. */
  71684. addPoints(nb: number, pointFunction?: any): number;
  71685. /**
  71686. * Adds points to the PCS from the surface of the model shape
  71687. * @param mesh is any Mesh object that will be used as a surface model for the points
  71688. * @param nb (positive integer) the number of particles to be created from this model
  71689. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71690. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71691. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71692. * @returns the number of groups in the system
  71693. */
  71694. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71695. /**
  71696. * Adds points to the PCS inside the model shape
  71697. * @param mesh is any Mesh object that will be used as a surface model for the points
  71698. * @param nb (positive integer) the number of particles to be created from this model
  71699. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71700. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71701. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71702. * @returns the number of groups in the system
  71703. */
  71704. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71705. /**
  71706. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71707. * This method calls `updateParticle()` for each particle of the SPS.
  71708. * For an animated SPS, it is usually called within the render loop.
  71709. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71710. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71711. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71712. * @returns the PCS.
  71713. */
  71714. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71715. /**
  71716. * Disposes the PCS.
  71717. */
  71718. dispose(): void;
  71719. /**
  71720. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71721. * doc :
  71722. * @returns the PCS.
  71723. */
  71724. refreshVisibleSize(): PointsCloudSystem;
  71725. /**
  71726. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71727. * @param size the size (float) of the visibility box
  71728. * note : this doesn't lock the PCS mesh bounding box.
  71729. * doc :
  71730. */
  71731. setVisibilityBox(size: number): void;
  71732. /**
  71733. * Gets whether the PCS is always visible or not
  71734. * doc :
  71735. */
  71736. get isAlwaysVisible(): boolean;
  71737. /**
  71738. * Sets the PCS as always visible or not
  71739. * doc :
  71740. */
  71741. set isAlwaysVisible(val: boolean);
  71742. /**
  71743. * Tells to `setParticles()` to compute the particle rotations or not
  71744. * Default value : false. The PCS is faster when it's set to false
  71745. * Note : particle rotations are only applied to parent particles
  71746. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71747. */
  71748. set computeParticleRotation(val: boolean);
  71749. /**
  71750. * Tells to `setParticles()` to compute the particle colors or not.
  71751. * Default value : true. The PCS is faster when it's set to false.
  71752. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71753. */
  71754. set computeParticleColor(val: boolean);
  71755. set computeParticleTexture(val: boolean);
  71756. /**
  71757. * Gets if `setParticles()` computes the particle colors or not.
  71758. * Default value : false. The PCS is faster when it's set to false.
  71759. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71760. */
  71761. get computeParticleColor(): boolean;
  71762. /**
  71763. * Gets if `setParticles()` computes the particle textures or not.
  71764. * Default value : false. The PCS is faster when it's set to false.
  71765. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71766. */
  71767. get computeParticleTexture(): boolean;
  71768. /**
  71769. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71770. */
  71771. set computeBoundingBox(val: boolean);
  71772. /**
  71773. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71774. */
  71775. get computeBoundingBox(): boolean;
  71776. /**
  71777. * This function does nothing. It may be overwritten to set all the particle first values.
  71778. * The PCS doesn't call this function, you may have to call it by your own.
  71779. * doc :
  71780. */
  71781. initParticles(): void;
  71782. /**
  71783. * This function does nothing. It may be overwritten to recycle a particle
  71784. * The PCS doesn't call this function, you can to call it
  71785. * doc :
  71786. * @param particle The particle to recycle
  71787. * @returns the recycled particle
  71788. */
  71789. recycleParticle(particle: CloudPoint): CloudPoint;
  71790. /**
  71791. * Updates a particle : this function should be overwritten by the user.
  71792. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71793. * doc :
  71794. * @example : just set a particle position or velocity and recycle conditions
  71795. * @param particle The particle to update
  71796. * @returns the updated particle
  71797. */
  71798. updateParticle(particle: CloudPoint): CloudPoint;
  71799. /**
  71800. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71801. * This does nothing and may be overwritten by the user.
  71802. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71803. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71804. * @param update the boolean update value actually passed to setParticles()
  71805. */
  71806. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71807. /**
  71808. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71809. * This will be passed three parameters.
  71810. * This does nothing and may be overwritten by the user.
  71811. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71812. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71813. * @param update the boolean update value actually passed to setParticles()
  71814. */
  71815. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71816. }
  71817. }
  71818. declare module "babylonjs/Particles/cloudPoint" {
  71819. import { Nullable } from "babylonjs/types";
  71820. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71821. import { Mesh } from "babylonjs/Meshes/mesh";
  71822. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71823. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71824. /**
  71825. * Represents one particle of a points cloud system.
  71826. */
  71827. export class CloudPoint {
  71828. /**
  71829. * particle global index
  71830. */
  71831. idx: number;
  71832. /**
  71833. * The color of the particle
  71834. */
  71835. color: Nullable<Color4>;
  71836. /**
  71837. * The world space position of the particle.
  71838. */
  71839. position: Vector3;
  71840. /**
  71841. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71842. */
  71843. rotation: Vector3;
  71844. /**
  71845. * The world space rotation quaternion of the particle.
  71846. */
  71847. rotationQuaternion: Nullable<Quaternion>;
  71848. /**
  71849. * The uv of the particle.
  71850. */
  71851. uv: Nullable<Vector2>;
  71852. /**
  71853. * The current speed of the particle.
  71854. */
  71855. velocity: Vector3;
  71856. /**
  71857. * The pivot point in the particle local space.
  71858. */
  71859. pivot: Vector3;
  71860. /**
  71861. * Must the particle be translated from its pivot point in its local space ?
  71862. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71863. * Default : false
  71864. */
  71865. translateFromPivot: boolean;
  71866. /**
  71867. * Index of this particle in the global "positions" array (Internal use)
  71868. * @hidden
  71869. */
  71870. _pos: number;
  71871. /**
  71872. * @hidden Index of this particle in the global "indices" array (Internal use)
  71873. */
  71874. _ind: number;
  71875. /**
  71876. * Group this particle belongs to
  71877. */
  71878. _group: PointsGroup;
  71879. /**
  71880. * Group id of this particle
  71881. */
  71882. groupId: number;
  71883. /**
  71884. * Index of the particle in its group id (Internal use)
  71885. */
  71886. idxInGroup: number;
  71887. /**
  71888. * @hidden Particle BoundingInfo object (Internal use)
  71889. */
  71890. _boundingInfo: BoundingInfo;
  71891. /**
  71892. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71893. */
  71894. _pcs: PointsCloudSystem;
  71895. /**
  71896. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71897. */
  71898. _stillInvisible: boolean;
  71899. /**
  71900. * @hidden Last computed particle rotation matrix
  71901. */
  71902. _rotationMatrix: number[];
  71903. /**
  71904. * Parent particle Id, if any.
  71905. * Default null.
  71906. */
  71907. parentId: Nullable<number>;
  71908. /**
  71909. * @hidden Internal global position in the PCS.
  71910. */
  71911. _globalPosition: Vector3;
  71912. /**
  71913. * Creates a Point Cloud object.
  71914. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71915. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71916. * @param group (PointsGroup) is the group the particle belongs to
  71917. * @param groupId (integer) is the group identifier in the PCS.
  71918. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71919. * @param pcs defines the PCS it is associated to
  71920. */
  71921. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71922. /**
  71923. * get point size
  71924. */
  71925. get size(): Vector3;
  71926. /**
  71927. * Set point size
  71928. */
  71929. set size(scale: Vector3);
  71930. /**
  71931. * Legacy support, changed quaternion to rotationQuaternion
  71932. */
  71933. get quaternion(): Nullable<Quaternion>;
  71934. /**
  71935. * Legacy support, changed quaternion to rotationQuaternion
  71936. */
  71937. set quaternion(q: Nullable<Quaternion>);
  71938. /**
  71939. * Returns a boolean. True if the particle intersects a mesh, else false
  71940. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71941. * @param target is the object (point or mesh) what the intersection is computed against
  71942. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71943. * @returns true if it intersects
  71944. */
  71945. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71946. /**
  71947. * get the rotation matrix of the particle
  71948. * @hidden
  71949. */
  71950. getRotationMatrix(m: Matrix): void;
  71951. }
  71952. /**
  71953. * Represents a group of points in a points cloud system
  71954. * * PCS internal tool, don't use it manually.
  71955. */
  71956. export class PointsGroup {
  71957. /**
  71958. * The group id
  71959. * @hidden
  71960. */
  71961. groupID: number;
  71962. /**
  71963. * image data for group (internal use)
  71964. * @hidden
  71965. */
  71966. _groupImageData: Nullable<ArrayBufferView>;
  71967. /**
  71968. * Image Width (internal use)
  71969. * @hidden
  71970. */
  71971. _groupImgWidth: number;
  71972. /**
  71973. * Image Height (internal use)
  71974. * @hidden
  71975. */
  71976. _groupImgHeight: number;
  71977. /**
  71978. * Custom position function (internal use)
  71979. * @hidden
  71980. */
  71981. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71982. /**
  71983. * density per facet for surface points
  71984. * @hidden
  71985. */
  71986. _groupDensity: number[];
  71987. /**
  71988. * Only when points are colored by texture carries pointer to texture list array
  71989. * @hidden
  71990. */
  71991. _textureNb: number;
  71992. /**
  71993. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71994. * PCS internal tool, don't use it manually.
  71995. * @hidden
  71996. */
  71997. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71998. }
  71999. }
  72000. declare module "babylonjs/Particles/index" {
  72001. export * from "babylonjs/Particles/baseParticleSystem";
  72002. export * from "babylonjs/Particles/EmitterTypes/index";
  72003. export * from "babylonjs/Particles/gpuParticleSystem";
  72004. export * from "babylonjs/Particles/IParticleSystem";
  72005. export * from "babylonjs/Particles/particle";
  72006. export * from "babylonjs/Particles/particleHelper";
  72007. export * from "babylonjs/Particles/particleSystem";
  72008. import "babylonjs/Particles/particleSystemComponent";
  72009. export * from "babylonjs/Particles/particleSystemComponent";
  72010. export * from "babylonjs/Particles/particleSystemSet";
  72011. export * from "babylonjs/Particles/solidParticle";
  72012. export * from "babylonjs/Particles/solidParticleSystem";
  72013. export * from "babylonjs/Particles/cloudPoint";
  72014. export * from "babylonjs/Particles/pointsCloudSystem";
  72015. export * from "babylonjs/Particles/subEmitter";
  72016. }
  72017. declare module "babylonjs/Physics/physicsEngineComponent" {
  72018. import { Nullable } from "babylonjs/types";
  72019. import { Observable, Observer } from "babylonjs/Misc/observable";
  72020. import { Vector3 } from "babylonjs/Maths/math.vector";
  72021. import { Mesh } from "babylonjs/Meshes/mesh";
  72022. import { ISceneComponent } from "babylonjs/sceneComponent";
  72023. import { Scene } from "babylonjs/scene";
  72024. import { Node } from "babylonjs/node";
  72025. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  72026. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72027. module "babylonjs/scene" {
  72028. interface Scene {
  72029. /** @hidden (Backing field) */
  72030. _physicsEngine: Nullable<IPhysicsEngine>;
  72031. /** @hidden */
  72032. _physicsTimeAccumulator: number;
  72033. /**
  72034. * Gets the current physics engine
  72035. * @returns a IPhysicsEngine or null if none attached
  72036. */
  72037. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  72038. /**
  72039. * Enables physics to the current scene
  72040. * @param gravity defines the scene's gravity for the physics engine
  72041. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  72042. * @return a boolean indicating if the physics engine was initialized
  72043. */
  72044. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  72045. /**
  72046. * Disables and disposes the physics engine associated with the scene
  72047. */
  72048. disablePhysicsEngine(): void;
  72049. /**
  72050. * Gets a boolean indicating if there is an active physics engine
  72051. * @returns a boolean indicating if there is an active physics engine
  72052. */
  72053. isPhysicsEnabled(): boolean;
  72054. /**
  72055. * Deletes a physics compound impostor
  72056. * @param compound defines the compound to delete
  72057. */
  72058. deleteCompoundImpostor(compound: any): void;
  72059. /**
  72060. * An event triggered when physic simulation is about to be run
  72061. */
  72062. onBeforePhysicsObservable: Observable<Scene>;
  72063. /**
  72064. * An event triggered when physic simulation has been done
  72065. */
  72066. onAfterPhysicsObservable: Observable<Scene>;
  72067. }
  72068. }
  72069. module "babylonjs/Meshes/abstractMesh" {
  72070. interface AbstractMesh {
  72071. /** @hidden */
  72072. _physicsImpostor: Nullable<PhysicsImpostor>;
  72073. /**
  72074. * Gets or sets impostor used for physic simulation
  72075. * @see https://doc.babylonjs.com/features/physics_engine
  72076. */
  72077. physicsImpostor: Nullable<PhysicsImpostor>;
  72078. /**
  72079. * Gets the current physics impostor
  72080. * @see https://doc.babylonjs.com/features/physics_engine
  72081. * @returns a physics impostor or null
  72082. */
  72083. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72084. /** Apply a physic impulse to the mesh
  72085. * @param force defines the force to apply
  72086. * @param contactPoint defines where to apply the force
  72087. * @returns the current mesh
  72088. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72089. */
  72090. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72091. /**
  72092. * Creates a physic joint between two meshes
  72093. * @param otherMesh defines the other mesh to use
  72094. * @param pivot1 defines the pivot to use on this mesh
  72095. * @param pivot2 defines the pivot to use on the other mesh
  72096. * @param options defines additional options (can be plugin dependent)
  72097. * @returns the current mesh
  72098. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72099. */
  72100. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72101. /** @hidden */
  72102. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72103. }
  72104. }
  72105. /**
  72106. * Defines the physics engine scene component responsible to manage a physics engine
  72107. */
  72108. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72109. /**
  72110. * The component name helpful to identify the component in the list of scene components.
  72111. */
  72112. readonly name: string;
  72113. /**
  72114. * The scene the component belongs to.
  72115. */
  72116. scene: Scene;
  72117. /**
  72118. * Creates a new instance of the component for the given scene
  72119. * @param scene Defines the scene to register the component in
  72120. */
  72121. constructor(scene: Scene);
  72122. /**
  72123. * Registers the component in a given scene
  72124. */
  72125. register(): void;
  72126. /**
  72127. * Rebuilds the elements related to this component in case of
  72128. * context lost for instance.
  72129. */
  72130. rebuild(): void;
  72131. /**
  72132. * Disposes the component and the associated ressources
  72133. */
  72134. dispose(): void;
  72135. }
  72136. }
  72137. declare module "babylonjs/Physics/physicsHelper" {
  72138. import { Nullable } from "babylonjs/types";
  72139. import { Vector3 } from "babylonjs/Maths/math.vector";
  72140. import { Mesh } from "babylonjs/Meshes/mesh";
  72141. import { Scene } from "babylonjs/scene";
  72142. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72143. /**
  72144. * A helper for physics simulations
  72145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72146. */
  72147. export class PhysicsHelper {
  72148. private _scene;
  72149. private _physicsEngine;
  72150. /**
  72151. * Initializes the Physics helper
  72152. * @param scene Babylon.js scene
  72153. */
  72154. constructor(scene: Scene);
  72155. /**
  72156. * Applies a radial explosion impulse
  72157. * @param origin the origin of the explosion
  72158. * @param radiusOrEventOptions the radius or the options of radial explosion
  72159. * @param strength the explosion strength
  72160. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72161. * @returns A physics radial explosion event, or null
  72162. */
  72163. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72164. /**
  72165. * Applies a radial explosion force
  72166. * @param origin the origin of the explosion
  72167. * @param radiusOrEventOptions the radius or the options of radial explosion
  72168. * @param strength the explosion strength
  72169. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72170. * @returns A physics radial explosion event, or null
  72171. */
  72172. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72173. /**
  72174. * Creates a gravitational field
  72175. * @param origin the origin of the explosion
  72176. * @param radiusOrEventOptions the radius or the options of radial explosion
  72177. * @param strength the explosion strength
  72178. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72179. * @returns A physics gravitational field event, or null
  72180. */
  72181. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72182. /**
  72183. * Creates a physics updraft event
  72184. * @param origin the origin of the updraft
  72185. * @param radiusOrEventOptions the radius or the options of the updraft
  72186. * @param strength the strength of the updraft
  72187. * @param height the height of the updraft
  72188. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72189. * @returns A physics updraft event, or null
  72190. */
  72191. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72192. /**
  72193. * Creates a physics vortex event
  72194. * @param origin the of the vortex
  72195. * @param radiusOrEventOptions the radius or the options of the vortex
  72196. * @param strength the strength of the vortex
  72197. * @param height the height of the vortex
  72198. * @returns a Physics vortex event, or null
  72199. * A physics vortex event or null
  72200. */
  72201. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72202. }
  72203. /**
  72204. * Represents a physics radial explosion event
  72205. */
  72206. class PhysicsRadialExplosionEvent {
  72207. private _scene;
  72208. private _options;
  72209. private _sphere;
  72210. private _dataFetched;
  72211. /**
  72212. * Initializes a radial explosioin event
  72213. * @param _scene BabylonJS scene
  72214. * @param _options The options for the vortex event
  72215. */
  72216. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72217. /**
  72218. * Returns the data related to the radial explosion event (sphere).
  72219. * @returns The radial explosion event data
  72220. */
  72221. getData(): PhysicsRadialExplosionEventData;
  72222. /**
  72223. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72224. * @param impostor A physics imposter
  72225. * @param origin the origin of the explosion
  72226. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72227. */
  72228. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72229. /**
  72230. * Triggers affecterd impostors callbacks
  72231. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72232. */
  72233. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72234. /**
  72235. * Disposes the sphere.
  72236. * @param force Specifies if the sphere should be disposed by force
  72237. */
  72238. dispose(force?: boolean): void;
  72239. /*** Helpers ***/
  72240. private _prepareSphere;
  72241. private _intersectsWithSphere;
  72242. }
  72243. /**
  72244. * Represents a gravitational field event
  72245. */
  72246. class PhysicsGravitationalFieldEvent {
  72247. private _physicsHelper;
  72248. private _scene;
  72249. private _origin;
  72250. private _options;
  72251. private _tickCallback;
  72252. private _sphere;
  72253. private _dataFetched;
  72254. /**
  72255. * Initializes the physics gravitational field event
  72256. * @param _physicsHelper A physics helper
  72257. * @param _scene BabylonJS scene
  72258. * @param _origin The origin position of the gravitational field event
  72259. * @param _options The options for the vortex event
  72260. */
  72261. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72262. /**
  72263. * Returns the data related to the gravitational field event (sphere).
  72264. * @returns A gravitational field event
  72265. */
  72266. getData(): PhysicsGravitationalFieldEventData;
  72267. /**
  72268. * Enables the gravitational field.
  72269. */
  72270. enable(): void;
  72271. /**
  72272. * Disables the gravitational field.
  72273. */
  72274. disable(): void;
  72275. /**
  72276. * Disposes the sphere.
  72277. * @param force The force to dispose from the gravitational field event
  72278. */
  72279. dispose(force?: boolean): void;
  72280. private _tick;
  72281. }
  72282. /**
  72283. * Represents a physics updraft event
  72284. */
  72285. class PhysicsUpdraftEvent {
  72286. private _scene;
  72287. private _origin;
  72288. private _options;
  72289. private _physicsEngine;
  72290. private _originTop;
  72291. private _originDirection;
  72292. private _tickCallback;
  72293. private _cylinder;
  72294. private _cylinderPosition;
  72295. private _dataFetched;
  72296. /**
  72297. * Initializes the physics updraft event
  72298. * @param _scene BabylonJS scene
  72299. * @param _origin The origin position of the updraft
  72300. * @param _options The options for the updraft event
  72301. */
  72302. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72303. /**
  72304. * Returns the data related to the updraft event (cylinder).
  72305. * @returns A physics updraft event
  72306. */
  72307. getData(): PhysicsUpdraftEventData;
  72308. /**
  72309. * Enables the updraft.
  72310. */
  72311. enable(): void;
  72312. /**
  72313. * Disables the updraft.
  72314. */
  72315. disable(): void;
  72316. /**
  72317. * Disposes the cylinder.
  72318. * @param force Specifies if the updraft should be disposed by force
  72319. */
  72320. dispose(force?: boolean): void;
  72321. private getImpostorHitData;
  72322. private _tick;
  72323. /*** Helpers ***/
  72324. private _prepareCylinder;
  72325. private _intersectsWithCylinder;
  72326. }
  72327. /**
  72328. * Represents a physics vortex event
  72329. */
  72330. class PhysicsVortexEvent {
  72331. private _scene;
  72332. private _origin;
  72333. private _options;
  72334. private _physicsEngine;
  72335. private _originTop;
  72336. private _tickCallback;
  72337. private _cylinder;
  72338. private _cylinderPosition;
  72339. private _dataFetched;
  72340. /**
  72341. * Initializes the physics vortex event
  72342. * @param _scene The BabylonJS scene
  72343. * @param _origin The origin position of the vortex
  72344. * @param _options The options for the vortex event
  72345. */
  72346. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72347. /**
  72348. * Returns the data related to the vortex event (cylinder).
  72349. * @returns The physics vortex event data
  72350. */
  72351. getData(): PhysicsVortexEventData;
  72352. /**
  72353. * Enables the vortex.
  72354. */
  72355. enable(): void;
  72356. /**
  72357. * Disables the cortex.
  72358. */
  72359. disable(): void;
  72360. /**
  72361. * Disposes the sphere.
  72362. * @param force
  72363. */
  72364. dispose(force?: boolean): void;
  72365. private getImpostorHitData;
  72366. private _tick;
  72367. /*** Helpers ***/
  72368. private _prepareCylinder;
  72369. private _intersectsWithCylinder;
  72370. }
  72371. /**
  72372. * Options fot the radial explosion event
  72373. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72374. */
  72375. export class PhysicsRadialExplosionEventOptions {
  72376. /**
  72377. * The radius of the sphere for the radial explosion.
  72378. */
  72379. radius: number;
  72380. /**
  72381. * The strenth of the explosion.
  72382. */
  72383. strength: number;
  72384. /**
  72385. * The strenght of the force in correspondence to the distance of the affected object
  72386. */
  72387. falloff: PhysicsRadialImpulseFalloff;
  72388. /**
  72389. * Sphere options for the radial explosion.
  72390. */
  72391. sphere: {
  72392. segments: number;
  72393. diameter: number;
  72394. };
  72395. /**
  72396. * Sphere options for the radial explosion.
  72397. */
  72398. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72399. }
  72400. /**
  72401. * Options fot the updraft event
  72402. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72403. */
  72404. export class PhysicsUpdraftEventOptions {
  72405. /**
  72406. * The radius of the cylinder for the vortex
  72407. */
  72408. radius: number;
  72409. /**
  72410. * The strenth of the updraft.
  72411. */
  72412. strength: number;
  72413. /**
  72414. * The height of the cylinder for the updraft.
  72415. */
  72416. height: number;
  72417. /**
  72418. * The mode for the the updraft.
  72419. */
  72420. updraftMode: PhysicsUpdraftMode;
  72421. }
  72422. /**
  72423. * Options fot the vortex event
  72424. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72425. */
  72426. export class PhysicsVortexEventOptions {
  72427. /**
  72428. * The radius of the cylinder for the vortex
  72429. */
  72430. radius: number;
  72431. /**
  72432. * The strenth of the vortex.
  72433. */
  72434. strength: number;
  72435. /**
  72436. * The height of the cylinder for the vortex.
  72437. */
  72438. height: number;
  72439. /**
  72440. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72441. */
  72442. centripetalForceThreshold: number;
  72443. /**
  72444. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72445. */
  72446. centripetalForceMultiplier: number;
  72447. /**
  72448. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72449. */
  72450. centrifugalForceMultiplier: number;
  72451. /**
  72452. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72453. */
  72454. updraftForceMultiplier: number;
  72455. }
  72456. /**
  72457. * The strenght of the force in correspondence to the distance of the affected object
  72458. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72459. */
  72460. export enum PhysicsRadialImpulseFalloff {
  72461. /** Defines that impulse is constant in strength across it's whole radius */
  72462. Constant = 0,
  72463. /** Defines that impulse gets weaker if it's further from the origin */
  72464. Linear = 1
  72465. }
  72466. /**
  72467. * The strength of the force in correspondence to the distance of the affected object
  72468. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72469. */
  72470. export enum PhysicsUpdraftMode {
  72471. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72472. Center = 0,
  72473. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72474. Perpendicular = 1
  72475. }
  72476. /**
  72477. * Interface for a physics hit data
  72478. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72479. */
  72480. export interface PhysicsHitData {
  72481. /**
  72482. * The force applied at the contact point
  72483. */
  72484. force: Vector3;
  72485. /**
  72486. * The contact point
  72487. */
  72488. contactPoint: Vector3;
  72489. /**
  72490. * The distance from the origin to the contact point
  72491. */
  72492. distanceFromOrigin: number;
  72493. }
  72494. /**
  72495. * Interface for radial explosion event data
  72496. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72497. */
  72498. export interface PhysicsRadialExplosionEventData {
  72499. /**
  72500. * A sphere used for the radial explosion event
  72501. */
  72502. sphere: Mesh;
  72503. }
  72504. /**
  72505. * Interface for gravitational field event data
  72506. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72507. */
  72508. export interface PhysicsGravitationalFieldEventData {
  72509. /**
  72510. * A sphere mesh used for the gravitational field event
  72511. */
  72512. sphere: Mesh;
  72513. }
  72514. /**
  72515. * Interface for updraft event data
  72516. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72517. */
  72518. export interface PhysicsUpdraftEventData {
  72519. /**
  72520. * A cylinder used for the updraft event
  72521. */
  72522. cylinder: Mesh;
  72523. }
  72524. /**
  72525. * Interface for vortex event data
  72526. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72527. */
  72528. export interface PhysicsVortexEventData {
  72529. /**
  72530. * A cylinder used for the vortex event
  72531. */
  72532. cylinder: Mesh;
  72533. }
  72534. /**
  72535. * Interface for an affected physics impostor
  72536. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72537. */
  72538. export interface PhysicsAffectedImpostorWithData {
  72539. /**
  72540. * The impostor affected by the effect
  72541. */
  72542. impostor: PhysicsImpostor;
  72543. /**
  72544. * The data about the hit/horce from the explosion
  72545. */
  72546. hitData: PhysicsHitData;
  72547. }
  72548. }
  72549. declare module "babylonjs/Physics/Plugins/index" {
  72550. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72551. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72552. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72553. }
  72554. declare module "babylonjs/Physics/index" {
  72555. export * from "babylonjs/Physics/IPhysicsEngine";
  72556. export * from "babylonjs/Physics/physicsEngine";
  72557. export * from "babylonjs/Physics/physicsEngineComponent";
  72558. export * from "babylonjs/Physics/physicsHelper";
  72559. export * from "babylonjs/Physics/physicsImpostor";
  72560. export * from "babylonjs/Physics/physicsJoint";
  72561. export * from "babylonjs/Physics/Plugins/index";
  72562. }
  72563. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72564. /** @hidden */
  72565. export var blackAndWhitePixelShader: {
  72566. name: string;
  72567. shader: string;
  72568. };
  72569. }
  72570. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72571. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72572. import { Camera } from "babylonjs/Cameras/camera";
  72573. import { Engine } from "babylonjs/Engines/engine";
  72574. import "babylonjs/Shaders/blackAndWhite.fragment";
  72575. import { Nullable } from "babylonjs/types";
  72576. import { Scene } from "babylonjs/scene";
  72577. /**
  72578. * Post process used to render in black and white
  72579. */
  72580. export class BlackAndWhitePostProcess extends PostProcess {
  72581. /**
  72582. * Linear about to convert he result to black and white (default: 1)
  72583. */
  72584. degree: number;
  72585. /**
  72586. * Gets a string identifying the name of the class
  72587. * @returns "BlackAndWhitePostProcess" string
  72588. */
  72589. getClassName(): string;
  72590. /**
  72591. * Creates a black and white post process
  72592. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72593. * @param name The name of the effect.
  72594. * @param options The required width/height ratio to downsize to before computing the render pass.
  72595. * @param camera The camera to apply the render pass to.
  72596. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72597. * @param engine The engine which the post process will be applied. (default: current engine)
  72598. * @param reusable If the post process can be reused on the same frame. (default: false)
  72599. */
  72600. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72601. /** @hidden */
  72602. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72603. }
  72604. }
  72605. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72606. import { Nullable } from "babylonjs/types";
  72607. import { Camera } from "babylonjs/Cameras/camera";
  72608. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72609. import { Engine } from "babylonjs/Engines/engine";
  72610. /**
  72611. * This represents a set of one or more post processes in Babylon.
  72612. * A post process can be used to apply a shader to a texture after it is rendered.
  72613. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72614. */
  72615. export class PostProcessRenderEffect {
  72616. private _postProcesses;
  72617. private _getPostProcesses;
  72618. private _singleInstance;
  72619. private _cameras;
  72620. private _indicesForCamera;
  72621. /**
  72622. * Name of the effect
  72623. * @hidden
  72624. */
  72625. _name: string;
  72626. /**
  72627. * Instantiates a post process render effect.
  72628. * A post process can be used to apply a shader to a texture after it is rendered.
  72629. * @param engine The engine the effect is tied to
  72630. * @param name The name of the effect
  72631. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72632. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72633. */
  72634. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72635. /**
  72636. * Checks if all the post processes in the effect are supported.
  72637. */
  72638. get isSupported(): boolean;
  72639. /**
  72640. * Updates the current state of the effect
  72641. * @hidden
  72642. */
  72643. _update(): void;
  72644. /**
  72645. * Attaches the effect on cameras
  72646. * @param cameras The camera to attach to.
  72647. * @hidden
  72648. */
  72649. _attachCameras(cameras: Camera): void;
  72650. /**
  72651. * Attaches the effect on cameras
  72652. * @param cameras The camera to attach to.
  72653. * @hidden
  72654. */
  72655. _attachCameras(cameras: Camera[]): void;
  72656. /**
  72657. * Detaches the effect on cameras
  72658. * @param cameras The camera to detatch from.
  72659. * @hidden
  72660. */
  72661. _detachCameras(cameras: Camera): void;
  72662. /**
  72663. * Detatches the effect on cameras
  72664. * @param cameras The camera to detatch from.
  72665. * @hidden
  72666. */
  72667. _detachCameras(cameras: Camera[]): void;
  72668. /**
  72669. * Enables the effect on given cameras
  72670. * @param cameras The camera to enable.
  72671. * @hidden
  72672. */
  72673. _enable(cameras: Camera): void;
  72674. /**
  72675. * Enables the effect on given cameras
  72676. * @param cameras The camera to enable.
  72677. * @hidden
  72678. */
  72679. _enable(cameras: Nullable<Camera[]>): void;
  72680. /**
  72681. * Disables the effect on the given cameras
  72682. * @param cameras The camera to disable.
  72683. * @hidden
  72684. */
  72685. _disable(cameras: Camera): void;
  72686. /**
  72687. * Disables the effect on the given cameras
  72688. * @param cameras The camera to disable.
  72689. * @hidden
  72690. */
  72691. _disable(cameras: Nullable<Camera[]>): void;
  72692. /**
  72693. * Gets a list of the post processes contained in the effect.
  72694. * @param camera The camera to get the post processes on.
  72695. * @returns The list of the post processes in the effect.
  72696. */
  72697. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72698. }
  72699. }
  72700. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72701. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72702. /** @hidden */
  72703. export var extractHighlightsPixelShader: {
  72704. name: string;
  72705. shader: string;
  72706. };
  72707. }
  72708. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72709. import { Nullable } from "babylonjs/types";
  72710. import { Camera } from "babylonjs/Cameras/camera";
  72711. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72712. import { Engine } from "babylonjs/Engines/engine";
  72713. import "babylonjs/Shaders/extractHighlights.fragment";
  72714. /**
  72715. * 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.
  72716. */
  72717. export class ExtractHighlightsPostProcess extends PostProcess {
  72718. /**
  72719. * The luminance threshold, pixels below this value will be set to black.
  72720. */
  72721. threshold: number;
  72722. /** @hidden */
  72723. _exposure: number;
  72724. /**
  72725. * Post process which has the input texture to be used when performing highlight extraction
  72726. * @hidden
  72727. */
  72728. _inputPostProcess: Nullable<PostProcess>;
  72729. /**
  72730. * Gets a string identifying the name of the class
  72731. * @returns "ExtractHighlightsPostProcess" string
  72732. */
  72733. getClassName(): string;
  72734. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72735. }
  72736. }
  72737. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72738. /** @hidden */
  72739. export var bloomMergePixelShader: {
  72740. name: string;
  72741. shader: string;
  72742. };
  72743. }
  72744. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72745. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72746. import { Nullable } from "babylonjs/types";
  72747. import { Engine } from "babylonjs/Engines/engine";
  72748. import { Camera } from "babylonjs/Cameras/camera";
  72749. import "babylonjs/Shaders/bloomMerge.fragment";
  72750. /**
  72751. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72752. */
  72753. export class BloomMergePostProcess extends PostProcess {
  72754. /** Weight of the bloom to be added to the original input. */
  72755. weight: number;
  72756. /**
  72757. * Gets a string identifying the name of the class
  72758. * @returns "BloomMergePostProcess" string
  72759. */
  72760. getClassName(): string;
  72761. /**
  72762. * Creates a new instance of @see BloomMergePostProcess
  72763. * @param name The name of the effect.
  72764. * @param originalFromInput Post process which's input will be used for the merge.
  72765. * @param blurred Blurred highlights post process which's output will be used.
  72766. * @param weight Weight of the bloom to be added to the original input.
  72767. * @param options The required width/height ratio to downsize to before computing the render pass.
  72768. * @param camera The camera to apply the render pass to.
  72769. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72770. * @param engine The engine which the post process will be applied. (default: current engine)
  72771. * @param reusable If the post process can be reused on the same frame. (default: false)
  72772. * @param textureType Type of textures used when performing the post process. (default: 0)
  72773. * @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)
  72774. */
  72775. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72776. /** Weight of the bloom to be added to the original input. */
  72777. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72778. }
  72779. }
  72780. declare module "babylonjs/PostProcesses/bloomEffect" {
  72781. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72782. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72783. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72784. import { Camera } from "babylonjs/Cameras/camera";
  72785. import { Scene } from "babylonjs/scene";
  72786. /**
  72787. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72788. */
  72789. export class BloomEffect extends PostProcessRenderEffect {
  72790. private bloomScale;
  72791. /**
  72792. * @hidden Internal
  72793. */
  72794. _effects: Array<PostProcess>;
  72795. /**
  72796. * @hidden Internal
  72797. */
  72798. _downscale: ExtractHighlightsPostProcess;
  72799. private _blurX;
  72800. private _blurY;
  72801. private _merge;
  72802. /**
  72803. * The luminance threshold to find bright areas of the image to bloom.
  72804. */
  72805. get threshold(): number;
  72806. set threshold(value: number);
  72807. /**
  72808. * The strength of the bloom.
  72809. */
  72810. get weight(): number;
  72811. set weight(value: number);
  72812. /**
  72813. * Specifies the size of the bloom blur kernel, relative to the final output size
  72814. */
  72815. get kernel(): number;
  72816. set kernel(value: number);
  72817. /**
  72818. * Creates a new instance of @see BloomEffect
  72819. * @param scene The scene the effect belongs to.
  72820. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72821. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72822. * @param bloomWeight The the strength of bloom.
  72823. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72824. * @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)
  72825. */
  72826. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72827. /**
  72828. * Disposes each of the internal effects for a given camera.
  72829. * @param camera The camera to dispose the effect on.
  72830. */
  72831. disposeEffects(camera: Camera): void;
  72832. /**
  72833. * @hidden Internal
  72834. */
  72835. _updateEffects(): void;
  72836. /**
  72837. * Internal
  72838. * @returns if all the contained post processes are ready.
  72839. * @hidden
  72840. */
  72841. _isReady(): boolean;
  72842. }
  72843. }
  72844. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72845. /** @hidden */
  72846. export var chromaticAberrationPixelShader: {
  72847. name: string;
  72848. shader: string;
  72849. };
  72850. }
  72851. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72852. import { Vector2 } from "babylonjs/Maths/math.vector";
  72853. import { Nullable } from "babylonjs/types";
  72854. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72855. import { Camera } from "babylonjs/Cameras/camera";
  72856. import { Engine } from "babylonjs/Engines/engine";
  72857. import "babylonjs/Shaders/chromaticAberration.fragment";
  72858. import { Scene } from "babylonjs/scene";
  72859. /**
  72860. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72861. */
  72862. export class ChromaticAberrationPostProcess extends PostProcess {
  72863. /**
  72864. * The amount of seperation of rgb channels (default: 30)
  72865. */
  72866. aberrationAmount: number;
  72867. /**
  72868. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72869. */
  72870. radialIntensity: number;
  72871. /**
  72872. * 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))
  72873. */
  72874. direction: Vector2;
  72875. /**
  72876. * 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))
  72877. */
  72878. centerPosition: Vector2;
  72879. /** The width of the screen to apply the effect on */
  72880. screenWidth: number;
  72881. /** The height of the screen to apply the effect on */
  72882. screenHeight: number;
  72883. /**
  72884. * Gets a string identifying the name of the class
  72885. * @returns "ChromaticAberrationPostProcess" string
  72886. */
  72887. getClassName(): string;
  72888. /**
  72889. * Creates a new instance ChromaticAberrationPostProcess
  72890. * @param name The name of the effect.
  72891. * @param screenWidth The width of the screen to apply the effect on.
  72892. * @param screenHeight The height of the screen to apply the effect on.
  72893. * @param options The required width/height ratio to downsize to before computing the render pass.
  72894. * @param camera The camera to apply the render pass to.
  72895. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72896. * @param engine The engine which the post process will be applied. (default: current engine)
  72897. * @param reusable If the post process can be reused on the same frame. (default: false)
  72898. * @param textureType Type of textures used when performing the post process. (default: 0)
  72899. * @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)
  72900. */
  72901. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72902. /** @hidden */
  72903. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72904. }
  72905. }
  72906. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72907. /** @hidden */
  72908. export var circleOfConfusionPixelShader: {
  72909. name: string;
  72910. shader: string;
  72911. };
  72912. }
  72913. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72914. import { Nullable } from "babylonjs/types";
  72915. import { Engine } from "babylonjs/Engines/engine";
  72916. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72917. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72918. import { Camera } from "babylonjs/Cameras/camera";
  72919. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72920. /**
  72921. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72922. */
  72923. export class CircleOfConfusionPostProcess extends PostProcess {
  72924. /**
  72925. * 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.
  72926. */
  72927. lensSize: number;
  72928. /**
  72929. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72930. */
  72931. fStop: number;
  72932. /**
  72933. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72934. */
  72935. focusDistance: number;
  72936. /**
  72937. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72938. */
  72939. focalLength: number;
  72940. /**
  72941. * Gets a string identifying the name of the class
  72942. * @returns "CircleOfConfusionPostProcess" string
  72943. */
  72944. getClassName(): string;
  72945. private _depthTexture;
  72946. /**
  72947. * Creates a new instance CircleOfConfusionPostProcess
  72948. * @param name The name of the effect.
  72949. * @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.
  72950. * @param options The required width/height ratio to downsize to before computing the render pass.
  72951. * @param camera The camera to apply the render pass to.
  72952. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72953. * @param engine The engine which the post process will be applied. (default: current engine)
  72954. * @param reusable If the post process can be reused on the same frame. (default: false)
  72955. * @param textureType Type of textures used when performing the post process. (default: 0)
  72956. * @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)
  72957. */
  72958. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72959. /**
  72960. * 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.
  72961. */
  72962. set depthTexture(value: RenderTargetTexture);
  72963. }
  72964. }
  72965. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72966. /** @hidden */
  72967. export var colorCorrectionPixelShader: {
  72968. name: string;
  72969. shader: string;
  72970. };
  72971. }
  72972. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72973. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72974. import { Engine } from "babylonjs/Engines/engine";
  72975. import { Camera } from "babylonjs/Cameras/camera";
  72976. import "babylonjs/Shaders/colorCorrection.fragment";
  72977. import { Nullable } from "babylonjs/types";
  72978. import { Scene } from "babylonjs/scene";
  72979. /**
  72980. *
  72981. * This post-process allows the modification of rendered colors by using
  72982. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72983. *
  72984. * The object needs to be provided an url to a texture containing the color
  72985. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72986. * Use an image editing software to tweak the LUT to match your needs.
  72987. *
  72988. * For an example of a color LUT, see here:
  72989. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72990. * For explanations on color grading, see here:
  72991. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72992. *
  72993. */
  72994. export class ColorCorrectionPostProcess extends PostProcess {
  72995. private _colorTableTexture;
  72996. /**
  72997. * Gets the color table url used to create the LUT texture
  72998. */
  72999. colorTableUrl: string;
  73000. /**
  73001. * Gets a string identifying the name of the class
  73002. * @returns "ColorCorrectionPostProcess" string
  73003. */
  73004. getClassName(): string;
  73005. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73006. /** @hidden */
  73007. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  73008. }
  73009. }
  73010. declare module "babylonjs/Shaders/convolution.fragment" {
  73011. /** @hidden */
  73012. export var convolutionPixelShader: {
  73013. name: string;
  73014. shader: string;
  73015. };
  73016. }
  73017. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  73018. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73019. import { Nullable } from "babylonjs/types";
  73020. import { Camera } from "babylonjs/Cameras/camera";
  73021. import { Engine } from "babylonjs/Engines/engine";
  73022. import "babylonjs/Shaders/convolution.fragment";
  73023. import { Scene } from "babylonjs/scene";
  73024. /**
  73025. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  73026. * input texture to perform effects such as edge detection or sharpening
  73027. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73028. */
  73029. export class ConvolutionPostProcess extends PostProcess {
  73030. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  73031. kernel: number[];
  73032. /**
  73033. * Gets a string identifying the name of the class
  73034. * @returns "ConvolutionPostProcess" string
  73035. */
  73036. getClassName(): string;
  73037. /**
  73038. * Creates a new instance ConvolutionPostProcess
  73039. * @param name The name of the effect.
  73040. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  73041. * @param options The required width/height ratio to downsize to before computing the render pass.
  73042. * @param camera The camera to apply the render pass to.
  73043. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73044. * @param engine The engine which the post process will be applied. (default: current engine)
  73045. * @param reusable If the post process can be reused on the same frame. (default: false)
  73046. * @param textureType Type of textures used when performing the post process. (default: 0)
  73047. */
  73048. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73049. /** @hidden */
  73050. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  73051. /**
  73052. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73053. */
  73054. static EdgeDetect0Kernel: number[];
  73055. /**
  73056. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73057. */
  73058. static EdgeDetect1Kernel: number[];
  73059. /**
  73060. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73061. */
  73062. static EdgeDetect2Kernel: number[];
  73063. /**
  73064. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73065. */
  73066. static SharpenKernel: number[];
  73067. /**
  73068. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73069. */
  73070. static EmbossKernel: number[];
  73071. /**
  73072. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73073. */
  73074. static GaussianKernel: number[];
  73075. }
  73076. }
  73077. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  73078. import { Nullable } from "babylonjs/types";
  73079. import { Vector2 } from "babylonjs/Maths/math.vector";
  73080. import { Camera } from "babylonjs/Cameras/camera";
  73081. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73082. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73083. import { Engine } from "babylonjs/Engines/engine";
  73084. import { Scene } from "babylonjs/scene";
  73085. /**
  73086. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73087. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73088. * based on samples that have a large difference in distance than the center pixel.
  73089. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73090. */
  73091. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73092. /**
  73093. * The direction the blur should be applied
  73094. */
  73095. direction: Vector2;
  73096. /**
  73097. * Gets a string identifying the name of the class
  73098. * @returns "DepthOfFieldBlurPostProcess" string
  73099. */
  73100. getClassName(): string;
  73101. /**
  73102. * Creates a new instance CircleOfConfusionPostProcess
  73103. * @param name The name of the effect.
  73104. * @param scene The scene the effect belongs to.
  73105. * @param direction The direction the blur should be applied.
  73106. * @param kernel The size of the kernel used to blur.
  73107. * @param options The required width/height ratio to downsize to before computing the render pass.
  73108. * @param camera The camera to apply the render pass to.
  73109. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73110. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73111. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73112. * @param engine The engine which the post process will be applied. (default: current engine)
  73113. * @param reusable If the post process can be reused on the same frame. (default: false)
  73114. * @param textureType Type of textures used when performing the post process. (default: 0)
  73115. * @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)
  73116. */
  73117. 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);
  73118. }
  73119. }
  73120. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73121. /** @hidden */
  73122. export var depthOfFieldMergePixelShader: {
  73123. name: string;
  73124. shader: string;
  73125. };
  73126. }
  73127. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73128. import { Nullable } from "babylonjs/types";
  73129. import { Camera } from "babylonjs/Cameras/camera";
  73130. import { Effect } from "babylonjs/Materials/effect";
  73131. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73132. import { Engine } from "babylonjs/Engines/engine";
  73133. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73134. /**
  73135. * Options to be set when merging outputs from the default pipeline.
  73136. */
  73137. export class DepthOfFieldMergePostProcessOptions {
  73138. /**
  73139. * The original image to merge on top of
  73140. */
  73141. originalFromInput: PostProcess;
  73142. /**
  73143. * Parameters to perform the merge of the depth of field effect
  73144. */
  73145. depthOfField?: {
  73146. circleOfConfusion: PostProcess;
  73147. blurSteps: Array<PostProcess>;
  73148. };
  73149. /**
  73150. * Parameters to perform the merge of bloom effect
  73151. */
  73152. bloom?: {
  73153. blurred: PostProcess;
  73154. weight: number;
  73155. };
  73156. }
  73157. /**
  73158. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73159. */
  73160. export class DepthOfFieldMergePostProcess extends PostProcess {
  73161. private blurSteps;
  73162. /**
  73163. * Gets a string identifying the name of the class
  73164. * @returns "DepthOfFieldMergePostProcess" string
  73165. */
  73166. getClassName(): string;
  73167. /**
  73168. * Creates a new instance of DepthOfFieldMergePostProcess
  73169. * @param name The name of the effect.
  73170. * @param originalFromInput Post process which's input will be used for the merge.
  73171. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73172. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73173. * @param options The required width/height ratio to downsize to before computing the render pass.
  73174. * @param camera The camera to apply the render pass to.
  73175. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73176. * @param engine The engine which the post process will be applied. (default: current engine)
  73177. * @param reusable If the post process can be reused on the same frame. (default: false)
  73178. * @param textureType Type of textures used when performing the post process. (default: 0)
  73179. * @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)
  73180. */
  73181. 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);
  73182. /**
  73183. * Updates the effect with the current post process compile time values and recompiles the shader.
  73184. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73185. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73186. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73187. * @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
  73188. * @param onCompiled Called when the shader has been compiled.
  73189. * @param onError Called if there is an error when compiling a shader.
  73190. */
  73191. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73192. }
  73193. }
  73194. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73195. import { Nullable } from "babylonjs/types";
  73196. import { Camera } from "babylonjs/Cameras/camera";
  73197. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73198. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73199. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73200. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73201. import { Scene } from "babylonjs/scene";
  73202. /**
  73203. * Specifies the level of max blur that should be applied when using the depth of field effect
  73204. */
  73205. export enum DepthOfFieldEffectBlurLevel {
  73206. /**
  73207. * Subtle blur
  73208. */
  73209. Low = 0,
  73210. /**
  73211. * Medium blur
  73212. */
  73213. Medium = 1,
  73214. /**
  73215. * Large blur
  73216. */
  73217. High = 2
  73218. }
  73219. /**
  73220. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73221. */
  73222. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73223. private _circleOfConfusion;
  73224. /**
  73225. * @hidden Internal, blurs from high to low
  73226. */
  73227. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73228. private _depthOfFieldBlurY;
  73229. private _dofMerge;
  73230. /**
  73231. * @hidden Internal post processes in depth of field effect
  73232. */
  73233. _effects: Array<PostProcess>;
  73234. /**
  73235. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73236. */
  73237. set focalLength(value: number);
  73238. get focalLength(): number;
  73239. /**
  73240. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73241. */
  73242. set fStop(value: number);
  73243. get fStop(): number;
  73244. /**
  73245. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73246. */
  73247. set focusDistance(value: number);
  73248. get focusDistance(): number;
  73249. /**
  73250. * 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.
  73251. */
  73252. set lensSize(value: number);
  73253. get lensSize(): number;
  73254. /**
  73255. * Creates a new instance DepthOfFieldEffect
  73256. * @param scene The scene the effect belongs to.
  73257. * @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.
  73258. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73259. * @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)
  73260. */
  73261. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73262. /**
  73263. * Get the current class name of the current effet
  73264. * @returns "DepthOfFieldEffect"
  73265. */
  73266. getClassName(): string;
  73267. /**
  73268. * 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.
  73269. */
  73270. set depthTexture(value: RenderTargetTexture);
  73271. /**
  73272. * Disposes each of the internal effects for a given camera.
  73273. * @param camera The camera to dispose the effect on.
  73274. */
  73275. disposeEffects(camera: Camera): void;
  73276. /**
  73277. * @hidden Internal
  73278. */
  73279. _updateEffects(): void;
  73280. /**
  73281. * Internal
  73282. * @returns if all the contained post processes are ready.
  73283. * @hidden
  73284. */
  73285. _isReady(): boolean;
  73286. }
  73287. }
  73288. declare module "babylonjs/Shaders/displayPass.fragment" {
  73289. /** @hidden */
  73290. export var displayPassPixelShader: {
  73291. name: string;
  73292. shader: string;
  73293. };
  73294. }
  73295. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73296. import { Nullable } from "babylonjs/types";
  73297. import { Camera } from "babylonjs/Cameras/camera";
  73298. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73299. import { Engine } from "babylonjs/Engines/engine";
  73300. import "babylonjs/Shaders/displayPass.fragment";
  73301. import { Scene } from "babylonjs/scene";
  73302. /**
  73303. * DisplayPassPostProcess which produces an output the same as it's input
  73304. */
  73305. export class DisplayPassPostProcess extends PostProcess {
  73306. /**
  73307. * Gets a string identifying the name of the class
  73308. * @returns "DisplayPassPostProcess" string
  73309. */
  73310. getClassName(): string;
  73311. /**
  73312. * Creates the DisplayPassPostProcess
  73313. * @param name The name of the effect.
  73314. * @param options The required width/height ratio to downsize to before computing the render pass.
  73315. * @param camera The camera to apply the render pass to.
  73316. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73317. * @param engine The engine which the post process will be applied. (default: current engine)
  73318. * @param reusable If the post process can be reused on the same frame. (default: false)
  73319. */
  73320. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73321. /** @hidden */
  73322. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73323. }
  73324. }
  73325. declare module "babylonjs/Shaders/filter.fragment" {
  73326. /** @hidden */
  73327. export var filterPixelShader: {
  73328. name: string;
  73329. shader: string;
  73330. };
  73331. }
  73332. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73333. import { Nullable } from "babylonjs/types";
  73334. import { Matrix } from "babylonjs/Maths/math.vector";
  73335. import { Camera } from "babylonjs/Cameras/camera";
  73336. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73337. import { Engine } from "babylonjs/Engines/engine";
  73338. import "babylonjs/Shaders/filter.fragment";
  73339. import { Scene } from "babylonjs/scene";
  73340. /**
  73341. * Applies a kernel filter to the image
  73342. */
  73343. export class FilterPostProcess extends PostProcess {
  73344. /** The matrix to be applied to the image */
  73345. kernelMatrix: Matrix;
  73346. /**
  73347. * Gets a string identifying the name of the class
  73348. * @returns "FilterPostProcess" string
  73349. */
  73350. getClassName(): string;
  73351. /**
  73352. *
  73353. * @param name The name of the effect.
  73354. * @param kernelMatrix The matrix to be applied to the image
  73355. * @param options The required width/height ratio to downsize to before computing the render pass.
  73356. * @param camera The camera to apply the render pass to.
  73357. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73358. * @param engine The engine which the post process will be applied. (default: current engine)
  73359. * @param reusable If the post process can be reused on the same frame. (default: false)
  73360. */
  73361. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73362. /** @hidden */
  73363. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73364. }
  73365. }
  73366. declare module "babylonjs/Shaders/fxaa.fragment" {
  73367. /** @hidden */
  73368. export var fxaaPixelShader: {
  73369. name: string;
  73370. shader: string;
  73371. };
  73372. }
  73373. declare module "babylonjs/Shaders/fxaa.vertex" {
  73374. /** @hidden */
  73375. export var fxaaVertexShader: {
  73376. name: string;
  73377. shader: string;
  73378. };
  73379. }
  73380. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73381. import { Nullable } from "babylonjs/types";
  73382. import { Camera } from "babylonjs/Cameras/camera";
  73383. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73384. import { Engine } from "babylonjs/Engines/engine";
  73385. import "babylonjs/Shaders/fxaa.fragment";
  73386. import "babylonjs/Shaders/fxaa.vertex";
  73387. import { Scene } from "babylonjs/scene";
  73388. /**
  73389. * Fxaa post process
  73390. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73391. */
  73392. export class FxaaPostProcess extends PostProcess {
  73393. /**
  73394. * Gets a string identifying the name of the class
  73395. * @returns "FxaaPostProcess" string
  73396. */
  73397. getClassName(): string;
  73398. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73399. private _getDefines;
  73400. /** @hidden */
  73401. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73402. }
  73403. }
  73404. declare module "babylonjs/Shaders/grain.fragment" {
  73405. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73406. /** @hidden */
  73407. export var grainPixelShader: {
  73408. name: string;
  73409. shader: string;
  73410. };
  73411. }
  73412. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73413. import { Nullable } from "babylonjs/types";
  73414. import { Camera } from "babylonjs/Cameras/camera";
  73415. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73416. import { Engine } from "babylonjs/Engines/engine";
  73417. import "babylonjs/Shaders/grain.fragment";
  73418. import { Scene } from "babylonjs/scene";
  73419. /**
  73420. * The GrainPostProcess adds noise to the image at mid luminance levels
  73421. */
  73422. export class GrainPostProcess extends PostProcess {
  73423. /**
  73424. * The intensity of the grain added (default: 30)
  73425. */
  73426. intensity: number;
  73427. /**
  73428. * If the grain should be randomized on every frame
  73429. */
  73430. animated: boolean;
  73431. /**
  73432. * Gets a string identifying the name of the class
  73433. * @returns "GrainPostProcess" string
  73434. */
  73435. getClassName(): string;
  73436. /**
  73437. * Creates a new instance of @see GrainPostProcess
  73438. * @param name The name of the effect.
  73439. * @param options The required width/height ratio to downsize to before computing the render pass.
  73440. * @param camera The camera to apply the render pass to.
  73441. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73442. * @param engine The engine which the post process will be applied. (default: current engine)
  73443. * @param reusable If the post process can be reused on the same frame. (default: false)
  73444. * @param textureType Type of textures used when performing the post process. (default: 0)
  73445. * @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)
  73446. */
  73447. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73448. /** @hidden */
  73449. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73450. }
  73451. }
  73452. declare module "babylonjs/Shaders/highlights.fragment" {
  73453. /** @hidden */
  73454. export var highlightsPixelShader: {
  73455. name: string;
  73456. shader: string;
  73457. };
  73458. }
  73459. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73460. import { Nullable } from "babylonjs/types";
  73461. import { Camera } from "babylonjs/Cameras/camera";
  73462. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73463. import { Engine } from "babylonjs/Engines/engine";
  73464. import "babylonjs/Shaders/highlights.fragment";
  73465. /**
  73466. * Extracts highlights from the image
  73467. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73468. */
  73469. export class HighlightsPostProcess extends PostProcess {
  73470. /**
  73471. * Gets a string identifying the name of the class
  73472. * @returns "HighlightsPostProcess" string
  73473. */
  73474. getClassName(): string;
  73475. /**
  73476. * Extracts highlights from the image
  73477. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73478. * @param name The name of the effect.
  73479. * @param options The required width/height ratio to downsize to before computing the render pass.
  73480. * @param camera The camera to apply the render pass to.
  73481. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73482. * @param engine The engine which the post process will be applied. (default: current engine)
  73483. * @param reusable If the post process can be reused on the same frame. (default: false)
  73484. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73485. */
  73486. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73487. }
  73488. }
  73489. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73490. /** @hidden */
  73491. export var mrtFragmentDeclaration: {
  73492. name: string;
  73493. shader: string;
  73494. };
  73495. }
  73496. declare module "babylonjs/Shaders/geometry.fragment" {
  73497. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73498. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73499. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73500. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73501. /** @hidden */
  73502. export var geometryPixelShader: {
  73503. name: string;
  73504. shader: string;
  73505. };
  73506. }
  73507. declare module "babylonjs/Shaders/geometry.vertex" {
  73508. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73509. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73510. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73511. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73512. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73513. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73514. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73515. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73516. /** @hidden */
  73517. export var geometryVertexShader: {
  73518. name: string;
  73519. shader: string;
  73520. };
  73521. }
  73522. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73523. import { Matrix } from "babylonjs/Maths/math.vector";
  73524. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73525. import { Mesh } from "babylonjs/Meshes/mesh";
  73526. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73527. import { Effect } from "babylonjs/Materials/effect";
  73528. import { Scene } from "babylonjs/scene";
  73529. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73530. import "babylonjs/Shaders/geometry.fragment";
  73531. import "babylonjs/Shaders/geometry.vertex";
  73532. /** @hidden */
  73533. interface ISavedTransformationMatrix {
  73534. world: Matrix;
  73535. viewProjection: Matrix;
  73536. }
  73537. /**
  73538. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73539. */
  73540. export class GeometryBufferRenderer {
  73541. /**
  73542. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73543. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73544. */
  73545. static readonly POSITION_TEXTURE_TYPE: number;
  73546. /**
  73547. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73548. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73549. */
  73550. static readonly VELOCITY_TEXTURE_TYPE: number;
  73551. /**
  73552. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73553. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73554. */
  73555. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73556. /**
  73557. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73558. * in order to compute objects velocities when enableVelocity is set to "true"
  73559. * @hidden
  73560. */
  73561. _previousTransformationMatrices: {
  73562. [index: number]: ISavedTransformationMatrix;
  73563. };
  73564. /**
  73565. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73566. * in order to compute objects velocities when enableVelocity is set to "true"
  73567. * @hidden
  73568. */
  73569. _previousBonesTransformationMatrices: {
  73570. [index: number]: Float32Array;
  73571. };
  73572. /**
  73573. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73574. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73575. */
  73576. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73577. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73578. renderTransparentMeshes: boolean;
  73579. private _scene;
  73580. private _resizeObserver;
  73581. private _multiRenderTarget;
  73582. private _ratio;
  73583. private _enablePosition;
  73584. private _enableVelocity;
  73585. private _enableReflectivity;
  73586. private _positionIndex;
  73587. private _velocityIndex;
  73588. private _reflectivityIndex;
  73589. protected _effect: Effect;
  73590. protected _cachedDefines: string;
  73591. /**
  73592. * Set the render list (meshes to be rendered) used in the G buffer.
  73593. */
  73594. set renderList(meshes: Mesh[]);
  73595. /**
  73596. * Gets wether or not G buffer are supported by the running hardware.
  73597. * This requires draw buffer supports
  73598. */
  73599. get isSupported(): boolean;
  73600. /**
  73601. * Returns the index of the given texture type in the G-Buffer textures array
  73602. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73603. * @returns the index of the given texture type in the G-Buffer textures array
  73604. */
  73605. getTextureIndex(textureType: number): number;
  73606. /**
  73607. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73608. */
  73609. get enablePosition(): boolean;
  73610. /**
  73611. * Sets whether or not objects positions are enabled for the G buffer.
  73612. */
  73613. set enablePosition(enable: boolean);
  73614. /**
  73615. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73616. */
  73617. get enableVelocity(): boolean;
  73618. /**
  73619. * Sets wether or not objects velocities are enabled for the G buffer.
  73620. */
  73621. set enableVelocity(enable: boolean);
  73622. /**
  73623. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73624. */
  73625. get enableReflectivity(): boolean;
  73626. /**
  73627. * Sets wether or not objects roughness are enabled for the G buffer.
  73628. */
  73629. set enableReflectivity(enable: boolean);
  73630. /**
  73631. * Gets the scene associated with the buffer.
  73632. */
  73633. get scene(): Scene;
  73634. /**
  73635. * Gets the ratio used by the buffer during its creation.
  73636. * How big is the buffer related to the main canvas.
  73637. */
  73638. get ratio(): number;
  73639. /** @hidden */
  73640. static _SceneComponentInitialization: (scene: Scene) => void;
  73641. /**
  73642. * Creates a new G Buffer for the scene
  73643. * @param scene The scene the buffer belongs to
  73644. * @param ratio How big is the buffer related to the main canvas.
  73645. */
  73646. constructor(scene: Scene, ratio?: number);
  73647. /**
  73648. * Checks wether everything is ready to render a submesh to the G buffer.
  73649. * @param subMesh the submesh to check readiness for
  73650. * @param useInstances is the mesh drawn using instance or not
  73651. * @returns true if ready otherwise false
  73652. */
  73653. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73654. /**
  73655. * Gets the current underlying G Buffer.
  73656. * @returns the buffer
  73657. */
  73658. getGBuffer(): MultiRenderTarget;
  73659. /**
  73660. * Gets the number of samples used to render the buffer (anti aliasing).
  73661. */
  73662. get samples(): number;
  73663. /**
  73664. * Sets the number of samples used to render the buffer (anti aliasing).
  73665. */
  73666. set samples(value: number);
  73667. /**
  73668. * Disposes the renderer and frees up associated resources.
  73669. */
  73670. dispose(): void;
  73671. protected _createRenderTargets(): void;
  73672. private _copyBonesTransformationMatrices;
  73673. }
  73674. }
  73675. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73676. import { Nullable } from "babylonjs/types";
  73677. import { Scene } from "babylonjs/scene";
  73678. import { ISceneComponent } from "babylonjs/sceneComponent";
  73679. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73680. module "babylonjs/scene" {
  73681. interface Scene {
  73682. /** @hidden (Backing field) */
  73683. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73684. /**
  73685. * Gets or Sets the current geometry buffer associated to the scene.
  73686. */
  73687. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73688. /**
  73689. * Enables a GeometryBufferRender and associates it with the scene
  73690. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73691. * @returns the GeometryBufferRenderer
  73692. */
  73693. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73694. /**
  73695. * Disables the GeometryBufferRender associated with the scene
  73696. */
  73697. disableGeometryBufferRenderer(): void;
  73698. }
  73699. }
  73700. /**
  73701. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73702. * in several rendering techniques.
  73703. */
  73704. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73705. /**
  73706. * The component name helpful to identify the component in the list of scene components.
  73707. */
  73708. readonly name: string;
  73709. /**
  73710. * The scene the component belongs to.
  73711. */
  73712. scene: Scene;
  73713. /**
  73714. * Creates a new instance of the component for the given scene
  73715. * @param scene Defines the scene to register the component in
  73716. */
  73717. constructor(scene: Scene);
  73718. /**
  73719. * Registers the component in a given scene
  73720. */
  73721. register(): void;
  73722. /**
  73723. * Rebuilds the elements related to this component in case of
  73724. * context lost for instance.
  73725. */
  73726. rebuild(): void;
  73727. /**
  73728. * Disposes the component and the associated ressources
  73729. */
  73730. dispose(): void;
  73731. private _gatherRenderTargets;
  73732. }
  73733. }
  73734. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73735. /** @hidden */
  73736. export var motionBlurPixelShader: {
  73737. name: string;
  73738. shader: string;
  73739. };
  73740. }
  73741. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73742. import { Nullable } from "babylonjs/types";
  73743. import { Camera } from "babylonjs/Cameras/camera";
  73744. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73745. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73746. import "babylonjs/Animations/animatable";
  73747. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73748. import "babylonjs/Shaders/motionBlur.fragment";
  73749. import { Engine } from "babylonjs/Engines/engine";
  73750. import { Scene } from "babylonjs/scene";
  73751. /**
  73752. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73753. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73754. * As an example, all you have to do is to create the post-process:
  73755. * var mb = new BABYLON.MotionBlurPostProcess(
  73756. * 'mb', // The name of the effect.
  73757. * scene, // The scene containing the objects to blur according to their velocity.
  73758. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73759. * camera // The camera to apply the render pass to.
  73760. * );
  73761. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73762. */
  73763. export class MotionBlurPostProcess extends PostProcess {
  73764. /**
  73765. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73766. */
  73767. motionStrength: number;
  73768. /**
  73769. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73770. */
  73771. get motionBlurSamples(): number;
  73772. /**
  73773. * Sets the number of iterations to be used for motion blur quality
  73774. */
  73775. set motionBlurSamples(samples: number);
  73776. private _motionBlurSamples;
  73777. private _geometryBufferRenderer;
  73778. /**
  73779. * Gets a string identifying the name of the class
  73780. * @returns "MotionBlurPostProcess" string
  73781. */
  73782. getClassName(): string;
  73783. /**
  73784. * Creates a new instance MotionBlurPostProcess
  73785. * @param name The name of the effect.
  73786. * @param scene The scene containing the objects to blur according to their velocity.
  73787. * @param options The required width/height ratio to downsize to before computing the render pass.
  73788. * @param camera The camera to apply the render pass to.
  73789. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73790. * @param engine The engine which the post process will be applied. (default: current engine)
  73791. * @param reusable If the post process can be reused on the same frame. (default: false)
  73792. * @param textureType Type of textures used when performing the post process. (default: 0)
  73793. * @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)
  73794. */
  73795. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73796. /**
  73797. * Excludes the given skinned mesh from computing bones velocities.
  73798. * 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.
  73799. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73800. */
  73801. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73802. /**
  73803. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73804. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73805. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73806. */
  73807. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73808. /**
  73809. * Disposes the post process.
  73810. * @param camera The camera to dispose the post process on.
  73811. */
  73812. dispose(camera?: Camera): void;
  73813. /** @hidden */
  73814. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73815. }
  73816. }
  73817. declare module "babylonjs/Shaders/refraction.fragment" {
  73818. /** @hidden */
  73819. export var refractionPixelShader: {
  73820. name: string;
  73821. shader: string;
  73822. };
  73823. }
  73824. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73825. import { Color3 } from "babylonjs/Maths/math.color";
  73826. import { Camera } from "babylonjs/Cameras/camera";
  73827. import { Texture } from "babylonjs/Materials/Textures/texture";
  73828. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73829. import { Engine } from "babylonjs/Engines/engine";
  73830. import "babylonjs/Shaders/refraction.fragment";
  73831. import { Scene } from "babylonjs/scene";
  73832. /**
  73833. * Post process which applies a refractin texture
  73834. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73835. */
  73836. export class RefractionPostProcess extends PostProcess {
  73837. private _refTexture;
  73838. private _ownRefractionTexture;
  73839. /** the base color of the refraction (used to taint the rendering) */
  73840. color: Color3;
  73841. /** simulated refraction depth */
  73842. depth: number;
  73843. /** the coefficient of the base color (0 to remove base color tainting) */
  73844. colorLevel: number;
  73845. /** Gets the url used to load the refraction texture */
  73846. refractionTextureUrl: string;
  73847. /**
  73848. * Gets or sets the refraction texture
  73849. * Please note that you are responsible for disposing the texture if you set it manually
  73850. */
  73851. get refractionTexture(): Texture;
  73852. set refractionTexture(value: Texture);
  73853. /**
  73854. * Gets a string identifying the name of the class
  73855. * @returns "RefractionPostProcess" string
  73856. */
  73857. getClassName(): string;
  73858. /**
  73859. * Initializes the RefractionPostProcess
  73860. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73861. * @param name The name of the effect.
  73862. * @param refractionTextureUrl Url of the refraction texture to use
  73863. * @param color the base color of the refraction (used to taint the rendering)
  73864. * @param depth simulated refraction depth
  73865. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73866. * @param camera The camera to apply the render pass to.
  73867. * @param options The required width/height ratio to downsize to before computing the render pass.
  73868. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73869. * @param engine The engine which the post process will be applied. (default: current engine)
  73870. * @param reusable If the post process can be reused on the same frame. (default: false)
  73871. */
  73872. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73873. /**
  73874. * Disposes of the post process
  73875. * @param camera Camera to dispose post process on
  73876. */
  73877. dispose(camera: Camera): void;
  73878. /** @hidden */
  73879. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73880. }
  73881. }
  73882. declare module "babylonjs/Shaders/sharpen.fragment" {
  73883. /** @hidden */
  73884. export var sharpenPixelShader: {
  73885. name: string;
  73886. shader: string;
  73887. };
  73888. }
  73889. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73890. import { Nullable } from "babylonjs/types";
  73891. import { Camera } from "babylonjs/Cameras/camera";
  73892. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73893. import "babylonjs/Shaders/sharpen.fragment";
  73894. import { Engine } from "babylonjs/Engines/engine";
  73895. import { Scene } from "babylonjs/scene";
  73896. /**
  73897. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73898. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73899. */
  73900. export class SharpenPostProcess extends PostProcess {
  73901. /**
  73902. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73903. */
  73904. colorAmount: number;
  73905. /**
  73906. * How much sharpness should be applied (default: 0.3)
  73907. */
  73908. edgeAmount: number;
  73909. /**
  73910. * Gets a string identifying the name of the class
  73911. * @returns "SharpenPostProcess" string
  73912. */
  73913. getClassName(): string;
  73914. /**
  73915. * Creates a new instance ConvolutionPostProcess
  73916. * @param name The name of the effect.
  73917. * @param options The required width/height ratio to downsize to before computing the render pass.
  73918. * @param camera The camera to apply the render pass to.
  73919. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73920. * @param engine The engine which the post process will be applied. (default: current engine)
  73921. * @param reusable If the post process can be reused on the same frame. (default: false)
  73922. * @param textureType Type of textures used when performing the post process. (default: 0)
  73923. * @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)
  73924. */
  73925. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73926. /** @hidden */
  73927. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73928. }
  73929. }
  73930. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73931. import { Nullable } from "babylonjs/types";
  73932. import { Camera } from "babylonjs/Cameras/camera";
  73933. import { Engine } from "babylonjs/Engines/engine";
  73934. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73935. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73936. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73937. /**
  73938. * PostProcessRenderPipeline
  73939. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73940. */
  73941. export class PostProcessRenderPipeline {
  73942. private engine;
  73943. private _renderEffects;
  73944. private _renderEffectsForIsolatedPass;
  73945. /**
  73946. * List of inspectable custom properties (used by the Inspector)
  73947. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73948. */
  73949. inspectableCustomProperties: IInspectable[];
  73950. /**
  73951. * @hidden
  73952. */
  73953. protected _cameras: Camera[];
  73954. /** @hidden */
  73955. _name: string;
  73956. /**
  73957. * Gets pipeline name
  73958. */
  73959. get name(): string;
  73960. /** Gets the list of attached cameras */
  73961. get cameras(): Camera[];
  73962. /**
  73963. * Initializes a PostProcessRenderPipeline
  73964. * @param engine engine to add the pipeline to
  73965. * @param name name of the pipeline
  73966. */
  73967. constructor(engine: Engine, name: string);
  73968. /**
  73969. * Gets the class name
  73970. * @returns "PostProcessRenderPipeline"
  73971. */
  73972. getClassName(): string;
  73973. /**
  73974. * If all the render effects in the pipeline are supported
  73975. */
  73976. get isSupported(): boolean;
  73977. /**
  73978. * Adds an effect to the pipeline
  73979. * @param renderEffect the effect to add
  73980. */
  73981. addEffect(renderEffect: PostProcessRenderEffect): void;
  73982. /** @hidden */
  73983. _rebuild(): void;
  73984. /** @hidden */
  73985. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73986. /** @hidden */
  73987. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73988. /** @hidden */
  73989. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73990. /** @hidden */
  73991. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73992. /** @hidden */
  73993. _attachCameras(cameras: Camera, unique: boolean): void;
  73994. /** @hidden */
  73995. _attachCameras(cameras: Camera[], unique: boolean): void;
  73996. /** @hidden */
  73997. _detachCameras(cameras: Camera): void;
  73998. /** @hidden */
  73999. _detachCameras(cameras: Nullable<Camera[]>): void;
  74000. /** @hidden */
  74001. _update(): void;
  74002. /** @hidden */
  74003. _reset(): void;
  74004. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  74005. /**
  74006. * Sets the required values to the prepass renderer.
  74007. * @param prePassRenderer defines the prepass renderer to setup.
  74008. * @returns true if the pre pass is needed.
  74009. */
  74010. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74011. /**
  74012. * Disposes of the pipeline
  74013. */
  74014. dispose(): void;
  74015. }
  74016. }
  74017. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  74018. import { Camera } from "babylonjs/Cameras/camera";
  74019. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74020. /**
  74021. * PostProcessRenderPipelineManager class
  74022. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74023. */
  74024. export class PostProcessRenderPipelineManager {
  74025. private _renderPipelines;
  74026. /**
  74027. * Initializes a PostProcessRenderPipelineManager
  74028. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74029. */
  74030. constructor();
  74031. /**
  74032. * Gets the list of supported render pipelines
  74033. */
  74034. get supportedPipelines(): PostProcessRenderPipeline[];
  74035. /**
  74036. * Adds a pipeline to the manager
  74037. * @param renderPipeline The pipeline to add
  74038. */
  74039. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  74040. /**
  74041. * Attaches a camera to the pipeline
  74042. * @param renderPipelineName The name of the pipeline to attach to
  74043. * @param cameras the camera to attach
  74044. * @param unique if the camera can be attached multiple times to the pipeline
  74045. */
  74046. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  74047. /**
  74048. * Detaches a camera from the pipeline
  74049. * @param renderPipelineName The name of the pipeline to detach from
  74050. * @param cameras the camera to detach
  74051. */
  74052. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  74053. /**
  74054. * Enables an effect by name on a pipeline
  74055. * @param renderPipelineName the name of the pipeline to enable the effect in
  74056. * @param renderEffectName the name of the effect to enable
  74057. * @param cameras the cameras that the effect should be enabled on
  74058. */
  74059. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74060. /**
  74061. * Disables an effect by name on a pipeline
  74062. * @param renderPipelineName the name of the pipeline to disable the effect in
  74063. * @param renderEffectName the name of the effect to disable
  74064. * @param cameras the cameras that the effect should be disabled on
  74065. */
  74066. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74067. /**
  74068. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  74069. */
  74070. update(): void;
  74071. /** @hidden */
  74072. _rebuild(): void;
  74073. /**
  74074. * Disposes of the manager and pipelines
  74075. */
  74076. dispose(): void;
  74077. }
  74078. }
  74079. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  74080. import { ISceneComponent } from "babylonjs/sceneComponent";
  74081. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74082. import { Scene } from "babylonjs/scene";
  74083. module "babylonjs/scene" {
  74084. interface Scene {
  74085. /** @hidden (Backing field) */
  74086. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74087. /**
  74088. * Gets the postprocess render pipeline manager
  74089. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74090. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74091. */
  74092. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74093. }
  74094. }
  74095. /**
  74096. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74097. */
  74098. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74099. /**
  74100. * The component name helpfull to identify the component in the list of scene components.
  74101. */
  74102. readonly name: string;
  74103. /**
  74104. * The scene the component belongs to.
  74105. */
  74106. scene: Scene;
  74107. /**
  74108. * Creates a new instance of the component for the given scene
  74109. * @param scene Defines the scene to register the component in
  74110. */
  74111. constructor(scene: Scene);
  74112. /**
  74113. * Registers the component in a given scene
  74114. */
  74115. register(): void;
  74116. /**
  74117. * Rebuilds the elements related to this component in case of
  74118. * context lost for instance.
  74119. */
  74120. rebuild(): void;
  74121. /**
  74122. * Disposes the component and the associated ressources
  74123. */
  74124. dispose(): void;
  74125. private _gatherRenderTargets;
  74126. }
  74127. }
  74128. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74129. import { Nullable } from "babylonjs/types";
  74130. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74131. import { Camera } from "babylonjs/Cameras/camera";
  74132. import { IDisposable } from "babylonjs/scene";
  74133. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74134. import { Scene } from "babylonjs/scene";
  74135. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74136. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74137. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74138. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74139. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74140. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74141. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74142. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74143. import { Animation } from "babylonjs/Animations/animation";
  74144. /**
  74145. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74146. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74147. */
  74148. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74149. private _scene;
  74150. private _camerasToBeAttached;
  74151. /**
  74152. * ID of the sharpen post process,
  74153. */
  74154. private readonly SharpenPostProcessId;
  74155. /**
  74156. * @ignore
  74157. * ID of the image processing post process;
  74158. */
  74159. readonly ImageProcessingPostProcessId: string;
  74160. /**
  74161. * @ignore
  74162. * ID of the Fast Approximate Anti-Aliasing post process;
  74163. */
  74164. readonly FxaaPostProcessId: string;
  74165. /**
  74166. * ID of the chromatic aberration post process,
  74167. */
  74168. private readonly ChromaticAberrationPostProcessId;
  74169. /**
  74170. * ID of the grain post process
  74171. */
  74172. private readonly GrainPostProcessId;
  74173. /**
  74174. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74175. */
  74176. sharpen: SharpenPostProcess;
  74177. private _sharpenEffect;
  74178. private bloom;
  74179. /**
  74180. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74181. */
  74182. depthOfField: DepthOfFieldEffect;
  74183. /**
  74184. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74185. */
  74186. fxaa: FxaaPostProcess;
  74187. /**
  74188. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74189. */
  74190. imageProcessing: ImageProcessingPostProcess;
  74191. /**
  74192. * Chromatic aberration post process which will shift rgb colors in the image
  74193. */
  74194. chromaticAberration: ChromaticAberrationPostProcess;
  74195. private _chromaticAberrationEffect;
  74196. /**
  74197. * Grain post process which add noise to the image
  74198. */
  74199. grain: GrainPostProcess;
  74200. private _grainEffect;
  74201. /**
  74202. * Glow post process which adds a glow to emissive areas of the image
  74203. */
  74204. private _glowLayer;
  74205. /**
  74206. * Animations which can be used to tweak settings over a period of time
  74207. */
  74208. animations: Animation[];
  74209. private _imageProcessingConfigurationObserver;
  74210. private _sharpenEnabled;
  74211. private _bloomEnabled;
  74212. private _depthOfFieldEnabled;
  74213. private _depthOfFieldBlurLevel;
  74214. private _fxaaEnabled;
  74215. private _imageProcessingEnabled;
  74216. private _defaultPipelineTextureType;
  74217. private _bloomScale;
  74218. private _chromaticAberrationEnabled;
  74219. private _grainEnabled;
  74220. private _buildAllowed;
  74221. /**
  74222. * Gets active scene
  74223. */
  74224. get scene(): Scene;
  74225. /**
  74226. * Enable or disable the sharpen process from the pipeline
  74227. */
  74228. set sharpenEnabled(enabled: boolean);
  74229. get sharpenEnabled(): boolean;
  74230. private _resizeObserver;
  74231. private _hardwareScaleLevel;
  74232. private _bloomKernel;
  74233. /**
  74234. * Specifies the size of the bloom blur kernel, relative to the final output size
  74235. */
  74236. get bloomKernel(): number;
  74237. set bloomKernel(value: number);
  74238. /**
  74239. * Specifies the weight of the bloom in the final rendering
  74240. */
  74241. private _bloomWeight;
  74242. /**
  74243. * Specifies the luma threshold for the area that will be blurred by the bloom
  74244. */
  74245. private _bloomThreshold;
  74246. private _hdr;
  74247. /**
  74248. * The strength of the bloom.
  74249. */
  74250. set bloomWeight(value: number);
  74251. get bloomWeight(): number;
  74252. /**
  74253. * The strength of the bloom.
  74254. */
  74255. set bloomThreshold(value: number);
  74256. get bloomThreshold(): number;
  74257. /**
  74258. * The scale of the bloom, lower value will provide better performance.
  74259. */
  74260. set bloomScale(value: number);
  74261. get bloomScale(): number;
  74262. /**
  74263. * Enable or disable the bloom from the pipeline
  74264. */
  74265. set bloomEnabled(enabled: boolean);
  74266. get bloomEnabled(): boolean;
  74267. private _rebuildBloom;
  74268. /**
  74269. * If the depth of field is enabled.
  74270. */
  74271. get depthOfFieldEnabled(): boolean;
  74272. set depthOfFieldEnabled(enabled: boolean);
  74273. /**
  74274. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74275. */
  74276. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74277. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74278. /**
  74279. * If the anti aliasing is enabled.
  74280. */
  74281. set fxaaEnabled(enabled: boolean);
  74282. get fxaaEnabled(): boolean;
  74283. private _samples;
  74284. /**
  74285. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74286. */
  74287. set samples(sampleCount: number);
  74288. get samples(): number;
  74289. /**
  74290. * If image processing is enabled.
  74291. */
  74292. set imageProcessingEnabled(enabled: boolean);
  74293. get imageProcessingEnabled(): boolean;
  74294. /**
  74295. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74296. */
  74297. set glowLayerEnabled(enabled: boolean);
  74298. get glowLayerEnabled(): boolean;
  74299. /**
  74300. * Gets the glow layer (or null if not defined)
  74301. */
  74302. get glowLayer(): Nullable<GlowLayer>;
  74303. /**
  74304. * Enable or disable the chromaticAberration process from the pipeline
  74305. */
  74306. set chromaticAberrationEnabled(enabled: boolean);
  74307. get chromaticAberrationEnabled(): boolean;
  74308. /**
  74309. * Enable or disable the grain process from the pipeline
  74310. */
  74311. set grainEnabled(enabled: boolean);
  74312. get grainEnabled(): boolean;
  74313. /**
  74314. * @constructor
  74315. * @param name - The rendering pipeline name (default: "")
  74316. * @param hdr - If high dynamic range textures should be used (default: true)
  74317. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74318. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74319. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74320. */
  74321. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74322. /**
  74323. * Get the class name
  74324. * @returns "DefaultRenderingPipeline"
  74325. */
  74326. getClassName(): string;
  74327. /**
  74328. * Force the compilation of the entire pipeline.
  74329. */
  74330. prepare(): void;
  74331. private _hasCleared;
  74332. private _prevPostProcess;
  74333. private _prevPrevPostProcess;
  74334. private _setAutoClearAndTextureSharing;
  74335. private _depthOfFieldSceneObserver;
  74336. private _buildPipeline;
  74337. private _disposePostProcesses;
  74338. /**
  74339. * Adds a camera to the pipeline
  74340. * @param camera the camera to be added
  74341. */
  74342. addCamera(camera: Camera): void;
  74343. /**
  74344. * Removes a camera from the pipeline
  74345. * @param camera the camera to remove
  74346. */
  74347. removeCamera(camera: Camera): void;
  74348. /**
  74349. * Dispose of the pipeline and stop all post processes
  74350. */
  74351. dispose(): void;
  74352. /**
  74353. * Serialize the rendering pipeline (Used when exporting)
  74354. * @returns the serialized object
  74355. */
  74356. serialize(): any;
  74357. /**
  74358. * Parse the serialized pipeline
  74359. * @param source Source pipeline.
  74360. * @param scene The scene to load the pipeline to.
  74361. * @param rootUrl The URL of the serialized pipeline.
  74362. * @returns An instantiated pipeline from the serialized object.
  74363. */
  74364. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74365. }
  74366. }
  74367. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74368. /** @hidden */
  74369. export var lensHighlightsPixelShader: {
  74370. name: string;
  74371. shader: string;
  74372. };
  74373. }
  74374. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74375. /** @hidden */
  74376. export var depthOfFieldPixelShader: {
  74377. name: string;
  74378. shader: string;
  74379. };
  74380. }
  74381. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74382. import { Camera } from "babylonjs/Cameras/camera";
  74383. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74384. import { Scene } from "babylonjs/scene";
  74385. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74386. import "babylonjs/Shaders/chromaticAberration.fragment";
  74387. import "babylonjs/Shaders/lensHighlights.fragment";
  74388. import "babylonjs/Shaders/depthOfField.fragment";
  74389. /**
  74390. * BABYLON.JS Chromatic Aberration GLSL Shader
  74391. * Author: Olivier Guyot
  74392. * Separates very slightly R, G and B colors on the edges of the screen
  74393. * Inspired by Francois Tarlier & Martins Upitis
  74394. */
  74395. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74396. /**
  74397. * @ignore
  74398. * The chromatic aberration PostProcess id in the pipeline
  74399. */
  74400. LensChromaticAberrationEffect: string;
  74401. /**
  74402. * @ignore
  74403. * The highlights enhancing PostProcess id in the pipeline
  74404. */
  74405. HighlightsEnhancingEffect: string;
  74406. /**
  74407. * @ignore
  74408. * The depth-of-field PostProcess id in the pipeline
  74409. */
  74410. LensDepthOfFieldEffect: string;
  74411. private _scene;
  74412. private _depthTexture;
  74413. private _grainTexture;
  74414. private _chromaticAberrationPostProcess;
  74415. private _highlightsPostProcess;
  74416. private _depthOfFieldPostProcess;
  74417. private _edgeBlur;
  74418. private _grainAmount;
  74419. private _chromaticAberration;
  74420. private _distortion;
  74421. private _highlightsGain;
  74422. private _highlightsThreshold;
  74423. private _dofDistance;
  74424. private _dofAperture;
  74425. private _dofDarken;
  74426. private _dofPentagon;
  74427. private _blurNoise;
  74428. /**
  74429. * @constructor
  74430. *
  74431. * Effect parameters are as follow:
  74432. * {
  74433. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74434. * edge_blur: number; // from 0 to x (1 for realism)
  74435. * distortion: number; // from 0 to x (1 for realism)
  74436. * grain_amount: number; // from 0 to 1
  74437. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74438. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74439. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74440. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74441. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74442. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74443. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74444. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74445. * }
  74446. * Note: if an effect parameter is unset, effect is disabled
  74447. *
  74448. * @param name The rendering pipeline name
  74449. * @param parameters - An object containing all parameters (see above)
  74450. * @param scene The scene linked to this pipeline
  74451. * @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)
  74452. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74453. */
  74454. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74455. /**
  74456. * Get the class name
  74457. * @returns "LensRenderingPipeline"
  74458. */
  74459. getClassName(): string;
  74460. /**
  74461. * Gets associated scene
  74462. */
  74463. get scene(): Scene;
  74464. /**
  74465. * Gets or sets the edge blur
  74466. */
  74467. get edgeBlur(): number;
  74468. set edgeBlur(value: number);
  74469. /**
  74470. * Gets or sets the grain amount
  74471. */
  74472. get grainAmount(): number;
  74473. set grainAmount(value: number);
  74474. /**
  74475. * Gets or sets the chromatic aberration amount
  74476. */
  74477. get chromaticAberration(): number;
  74478. set chromaticAberration(value: number);
  74479. /**
  74480. * Gets or sets the depth of field aperture
  74481. */
  74482. get dofAperture(): number;
  74483. set dofAperture(value: number);
  74484. /**
  74485. * Gets or sets the edge distortion
  74486. */
  74487. get edgeDistortion(): number;
  74488. set edgeDistortion(value: number);
  74489. /**
  74490. * Gets or sets the depth of field distortion
  74491. */
  74492. get dofDistortion(): number;
  74493. set dofDistortion(value: number);
  74494. /**
  74495. * Gets or sets the darken out of focus amount
  74496. */
  74497. get darkenOutOfFocus(): number;
  74498. set darkenOutOfFocus(value: number);
  74499. /**
  74500. * Gets or sets a boolean indicating if blur noise is enabled
  74501. */
  74502. get blurNoise(): boolean;
  74503. set blurNoise(value: boolean);
  74504. /**
  74505. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74506. */
  74507. get pentagonBokeh(): boolean;
  74508. set pentagonBokeh(value: boolean);
  74509. /**
  74510. * Gets or sets the highlight grain amount
  74511. */
  74512. get highlightsGain(): number;
  74513. set highlightsGain(value: number);
  74514. /**
  74515. * Gets or sets the highlight threshold
  74516. */
  74517. get highlightsThreshold(): number;
  74518. set highlightsThreshold(value: number);
  74519. /**
  74520. * Sets the amount of blur at the edges
  74521. * @param amount blur amount
  74522. */
  74523. setEdgeBlur(amount: number): void;
  74524. /**
  74525. * Sets edge blur to 0
  74526. */
  74527. disableEdgeBlur(): void;
  74528. /**
  74529. * Sets the amout of grain
  74530. * @param amount Amount of grain
  74531. */
  74532. setGrainAmount(amount: number): void;
  74533. /**
  74534. * Set grain amount to 0
  74535. */
  74536. disableGrain(): void;
  74537. /**
  74538. * Sets the chromatic aberration amount
  74539. * @param amount amount of chromatic aberration
  74540. */
  74541. setChromaticAberration(amount: number): void;
  74542. /**
  74543. * Sets chromatic aberration amount to 0
  74544. */
  74545. disableChromaticAberration(): void;
  74546. /**
  74547. * Sets the EdgeDistortion amount
  74548. * @param amount amount of EdgeDistortion
  74549. */
  74550. setEdgeDistortion(amount: number): void;
  74551. /**
  74552. * Sets edge distortion to 0
  74553. */
  74554. disableEdgeDistortion(): void;
  74555. /**
  74556. * Sets the FocusDistance amount
  74557. * @param amount amount of FocusDistance
  74558. */
  74559. setFocusDistance(amount: number): void;
  74560. /**
  74561. * Disables depth of field
  74562. */
  74563. disableDepthOfField(): void;
  74564. /**
  74565. * Sets the Aperture amount
  74566. * @param amount amount of Aperture
  74567. */
  74568. setAperture(amount: number): void;
  74569. /**
  74570. * Sets the DarkenOutOfFocus amount
  74571. * @param amount amount of DarkenOutOfFocus
  74572. */
  74573. setDarkenOutOfFocus(amount: number): void;
  74574. private _pentagonBokehIsEnabled;
  74575. /**
  74576. * Creates a pentagon bokeh effect
  74577. */
  74578. enablePentagonBokeh(): void;
  74579. /**
  74580. * Disables the pentagon bokeh effect
  74581. */
  74582. disablePentagonBokeh(): void;
  74583. /**
  74584. * Enables noise blur
  74585. */
  74586. enableNoiseBlur(): void;
  74587. /**
  74588. * Disables noise blur
  74589. */
  74590. disableNoiseBlur(): void;
  74591. /**
  74592. * Sets the HighlightsGain amount
  74593. * @param amount amount of HighlightsGain
  74594. */
  74595. setHighlightsGain(amount: number): void;
  74596. /**
  74597. * Sets the HighlightsThreshold amount
  74598. * @param amount amount of HighlightsThreshold
  74599. */
  74600. setHighlightsThreshold(amount: number): void;
  74601. /**
  74602. * Disables highlights
  74603. */
  74604. disableHighlights(): void;
  74605. /**
  74606. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74607. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74608. */
  74609. dispose(disableDepthRender?: boolean): void;
  74610. private _createChromaticAberrationPostProcess;
  74611. private _createHighlightsPostProcess;
  74612. private _createDepthOfFieldPostProcess;
  74613. private _createGrainTexture;
  74614. }
  74615. }
  74616. declare module "babylonjs/Shaders/ssao2.fragment" {
  74617. /** @hidden */
  74618. export var ssao2PixelShader: {
  74619. name: string;
  74620. shader: string;
  74621. };
  74622. }
  74623. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74624. /** @hidden */
  74625. export var ssaoCombinePixelShader: {
  74626. name: string;
  74627. shader: string;
  74628. };
  74629. }
  74630. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74631. import { Camera } from "babylonjs/Cameras/camera";
  74632. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74633. import { Scene } from "babylonjs/scene";
  74634. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74635. import "babylonjs/Shaders/ssao2.fragment";
  74636. import "babylonjs/Shaders/ssaoCombine.fragment";
  74637. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74638. /**
  74639. * Render pipeline to produce ssao effect
  74640. */
  74641. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74642. /**
  74643. * @ignore
  74644. * The PassPostProcess id in the pipeline that contains the original scene color
  74645. */
  74646. SSAOOriginalSceneColorEffect: string;
  74647. /**
  74648. * @ignore
  74649. * The SSAO PostProcess id in the pipeline
  74650. */
  74651. SSAORenderEffect: string;
  74652. /**
  74653. * @ignore
  74654. * The horizontal blur PostProcess id in the pipeline
  74655. */
  74656. SSAOBlurHRenderEffect: string;
  74657. /**
  74658. * @ignore
  74659. * The vertical blur PostProcess id in the pipeline
  74660. */
  74661. SSAOBlurVRenderEffect: string;
  74662. /**
  74663. * @ignore
  74664. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74665. */
  74666. SSAOCombineRenderEffect: string;
  74667. /**
  74668. * The output strength of the SSAO post-process. Default value is 1.0.
  74669. */
  74670. totalStrength: number;
  74671. /**
  74672. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74673. */
  74674. maxZ: number;
  74675. /**
  74676. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74677. */
  74678. minZAspect: number;
  74679. private _samples;
  74680. /**
  74681. * Number of samples used for the SSAO calculations. Default value is 8
  74682. */
  74683. set samples(n: number);
  74684. get samples(): number;
  74685. private _textureSamples;
  74686. /**
  74687. * Number of samples to use for antialiasing
  74688. */
  74689. set textureSamples(n: number);
  74690. get textureSamples(): number;
  74691. /**
  74692. * Force rendering the geometry through geometry buffer
  74693. */
  74694. private _forceGeometryBuffer;
  74695. /**
  74696. * Ratio object used for SSAO ratio and blur ratio
  74697. */
  74698. private _ratio;
  74699. /**
  74700. * Dynamically generated sphere sampler.
  74701. */
  74702. private _sampleSphere;
  74703. /**
  74704. * Blur filter offsets
  74705. */
  74706. private _samplerOffsets;
  74707. private _expensiveBlur;
  74708. /**
  74709. * If bilateral blur should be used
  74710. */
  74711. set expensiveBlur(b: boolean);
  74712. get expensiveBlur(): boolean;
  74713. /**
  74714. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74715. */
  74716. radius: number;
  74717. /**
  74718. * The base color of the SSAO post-process
  74719. * The final result is "base + ssao" between [0, 1]
  74720. */
  74721. base: number;
  74722. /**
  74723. * Support test.
  74724. */
  74725. static get IsSupported(): boolean;
  74726. private _scene;
  74727. private _randomTexture;
  74728. private _originalColorPostProcess;
  74729. private _ssaoPostProcess;
  74730. private _blurHPostProcess;
  74731. private _blurVPostProcess;
  74732. private _ssaoCombinePostProcess;
  74733. private _prePassRenderer;
  74734. /**
  74735. * Gets active scene
  74736. */
  74737. get scene(): Scene;
  74738. /**
  74739. * @constructor
  74740. * @param name The rendering pipeline name
  74741. * @param scene The scene linked to this pipeline
  74742. * @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 }
  74743. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74744. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74745. */
  74746. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74747. /**
  74748. * Get the class name
  74749. * @returns "SSAO2RenderingPipeline"
  74750. */
  74751. getClassName(): string;
  74752. /**
  74753. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74754. */
  74755. dispose(disableGeometryBufferRenderer?: boolean): void;
  74756. private _createBlurPostProcess;
  74757. /** @hidden */
  74758. _rebuild(): void;
  74759. private _bits;
  74760. private _radicalInverse_VdC;
  74761. private _hammersley;
  74762. private _hemisphereSample_uniform;
  74763. private _generateHemisphere;
  74764. private _getDefinesForSSAO;
  74765. private _createSSAOPostProcess;
  74766. private _createSSAOCombinePostProcess;
  74767. private _createRandomTexture;
  74768. /**
  74769. * Serialize the rendering pipeline (Used when exporting)
  74770. * @returns the serialized object
  74771. */
  74772. serialize(): any;
  74773. /**
  74774. * Parse the serialized pipeline
  74775. * @param source Source pipeline.
  74776. * @param scene The scene to load the pipeline to.
  74777. * @param rootUrl The URL of the serialized pipeline.
  74778. * @returns An instantiated pipeline from the serialized object.
  74779. */
  74780. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74781. /**
  74782. * Sets the required values to the prepass renderer.
  74783. * @param prePassRenderer defines the prepass renderer to setup
  74784. * @returns true if the pre pass is needed.
  74785. */
  74786. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74787. }
  74788. }
  74789. declare module "babylonjs/Shaders/ssao.fragment" {
  74790. /** @hidden */
  74791. export var ssaoPixelShader: {
  74792. name: string;
  74793. shader: string;
  74794. };
  74795. }
  74796. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74797. import { Camera } from "babylonjs/Cameras/camera";
  74798. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74799. import { Scene } from "babylonjs/scene";
  74800. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74801. import "babylonjs/Shaders/ssao.fragment";
  74802. import "babylonjs/Shaders/ssaoCombine.fragment";
  74803. /**
  74804. * Render pipeline to produce ssao effect
  74805. */
  74806. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74807. /**
  74808. * @ignore
  74809. * The PassPostProcess id in the pipeline that contains the original scene color
  74810. */
  74811. SSAOOriginalSceneColorEffect: string;
  74812. /**
  74813. * @ignore
  74814. * The SSAO PostProcess id in the pipeline
  74815. */
  74816. SSAORenderEffect: string;
  74817. /**
  74818. * @ignore
  74819. * The horizontal blur PostProcess id in the pipeline
  74820. */
  74821. SSAOBlurHRenderEffect: string;
  74822. /**
  74823. * @ignore
  74824. * The vertical blur PostProcess id in the pipeline
  74825. */
  74826. SSAOBlurVRenderEffect: string;
  74827. /**
  74828. * @ignore
  74829. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74830. */
  74831. SSAOCombineRenderEffect: string;
  74832. /**
  74833. * The output strength of the SSAO post-process. Default value is 1.0.
  74834. */
  74835. totalStrength: number;
  74836. /**
  74837. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74838. */
  74839. radius: number;
  74840. /**
  74841. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74842. * Must not be equal to fallOff and superior to fallOff.
  74843. * Default value is 0.0075
  74844. */
  74845. area: number;
  74846. /**
  74847. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74848. * Must not be equal to area and inferior to area.
  74849. * Default value is 0.000001
  74850. */
  74851. fallOff: number;
  74852. /**
  74853. * The base color of the SSAO post-process
  74854. * The final result is "base + ssao" between [0, 1]
  74855. */
  74856. base: number;
  74857. private _scene;
  74858. private _depthTexture;
  74859. private _randomTexture;
  74860. private _originalColorPostProcess;
  74861. private _ssaoPostProcess;
  74862. private _blurHPostProcess;
  74863. private _blurVPostProcess;
  74864. private _ssaoCombinePostProcess;
  74865. private _firstUpdate;
  74866. /**
  74867. * Gets active scene
  74868. */
  74869. get scene(): Scene;
  74870. /**
  74871. * @constructor
  74872. * @param name - The rendering pipeline name
  74873. * @param scene - The scene linked to this pipeline
  74874. * @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 }
  74875. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74876. */
  74877. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74878. /**
  74879. * Get the class name
  74880. * @returns "SSAORenderingPipeline"
  74881. */
  74882. getClassName(): string;
  74883. /**
  74884. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74885. */
  74886. dispose(disableDepthRender?: boolean): void;
  74887. private _createBlurPostProcess;
  74888. /** @hidden */
  74889. _rebuild(): void;
  74890. private _createSSAOPostProcess;
  74891. private _createSSAOCombinePostProcess;
  74892. private _createRandomTexture;
  74893. }
  74894. }
  74895. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74896. /** @hidden */
  74897. export var screenSpaceReflectionPixelShader: {
  74898. name: string;
  74899. shader: string;
  74900. };
  74901. }
  74902. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74903. import { Nullable } from "babylonjs/types";
  74904. import { Camera } from "babylonjs/Cameras/camera";
  74905. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74906. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74907. import { Engine } from "babylonjs/Engines/engine";
  74908. import { Scene } from "babylonjs/scene";
  74909. /**
  74910. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74911. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74912. */
  74913. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74914. /**
  74915. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74916. */
  74917. threshold: number;
  74918. /**
  74919. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74920. */
  74921. strength: number;
  74922. /**
  74923. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74924. */
  74925. reflectionSpecularFalloffExponent: number;
  74926. /**
  74927. * Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Typically in interval [0.1, 1.0]
  74928. */
  74929. step: number;
  74930. /**
  74931. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74932. */
  74933. roughnessFactor: number;
  74934. private _geometryBufferRenderer;
  74935. private _enableSmoothReflections;
  74936. private _reflectionSamples;
  74937. private _smoothSteps;
  74938. /**
  74939. * Gets a string identifying the name of the class
  74940. * @returns "ScreenSpaceReflectionPostProcess" string
  74941. */
  74942. getClassName(): string;
  74943. /**
  74944. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74945. * @param name The name of the effect.
  74946. * @param scene The scene containing the objects to calculate reflections.
  74947. * @param options The required width/height ratio to downsize to before computing the render pass.
  74948. * @param camera The camera to apply the render pass to.
  74949. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74950. * @param engine The engine which the post process will be applied. (default: current engine)
  74951. * @param reusable If the post process can be reused on the same frame. (default: false)
  74952. * @param textureType Type of textures used when performing the post process. (default: 0)
  74953. * @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)
  74954. */
  74955. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74956. /**
  74957. * Gets wether or not smoothing reflections is enabled.
  74958. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74959. */
  74960. get enableSmoothReflections(): boolean;
  74961. /**
  74962. * Sets wether or not smoothing reflections is enabled.
  74963. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74964. */
  74965. set enableSmoothReflections(enabled: boolean);
  74966. /**
  74967. * Gets the number of samples taken while computing reflections. More samples count is high,
  74968. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74969. */
  74970. get reflectionSamples(): number;
  74971. /**
  74972. * Sets the number of samples taken while computing reflections. More samples count is high,
  74973. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74974. */
  74975. set reflectionSamples(samples: number);
  74976. /**
  74977. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74978. * more the post-process will require GPU power and can generate a drop in FPS.
  74979. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74980. */
  74981. get smoothSteps(): number;
  74982. set smoothSteps(steps: number);
  74983. private _updateEffectDefines;
  74984. /** @hidden */
  74985. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74986. }
  74987. }
  74988. declare module "babylonjs/Shaders/standard.fragment" {
  74989. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74990. /** @hidden */
  74991. export var standardPixelShader: {
  74992. name: string;
  74993. shader: string;
  74994. };
  74995. }
  74996. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74997. import { Nullable } from "babylonjs/types";
  74998. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74999. import { Camera } from "babylonjs/Cameras/camera";
  75000. import { Texture } from "babylonjs/Materials/Textures/texture";
  75001. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75002. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75003. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  75004. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  75005. import { IDisposable } from "babylonjs/scene";
  75006. import { SpotLight } from "babylonjs/Lights/spotLight";
  75007. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  75008. import { Scene } from "babylonjs/scene";
  75009. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75010. import { Animation } from "babylonjs/Animations/animation";
  75011. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75012. import "babylonjs/Shaders/standard.fragment";
  75013. /**
  75014. * Standard rendering pipeline
  75015. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75016. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  75017. */
  75018. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  75019. /**
  75020. * Public members
  75021. */
  75022. /**
  75023. * Post-process which contains the original scene color before the pipeline applies all the effects
  75024. */
  75025. originalPostProcess: Nullable<PostProcess>;
  75026. /**
  75027. * Post-process used to down scale an image x4
  75028. */
  75029. downSampleX4PostProcess: Nullable<PostProcess>;
  75030. /**
  75031. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  75032. */
  75033. brightPassPostProcess: Nullable<PostProcess>;
  75034. /**
  75035. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  75036. */
  75037. blurHPostProcesses: PostProcess[];
  75038. /**
  75039. * Post-process array storing all the vertical blur post-processes used by the pipeline
  75040. */
  75041. blurVPostProcesses: PostProcess[];
  75042. /**
  75043. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  75044. */
  75045. textureAdderPostProcess: Nullable<PostProcess>;
  75046. /**
  75047. * Post-process used to create volumetric lighting effect
  75048. */
  75049. volumetricLightPostProcess: Nullable<PostProcess>;
  75050. /**
  75051. * Post-process used to smooth the previous volumetric light post-process on the X axis
  75052. */
  75053. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  75054. /**
  75055. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  75056. */
  75057. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  75058. /**
  75059. * Post-process used to merge the volumetric light effect and the real scene color
  75060. */
  75061. volumetricLightMergePostProces: Nullable<PostProcess>;
  75062. /**
  75063. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  75064. */
  75065. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  75066. /**
  75067. * Base post-process used to calculate the average luminance of the final image for HDR
  75068. */
  75069. luminancePostProcess: Nullable<PostProcess>;
  75070. /**
  75071. * Post-processes used to create down sample post-processes in order to get
  75072. * the average luminance of the final image for HDR
  75073. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  75074. */
  75075. luminanceDownSamplePostProcesses: PostProcess[];
  75076. /**
  75077. * Post-process used to create a HDR effect (light adaptation)
  75078. */
  75079. hdrPostProcess: Nullable<PostProcess>;
  75080. /**
  75081. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75082. */
  75083. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75084. /**
  75085. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75086. */
  75087. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75088. /**
  75089. * Post-process used to merge the final HDR post-process and the real scene color
  75090. */
  75091. hdrFinalPostProcess: Nullable<PostProcess>;
  75092. /**
  75093. * Post-process used to create a lens flare effect
  75094. */
  75095. lensFlarePostProcess: Nullable<PostProcess>;
  75096. /**
  75097. * Post-process that merges the result of the lens flare post-process and the real scene color
  75098. */
  75099. lensFlareComposePostProcess: Nullable<PostProcess>;
  75100. /**
  75101. * Post-process used to create a motion blur effect
  75102. */
  75103. motionBlurPostProcess: Nullable<PostProcess>;
  75104. /**
  75105. * Post-process used to create a depth of field effect
  75106. */
  75107. depthOfFieldPostProcess: Nullable<PostProcess>;
  75108. /**
  75109. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75110. */
  75111. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75112. /**
  75113. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75114. */
  75115. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75116. /**
  75117. * Represents the brightness threshold in order to configure the illuminated surfaces
  75118. */
  75119. brightThreshold: number;
  75120. /**
  75121. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75122. */
  75123. blurWidth: number;
  75124. /**
  75125. * Sets if the blur for highlighted surfaces must be only horizontal
  75126. */
  75127. horizontalBlur: boolean;
  75128. /**
  75129. * Gets the overall exposure used by the pipeline
  75130. */
  75131. get exposure(): number;
  75132. /**
  75133. * Sets the overall exposure used by the pipeline
  75134. */
  75135. set exposure(value: number);
  75136. /**
  75137. * Texture used typically to simulate "dirty" on camera lens
  75138. */
  75139. lensTexture: Nullable<Texture>;
  75140. /**
  75141. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75142. */
  75143. volumetricLightCoefficient: number;
  75144. /**
  75145. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75146. */
  75147. volumetricLightPower: number;
  75148. /**
  75149. * Used the set the blur intensity to smooth the volumetric lights
  75150. */
  75151. volumetricLightBlurScale: number;
  75152. /**
  75153. * Light (spot or directional) used to generate the volumetric lights rays
  75154. * The source light must have a shadow generate so the pipeline can get its
  75155. * depth map
  75156. */
  75157. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75158. /**
  75159. * For eye adaptation, represents the minimum luminance the eye can see
  75160. */
  75161. hdrMinimumLuminance: number;
  75162. /**
  75163. * For eye adaptation, represents the decrease luminance speed
  75164. */
  75165. hdrDecreaseRate: number;
  75166. /**
  75167. * For eye adaptation, represents the increase luminance speed
  75168. */
  75169. hdrIncreaseRate: number;
  75170. /**
  75171. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75172. */
  75173. get hdrAutoExposure(): boolean;
  75174. /**
  75175. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75176. */
  75177. set hdrAutoExposure(value: boolean);
  75178. /**
  75179. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75180. */
  75181. lensColorTexture: Nullable<Texture>;
  75182. /**
  75183. * The overall strengh for the lens flare effect
  75184. */
  75185. lensFlareStrength: number;
  75186. /**
  75187. * Dispersion coefficient for lens flare ghosts
  75188. */
  75189. lensFlareGhostDispersal: number;
  75190. /**
  75191. * Main lens flare halo width
  75192. */
  75193. lensFlareHaloWidth: number;
  75194. /**
  75195. * Based on the lens distortion effect, defines how much the lens flare result
  75196. * is distorted
  75197. */
  75198. lensFlareDistortionStrength: number;
  75199. /**
  75200. * Configures the blur intensity used for for lens flare (halo)
  75201. */
  75202. lensFlareBlurWidth: number;
  75203. /**
  75204. * Lens star texture must be used to simulate rays on the flares and is available
  75205. * in the documentation
  75206. */
  75207. lensStarTexture: Nullable<Texture>;
  75208. /**
  75209. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75210. * flare effect by taking account of the dirt texture
  75211. */
  75212. lensFlareDirtTexture: Nullable<Texture>;
  75213. /**
  75214. * Represents the focal length for the depth of field effect
  75215. */
  75216. depthOfFieldDistance: number;
  75217. /**
  75218. * Represents the blur intensity for the blurred part of the depth of field effect
  75219. */
  75220. depthOfFieldBlurWidth: number;
  75221. /**
  75222. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75223. */
  75224. get motionStrength(): number;
  75225. /**
  75226. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75227. */
  75228. set motionStrength(strength: number);
  75229. /**
  75230. * Gets wether or not the motion blur post-process is object based or screen based.
  75231. */
  75232. get objectBasedMotionBlur(): boolean;
  75233. /**
  75234. * Sets wether or not the motion blur post-process should be object based or screen based
  75235. */
  75236. set objectBasedMotionBlur(value: boolean);
  75237. /**
  75238. * List of animations for the pipeline (IAnimatable implementation)
  75239. */
  75240. animations: Animation[];
  75241. /**
  75242. * Private members
  75243. */
  75244. private _scene;
  75245. private _currentDepthOfFieldSource;
  75246. private _basePostProcess;
  75247. private _fixedExposure;
  75248. private _currentExposure;
  75249. private _hdrAutoExposure;
  75250. private _hdrCurrentLuminance;
  75251. private _motionStrength;
  75252. private _isObjectBasedMotionBlur;
  75253. private _floatTextureType;
  75254. private _camerasToBeAttached;
  75255. private _ratio;
  75256. private _bloomEnabled;
  75257. private _depthOfFieldEnabled;
  75258. private _vlsEnabled;
  75259. private _lensFlareEnabled;
  75260. private _hdrEnabled;
  75261. private _motionBlurEnabled;
  75262. private _fxaaEnabled;
  75263. private _screenSpaceReflectionsEnabled;
  75264. private _motionBlurSamples;
  75265. private _volumetricLightStepsCount;
  75266. private _samples;
  75267. /**
  75268. * @ignore
  75269. * Specifies if the bloom pipeline is enabled
  75270. */
  75271. get BloomEnabled(): boolean;
  75272. set BloomEnabled(enabled: boolean);
  75273. /**
  75274. * @ignore
  75275. * Specifies if the depth of field pipeline is enabed
  75276. */
  75277. get DepthOfFieldEnabled(): boolean;
  75278. set DepthOfFieldEnabled(enabled: boolean);
  75279. /**
  75280. * @ignore
  75281. * Specifies if the lens flare pipeline is enabed
  75282. */
  75283. get LensFlareEnabled(): boolean;
  75284. set LensFlareEnabled(enabled: boolean);
  75285. /**
  75286. * @ignore
  75287. * Specifies if the HDR pipeline is enabled
  75288. */
  75289. get HDREnabled(): boolean;
  75290. set HDREnabled(enabled: boolean);
  75291. /**
  75292. * @ignore
  75293. * Specifies if the volumetric lights scattering effect is enabled
  75294. */
  75295. get VLSEnabled(): boolean;
  75296. set VLSEnabled(enabled: boolean);
  75297. /**
  75298. * @ignore
  75299. * Specifies if the motion blur effect is enabled
  75300. */
  75301. get MotionBlurEnabled(): boolean;
  75302. set MotionBlurEnabled(enabled: boolean);
  75303. /**
  75304. * Specifies if anti-aliasing is enabled
  75305. */
  75306. get fxaaEnabled(): boolean;
  75307. set fxaaEnabled(enabled: boolean);
  75308. /**
  75309. * Specifies if screen space reflections are enabled.
  75310. */
  75311. get screenSpaceReflectionsEnabled(): boolean;
  75312. set screenSpaceReflectionsEnabled(enabled: boolean);
  75313. /**
  75314. * Specifies the number of steps used to calculate the volumetric lights
  75315. * Typically in interval [50, 200]
  75316. */
  75317. get volumetricLightStepsCount(): number;
  75318. set volumetricLightStepsCount(count: number);
  75319. /**
  75320. * Specifies the number of samples used for the motion blur effect
  75321. * Typically in interval [16, 64]
  75322. */
  75323. get motionBlurSamples(): number;
  75324. set motionBlurSamples(samples: number);
  75325. /**
  75326. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75327. */
  75328. get samples(): number;
  75329. set samples(sampleCount: number);
  75330. /**
  75331. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75332. * @constructor
  75333. * @param name The rendering pipeline name
  75334. * @param scene The scene linked to this pipeline
  75335. * @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)
  75336. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75337. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75338. */
  75339. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75340. private _buildPipeline;
  75341. private _createDownSampleX4PostProcess;
  75342. private _createBrightPassPostProcess;
  75343. private _createBlurPostProcesses;
  75344. private _createTextureAdderPostProcess;
  75345. private _createVolumetricLightPostProcess;
  75346. private _createLuminancePostProcesses;
  75347. private _createHdrPostProcess;
  75348. private _createLensFlarePostProcess;
  75349. private _createDepthOfFieldPostProcess;
  75350. private _createMotionBlurPostProcess;
  75351. private _getDepthTexture;
  75352. private _disposePostProcesses;
  75353. /**
  75354. * Dispose of the pipeline and stop all post processes
  75355. */
  75356. dispose(): void;
  75357. /**
  75358. * Serialize the rendering pipeline (Used when exporting)
  75359. * @returns the serialized object
  75360. */
  75361. serialize(): any;
  75362. /**
  75363. * Parse the serialized pipeline
  75364. * @param source Source pipeline.
  75365. * @param scene The scene to load the pipeline to.
  75366. * @param rootUrl The URL of the serialized pipeline.
  75367. * @returns An instantiated pipeline from the serialized object.
  75368. */
  75369. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75370. /**
  75371. * Luminance steps
  75372. */
  75373. static LuminanceSteps: number;
  75374. }
  75375. }
  75376. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75377. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75378. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75379. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75380. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75381. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75382. }
  75383. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75384. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75385. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75386. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75387. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75388. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75389. }
  75390. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75391. /** @hidden */
  75392. export var stereoscopicInterlacePixelShader: {
  75393. name: string;
  75394. shader: string;
  75395. };
  75396. }
  75397. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75398. import { Camera } from "babylonjs/Cameras/camera";
  75399. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75400. import { Engine } from "babylonjs/Engines/engine";
  75401. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75402. /**
  75403. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75404. */
  75405. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75406. private _stepSize;
  75407. private _passedProcess;
  75408. /**
  75409. * Gets a string identifying the name of the class
  75410. * @returns "StereoscopicInterlacePostProcessI" string
  75411. */
  75412. getClassName(): string;
  75413. /**
  75414. * Initializes a StereoscopicInterlacePostProcessI
  75415. * @param name The name of the effect.
  75416. * @param rigCameras The rig cameras to be appled to the post process
  75417. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75418. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75419. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75420. * @param engine The engine which the post process will be applied. (default: current engine)
  75421. * @param reusable If the post process can be reused on the same frame. (default: false)
  75422. */
  75423. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75424. }
  75425. /**
  75426. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75427. */
  75428. export class StereoscopicInterlacePostProcess extends PostProcess {
  75429. private _stepSize;
  75430. private _passedProcess;
  75431. /**
  75432. * Gets a string identifying the name of the class
  75433. * @returns "StereoscopicInterlacePostProcess" string
  75434. */
  75435. getClassName(): string;
  75436. /**
  75437. * Initializes a StereoscopicInterlacePostProcess
  75438. * @param name The name of the effect.
  75439. * @param rigCameras The rig cameras to be appled to the post process
  75440. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75441. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75442. * @param engine The engine which the post process will be applied. (default: current engine)
  75443. * @param reusable If the post process can be reused on the same frame. (default: false)
  75444. */
  75445. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75446. }
  75447. }
  75448. declare module "babylonjs/Shaders/tonemap.fragment" {
  75449. /** @hidden */
  75450. export var tonemapPixelShader: {
  75451. name: string;
  75452. shader: string;
  75453. };
  75454. }
  75455. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75456. import { Camera } from "babylonjs/Cameras/camera";
  75457. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75458. import "babylonjs/Shaders/tonemap.fragment";
  75459. import { Engine } from "babylonjs/Engines/engine";
  75460. /** Defines operator used for tonemapping */
  75461. export enum TonemappingOperator {
  75462. /** Hable */
  75463. Hable = 0,
  75464. /** Reinhard */
  75465. Reinhard = 1,
  75466. /** HejiDawson */
  75467. HejiDawson = 2,
  75468. /** Photographic */
  75469. Photographic = 3
  75470. }
  75471. /**
  75472. * Defines a post process to apply tone mapping
  75473. */
  75474. export class TonemapPostProcess extends PostProcess {
  75475. private _operator;
  75476. /** Defines the required exposure adjustement */
  75477. exposureAdjustment: number;
  75478. /**
  75479. * Gets a string identifying the name of the class
  75480. * @returns "TonemapPostProcess" string
  75481. */
  75482. getClassName(): string;
  75483. /**
  75484. * Creates a new TonemapPostProcess
  75485. * @param name defines the name of the postprocess
  75486. * @param _operator defines the operator to use
  75487. * @param exposureAdjustment defines the required exposure adjustement
  75488. * @param camera defines the camera to use (can be null)
  75489. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75490. * @param engine defines the hosting engine (can be ignore if camera is set)
  75491. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75492. */
  75493. constructor(name: string, _operator: TonemappingOperator,
  75494. /** Defines the required exposure adjustement */
  75495. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75496. }
  75497. }
  75498. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75499. /** @hidden */
  75500. export var volumetricLightScatteringPixelShader: {
  75501. name: string;
  75502. shader: string;
  75503. };
  75504. }
  75505. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75506. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75507. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75508. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75509. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75510. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75511. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75512. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75513. /** @hidden */
  75514. export var volumetricLightScatteringPassVertexShader: {
  75515. name: string;
  75516. shader: string;
  75517. };
  75518. }
  75519. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75520. /** @hidden */
  75521. export var volumetricLightScatteringPassPixelShader: {
  75522. name: string;
  75523. shader: string;
  75524. };
  75525. }
  75526. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75527. import { Vector3 } from "babylonjs/Maths/math.vector";
  75528. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75529. import { Mesh } from "babylonjs/Meshes/mesh";
  75530. import { Camera } from "babylonjs/Cameras/camera";
  75531. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75532. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75533. import { Scene } from "babylonjs/scene";
  75534. import "babylonjs/Meshes/Builders/planeBuilder";
  75535. import "babylonjs/Shaders/depth.vertex";
  75536. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75537. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75538. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75539. import { Engine } from "babylonjs/Engines/engine";
  75540. /**
  75541. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75542. */
  75543. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75544. private _volumetricLightScatteringPass;
  75545. private _volumetricLightScatteringRTT;
  75546. private _viewPort;
  75547. private _screenCoordinates;
  75548. private _cachedDefines;
  75549. /**
  75550. * If not undefined, the mesh position is computed from the attached node position
  75551. */
  75552. attachedNode: {
  75553. position: Vector3;
  75554. };
  75555. /**
  75556. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75557. */
  75558. customMeshPosition: Vector3;
  75559. /**
  75560. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75561. */
  75562. useCustomMeshPosition: boolean;
  75563. /**
  75564. * If the post-process should inverse the light scattering direction
  75565. */
  75566. invert: boolean;
  75567. /**
  75568. * The internal mesh used by the post-process
  75569. */
  75570. mesh: Mesh;
  75571. /**
  75572. * @hidden
  75573. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75574. */
  75575. get useDiffuseColor(): boolean;
  75576. set useDiffuseColor(useDiffuseColor: boolean);
  75577. /**
  75578. * Array containing the excluded meshes not rendered in the internal pass
  75579. */
  75580. excludedMeshes: AbstractMesh[];
  75581. /**
  75582. * Controls the overall intensity of the post-process
  75583. */
  75584. exposure: number;
  75585. /**
  75586. * Dissipates each sample's contribution in range [0, 1]
  75587. */
  75588. decay: number;
  75589. /**
  75590. * Controls the overall intensity of each sample
  75591. */
  75592. weight: number;
  75593. /**
  75594. * Controls the density of each sample
  75595. */
  75596. density: number;
  75597. /**
  75598. * @constructor
  75599. * @param name The post-process name
  75600. * @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)
  75601. * @param camera The camera that the post-process will be attached to
  75602. * @param mesh The mesh used to create the light scattering
  75603. * @param samples The post-process quality, default 100
  75604. * @param samplingModeThe post-process filtering mode
  75605. * @param engine The babylon engine
  75606. * @param reusable If the post-process is reusable
  75607. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75608. */
  75609. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75610. /**
  75611. * Returns the string "VolumetricLightScatteringPostProcess"
  75612. * @returns "VolumetricLightScatteringPostProcess"
  75613. */
  75614. getClassName(): string;
  75615. private _isReady;
  75616. /**
  75617. * Sets the new light position for light scattering effect
  75618. * @param position The new custom light position
  75619. */
  75620. setCustomMeshPosition(position: Vector3): void;
  75621. /**
  75622. * Returns the light position for light scattering effect
  75623. * @return Vector3 The custom light position
  75624. */
  75625. getCustomMeshPosition(): Vector3;
  75626. /**
  75627. * Disposes the internal assets and detaches the post-process from the camera
  75628. */
  75629. dispose(camera: Camera): void;
  75630. /**
  75631. * Returns the render target texture used by the post-process
  75632. * @return the render target texture used by the post-process
  75633. */
  75634. getPass(): RenderTargetTexture;
  75635. private _meshExcluded;
  75636. private _createPass;
  75637. private _updateMeshScreenCoordinates;
  75638. /**
  75639. * Creates a default mesh for the Volumeric Light Scattering post-process
  75640. * @param name The mesh name
  75641. * @param scene The scene where to create the mesh
  75642. * @return the default mesh
  75643. */
  75644. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75645. }
  75646. }
  75647. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75648. /** @hidden */
  75649. export var screenSpaceCurvaturePixelShader: {
  75650. name: string;
  75651. shader: string;
  75652. };
  75653. }
  75654. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75655. import { Nullable } from "babylonjs/types";
  75656. import { Camera } from "babylonjs/Cameras/camera";
  75657. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75658. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75659. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75660. import { Engine } from "babylonjs/Engines/engine";
  75661. import { Scene } from "babylonjs/scene";
  75662. /**
  75663. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75664. */
  75665. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75666. /**
  75667. * Defines how much ridge the curvature effect displays.
  75668. */
  75669. ridge: number;
  75670. /**
  75671. * Defines how much valley the curvature effect displays.
  75672. */
  75673. valley: number;
  75674. private _geometryBufferRenderer;
  75675. /**
  75676. * Gets a string identifying the name of the class
  75677. * @returns "ScreenSpaceCurvaturePostProcess" string
  75678. */
  75679. getClassName(): string;
  75680. /**
  75681. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75682. * @param name The name of the effect.
  75683. * @param scene The scene containing the objects to blur according to their velocity.
  75684. * @param options The required width/height ratio to downsize to before computing the render pass.
  75685. * @param camera The camera to apply the render pass to.
  75686. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75687. * @param engine The engine which the post process will be applied. (default: current engine)
  75688. * @param reusable If the post process can be reused on the same frame. (default: false)
  75689. * @param textureType Type of textures used when performing the post process. (default: 0)
  75690. * @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)
  75691. */
  75692. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75693. /**
  75694. * Support test.
  75695. */
  75696. static get IsSupported(): boolean;
  75697. /** @hidden */
  75698. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75699. }
  75700. }
  75701. declare module "babylonjs/PostProcesses/index" {
  75702. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75703. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75704. export * from "babylonjs/PostProcesses/bloomEffect";
  75705. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75706. export * from "babylonjs/PostProcesses/blurPostProcess";
  75707. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75708. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75709. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75710. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75711. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75712. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75713. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75714. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75715. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75716. export * from "babylonjs/PostProcesses/filterPostProcess";
  75717. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75718. export * from "babylonjs/PostProcesses/grainPostProcess";
  75719. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75720. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75721. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75722. export * from "babylonjs/PostProcesses/passPostProcess";
  75723. export * from "babylonjs/PostProcesses/postProcess";
  75724. export * from "babylonjs/PostProcesses/postProcessManager";
  75725. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75726. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75727. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75728. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75729. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75730. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75731. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75732. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75733. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75734. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75735. }
  75736. declare module "babylonjs/Probes/index" {
  75737. export * from "babylonjs/Probes/reflectionProbe";
  75738. }
  75739. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75740. import { Scene } from "babylonjs/scene";
  75741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75742. import { SmartArray } from "babylonjs/Misc/smartArray";
  75743. import { ISceneComponent } from "babylonjs/sceneComponent";
  75744. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75745. import "babylonjs/Meshes/Builders/boxBuilder";
  75746. import "babylonjs/Shaders/color.fragment";
  75747. import "babylonjs/Shaders/color.vertex";
  75748. import { Color3 } from "babylonjs/Maths/math.color";
  75749. import { Observable } from "babylonjs/Misc/observable";
  75750. module "babylonjs/scene" {
  75751. interface Scene {
  75752. /** @hidden (Backing field) */
  75753. _boundingBoxRenderer: BoundingBoxRenderer;
  75754. /** @hidden (Backing field) */
  75755. _forceShowBoundingBoxes: boolean;
  75756. /**
  75757. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75758. */
  75759. forceShowBoundingBoxes: boolean;
  75760. /**
  75761. * Gets the bounding box renderer associated with the scene
  75762. * @returns a BoundingBoxRenderer
  75763. */
  75764. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75765. }
  75766. }
  75767. module "babylonjs/Meshes/abstractMesh" {
  75768. interface AbstractMesh {
  75769. /** @hidden (Backing field) */
  75770. _showBoundingBox: boolean;
  75771. /**
  75772. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75773. */
  75774. showBoundingBox: boolean;
  75775. }
  75776. }
  75777. /**
  75778. * Component responsible of rendering the bounding box of the meshes in a scene.
  75779. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75780. */
  75781. export class BoundingBoxRenderer implements ISceneComponent {
  75782. /**
  75783. * The component name helpfull to identify the component in the list of scene components.
  75784. */
  75785. readonly name: string;
  75786. /**
  75787. * The scene the component belongs to.
  75788. */
  75789. scene: Scene;
  75790. /**
  75791. * Color of the bounding box lines placed in front of an object
  75792. */
  75793. frontColor: Color3;
  75794. /**
  75795. * Color of the bounding box lines placed behind an object
  75796. */
  75797. backColor: Color3;
  75798. /**
  75799. * Defines if the renderer should show the back lines or not
  75800. */
  75801. showBackLines: boolean;
  75802. /**
  75803. * Observable raised before rendering a bounding box
  75804. */
  75805. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75806. /**
  75807. * Observable raised after rendering a bounding box
  75808. */
  75809. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75810. /**
  75811. * @hidden
  75812. */
  75813. renderList: SmartArray<BoundingBox>;
  75814. private _colorShader;
  75815. private _vertexBuffers;
  75816. private _indexBuffer;
  75817. private _fillIndexBuffer;
  75818. private _fillIndexData;
  75819. /**
  75820. * Instantiates a new bounding box renderer in a scene.
  75821. * @param scene the scene the renderer renders in
  75822. */
  75823. constructor(scene: Scene);
  75824. /**
  75825. * Registers the component in a given scene
  75826. */
  75827. register(): void;
  75828. private _evaluateSubMesh;
  75829. private _activeMesh;
  75830. private _prepareRessources;
  75831. private _createIndexBuffer;
  75832. /**
  75833. * Rebuilds the elements related to this component in case of
  75834. * context lost for instance.
  75835. */
  75836. rebuild(): void;
  75837. /**
  75838. * @hidden
  75839. */
  75840. reset(): void;
  75841. /**
  75842. * Render the bounding boxes of a specific rendering group
  75843. * @param renderingGroupId defines the rendering group to render
  75844. */
  75845. render(renderingGroupId: number): void;
  75846. /**
  75847. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75848. * @param mesh Define the mesh to render the occlusion bounding box for
  75849. */
  75850. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75851. /**
  75852. * Dispose and release the resources attached to this renderer.
  75853. */
  75854. dispose(): void;
  75855. }
  75856. }
  75857. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75858. import { Nullable } from "babylonjs/types";
  75859. import { Scene } from "babylonjs/scene";
  75860. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75861. import { Camera } from "babylonjs/Cameras/camera";
  75862. import { ISceneComponent } from "babylonjs/sceneComponent";
  75863. module "babylonjs/scene" {
  75864. interface Scene {
  75865. /** @hidden (Backing field) */
  75866. _depthRenderer: {
  75867. [id: string]: DepthRenderer;
  75868. };
  75869. /**
  75870. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75871. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75872. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75873. * @returns the created depth renderer
  75874. */
  75875. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75876. /**
  75877. * Disables a depth renderer for a given camera
  75878. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75879. */
  75880. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75881. }
  75882. }
  75883. /**
  75884. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75885. * in several rendering techniques.
  75886. */
  75887. export class DepthRendererSceneComponent implements ISceneComponent {
  75888. /**
  75889. * The component name helpfull to identify the component in the list of scene components.
  75890. */
  75891. readonly name: string;
  75892. /**
  75893. * The scene the component belongs to.
  75894. */
  75895. scene: Scene;
  75896. /**
  75897. * Creates a new instance of the component for the given scene
  75898. * @param scene Defines the scene to register the component in
  75899. */
  75900. constructor(scene: Scene);
  75901. /**
  75902. * Registers the component in a given scene
  75903. */
  75904. register(): void;
  75905. /**
  75906. * Rebuilds the elements related to this component in case of
  75907. * context lost for instance.
  75908. */
  75909. rebuild(): void;
  75910. /**
  75911. * Disposes the component and the associated ressources
  75912. */
  75913. dispose(): void;
  75914. private _gatherRenderTargets;
  75915. private _gatherActiveCameraRenderTargets;
  75916. }
  75917. }
  75918. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75919. import { Nullable } from "babylonjs/types";
  75920. import { Scene } from "babylonjs/scene";
  75921. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75922. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75923. import { AbstractScene } from "babylonjs/abstractScene";
  75924. module "babylonjs/abstractScene" {
  75925. interface AbstractScene {
  75926. /** @hidden (Backing field) */
  75927. _prePassRenderer: Nullable<PrePassRenderer>;
  75928. /**
  75929. * Gets or Sets the current prepass renderer associated to the scene.
  75930. */
  75931. prePassRenderer: Nullable<PrePassRenderer>;
  75932. /**
  75933. * Enables the prepass and associates it with the scene
  75934. * @returns the PrePassRenderer
  75935. */
  75936. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75937. /**
  75938. * Disables the prepass associated with the scene
  75939. */
  75940. disablePrePassRenderer(): void;
  75941. }
  75942. }
  75943. /**
  75944. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75945. * in several rendering techniques.
  75946. */
  75947. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75948. /**
  75949. * The component name helpful to identify the component in the list of scene components.
  75950. */
  75951. readonly name: string;
  75952. /**
  75953. * The scene the component belongs to.
  75954. */
  75955. scene: Scene;
  75956. /**
  75957. * Creates a new instance of the component for the given scene
  75958. * @param scene Defines the scene to register the component in
  75959. */
  75960. constructor(scene: Scene);
  75961. /**
  75962. * Registers the component in a given scene
  75963. */
  75964. register(): void;
  75965. private _beforeCameraDraw;
  75966. private _afterCameraDraw;
  75967. private _beforeClearStage;
  75968. /**
  75969. * Serializes the component data to the specified json object
  75970. * @param serializationObject The object to serialize to
  75971. */
  75972. serialize(serializationObject: any): void;
  75973. /**
  75974. * Adds all the elements from the container to the scene
  75975. * @param container the container holding the elements
  75976. */
  75977. addFromContainer(container: AbstractScene): void;
  75978. /**
  75979. * Removes all the elements in the container from the scene
  75980. * @param container contains the elements to remove
  75981. * @param dispose if the removed element should be disposed (default: false)
  75982. */
  75983. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75984. /**
  75985. * Rebuilds the elements related to this component in case of
  75986. * context lost for instance.
  75987. */
  75988. rebuild(): void;
  75989. /**
  75990. * Disposes the component and the associated ressources
  75991. */
  75992. dispose(): void;
  75993. }
  75994. }
  75995. declare module "babylonjs/Shaders/outline.fragment" {
  75996. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75997. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75998. /** @hidden */
  75999. export var outlinePixelShader: {
  76000. name: string;
  76001. shader: string;
  76002. };
  76003. }
  76004. declare module "babylonjs/Shaders/outline.vertex" {
  76005. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76006. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76007. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76008. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76009. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76010. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76011. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76012. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76013. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  76014. /** @hidden */
  76015. export var outlineVertexShader: {
  76016. name: string;
  76017. shader: string;
  76018. };
  76019. }
  76020. declare module "babylonjs/Rendering/outlineRenderer" {
  76021. import { SubMesh } from "babylonjs/Meshes/subMesh";
  76022. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  76023. import { Scene } from "babylonjs/scene";
  76024. import { ISceneComponent } from "babylonjs/sceneComponent";
  76025. import "babylonjs/Shaders/outline.fragment";
  76026. import "babylonjs/Shaders/outline.vertex";
  76027. module "babylonjs/scene" {
  76028. interface Scene {
  76029. /** @hidden */
  76030. _outlineRenderer: OutlineRenderer;
  76031. /**
  76032. * Gets the outline renderer associated with the scene
  76033. * @returns a OutlineRenderer
  76034. */
  76035. getOutlineRenderer(): OutlineRenderer;
  76036. }
  76037. }
  76038. module "babylonjs/Meshes/abstractMesh" {
  76039. interface AbstractMesh {
  76040. /** @hidden (Backing field) */
  76041. _renderOutline: boolean;
  76042. /**
  76043. * Gets or sets a boolean indicating if the outline must be rendered as well
  76044. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  76045. */
  76046. renderOutline: boolean;
  76047. /** @hidden (Backing field) */
  76048. _renderOverlay: boolean;
  76049. /**
  76050. * Gets or sets a boolean indicating if the overlay must be rendered as well
  76051. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  76052. */
  76053. renderOverlay: boolean;
  76054. }
  76055. }
  76056. /**
  76057. * This class is responsible to draw bothe outline/overlay of meshes.
  76058. * It should not be used directly but through the available method on mesh.
  76059. */
  76060. export class OutlineRenderer implements ISceneComponent {
  76061. /**
  76062. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  76063. */
  76064. private static _StencilReference;
  76065. /**
  76066. * The name of the component. Each component must have a unique name.
  76067. */
  76068. name: string;
  76069. /**
  76070. * The scene the component belongs to.
  76071. */
  76072. scene: Scene;
  76073. /**
  76074. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  76075. */
  76076. zOffset: number;
  76077. private _engine;
  76078. private _effect;
  76079. private _cachedDefines;
  76080. private _savedDepthWrite;
  76081. /**
  76082. * Instantiates a new outline renderer. (There could be only one per scene).
  76083. * @param scene Defines the scene it belongs to
  76084. */
  76085. constructor(scene: Scene);
  76086. /**
  76087. * Register the component to one instance of a scene.
  76088. */
  76089. register(): void;
  76090. /**
  76091. * Rebuilds the elements related to this component in case of
  76092. * context lost for instance.
  76093. */
  76094. rebuild(): void;
  76095. /**
  76096. * Disposes the component and the associated ressources.
  76097. */
  76098. dispose(): void;
  76099. /**
  76100. * Renders the outline in the canvas.
  76101. * @param subMesh Defines the sumesh to render
  76102. * @param batch Defines the batch of meshes in case of instances
  76103. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76104. */
  76105. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76106. /**
  76107. * Returns whether or not the outline renderer is ready for a given submesh.
  76108. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76109. * @param subMesh Defines the submesh to check readyness for
  76110. * @param useInstances Defines wheter wee are trying to render instances or not
  76111. * @returns true if ready otherwise false
  76112. */
  76113. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76114. private _beforeRenderingMesh;
  76115. private _afterRenderingMesh;
  76116. }
  76117. }
  76118. declare module "babylonjs/Rendering/index" {
  76119. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76120. export * from "babylonjs/Rendering/depthRenderer";
  76121. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76122. export * from "babylonjs/Rendering/edgesRenderer";
  76123. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76124. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76125. export * from "babylonjs/Rendering/prePassRenderer";
  76126. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76127. export * from "babylonjs/Rendering/outlineRenderer";
  76128. export * from "babylonjs/Rendering/renderingGroup";
  76129. export * from "babylonjs/Rendering/renderingManager";
  76130. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76131. }
  76132. declare module "babylonjs/Sprites/ISprites" {
  76133. /**
  76134. * Defines the basic options interface of a Sprite Frame Source Size.
  76135. */
  76136. export interface ISpriteJSONSpriteSourceSize {
  76137. /**
  76138. * number of the original width of the Frame
  76139. */
  76140. w: number;
  76141. /**
  76142. * number of the original height of the Frame
  76143. */
  76144. h: number;
  76145. }
  76146. /**
  76147. * Defines the basic options interface of a Sprite Frame Data.
  76148. */
  76149. export interface ISpriteJSONSpriteFrameData {
  76150. /**
  76151. * number of the x offset of the Frame
  76152. */
  76153. x: number;
  76154. /**
  76155. * number of the y offset of the Frame
  76156. */
  76157. y: number;
  76158. /**
  76159. * number of the width of the Frame
  76160. */
  76161. w: number;
  76162. /**
  76163. * number of the height of the Frame
  76164. */
  76165. h: number;
  76166. }
  76167. /**
  76168. * Defines the basic options interface of a JSON Sprite.
  76169. */
  76170. export interface ISpriteJSONSprite {
  76171. /**
  76172. * string name of the Frame
  76173. */
  76174. filename: string;
  76175. /**
  76176. * ISpriteJSONSpriteFrame basic object of the frame data
  76177. */
  76178. frame: ISpriteJSONSpriteFrameData;
  76179. /**
  76180. * boolean to flag is the frame was rotated.
  76181. */
  76182. rotated: boolean;
  76183. /**
  76184. * boolean to flag is the frame was trimmed.
  76185. */
  76186. trimmed: boolean;
  76187. /**
  76188. * ISpriteJSONSpriteFrame basic object of the source data
  76189. */
  76190. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76191. /**
  76192. * ISpriteJSONSpriteFrame basic object of the source data
  76193. */
  76194. sourceSize: ISpriteJSONSpriteSourceSize;
  76195. }
  76196. /**
  76197. * Defines the basic options interface of a JSON atlas.
  76198. */
  76199. export interface ISpriteJSONAtlas {
  76200. /**
  76201. * Array of objects that contain the frame data.
  76202. */
  76203. frames: Array<ISpriteJSONSprite>;
  76204. /**
  76205. * object basic object containing the sprite meta data.
  76206. */
  76207. meta?: object;
  76208. }
  76209. }
  76210. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76211. /** @hidden */
  76212. export var spriteMapPixelShader: {
  76213. name: string;
  76214. shader: string;
  76215. };
  76216. }
  76217. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76218. /** @hidden */
  76219. export var spriteMapVertexShader: {
  76220. name: string;
  76221. shader: string;
  76222. };
  76223. }
  76224. declare module "babylonjs/Sprites/spriteMap" {
  76225. import { IDisposable, Scene } from "babylonjs/scene";
  76226. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76227. import { Texture } from "babylonjs/Materials/Textures/texture";
  76228. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76229. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76230. import "babylonjs/Meshes/Builders/planeBuilder";
  76231. import "babylonjs/Shaders/spriteMap.fragment";
  76232. import "babylonjs/Shaders/spriteMap.vertex";
  76233. /**
  76234. * Defines the basic options interface of a SpriteMap
  76235. */
  76236. export interface ISpriteMapOptions {
  76237. /**
  76238. * Vector2 of the number of cells in the grid.
  76239. */
  76240. stageSize?: Vector2;
  76241. /**
  76242. * Vector2 of the size of the output plane in World Units.
  76243. */
  76244. outputSize?: Vector2;
  76245. /**
  76246. * Vector3 of the position of the output plane in World Units.
  76247. */
  76248. outputPosition?: Vector3;
  76249. /**
  76250. * Vector3 of the rotation of the output plane.
  76251. */
  76252. outputRotation?: Vector3;
  76253. /**
  76254. * number of layers that the system will reserve in resources.
  76255. */
  76256. layerCount?: number;
  76257. /**
  76258. * number of max animation frames a single cell will reserve in resources.
  76259. */
  76260. maxAnimationFrames?: number;
  76261. /**
  76262. * number cell index of the base tile when the system compiles.
  76263. */
  76264. baseTile?: number;
  76265. /**
  76266. * boolean flip the sprite after its been repositioned by the framing data.
  76267. */
  76268. flipU?: boolean;
  76269. /**
  76270. * Vector3 scalar of the global RGB values of the SpriteMap.
  76271. */
  76272. colorMultiply?: Vector3;
  76273. }
  76274. /**
  76275. * Defines the IDisposable interface in order to be cleanable from resources.
  76276. */
  76277. export interface ISpriteMap extends IDisposable {
  76278. /**
  76279. * String name of the SpriteMap.
  76280. */
  76281. name: string;
  76282. /**
  76283. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76284. */
  76285. atlasJSON: ISpriteJSONAtlas;
  76286. /**
  76287. * Texture of the SpriteMap.
  76288. */
  76289. spriteSheet: Texture;
  76290. /**
  76291. * The parameters to initialize the SpriteMap with.
  76292. */
  76293. options: ISpriteMapOptions;
  76294. }
  76295. /**
  76296. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76297. */
  76298. export class SpriteMap implements ISpriteMap {
  76299. /** The Name of the spriteMap */
  76300. name: string;
  76301. /** The JSON file with the frame and meta data */
  76302. atlasJSON: ISpriteJSONAtlas;
  76303. /** The systems Sprite Sheet Texture */
  76304. spriteSheet: Texture;
  76305. /** Arguments passed with the Constructor */
  76306. options: ISpriteMapOptions;
  76307. /** Public Sprite Storage array, parsed from atlasJSON */
  76308. sprites: Array<ISpriteJSONSprite>;
  76309. /** Returns the Number of Sprites in the System */
  76310. get spriteCount(): number;
  76311. /** Returns the Position of Output Plane*/
  76312. get position(): Vector3;
  76313. /** Returns the Position of Output Plane*/
  76314. set position(v: Vector3);
  76315. /** Returns the Rotation of Output Plane*/
  76316. get rotation(): Vector3;
  76317. /** Returns the Rotation of Output Plane*/
  76318. set rotation(v: Vector3);
  76319. /** Sets the AnimationMap*/
  76320. get animationMap(): RawTexture;
  76321. /** Sets the AnimationMap*/
  76322. set animationMap(v: RawTexture);
  76323. /** Scene that the SpriteMap was created in */
  76324. private _scene;
  76325. /** Texture Buffer of Float32 that holds tile frame data*/
  76326. private _frameMap;
  76327. /** Texture Buffers of Float32 that holds tileMap data*/
  76328. private _tileMaps;
  76329. /** Texture Buffer of Float32 that holds Animation Data*/
  76330. private _animationMap;
  76331. /** Custom ShaderMaterial Central to the System*/
  76332. private _material;
  76333. /** Custom ShaderMaterial Central to the System*/
  76334. private _output;
  76335. /** Systems Time Ticker*/
  76336. private _time;
  76337. /**
  76338. * Creates a new SpriteMap
  76339. * @param name defines the SpriteMaps Name
  76340. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76341. * @param spriteSheet is the Texture that the Sprites are on.
  76342. * @param options a basic deployment configuration
  76343. * @param scene The Scene that the map is deployed on
  76344. */
  76345. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76346. /**
  76347. * Returns tileID location
  76348. * @returns Vector2 the cell position ID
  76349. */
  76350. getTileID(): Vector2;
  76351. /**
  76352. * Gets the UV location of the mouse over the SpriteMap.
  76353. * @returns Vector2 the UV position of the mouse interaction
  76354. */
  76355. getMousePosition(): Vector2;
  76356. /**
  76357. * Creates the "frame" texture Buffer
  76358. * -------------------------------------
  76359. * Structure of frames
  76360. * "filename": "Falling-Water-2.png",
  76361. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76362. * "rotated": true,
  76363. * "trimmed": true,
  76364. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76365. * "sourceSize": {"w":32,"h":32}
  76366. * @returns RawTexture of the frameMap
  76367. */
  76368. private _createFrameBuffer;
  76369. /**
  76370. * Creates the tileMap texture Buffer
  76371. * @param buffer normally and array of numbers, or a false to generate from scratch
  76372. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76373. * @returns RawTexture of the tileMap
  76374. */
  76375. private _createTileBuffer;
  76376. /**
  76377. * Modifies the data of the tileMaps
  76378. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76379. * @param pos is the iVector2 Coordinates of the Tile
  76380. * @param tile The SpriteIndex of the new Tile
  76381. */
  76382. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76383. /**
  76384. * Creates the animationMap texture Buffer
  76385. * @param buffer normally and array of numbers, or a false to generate from scratch
  76386. * @returns RawTexture of the animationMap
  76387. */
  76388. private _createTileAnimationBuffer;
  76389. /**
  76390. * Modifies the data of the animationMap
  76391. * @param cellID is the Index of the Sprite
  76392. * @param _frame is the target Animation frame
  76393. * @param toCell is the Target Index of the next frame of the animation
  76394. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76395. * @param speed is a global scalar of the time variable on the map.
  76396. */
  76397. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76398. /**
  76399. * Exports the .tilemaps file
  76400. */
  76401. saveTileMaps(): void;
  76402. /**
  76403. * Imports the .tilemaps file
  76404. * @param url of the .tilemaps file
  76405. */
  76406. loadTileMaps(url: string): void;
  76407. /**
  76408. * Release associated resources
  76409. */
  76410. dispose(): void;
  76411. }
  76412. }
  76413. declare module "babylonjs/Sprites/spritePackedManager" {
  76414. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76415. import { Scene } from "babylonjs/scene";
  76416. /**
  76417. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76418. * @see https://doc.babylonjs.com/babylon101/sprites
  76419. */
  76420. export class SpritePackedManager extends SpriteManager {
  76421. /** defines the packed manager's name */
  76422. name: string;
  76423. /**
  76424. * Creates a new sprite manager from a packed sprite sheet
  76425. * @param name defines the manager's name
  76426. * @param imgUrl defines the sprite sheet url
  76427. * @param capacity defines the maximum allowed number of sprites
  76428. * @param scene defines the hosting scene
  76429. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76430. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76431. * @param samplingMode defines the smapling mode to use with spritesheet
  76432. * @param fromPacked set to true; do not alter
  76433. */
  76434. constructor(
  76435. /** defines the packed manager's name */
  76436. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76437. }
  76438. }
  76439. declare module "babylonjs/Sprites/index" {
  76440. export * from "babylonjs/Sprites/sprite";
  76441. export * from "babylonjs/Sprites/ISprites";
  76442. export * from "babylonjs/Sprites/spriteManager";
  76443. export * from "babylonjs/Sprites/spriteMap";
  76444. export * from "babylonjs/Sprites/spritePackedManager";
  76445. export * from "babylonjs/Sprites/spriteSceneComponent";
  76446. }
  76447. declare module "babylonjs/States/index" {
  76448. export * from "babylonjs/States/alphaCullingState";
  76449. export * from "babylonjs/States/depthCullingState";
  76450. export * from "babylonjs/States/stencilState";
  76451. }
  76452. declare module "babylonjs/Misc/assetsManager" {
  76453. import { Scene } from "babylonjs/scene";
  76454. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76455. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76456. import { Skeleton } from "babylonjs/Bones/skeleton";
  76457. import { Observable } from "babylonjs/Misc/observable";
  76458. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76459. import { Texture } from "babylonjs/Materials/Textures/texture";
  76460. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76461. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76462. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76463. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76464. import { AssetContainer } from "babylonjs/assetContainer";
  76465. /**
  76466. * Defines the list of states available for a task inside a AssetsManager
  76467. */
  76468. export enum AssetTaskState {
  76469. /**
  76470. * Initialization
  76471. */
  76472. INIT = 0,
  76473. /**
  76474. * Running
  76475. */
  76476. RUNNING = 1,
  76477. /**
  76478. * Done
  76479. */
  76480. DONE = 2,
  76481. /**
  76482. * Error
  76483. */
  76484. ERROR = 3
  76485. }
  76486. /**
  76487. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76488. */
  76489. export abstract class AbstractAssetTask {
  76490. /**
  76491. * Task name
  76492. */ name: string;
  76493. /**
  76494. * Callback called when the task is successful
  76495. */
  76496. onSuccess: (task: any) => void;
  76497. /**
  76498. * Callback called when the task is not successful
  76499. */
  76500. onError: (task: any, message?: string, exception?: any) => void;
  76501. /**
  76502. * Creates a new AssetsManager
  76503. * @param name defines the name of the task
  76504. */
  76505. constructor(
  76506. /**
  76507. * Task name
  76508. */ name: string);
  76509. private _isCompleted;
  76510. private _taskState;
  76511. private _errorObject;
  76512. /**
  76513. * Get if the task is completed
  76514. */
  76515. get isCompleted(): boolean;
  76516. /**
  76517. * Gets the current state of the task
  76518. */
  76519. get taskState(): AssetTaskState;
  76520. /**
  76521. * Gets the current error object (if task is in error)
  76522. */
  76523. get errorObject(): {
  76524. message?: string;
  76525. exception?: any;
  76526. };
  76527. /**
  76528. * Internal only
  76529. * @hidden
  76530. */
  76531. _setErrorObject(message?: string, exception?: any): void;
  76532. /**
  76533. * Execute the current task
  76534. * @param scene defines the scene where you want your assets to be loaded
  76535. * @param onSuccess is a callback called when the task is successfully executed
  76536. * @param onError is a callback called if an error occurs
  76537. */
  76538. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76539. /**
  76540. * Execute the current task
  76541. * @param scene defines the scene where you want your assets to be loaded
  76542. * @param onSuccess is a callback called when the task is successfully executed
  76543. * @param onError is a callback called if an error occurs
  76544. */
  76545. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76546. /**
  76547. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76548. * This can be used with failed tasks that have the reason for failure fixed.
  76549. */
  76550. reset(): void;
  76551. private onErrorCallback;
  76552. private onDoneCallback;
  76553. }
  76554. /**
  76555. * Define the interface used by progress events raised during assets loading
  76556. */
  76557. export interface IAssetsProgressEvent {
  76558. /**
  76559. * Defines the number of remaining tasks to process
  76560. */
  76561. remainingCount: number;
  76562. /**
  76563. * Defines the total number of tasks
  76564. */
  76565. totalCount: number;
  76566. /**
  76567. * Defines the task that was just processed
  76568. */
  76569. task: AbstractAssetTask;
  76570. }
  76571. /**
  76572. * Class used to share progress information about assets loading
  76573. */
  76574. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76575. /**
  76576. * Defines the number of remaining tasks to process
  76577. */
  76578. remainingCount: number;
  76579. /**
  76580. * Defines the total number of tasks
  76581. */
  76582. totalCount: number;
  76583. /**
  76584. * Defines the task that was just processed
  76585. */
  76586. task: AbstractAssetTask;
  76587. /**
  76588. * Creates a AssetsProgressEvent
  76589. * @param remainingCount defines the number of remaining tasks to process
  76590. * @param totalCount defines the total number of tasks
  76591. * @param task defines the task that was just processed
  76592. */
  76593. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76594. }
  76595. /**
  76596. * Define a task used by AssetsManager to load assets into a container
  76597. */
  76598. export class ContainerAssetTask extends AbstractAssetTask {
  76599. /**
  76600. * Defines the name of the task
  76601. */
  76602. name: string;
  76603. /**
  76604. * Defines the list of mesh's names you want to load
  76605. */
  76606. meshesNames: any;
  76607. /**
  76608. * Defines the root url to use as a base to load your meshes and associated resources
  76609. */
  76610. rootUrl: string;
  76611. /**
  76612. * Defines the filename or File of the scene to load from
  76613. */
  76614. sceneFilename: string | File;
  76615. /**
  76616. * Get the loaded asset container
  76617. */
  76618. loadedContainer: AssetContainer;
  76619. /**
  76620. * Gets the list of loaded meshes
  76621. */
  76622. loadedMeshes: Array<AbstractMesh>;
  76623. /**
  76624. * Gets the list of loaded particle systems
  76625. */
  76626. loadedParticleSystems: Array<IParticleSystem>;
  76627. /**
  76628. * Gets the list of loaded skeletons
  76629. */
  76630. loadedSkeletons: Array<Skeleton>;
  76631. /**
  76632. * Gets the list of loaded animation groups
  76633. */
  76634. loadedAnimationGroups: Array<AnimationGroup>;
  76635. /**
  76636. * Callback called when the task is successful
  76637. */
  76638. onSuccess: (task: ContainerAssetTask) => void;
  76639. /**
  76640. * Callback called when the task is successful
  76641. */
  76642. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76643. /**
  76644. * Creates a new ContainerAssetTask
  76645. * @param name defines the name of the task
  76646. * @param meshesNames defines the list of mesh's names you want to load
  76647. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76648. * @param sceneFilename defines the filename or File of the scene to load from
  76649. */
  76650. constructor(
  76651. /**
  76652. * Defines the name of the task
  76653. */
  76654. name: string,
  76655. /**
  76656. * Defines the list of mesh's names you want to load
  76657. */
  76658. meshesNames: any,
  76659. /**
  76660. * Defines the root url to use as a base to load your meshes and associated resources
  76661. */
  76662. rootUrl: string,
  76663. /**
  76664. * Defines the filename or File of the scene to load from
  76665. */
  76666. sceneFilename: string | File);
  76667. /**
  76668. * Execute the current task
  76669. * @param scene defines the scene where you want your assets to be loaded
  76670. * @param onSuccess is a callback called when the task is successfully executed
  76671. * @param onError is a callback called if an error occurs
  76672. */
  76673. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76674. }
  76675. /**
  76676. * Define a task used by AssetsManager to load meshes
  76677. */
  76678. export class MeshAssetTask extends AbstractAssetTask {
  76679. /**
  76680. * Defines the name of the task
  76681. */
  76682. name: string;
  76683. /**
  76684. * Defines the list of mesh's names you want to load
  76685. */
  76686. meshesNames: any;
  76687. /**
  76688. * Defines the root url to use as a base to load your meshes and associated resources
  76689. */
  76690. rootUrl: string;
  76691. /**
  76692. * Defines the filename or File of the scene to load from
  76693. */
  76694. sceneFilename: string | File;
  76695. /**
  76696. * Gets the list of loaded meshes
  76697. */
  76698. loadedMeshes: Array<AbstractMesh>;
  76699. /**
  76700. * Gets the list of loaded particle systems
  76701. */
  76702. loadedParticleSystems: Array<IParticleSystem>;
  76703. /**
  76704. * Gets the list of loaded skeletons
  76705. */
  76706. loadedSkeletons: Array<Skeleton>;
  76707. /**
  76708. * Gets the list of loaded animation groups
  76709. */
  76710. loadedAnimationGroups: Array<AnimationGroup>;
  76711. /**
  76712. * Callback called when the task is successful
  76713. */
  76714. onSuccess: (task: MeshAssetTask) => void;
  76715. /**
  76716. * Callback called when the task is successful
  76717. */
  76718. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76719. /**
  76720. * Creates a new MeshAssetTask
  76721. * @param name defines the name of the task
  76722. * @param meshesNames defines the list of mesh's names you want to load
  76723. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76724. * @param sceneFilename defines the filename or File of the scene to load from
  76725. */
  76726. constructor(
  76727. /**
  76728. * Defines the name of the task
  76729. */
  76730. name: string,
  76731. /**
  76732. * Defines the list of mesh's names you want to load
  76733. */
  76734. meshesNames: any,
  76735. /**
  76736. * Defines the root url to use as a base to load your meshes and associated resources
  76737. */
  76738. rootUrl: string,
  76739. /**
  76740. * Defines the filename or File of the scene to load from
  76741. */
  76742. sceneFilename: string | File);
  76743. /**
  76744. * Execute the current task
  76745. * @param scene defines the scene where you want your assets to be loaded
  76746. * @param onSuccess is a callback called when the task is successfully executed
  76747. * @param onError is a callback called if an error occurs
  76748. */
  76749. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76750. }
  76751. /**
  76752. * Define a task used by AssetsManager to load text content
  76753. */
  76754. export class TextFileAssetTask extends AbstractAssetTask {
  76755. /**
  76756. * Defines the name of the task
  76757. */
  76758. name: string;
  76759. /**
  76760. * Defines the location of the file to load
  76761. */
  76762. url: string;
  76763. /**
  76764. * Gets the loaded text string
  76765. */
  76766. text: string;
  76767. /**
  76768. * Callback called when the task is successful
  76769. */
  76770. onSuccess: (task: TextFileAssetTask) => void;
  76771. /**
  76772. * Callback called when the task is successful
  76773. */
  76774. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76775. /**
  76776. * Creates a new TextFileAssetTask object
  76777. * @param name defines the name of the task
  76778. * @param url defines the location of the file to load
  76779. */
  76780. constructor(
  76781. /**
  76782. * Defines the name of the task
  76783. */
  76784. name: string,
  76785. /**
  76786. * Defines the location of the file to load
  76787. */
  76788. url: string);
  76789. /**
  76790. * Execute the current task
  76791. * @param scene defines the scene where you want your assets to be loaded
  76792. * @param onSuccess is a callback called when the task is successfully executed
  76793. * @param onError is a callback called if an error occurs
  76794. */
  76795. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76796. }
  76797. /**
  76798. * Define a task used by AssetsManager to load binary data
  76799. */
  76800. export class BinaryFileAssetTask extends AbstractAssetTask {
  76801. /**
  76802. * Defines the name of the task
  76803. */
  76804. name: string;
  76805. /**
  76806. * Defines the location of the file to load
  76807. */
  76808. url: string;
  76809. /**
  76810. * Gets the lodaded data (as an array buffer)
  76811. */
  76812. data: ArrayBuffer;
  76813. /**
  76814. * Callback called when the task is successful
  76815. */
  76816. onSuccess: (task: BinaryFileAssetTask) => void;
  76817. /**
  76818. * Callback called when the task is successful
  76819. */
  76820. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76821. /**
  76822. * Creates a new BinaryFileAssetTask object
  76823. * @param name defines the name of the new task
  76824. * @param url defines the location of the file to load
  76825. */
  76826. constructor(
  76827. /**
  76828. * Defines the name of the task
  76829. */
  76830. name: string,
  76831. /**
  76832. * Defines the location of the file to load
  76833. */
  76834. url: string);
  76835. /**
  76836. * Execute the current task
  76837. * @param scene defines the scene where you want your assets to be loaded
  76838. * @param onSuccess is a callback called when the task is successfully executed
  76839. * @param onError is a callback called if an error occurs
  76840. */
  76841. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76842. }
  76843. /**
  76844. * Define a task used by AssetsManager to load images
  76845. */
  76846. export class ImageAssetTask extends AbstractAssetTask {
  76847. /**
  76848. * Defines the name of the task
  76849. */
  76850. name: string;
  76851. /**
  76852. * Defines the location of the image to load
  76853. */
  76854. url: string;
  76855. /**
  76856. * Gets the loaded images
  76857. */
  76858. image: HTMLImageElement;
  76859. /**
  76860. * Callback called when the task is successful
  76861. */
  76862. onSuccess: (task: ImageAssetTask) => void;
  76863. /**
  76864. * Callback called when the task is successful
  76865. */
  76866. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76867. /**
  76868. * Creates a new ImageAssetTask
  76869. * @param name defines the name of the task
  76870. * @param url defines the location of the image to load
  76871. */
  76872. constructor(
  76873. /**
  76874. * Defines the name of the task
  76875. */
  76876. name: string,
  76877. /**
  76878. * Defines the location of the image to load
  76879. */
  76880. url: string);
  76881. /**
  76882. * Execute the current task
  76883. * @param scene defines the scene where you want your assets to be loaded
  76884. * @param onSuccess is a callback called when the task is successfully executed
  76885. * @param onError is a callback called if an error occurs
  76886. */
  76887. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76888. }
  76889. /**
  76890. * Defines the interface used by texture loading tasks
  76891. */
  76892. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76893. /**
  76894. * Gets the loaded texture
  76895. */
  76896. texture: TEX;
  76897. }
  76898. /**
  76899. * Define a task used by AssetsManager to load 2D textures
  76900. */
  76901. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76902. /**
  76903. * Defines the name of the task
  76904. */
  76905. name: string;
  76906. /**
  76907. * Defines the location of the file to load
  76908. */
  76909. url: string;
  76910. /**
  76911. * Defines if mipmap should not be generated (default is false)
  76912. */
  76913. noMipmap?: boolean | undefined;
  76914. /**
  76915. * Defines if texture must be inverted on Y axis (default is true)
  76916. */
  76917. invertY: boolean;
  76918. /**
  76919. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76920. */
  76921. samplingMode: number;
  76922. /**
  76923. * Gets the loaded texture
  76924. */
  76925. texture: Texture;
  76926. /**
  76927. * Callback called when the task is successful
  76928. */
  76929. onSuccess: (task: TextureAssetTask) => void;
  76930. /**
  76931. * Callback called when the task is successful
  76932. */
  76933. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76934. /**
  76935. * Creates a new TextureAssetTask object
  76936. * @param name defines the name of the task
  76937. * @param url defines the location of the file to load
  76938. * @param noMipmap defines if mipmap should not be generated (default is false)
  76939. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76940. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76941. */
  76942. constructor(
  76943. /**
  76944. * Defines the name of the task
  76945. */
  76946. name: string,
  76947. /**
  76948. * Defines the location of the file to load
  76949. */
  76950. url: string,
  76951. /**
  76952. * Defines if mipmap should not be generated (default is false)
  76953. */
  76954. noMipmap?: boolean | undefined,
  76955. /**
  76956. * Defines if texture must be inverted on Y axis (default is true)
  76957. */
  76958. invertY?: boolean,
  76959. /**
  76960. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76961. */
  76962. samplingMode?: number);
  76963. /**
  76964. * Execute the current task
  76965. * @param scene defines the scene where you want your assets to be loaded
  76966. * @param onSuccess is a callback called when the task is successfully executed
  76967. * @param onError is a callback called if an error occurs
  76968. */
  76969. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76970. }
  76971. /**
  76972. * Define a task used by AssetsManager to load cube textures
  76973. */
  76974. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76975. /**
  76976. * Defines the name of the task
  76977. */
  76978. name: string;
  76979. /**
  76980. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76981. */
  76982. url: string;
  76983. /**
  76984. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76985. */
  76986. extensions?: string[] | undefined;
  76987. /**
  76988. * Defines if mipmaps should not be generated (default is false)
  76989. */
  76990. noMipmap?: boolean | undefined;
  76991. /**
  76992. * Defines the explicit list of files (undefined by default)
  76993. */
  76994. files?: string[] | undefined;
  76995. /**
  76996. * Gets the loaded texture
  76997. */
  76998. texture: CubeTexture;
  76999. /**
  77000. * Callback called when the task is successful
  77001. */
  77002. onSuccess: (task: CubeTextureAssetTask) => void;
  77003. /**
  77004. * Callback called when the task is successful
  77005. */
  77006. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  77007. /**
  77008. * Creates a new CubeTextureAssetTask
  77009. * @param name defines the name of the task
  77010. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77011. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77012. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77013. * @param files defines the explicit list of files (undefined by default)
  77014. */
  77015. constructor(
  77016. /**
  77017. * Defines the name of the task
  77018. */
  77019. name: string,
  77020. /**
  77021. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77022. */
  77023. url: string,
  77024. /**
  77025. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77026. */
  77027. extensions?: string[] | undefined,
  77028. /**
  77029. * Defines if mipmaps should not be generated (default is false)
  77030. */
  77031. noMipmap?: boolean | undefined,
  77032. /**
  77033. * Defines the explicit list of files (undefined by default)
  77034. */
  77035. files?: string[] | undefined);
  77036. /**
  77037. * Execute the current task
  77038. * @param scene defines the scene where you want your assets to be loaded
  77039. * @param onSuccess is a callback called when the task is successfully executed
  77040. * @param onError is a callback called if an error occurs
  77041. */
  77042. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77043. }
  77044. /**
  77045. * Define a task used by AssetsManager to load HDR cube textures
  77046. */
  77047. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  77048. /**
  77049. * Defines the name of the task
  77050. */
  77051. name: string;
  77052. /**
  77053. * Defines the location of the file to load
  77054. */
  77055. url: string;
  77056. /**
  77057. * Defines the desired size (the more it increases the longer the generation will be)
  77058. */
  77059. size: number;
  77060. /**
  77061. * Defines if mipmaps should not be generated (default is false)
  77062. */
  77063. noMipmap: boolean;
  77064. /**
  77065. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77066. */
  77067. generateHarmonics: boolean;
  77068. /**
  77069. * 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)
  77070. */
  77071. gammaSpace: boolean;
  77072. /**
  77073. * Internal Use Only
  77074. */
  77075. reserved: boolean;
  77076. /**
  77077. * Gets the loaded texture
  77078. */
  77079. texture: HDRCubeTexture;
  77080. /**
  77081. * Callback called when the task is successful
  77082. */
  77083. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77084. /**
  77085. * Callback called when the task is successful
  77086. */
  77087. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77088. /**
  77089. * Creates a new HDRCubeTextureAssetTask object
  77090. * @param name defines the name of the task
  77091. * @param url defines the location of the file to load
  77092. * @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.
  77093. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77094. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77095. * @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)
  77096. * @param reserved Internal use only
  77097. */
  77098. constructor(
  77099. /**
  77100. * Defines the name of the task
  77101. */
  77102. name: string,
  77103. /**
  77104. * Defines the location of the file to load
  77105. */
  77106. url: string,
  77107. /**
  77108. * Defines the desired size (the more it increases the longer the generation will be)
  77109. */
  77110. size: number,
  77111. /**
  77112. * Defines if mipmaps should not be generated (default is false)
  77113. */
  77114. noMipmap?: boolean,
  77115. /**
  77116. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77117. */
  77118. generateHarmonics?: boolean,
  77119. /**
  77120. * 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)
  77121. */
  77122. gammaSpace?: boolean,
  77123. /**
  77124. * Internal Use Only
  77125. */
  77126. reserved?: boolean);
  77127. /**
  77128. * Execute the current task
  77129. * @param scene defines the scene where you want your assets to be loaded
  77130. * @param onSuccess is a callback called when the task is successfully executed
  77131. * @param onError is a callback called if an error occurs
  77132. */
  77133. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77134. }
  77135. /**
  77136. * Define a task used by AssetsManager to load Equirectangular cube textures
  77137. */
  77138. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77139. /**
  77140. * Defines the name of the task
  77141. */
  77142. name: string;
  77143. /**
  77144. * Defines the location of the file to load
  77145. */
  77146. url: string;
  77147. /**
  77148. * Defines the desired size (the more it increases the longer the generation will be)
  77149. */
  77150. size: number;
  77151. /**
  77152. * Defines if mipmaps should not be generated (default is false)
  77153. */
  77154. noMipmap: boolean;
  77155. /**
  77156. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77157. * but the standard material would require them in Gamma space) (default is true)
  77158. */
  77159. gammaSpace: boolean;
  77160. /**
  77161. * Gets the loaded texture
  77162. */
  77163. texture: EquiRectangularCubeTexture;
  77164. /**
  77165. * Callback called when the task is successful
  77166. */
  77167. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77168. /**
  77169. * Callback called when the task is successful
  77170. */
  77171. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77172. /**
  77173. * Creates a new EquiRectangularCubeTextureAssetTask object
  77174. * @param name defines the name of the task
  77175. * @param url defines the location of the file to load
  77176. * @param size defines the desired size (the more it increases the longer the generation will be)
  77177. * If the size is omitted this implies you are using a preprocessed cubemap.
  77178. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77179. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77180. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77181. * (default is true)
  77182. */
  77183. constructor(
  77184. /**
  77185. * Defines the name of the task
  77186. */
  77187. name: string,
  77188. /**
  77189. * Defines the location of the file to load
  77190. */
  77191. url: string,
  77192. /**
  77193. * Defines the desired size (the more it increases the longer the generation will be)
  77194. */
  77195. size: number,
  77196. /**
  77197. * Defines if mipmaps should not be generated (default is false)
  77198. */
  77199. noMipmap?: boolean,
  77200. /**
  77201. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77202. * but the standard material would require them in Gamma space) (default is true)
  77203. */
  77204. gammaSpace?: boolean);
  77205. /**
  77206. * Execute the current task
  77207. * @param scene defines the scene where you want your assets to be loaded
  77208. * @param onSuccess is a callback called when the task is successfully executed
  77209. * @param onError is a callback called if an error occurs
  77210. */
  77211. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77212. }
  77213. /**
  77214. * This class can be used to easily import assets into a scene
  77215. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77216. */
  77217. export class AssetsManager {
  77218. private _scene;
  77219. private _isLoading;
  77220. protected _tasks: AbstractAssetTask[];
  77221. protected _waitingTasksCount: number;
  77222. protected _totalTasksCount: number;
  77223. /**
  77224. * Callback called when all tasks are processed
  77225. */
  77226. onFinish: (tasks: AbstractAssetTask[]) => void;
  77227. /**
  77228. * Callback called when a task is successful
  77229. */
  77230. onTaskSuccess: (task: AbstractAssetTask) => void;
  77231. /**
  77232. * Callback called when a task had an error
  77233. */
  77234. onTaskError: (task: AbstractAssetTask) => void;
  77235. /**
  77236. * Callback called when a task is done (whatever the result is)
  77237. */
  77238. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77239. /**
  77240. * Observable called when all tasks are processed
  77241. */
  77242. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77243. /**
  77244. * Observable called when a task had an error
  77245. */
  77246. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77247. /**
  77248. * Observable called when all tasks were executed
  77249. */
  77250. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77251. /**
  77252. * Observable called when a task is done (whatever the result is)
  77253. */
  77254. onProgressObservable: Observable<IAssetsProgressEvent>;
  77255. /**
  77256. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77257. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77258. */
  77259. useDefaultLoadingScreen: boolean;
  77260. /**
  77261. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77262. * when all assets have been downloaded.
  77263. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77264. */
  77265. autoHideLoadingUI: boolean;
  77266. /**
  77267. * Creates a new AssetsManager
  77268. * @param scene defines the scene to work on
  77269. */
  77270. constructor(scene: Scene);
  77271. /**
  77272. * Add a ContainerAssetTask to the list of active tasks
  77273. * @param taskName defines the name of the new task
  77274. * @param meshesNames defines the name of meshes to load
  77275. * @param rootUrl defines the root url to use to locate files
  77276. * @param sceneFilename defines the filename of the scene file
  77277. * @returns a new ContainerAssetTask object
  77278. */
  77279. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77280. /**
  77281. * Add a MeshAssetTask to the list of active tasks
  77282. * @param taskName defines the name of the new task
  77283. * @param meshesNames defines the name of meshes to load
  77284. * @param rootUrl defines the root url to use to locate files
  77285. * @param sceneFilename defines the filename of the scene file
  77286. * @returns a new MeshAssetTask object
  77287. */
  77288. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77289. /**
  77290. * Add a TextFileAssetTask to the list of active tasks
  77291. * @param taskName defines the name of the new task
  77292. * @param url defines the url of the file to load
  77293. * @returns a new TextFileAssetTask object
  77294. */
  77295. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77296. /**
  77297. * Add a BinaryFileAssetTask to the list of active tasks
  77298. * @param taskName defines the name of the new task
  77299. * @param url defines the url of the file to load
  77300. * @returns a new BinaryFileAssetTask object
  77301. */
  77302. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77303. /**
  77304. * Add a ImageAssetTask to the list of active tasks
  77305. * @param taskName defines the name of the new task
  77306. * @param url defines the url of the file to load
  77307. * @returns a new ImageAssetTask object
  77308. */
  77309. addImageTask(taskName: string, url: string): ImageAssetTask;
  77310. /**
  77311. * Add a TextureAssetTask to the list of active tasks
  77312. * @param taskName defines the name of the new task
  77313. * @param url defines the url of the file to load
  77314. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77315. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77316. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77317. * @returns a new TextureAssetTask object
  77318. */
  77319. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77320. /**
  77321. * Add a CubeTextureAssetTask to the list of active tasks
  77322. * @param taskName defines the name of the new task
  77323. * @param url defines the url of the file to load
  77324. * @param extensions defines the extension to use to load the cube map (can be null)
  77325. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77326. * @param files defines the list of files to load (can be null)
  77327. * @returns a new CubeTextureAssetTask object
  77328. */
  77329. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77330. /**
  77331. *
  77332. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77333. * @param taskName defines the name of the new task
  77334. * @param url defines the url of the file to load
  77335. * @param size defines the size you want for the cubemap (can be null)
  77336. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77337. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77338. * @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)
  77339. * @param reserved Internal use only
  77340. * @returns a new HDRCubeTextureAssetTask object
  77341. */
  77342. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77343. /**
  77344. *
  77345. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77346. * @param taskName defines the name of the new task
  77347. * @param url defines the url of the file to load
  77348. * @param size defines the size you want for the cubemap (can be null)
  77349. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77350. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77351. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77352. * @returns a new EquiRectangularCubeTextureAssetTask object
  77353. */
  77354. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77355. /**
  77356. * Remove a task from the assets manager.
  77357. * @param task the task to remove
  77358. */
  77359. removeTask(task: AbstractAssetTask): void;
  77360. private _decreaseWaitingTasksCount;
  77361. private _runTask;
  77362. /**
  77363. * Reset the AssetsManager and remove all tasks
  77364. * @return the current instance of the AssetsManager
  77365. */
  77366. reset(): AssetsManager;
  77367. /**
  77368. * Start the loading process
  77369. * @return the current instance of the AssetsManager
  77370. */
  77371. load(): AssetsManager;
  77372. /**
  77373. * Start the loading process as an async operation
  77374. * @return a promise returning the list of failed tasks
  77375. */
  77376. loadAsync(): Promise<void>;
  77377. }
  77378. }
  77379. declare module "babylonjs/Misc/deferred" {
  77380. /**
  77381. * Wrapper class for promise with external resolve and reject.
  77382. */
  77383. export class Deferred<T> {
  77384. /**
  77385. * The promise associated with this deferred object.
  77386. */
  77387. readonly promise: Promise<T>;
  77388. private _resolve;
  77389. private _reject;
  77390. /**
  77391. * The resolve method of the promise associated with this deferred object.
  77392. */
  77393. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77394. /**
  77395. * The reject method of the promise associated with this deferred object.
  77396. */
  77397. get reject(): (reason?: any) => void;
  77398. /**
  77399. * Constructor for this deferred object.
  77400. */
  77401. constructor();
  77402. }
  77403. }
  77404. declare module "babylonjs/Misc/meshExploder" {
  77405. import { Mesh } from "babylonjs/Meshes/mesh";
  77406. /**
  77407. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77408. */
  77409. export class MeshExploder {
  77410. private _centerMesh;
  77411. private _meshes;
  77412. private _meshesOrigins;
  77413. private _toCenterVectors;
  77414. private _scaledDirection;
  77415. private _newPosition;
  77416. private _centerPosition;
  77417. /**
  77418. * Explodes meshes from a center mesh.
  77419. * @param meshes The meshes to explode.
  77420. * @param centerMesh The mesh to be center of explosion.
  77421. */
  77422. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77423. private _setCenterMesh;
  77424. /**
  77425. * Get class name
  77426. * @returns "MeshExploder"
  77427. */
  77428. getClassName(): string;
  77429. /**
  77430. * "Exploded meshes"
  77431. * @returns Array of meshes with the centerMesh at index 0.
  77432. */
  77433. getMeshes(): Array<Mesh>;
  77434. /**
  77435. * Explodes meshes giving a specific direction
  77436. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77437. */
  77438. explode(direction?: number): void;
  77439. }
  77440. }
  77441. declare module "babylonjs/Misc/filesInput" {
  77442. import { Engine } from "babylonjs/Engines/engine";
  77443. import { Scene } from "babylonjs/scene";
  77444. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77445. import { Nullable } from "babylonjs/types";
  77446. /**
  77447. * Class used to help managing file picking and drag'n'drop
  77448. */
  77449. export class FilesInput {
  77450. /**
  77451. * List of files ready to be loaded
  77452. */
  77453. static get FilesToLoad(): {
  77454. [key: string]: File;
  77455. };
  77456. /**
  77457. * Callback called when a file is processed
  77458. */
  77459. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77460. private _engine;
  77461. private _currentScene;
  77462. private _sceneLoadedCallback;
  77463. private _progressCallback;
  77464. private _additionalRenderLoopLogicCallback;
  77465. private _textureLoadingCallback;
  77466. private _startingProcessingFilesCallback;
  77467. private _onReloadCallback;
  77468. private _errorCallback;
  77469. private _elementToMonitor;
  77470. private _sceneFileToLoad;
  77471. private _filesToLoad;
  77472. /**
  77473. * Creates a new FilesInput
  77474. * @param engine defines the rendering engine
  77475. * @param scene defines the hosting scene
  77476. * @param sceneLoadedCallback callback called when scene is loaded
  77477. * @param progressCallback callback called to track progress
  77478. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77479. * @param textureLoadingCallback callback called when a texture is loading
  77480. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77481. * @param onReloadCallback callback called when a reload is requested
  77482. * @param errorCallback callback call if an error occurs
  77483. */
  77484. constructor(engine: Engine, scene: Nullable<Scene>, sceneLoadedCallback: Nullable<(sceneFile: File, scene: Scene) => void>, progressCallback: Nullable<(progress: ISceneLoaderProgressEvent) => void>, additionalRenderLoopLogicCallback: Nullable<() => void>, textureLoadingCallback: Nullable<(remaining: number) => void>, startingProcessingFilesCallback: Nullable<(files?: File[]) => void>, onReloadCallback: Nullable<(sceneFile: File) => void>, errorCallback: Nullable<(sceneFile: File, scene: Nullable<Scene>, message: string) => void>);
  77485. private _dragEnterHandler;
  77486. private _dragOverHandler;
  77487. private _dropHandler;
  77488. /**
  77489. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77490. * @param elementToMonitor defines the DOM element to track
  77491. */
  77492. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77493. /** Gets the current list of files to load */
  77494. get filesToLoad(): File[];
  77495. /**
  77496. * Release all associated resources
  77497. */
  77498. dispose(): void;
  77499. private renderFunction;
  77500. private drag;
  77501. private drop;
  77502. private _traverseFolder;
  77503. private _processFiles;
  77504. /**
  77505. * Load files from a drop event
  77506. * @param event defines the drop event to use as source
  77507. */
  77508. loadFiles(event: any): void;
  77509. private _processReload;
  77510. /**
  77511. * Reload the current scene from the loaded files
  77512. */
  77513. reload(): void;
  77514. }
  77515. }
  77516. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77517. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77518. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77519. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77520. }
  77521. declare module "babylonjs/Misc/sceneOptimizer" {
  77522. import { Scene, IDisposable } from "babylonjs/scene";
  77523. import { Observable } from "babylonjs/Misc/observable";
  77524. /**
  77525. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77526. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77527. */
  77528. export class SceneOptimization {
  77529. /**
  77530. * Defines the priority of this optimization (0 by default which means first in the list)
  77531. */
  77532. priority: number;
  77533. /**
  77534. * Gets a string describing the action executed by the current optimization
  77535. * @returns description string
  77536. */
  77537. getDescription(): string;
  77538. /**
  77539. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77540. * @param scene defines the current scene where to apply this optimization
  77541. * @param optimizer defines the current optimizer
  77542. * @returns true if everything that can be done was applied
  77543. */
  77544. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77545. /**
  77546. * Creates the SceneOptimization object
  77547. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77548. * @param desc defines the description associated with the optimization
  77549. */
  77550. constructor(
  77551. /**
  77552. * Defines the priority of this optimization (0 by default which means first in the list)
  77553. */
  77554. priority?: number);
  77555. }
  77556. /**
  77557. * Defines an optimization used to reduce the size of render target textures
  77558. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77559. */
  77560. export class TextureOptimization extends SceneOptimization {
  77561. /**
  77562. * Defines the priority of this optimization (0 by default which means first in the list)
  77563. */
  77564. priority: number;
  77565. /**
  77566. * 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
  77567. */
  77568. maximumSize: number;
  77569. /**
  77570. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77571. */
  77572. step: number;
  77573. /**
  77574. * Gets a string describing the action executed by the current optimization
  77575. * @returns description string
  77576. */
  77577. getDescription(): string;
  77578. /**
  77579. * Creates the TextureOptimization object
  77580. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77581. * @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
  77582. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77583. */
  77584. constructor(
  77585. /**
  77586. * Defines the priority of this optimization (0 by default which means first in the list)
  77587. */
  77588. priority?: number,
  77589. /**
  77590. * 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
  77591. */
  77592. maximumSize?: number,
  77593. /**
  77594. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77595. */
  77596. step?: number);
  77597. /**
  77598. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77599. * @param scene defines the current scene where to apply this optimization
  77600. * @param optimizer defines the current optimizer
  77601. * @returns true if everything that can be done was applied
  77602. */
  77603. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77604. }
  77605. /**
  77606. * Defines an optimization used to increase or decrease the rendering resolution
  77607. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77608. */
  77609. export class HardwareScalingOptimization extends SceneOptimization {
  77610. /**
  77611. * Defines the priority of this optimization (0 by default which means first in the list)
  77612. */
  77613. priority: number;
  77614. /**
  77615. * Defines the maximum scale to use (2 by default)
  77616. */
  77617. maximumScale: number;
  77618. /**
  77619. * Defines the step to use between two passes (0.5 by default)
  77620. */
  77621. step: number;
  77622. private _currentScale;
  77623. private _directionOffset;
  77624. /**
  77625. * Gets a string describing the action executed by the current optimization
  77626. * @return description string
  77627. */
  77628. getDescription(): string;
  77629. /**
  77630. * Creates the HardwareScalingOptimization object
  77631. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77632. * @param maximumScale defines the maximum scale to use (2 by default)
  77633. * @param step defines the step to use between two passes (0.5 by default)
  77634. */
  77635. constructor(
  77636. /**
  77637. * Defines the priority of this optimization (0 by default which means first in the list)
  77638. */
  77639. priority?: number,
  77640. /**
  77641. * Defines the maximum scale to use (2 by default)
  77642. */
  77643. maximumScale?: number,
  77644. /**
  77645. * Defines the step to use between two passes (0.5 by default)
  77646. */
  77647. step?: number);
  77648. /**
  77649. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77650. * @param scene defines the current scene where to apply this optimization
  77651. * @param optimizer defines the current optimizer
  77652. * @returns true if everything that can be done was applied
  77653. */
  77654. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77655. }
  77656. /**
  77657. * Defines an optimization used to remove shadows
  77658. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77659. */
  77660. export class ShadowsOptimization extends SceneOptimization {
  77661. /**
  77662. * Gets a string describing the action executed by the current optimization
  77663. * @return description string
  77664. */
  77665. getDescription(): string;
  77666. /**
  77667. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77668. * @param scene defines the current scene where to apply this optimization
  77669. * @param optimizer defines the current optimizer
  77670. * @returns true if everything that can be done was applied
  77671. */
  77672. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77673. }
  77674. /**
  77675. * Defines an optimization used to turn post-processes off
  77676. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77677. */
  77678. export class PostProcessesOptimization extends SceneOptimization {
  77679. /**
  77680. * Gets a string describing the action executed by the current optimization
  77681. * @return description string
  77682. */
  77683. getDescription(): string;
  77684. /**
  77685. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77686. * @param scene defines the current scene where to apply this optimization
  77687. * @param optimizer defines the current optimizer
  77688. * @returns true if everything that can be done was applied
  77689. */
  77690. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77691. }
  77692. /**
  77693. * Defines an optimization used to turn lens flares off
  77694. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77695. */
  77696. export class LensFlaresOptimization extends SceneOptimization {
  77697. /**
  77698. * Gets a string describing the action executed by the current optimization
  77699. * @return description string
  77700. */
  77701. getDescription(): string;
  77702. /**
  77703. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77704. * @param scene defines the current scene where to apply this optimization
  77705. * @param optimizer defines the current optimizer
  77706. * @returns true if everything that can be done was applied
  77707. */
  77708. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77709. }
  77710. /**
  77711. * Defines an optimization based on user defined callback.
  77712. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77713. */
  77714. export class CustomOptimization extends SceneOptimization {
  77715. /**
  77716. * Callback called to apply the custom optimization.
  77717. */
  77718. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77719. /**
  77720. * Callback called to get custom description
  77721. */
  77722. onGetDescription: () => string;
  77723. /**
  77724. * Gets a string describing the action executed by the current optimization
  77725. * @returns description string
  77726. */
  77727. getDescription(): string;
  77728. /**
  77729. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77730. * @param scene defines the current scene where to apply this optimization
  77731. * @param optimizer defines the current optimizer
  77732. * @returns true if everything that can be done was applied
  77733. */
  77734. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77735. }
  77736. /**
  77737. * Defines an optimization used to turn particles off
  77738. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77739. */
  77740. export class ParticlesOptimization extends SceneOptimization {
  77741. /**
  77742. * Gets a string describing the action executed by the current optimization
  77743. * @return description string
  77744. */
  77745. getDescription(): string;
  77746. /**
  77747. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77748. * @param scene defines the current scene where to apply this optimization
  77749. * @param optimizer defines the current optimizer
  77750. * @returns true if everything that can be done was applied
  77751. */
  77752. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77753. }
  77754. /**
  77755. * Defines an optimization used to turn render targets off
  77756. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77757. */
  77758. export class RenderTargetsOptimization extends SceneOptimization {
  77759. /**
  77760. * Gets a string describing the action executed by the current optimization
  77761. * @return description string
  77762. */
  77763. getDescription(): string;
  77764. /**
  77765. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77766. * @param scene defines the current scene where to apply this optimization
  77767. * @param optimizer defines the current optimizer
  77768. * @returns true if everything that can be done was applied
  77769. */
  77770. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77771. }
  77772. /**
  77773. * Defines an optimization used to merge meshes with compatible materials
  77774. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77775. */
  77776. export class MergeMeshesOptimization extends SceneOptimization {
  77777. private static _UpdateSelectionTree;
  77778. /**
  77779. * Gets or sets a boolean which defines if optimization octree has to be updated
  77780. */
  77781. static get UpdateSelectionTree(): boolean;
  77782. /**
  77783. * Gets or sets a boolean which defines if optimization octree has to be updated
  77784. */
  77785. static set UpdateSelectionTree(value: boolean);
  77786. /**
  77787. * Gets a string describing the action executed by the current optimization
  77788. * @return description string
  77789. */
  77790. getDescription(): string;
  77791. private _canBeMerged;
  77792. /**
  77793. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77794. * @param scene defines the current scene where to apply this optimization
  77795. * @param optimizer defines the current optimizer
  77796. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77797. * @returns true if everything that can be done was applied
  77798. */
  77799. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77800. }
  77801. /**
  77802. * Defines a list of options used by SceneOptimizer
  77803. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77804. */
  77805. export class SceneOptimizerOptions {
  77806. /**
  77807. * Defines the target frame rate to reach (60 by default)
  77808. */
  77809. targetFrameRate: number;
  77810. /**
  77811. * Defines the interval between two checkes (2000ms by default)
  77812. */
  77813. trackerDuration: number;
  77814. /**
  77815. * Gets the list of optimizations to apply
  77816. */
  77817. optimizations: SceneOptimization[];
  77818. /**
  77819. * Creates a new list of options used by SceneOptimizer
  77820. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77821. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77822. */
  77823. constructor(
  77824. /**
  77825. * Defines the target frame rate to reach (60 by default)
  77826. */
  77827. targetFrameRate?: number,
  77828. /**
  77829. * Defines the interval between two checkes (2000ms by default)
  77830. */
  77831. trackerDuration?: number);
  77832. /**
  77833. * Add a new optimization
  77834. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77835. * @returns the current SceneOptimizerOptions
  77836. */
  77837. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77838. /**
  77839. * Add a new custom optimization
  77840. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77841. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77842. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77843. * @returns the current SceneOptimizerOptions
  77844. */
  77845. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77846. /**
  77847. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77848. * @param targetFrameRate defines the target frame rate (60 by default)
  77849. * @returns a SceneOptimizerOptions object
  77850. */
  77851. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77852. /**
  77853. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77854. * @param targetFrameRate defines the target frame rate (60 by default)
  77855. * @returns a SceneOptimizerOptions object
  77856. */
  77857. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77858. /**
  77859. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77860. * @param targetFrameRate defines the target frame rate (60 by default)
  77861. * @returns a SceneOptimizerOptions object
  77862. */
  77863. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77864. }
  77865. /**
  77866. * Class used to run optimizations in order to reach a target frame rate
  77867. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77868. */
  77869. export class SceneOptimizer implements IDisposable {
  77870. private _isRunning;
  77871. private _options;
  77872. private _scene;
  77873. private _currentPriorityLevel;
  77874. private _targetFrameRate;
  77875. private _trackerDuration;
  77876. private _currentFrameRate;
  77877. private _sceneDisposeObserver;
  77878. private _improvementMode;
  77879. /**
  77880. * Defines an observable called when the optimizer reaches the target frame rate
  77881. */
  77882. onSuccessObservable: Observable<SceneOptimizer>;
  77883. /**
  77884. * Defines an observable called when the optimizer enables an optimization
  77885. */
  77886. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77887. /**
  77888. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77889. */
  77890. onFailureObservable: Observable<SceneOptimizer>;
  77891. /**
  77892. * Gets a boolean indicating if the optimizer is in improvement mode
  77893. */
  77894. get isInImprovementMode(): boolean;
  77895. /**
  77896. * Gets the current priority level (0 at start)
  77897. */
  77898. get currentPriorityLevel(): number;
  77899. /**
  77900. * Gets the current frame rate checked by the SceneOptimizer
  77901. */
  77902. get currentFrameRate(): number;
  77903. /**
  77904. * Gets or sets the current target frame rate (60 by default)
  77905. */
  77906. get targetFrameRate(): number;
  77907. /**
  77908. * Gets or sets the current target frame rate (60 by default)
  77909. */
  77910. set targetFrameRate(value: number);
  77911. /**
  77912. * Gets or sets the current interval between two checks (every 2000ms by default)
  77913. */
  77914. get trackerDuration(): number;
  77915. /**
  77916. * Gets or sets the current interval between two checks (every 2000ms by default)
  77917. */
  77918. set trackerDuration(value: number);
  77919. /**
  77920. * Gets the list of active optimizations
  77921. */
  77922. get optimizations(): SceneOptimization[];
  77923. /**
  77924. * Creates a new SceneOptimizer
  77925. * @param scene defines the scene to work on
  77926. * @param options defines the options to use with the SceneOptimizer
  77927. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77928. * @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)
  77929. */
  77930. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77931. /**
  77932. * Stops the current optimizer
  77933. */
  77934. stop(): void;
  77935. /**
  77936. * Reset the optimizer to initial step (current priority level = 0)
  77937. */
  77938. reset(): void;
  77939. /**
  77940. * Start the optimizer. By default it will try to reach a specific framerate
  77941. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77942. */
  77943. start(): void;
  77944. private _checkCurrentState;
  77945. /**
  77946. * Release all resources
  77947. */
  77948. dispose(): void;
  77949. /**
  77950. * Helper function to create a SceneOptimizer with one single line of code
  77951. * @param scene defines the scene to work on
  77952. * @param options defines the options to use with the SceneOptimizer
  77953. * @param onSuccess defines a callback to call on success
  77954. * @param onFailure defines a callback to call on failure
  77955. * @returns the new SceneOptimizer object
  77956. */
  77957. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77958. }
  77959. }
  77960. declare module "babylonjs/Misc/sceneSerializer" {
  77961. import { Scene } from "babylonjs/scene";
  77962. /**
  77963. * Class used to serialize a scene into a string
  77964. */
  77965. export class SceneSerializer {
  77966. /**
  77967. * Clear cache used by a previous serialization
  77968. */
  77969. static ClearCache(): void;
  77970. /**
  77971. * Serialize a scene into a JSON compatible object
  77972. * @param scene defines the scene to serialize
  77973. * @returns a JSON compatible object
  77974. */
  77975. static Serialize(scene: Scene): any;
  77976. /**
  77977. * Serialize a mesh into a JSON compatible object
  77978. * @param toSerialize defines the mesh to serialize
  77979. * @param withParents defines if parents must be serialized as well
  77980. * @param withChildren defines if children must be serialized as well
  77981. * @returns a JSON compatible object
  77982. */
  77983. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77984. }
  77985. }
  77986. declare module "babylonjs/Misc/textureTools" {
  77987. import { Texture } from "babylonjs/Materials/Textures/texture";
  77988. /**
  77989. * Class used to host texture specific utilities
  77990. */
  77991. export class TextureTools {
  77992. /**
  77993. * Uses the GPU to create a copy texture rescaled at a given size
  77994. * @param texture Texture to copy from
  77995. * @param width defines the desired width
  77996. * @param height defines the desired height
  77997. * @param useBilinearMode defines if bilinear mode has to be used
  77998. * @return the generated texture
  77999. */
  78000. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  78001. }
  78002. }
  78003. declare module "babylonjs/Misc/videoRecorder" {
  78004. import { Nullable } from "babylonjs/types";
  78005. import { Engine } from "babylonjs/Engines/engine";
  78006. /**
  78007. * This represents the different options available for the video capture.
  78008. */
  78009. export interface VideoRecorderOptions {
  78010. /** Defines the mime type of the video. */
  78011. mimeType: string;
  78012. /** Defines the FPS the video should be recorded at. */
  78013. fps: number;
  78014. /** Defines the chunk size for the recording data. */
  78015. recordChunckSize: number;
  78016. /** The audio tracks to attach to the recording. */
  78017. audioTracks?: MediaStreamTrack[];
  78018. }
  78019. /**
  78020. * This can help with recording videos from BabylonJS.
  78021. * This is based on the available WebRTC functionalities of the browser.
  78022. *
  78023. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  78024. */
  78025. export class VideoRecorder {
  78026. private static readonly _defaultOptions;
  78027. /**
  78028. * Returns whether or not the VideoRecorder is available in your browser.
  78029. * @param engine Defines the Babylon Engine.
  78030. * @returns true if supported otherwise false.
  78031. */
  78032. static IsSupported(engine: Engine): boolean;
  78033. private readonly _options;
  78034. private _canvas;
  78035. private _mediaRecorder;
  78036. private _recordedChunks;
  78037. private _fileName;
  78038. private _resolve;
  78039. private _reject;
  78040. /**
  78041. * True when a recording is already in progress.
  78042. */
  78043. get isRecording(): boolean;
  78044. /**
  78045. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  78046. * @param engine Defines the BabylonJS Engine you wish to record.
  78047. * @param options Defines options that can be used to customize the capture.
  78048. */
  78049. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  78050. /**
  78051. * Stops the current recording before the default capture timeout passed in the startRecording function.
  78052. */
  78053. stopRecording(): void;
  78054. /**
  78055. * Starts recording the canvas for a max duration specified in parameters.
  78056. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  78057. * If null no automatic download will start and you can rely on the promise to get the data back.
  78058. * @param maxDuration Defines the maximum recording time in seconds.
  78059. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  78060. * @return A promise callback at the end of the recording with the video data in Blob.
  78061. */
  78062. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  78063. /**
  78064. * Releases internal resources used during the recording.
  78065. */
  78066. dispose(): void;
  78067. private _handleDataAvailable;
  78068. private _handleError;
  78069. private _handleStop;
  78070. }
  78071. }
  78072. declare module "babylonjs/Misc/screenshotTools" {
  78073. import { Camera } from "babylonjs/Cameras/camera";
  78074. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  78075. import { Engine } from "babylonjs/Engines/engine";
  78076. /**
  78077. * Class containing a set of static utilities functions for screenshots
  78078. */
  78079. export class ScreenshotTools {
  78080. /**
  78081. * Captures a screenshot of the current rendering
  78082. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78083. * @param engine defines the rendering engine
  78084. * @param camera defines the source camera
  78085. * @param size This parameter can be set to a single number or to an object with the
  78086. * following (optional) properties: precision, width, height. If a single number is passed,
  78087. * it will be used for both width and height. If an object is passed, the screenshot size
  78088. * will be derived from the parameters. The precision property is a multiplier allowing
  78089. * rendering at a higher or lower resolution
  78090. * @param successCallback defines the callback receives a single parameter which contains the
  78091. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78092. * src parameter of an <img> to display it
  78093. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78094. * Check your browser for supported MIME types
  78095. */
  78096. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78097. /**
  78098. * Captures a screenshot of the current rendering
  78099. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78100. * @param engine defines the rendering engine
  78101. * @param camera defines the source camera
  78102. * @param size This parameter can be set to a single number or to an object with the
  78103. * following (optional) properties: precision, width, height. If a single number is passed,
  78104. * it will be used for both width and height. If an object is passed, the screenshot size
  78105. * will be derived from the parameters. The precision property is a multiplier allowing
  78106. * rendering at a higher or lower resolution
  78107. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78108. * Check your browser for supported MIME types
  78109. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78110. * to the src parameter of an <img> to display it
  78111. */
  78112. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78113. /**
  78114. * Generates an image screenshot from the specified camera.
  78115. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78116. * @param engine The engine to use for rendering
  78117. * @param camera The camera to use for rendering
  78118. * @param size This parameter can be set to a single number or to an object with the
  78119. * following (optional) properties: precision, width, height. If a single number is passed,
  78120. * it will be used for both width and height. If an object is passed, the screenshot size
  78121. * will be derived from the parameters. The precision property is a multiplier allowing
  78122. * rendering at a higher or lower resolution
  78123. * @param successCallback The callback receives a single parameter which contains the
  78124. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78125. * src parameter of an <img> to display it
  78126. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78127. * Check your browser for supported MIME types
  78128. * @param samples Texture samples (default: 1)
  78129. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78130. * @param fileName A name for for the downloaded file.
  78131. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78132. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78133. */
  78134. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  78135. /**
  78136. * Generates an image screenshot from the specified camera.
  78137. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78138. * @param engine The engine to use for rendering
  78139. * @param camera The camera to use for rendering
  78140. * @param size This parameter can be set to a single number or to an object with the
  78141. * following (optional) properties: precision, width, height. If a single number is passed,
  78142. * it will be used for both width and height. If an object is passed, the screenshot size
  78143. * will be derived from the parameters. The precision property is a multiplier allowing
  78144. * rendering at a higher or lower resolution
  78145. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78146. * Check your browser for supported MIME types
  78147. * @param samples Texture samples (default: 1)
  78148. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78149. * @param fileName A name for for the downloaded file.
  78150. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78151. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78152. * to the src parameter of an <img> to display it
  78153. */
  78154. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78155. /**
  78156. * Gets height and width for screenshot size
  78157. * @private
  78158. */
  78159. private static _getScreenshotSize;
  78160. }
  78161. }
  78162. declare module "babylonjs/Misc/dataReader" {
  78163. /**
  78164. * Interface for a data buffer
  78165. */
  78166. export interface IDataBuffer {
  78167. /**
  78168. * Reads bytes from the data buffer.
  78169. * @param byteOffset The byte offset to read
  78170. * @param byteLength The byte length to read
  78171. * @returns A promise that resolves when the bytes are read
  78172. */
  78173. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78174. /**
  78175. * The byte length of the buffer.
  78176. */
  78177. readonly byteLength: number;
  78178. }
  78179. /**
  78180. * Utility class for reading from a data buffer
  78181. */
  78182. export class DataReader {
  78183. /**
  78184. * The data buffer associated with this data reader.
  78185. */
  78186. readonly buffer: IDataBuffer;
  78187. /**
  78188. * The current byte offset from the beginning of the data buffer.
  78189. */
  78190. byteOffset: number;
  78191. private _dataView;
  78192. private _dataByteOffset;
  78193. /**
  78194. * Constructor
  78195. * @param buffer The buffer to read
  78196. */
  78197. constructor(buffer: IDataBuffer);
  78198. /**
  78199. * Loads the given byte length.
  78200. * @param byteLength The byte length to load
  78201. * @returns A promise that resolves when the load is complete
  78202. */
  78203. loadAsync(byteLength: number): Promise<void>;
  78204. /**
  78205. * Read a unsigned 32-bit integer from the currently loaded data range.
  78206. * @returns The 32-bit integer read
  78207. */
  78208. readUint32(): number;
  78209. /**
  78210. * Read a byte array from the currently loaded data range.
  78211. * @param byteLength The byte length to read
  78212. * @returns The byte array read
  78213. */
  78214. readUint8Array(byteLength: number): Uint8Array;
  78215. /**
  78216. * Read a string from the currently loaded data range.
  78217. * @param byteLength The byte length to read
  78218. * @returns The string read
  78219. */
  78220. readString(byteLength: number): string;
  78221. /**
  78222. * Skips the given byte length the currently loaded data range.
  78223. * @param byteLength The byte length to skip
  78224. */
  78225. skipBytes(byteLength: number): void;
  78226. }
  78227. }
  78228. declare module "babylonjs/Misc/dataStorage" {
  78229. /**
  78230. * Class for storing data to local storage if available or in-memory storage otherwise
  78231. */
  78232. export class DataStorage {
  78233. private static _Storage;
  78234. private static _GetStorage;
  78235. /**
  78236. * Reads a string from the data storage
  78237. * @param key The key to read
  78238. * @param defaultValue The value if the key doesn't exist
  78239. * @returns The string value
  78240. */
  78241. static ReadString(key: string, defaultValue: string): string;
  78242. /**
  78243. * Writes a string to the data storage
  78244. * @param key The key to write
  78245. * @param value The value to write
  78246. */
  78247. static WriteString(key: string, value: string): void;
  78248. /**
  78249. * Reads a boolean from the data storage
  78250. * @param key The key to read
  78251. * @param defaultValue The value if the key doesn't exist
  78252. * @returns The boolean value
  78253. */
  78254. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78255. /**
  78256. * Writes a boolean to the data storage
  78257. * @param key The key to write
  78258. * @param value The value to write
  78259. */
  78260. static WriteBoolean(key: string, value: boolean): void;
  78261. /**
  78262. * Reads a number from the data storage
  78263. * @param key The key to read
  78264. * @param defaultValue The value if the key doesn't exist
  78265. * @returns The number value
  78266. */
  78267. static ReadNumber(key: string, defaultValue: number): number;
  78268. /**
  78269. * Writes a number to the data storage
  78270. * @param key The key to write
  78271. * @param value The value to write
  78272. */
  78273. static WriteNumber(key: string, value: number): void;
  78274. }
  78275. }
  78276. declare module "babylonjs/Misc/sceneRecorder" {
  78277. import { Scene } from "babylonjs/scene";
  78278. /**
  78279. * Class used to record delta files between 2 scene states
  78280. */
  78281. export class SceneRecorder {
  78282. private _trackedScene;
  78283. private _savedJSON;
  78284. /**
  78285. * Track a given scene. This means the current scene state will be considered the original state
  78286. * @param scene defines the scene to track
  78287. */
  78288. track(scene: Scene): void;
  78289. /**
  78290. * Get the delta between current state and original state
  78291. * @returns a string containing the delta
  78292. */
  78293. getDelta(): any;
  78294. private _compareArray;
  78295. private _compareObjects;
  78296. private _compareCollections;
  78297. private static GetShadowGeneratorById;
  78298. /**
  78299. * Apply a given delta to a given scene
  78300. * @param deltaJSON defines the JSON containing the delta
  78301. * @param scene defines the scene to apply the delta to
  78302. */
  78303. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78304. private static _ApplyPropertiesToEntity;
  78305. private static _ApplyDeltaForEntity;
  78306. }
  78307. }
  78308. declare module "babylonjs/Misc/index" {
  78309. export * from "babylonjs/Misc/andOrNotEvaluator";
  78310. export * from "babylonjs/Misc/assetsManager";
  78311. export * from "babylonjs/Misc/basis";
  78312. export * from "babylonjs/Misc/dds";
  78313. export * from "babylonjs/Misc/decorators";
  78314. export * from "babylonjs/Misc/deferred";
  78315. export * from "babylonjs/Misc/environmentTextureTools";
  78316. export * from "babylonjs/Misc/meshExploder";
  78317. export * from "babylonjs/Misc/filesInput";
  78318. export * from "babylonjs/Misc/HighDynamicRange/index";
  78319. export * from "babylonjs/Misc/khronosTextureContainer";
  78320. export * from "babylonjs/Misc/observable";
  78321. export * from "babylonjs/Misc/performanceMonitor";
  78322. export * from "babylonjs/Misc/promise";
  78323. export * from "babylonjs/Misc/sceneOptimizer";
  78324. export * from "babylonjs/Misc/sceneSerializer";
  78325. export * from "babylonjs/Misc/smartArray";
  78326. export * from "babylonjs/Misc/stringDictionary";
  78327. export * from "babylonjs/Misc/tags";
  78328. export * from "babylonjs/Misc/textureTools";
  78329. export * from "babylonjs/Misc/tga";
  78330. export * from "babylonjs/Misc/tools";
  78331. export * from "babylonjs/Misc/videoRecorder";
  78332. export * from "babylonjs/Misc/virtualJoystick";
  78333. export * from "babylonjs/Misc/workerPool";
  78334. export * from "babylonjs/Misc/logger";
  78335. export * from "babylonjs/Misc/typeStore";
  78336. export * from "babylonjs/Misc/filesInputStore";
  78337. export * from "babylonjs/Misc/deepCopier";
  78338. export * from "babylonjs/Misc/pivotTools";
  78339. export * from "babylonjs/Misc/precisionDate";
  78340. export * from "babylonjs/Misc/screenshotTools";
  78341. export * from "babylonjs/Misc/typeStore";
  78342. export * from "babylonjs/Misc/webRequest";
  78343. export * from "babylonjs/Misc/iInspectable";
  78344. export * from "babylonjs/Misc/brdfTextureTools";
  78345. export * from "babylonjs/Misc/rgbdTextureTools";
  78346. export * from "babylonjs/Misc/gradients";
  78347. export * from "babylonjs/Misc/perfCounter";
  78348. export * from "babylonjs/Misc/fileRequest";
  78349. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78350. export * from "babylonjs/Misc/retryStrategy";
  78351. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78352. export * from "babylonjs/Misc/canvasGenerator";
  78353. export * from "babylonjs/Misc/fileTools";
  78354. export * from "babylonjs/Misc/stringTools";
  78355. export * from "babylonjs/Misc/dataReader";
  78356. export * from "babylonjs/Misc/minMaxReducer";
  78357. export * from "babylonjs/Misc/depthReducer";
  78358. export * from "babylonjs/Misc/dataStorage";
  78359. export * from "babylonjs/Misc/sceneRecorder";
  78360. }
  78361. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78362. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78363. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78364. import { Observable } from "babylonjs/Misc/observable";
  78365. import { Matrix } from "babylonjs/Maths/math.vector";
  78366. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78367. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78368. /**
  78369. * An interface for all Hit test features
  78370. */
  78371. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78372. /**
  78373. * Triggered when new babylon (transformed) hit test results are available
  78374. */
  78375. onHitTestResultObservable: Observable<T[]>;
  78376. }
  78377. /**
  78378. * Options used for hit testing
  78379. */
  78380. export interface IWebXRLegacyHitTestOptions {
  78381. /**
  78382. * Only test when user interacted with the scene. Default - hit test every frame
  78383. */
  78384. testOnPointerDownOnly?: boolean;
  78385. /**
  78386. * The node to use to transform the local results to world coordinates
  78387. */
  78388. worldParentNode?: TransformNode;
  78389. }
  78390. /**
  78391. * Interface defining the babylon result of raycasting/hit-test
  78392. */
  78393. export interface IWebXRLegacyHitResult {
  78394. /**
  78395. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78396. */
  78397. transformationMatrix: Matrix;
  78398. /**
  78399. * The native hit test result
  78400. */
  78401. xrHitResult: XRHitResult | XRHitTestResult;
  78402. }
  78403. /**
  78404. * The currently-working hit-test module.
  78405. * Hit test (or Ray-casting) is used to interact with the real world.
  78406. * For further information read here - https://github.com/immersive-web/hit-test
  78407. */
  78408. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78409. /**
  78410. * options to use when constructing this feature
  78411. */
  78412. readonly options: IWebXRLegacyHitTestOptions;
  78413. private _direction;
  78414. private _mat;
  78415. private _onSelectEnabled;
  78416. private _origin;
  78417. /**
  78418. * The module's name
  78419. */
  78420. static readonly Name: string;
  78421. /**
  78422. * The (Babylon) version of this module.
  78423. * This is an integer representing the implementation version.
  78424. * This number does not correspond to the WebXR specs version
  78425. */
  78426. static readonly Version: number;
  78427. /**
  78428. * Populated with the last native XR Hit Results
  78429. */
  78430. lastNativeXRHitResults: XRHitResult[];
  78431. /**
  78432. * Triggered when new babylon (transformed) hit test results are available
  78433. */
  78434. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78435. /**
  78436. * Creates a new instance of the (legacy version) hit test feature
  78437. * @param _xrSessionManager an instance of WebXRSessionManager
  78438. * @param options options to use when constructing this feature
  78439. */
  78440. constructor(_xrSessionManager: WebXRSessionManager,
  78441. /**
  78442. * options to use when constructing this feature
  78443. */
  78444. options?: IWebXRLegacyHitTestOptions);
  78445. /**
  78446. * execute a hit test with an XR Ray
  78447. *
  78448. * @param xrSession a native xrSession that will execute this hit test
  78449. * @param xrRay the ray (position and direction) to use for ray-casting
  78450. * @param referenceSpace native XR reference space to use for the hit-test
  78451. * @param filter filter function that will filter the results
  78452. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78453. */
  78454. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78455. /**
  78456. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78457. * @param event the (select) event to use to select with
  78458. * @param referenceSpace the reference space to use for this hit test
  78459. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78460. */
  78461. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78462. /**
  78463. * attach this feature
  78464. * Will usually be called by the features manager
  78465. *
  78466. * @returns true if successful.
  78467. */
  78468. attach(): boolean;
  78469. /**
  78470. * detach this feature.
  78471. * Will usually be called by the features manager
  78472. *
  78473. * @returns true if successful.
  78474. */
  78475. detach(): boolean;
  78476. /**
  78477. * Dispose this feature and all of the resources attached
  78478. */
  78479. dispose(): void;
  78480. protected _onXRFrame(frame: XRFrame): void;
  78481. private _onHitTestResults;
  78482. private _onSelect;
  78483. }
  78484. }
  78485. declare module "babylonjs/XR/features/WebXRHitTest" {
  78486. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78487. import { Observable } from "babylonjs/Misc/observable";
  78488. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78489. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78490. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78491. /**
  78492. * Options used for hit testing (version 2)
  78493. */
  78494. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78495. /**
  78496. * Do not create a permanent hit test. Will usually be used when only
  78497. * transient inputs are needed.
  78498. */
  78499. disablePermanentHitTest?: boolean;
  78500. /**
  78501. * Enable transient (for example touch-based) hit test inspections
  78502. */
  78503. enableTransientHitTest?: boolean;
  78504. /**
  78505. * Offset ray for the permanent hit test
  78506. */
  78507. offsetRay?: Vector3;
  78508. /**
  78509. * Offset ray for the transient hit test
  78510. */
  78511. transientOffsetRay?: Vector3;
  78512. /**
  78513. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78514. */
  78515. useReferenceSpace?: boolean;
  78516. /**
  78517. * Override the default entity type(s) of the hit-test result
  78518. */
  78519. entityTypes?: XRHitTestTrackableType[];
  78520. }
  78521. /**
  78522. * Interface defining the babylon result of hit-test
  78523. */
  78524. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78525. /**
  78526. * The input source that generated this hit test (if transient)
  78527. */
  78528. inputSource?: XRInputSource;
  78529. /**
  78530. * Is this a transient hit test
  78531. */
  78532. isTransient?: boolean;
  78533. /**
  78534. * Position of the hit test result
  78535. */
  78536. position: Vector3;
  78537. /**
  78538. * Rotation of the hit test result
  78539. */
  78540. rotationQuaternion: Quaternion;
  78541. /**
  78542. * The native hit test result
  78543. */
  78544. xrHitResult: XRHitTestResult;
  78545. }
  78546. /**
  78547. * The currently-working hit-test module.
  78548. * Hit test (or Ray-casting) is used to interact with the real world.
  78549. * For further information read here - https://github.com/immersive-web/hit-test
  78550. *
  78551. * Tested on chrome (mobile) 80.
  78552. */
  78553. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78554. /**
  78555. * options to use when constructing this feature
  78556. */
  78557. readonly options: IWebXRHitTestOptions;
  78558. private _tmpMat;
  78559. private _tmpPos;
  78560. private _tmpQuat;
  78561. private _transientXrHitTestSource;
  78562. private _xrHitTestSource;
  78563. private initHitTestSource;
  78564. /**
  78565. * The module's name
  78566. */
  78567. static readonly Name: string;
  78568. /**
  78569. * The (Babylon) version of this module.
  78570. * This is an integer representing the implementation version.
  78571. * This number does not correspond to the WebXR specs version
  78572. */
  78573. static readonly Version: number;
  78574. /**
  78575. * When set to true, each hit test will have its own position/rotation objects
  78576. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78577. * the developers will clone them or copy them as they see fit.
  78578. */
  78579. autoCloneTransformation: boolean;
  78580. /**
  78581. * Triggered when new babylon (transformed) hit test results are available
  78582. */
  78583. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78584. /**
  78585. * Use this to temporarily pause hit test checks.
  78586. */
  78587. paused: boolean;
  78588. /**
  78589. * Creates a new instance of the hit test feature
  78590. * @param _xrSessionManager an instance of WebXRSessionManager
  78591. * @param options options to use when constructing this feature
  78592. */
  78593. constructor(_xrSessionManager: WebXRSessionManager,
  78594. /**
  78595. * options to use when constructing this feature
  78596. */
  78597. options?: IWebXRHitTestOptions);
  78598. /**
  78599. * attach this feature
  78600. * Will usually be called by the features manager
  78601. *
  78602. * @returns true if successful.
  78603. */
  78604. attach(): boolean;
  78605. /**
  78606. * detach this feature.
  78607. * Will usually be called by the features manager
  78608. *
  78609. * @returns true if successful.
  78610. */
  78611. detach(): boolean;
  78612. /**
  78613. * Dispose this feature and all of the resources attached
  78614. */
  78615. dispose(): void;
  78616. protected _onXRFrame(frame: XRFrame): void;
  78617. private _processWebXRHitTestResult;
  78618. }
  78619. }
  78620. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78621. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78622. import { Observable } from "babylonjs/Misc/observable";
  78623. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78624. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78625. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78626. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78627. /**
  78628. * Configuration options of the anchor system
  78629. */
  78630. export interface IWebXRAnchorSystemOptions {
  78631. /**
  78632. * a node that will be used to convert local to world coordinates
  78633. */
  78634. worldParentNode?: TransformNode;
  78635. /**
  78636. * If set to true a reference of the created anchors will be kept until the next session starts
  78637. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78638. */
  78639. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78640. }
  78641. /**
  78642. * A babylon container for an XR Anchor
  78643. */
  78644. export interface IWebXRAnchor {
  78645. /**
  78646. * A babylon-assigned ID for this anchor
  78647. */
  78648. id: number;
  78649. /**
  78650. * Transformation matrix to apply to an object attached to this anchor
  78651. */
  78652. transformationMatrix: Matrix;
  78653. /**
  78654. * The native anchor object
  78655. */
  78656. xrAnchor: XRAnchor;
  78657. /**
  78658. * if defined, this object will be constantly updated by the anchor's position and rotation
  78659. */
  78660. attachedNode?: TransformNode;
  78661. }
  78662. /**
  78663. * An implementation of the anchor system for WebXR.
  78664. * For further information see https://github.com/immersive-web/anchors/
  78665. */
  78666. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78667. private _options;
  78668. private _lastFrameDetected;
  78669. private _trackedAnchors;
  78670. private _referenceSpaceForFrameAnchors;
  78671. private _futureAnchors;
  78672. /**
  78673. * The module's name
  78674. */
  78675. static readonly Name: string;
  78676. /**
  78677. * The (Babylon) version of this module.
  78678. * This is an integer representing the implementation version.
  78679. * This number does not correspond to the WebXR specs version
  78680. */
  78681. static readonly Version: number;
  78682. /**
  78683. * Observers registered here will be executed when a new anchor was added to the session
  78684. */
  78685. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78686. /**
  78687. * Observers registered here will be executed when an anchor was removed from the session
  78688. */
  78689. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78690. /**
  78691. * Observers registered here will be executed when an existing anchor updates
  78692. * This can execute N times every frame
  78693. */
  78694. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78695. /**
  78696. * Set the reference space to use for anchor creation, when not using a hit test.
  78697. * Will default to the session's reference space if not defined
  78698. */
  78699. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78700. /**
  78701. * constructs a new anchor system
  78702. * @param _xrSessionManager an instance of WebXRSessionManager
  78703. * @param _options configuration object for this feature
  78704. */
  78705. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78706. private _tmpVector;
  78707. private _tmpQuaternion;
  78708. private _populateTmpTransformation;
  78709. /**
  78710. * Create a new anchor point using a hit test result at a specific point in the scene
  78711. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78712. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78713. *
  78714. * @param hitTestResult The hit test result to use for this anchor creation
  78715. * @param position an optional position offset for this anchor
  78716. * @param rotationQuaternion an optional rotation offset for this anchor
  78717. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78718. */
  78719. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78720. /**
  78721. * Add a new anchor at a specific position and rotation
  78722. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78723. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78724. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78725. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78726. *
  78727. * @param position the position in which to add an anchor
  78728. * @param rotationQuaternion an optional rotation for the anchor transformation
  78729. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78730. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78731. */
  78732. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78733. /**
  78734. * detach this feature.
  78735. * Will usually be called by the features manager
  78736. *
  78737. * @returns true if successful.
  78738. */
  78739. detach(): boolean;
  78740. /**
  78741. * Dispose this feature and all of the resources attached
  78742. */
  78743. dispose(): void;
  78744. protected _onXRFrame(frame: XRFrame): void;
  78745. /**
  78746. * avoiding using Array.find for global support.
  78747. * @param xrAnchor the plane to find in the array
  78748. */
  78749. private _findIndexInAnchorArray;
  78750. private _updateAnchorWithXRFrame;
  78751. private _createAnchorAtTransformation;
  78752. }
  78753. }
  78754. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78755. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78756. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78757. import { Observable } from "babylonjs/Misc/observable";
  78758. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78759. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78760. /**
  78761. * Options used in the plane detector module
  78762. */
  78763. export interface IWebXRPlaneDetectorOptions {
  78764. /**
  78765. * The node to use to transform the local results to world coordinates
  78766. */
  78767. worldParentNode?: TransformNode;
  78768. /**
  78769. * If set to true a reference of the created planes will be kept until the next session starts
  78770. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78771. */
  78772. doNotRemovePlanesOnSessionEnded?: boolean;
  78773. }
  78774. /**
  78775. * A babylon interface for a WebXR plane.
  78776. * A Plane is actually a polygon, built from N points in space
  78777. *
  78778. * Supported in chrome 79, not supported in canary 81 ATM
  78779. */
  78780. export interface IWebXRPlane {
  78781. /**
  78782. * a babylon-assigned ID for this polygon
  78783. */
  78784. id: number;
  78785. /**
  78786. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78787. */
  78788. polygonDefinition: Array<Vector3>;
  78789. /**
  78790. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78791. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78792. */
  78793. transformationMatrix: Matrix;
  78794. /**
  78795. * the native xr-plane object
  78796. */
  78797. xrPlane: XRPlane;
  78798. }
  78799. /**
  78800. * The plane detector is used to detect planes in the real world when in AR
  78801. * For more information see https://github.com/immersive-web/real-world-geometry/
  78802. */
  78803. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78804. private _options;
  78805. private _detectedPlanes;
  78806. private _enabled;
  78807. private _lastFrameDetected;
  78808. /**
  78809. * The module's name
  78810. */
  78811. static readonly Name: string;
  78812. /**
  78813. * The (Babylon) version of this module.
  78814. * This is an integer representing the implementation version.
  78815. * This number does not correspond to the WebXR specs version
  78816. */
  78817. static readonly Version: number;
  78818. /**
  78819. * Observers registered here will be executed when a new plane was added to the session
  78820. */
  78821. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78822. /**
  78823. * Observers registered here will be executed when a plane is no longer detected in the session
  78824. */
  78825. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78826. /**
  78827. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78828. * This can execute N times every frame
  78829. */
  78830. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78831. /**
  78832. * construct a new Plane Detector
  78833. * @param _xrSessionManager an instance of xr Session manager
  78834. * @param _options configuration to use when constructing this feature
  78835. */
  78836. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78837. /**
  78838. * detach this feature.
  78839. * Will usually be called by the features manager
  78840. *
  78841. * @returns true if successful.
  78842. */
  78843. detach(): boolean;
  78844. /**
  78845. * Dispose this feature and all of the resources attached
  78846. */
  78847. dispose(): void;
  78848. protected _onXRFrame(frame: XRFrame): void;
  78849. private _init;
  78850. private _updatePlaneWithXRPlane;
  78851. /**
  78852. * avoiding using Array.find for global support.
  78853. * @param xrPlane the plane to find in the array
  78854. */
  78855. private findIndexInPlaneArray;
  78856. }
  78857. }
  78858. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78859. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78860. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78861. import { Observable } from "babylonjs/Misc/observable";
  78862. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78863. /**
  78864. * Options interface for the background remover plugin
  78865. */
  78866. export interface IWebXRBackgroundRemoverOptions {
  78867. /**
  78868. * Further background meshes to disable when entering AR
  78869. */
  78870. backgroundMeshes?: AbstractMesh[];
  78871. /**
  78872. * flags to configure the removal of the environment helper.
  78873. * If not set, the entire background will be removed. If set, flags should be set as well.
  78874. */
  78875. environmentHelperRemovalFlags?: {
  78876. /**
  78877. * Should the skybox be removed (default false)
  78878. */
  78879. skyBox?: boolean;
  78880. /**
  78881. * Should the ground be removed (default false)
  78882. */
  78883. ground?: boolean;
  78884. };
  78885. /**
  78886. * don't disable the environment helper
  78887. */
  78888. ignoreEnvironmentHelper?: boolean;
  78889. }
  78890. /**
  78891. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78892. */
  78893. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78894. /**
  78895. * read-only options to be used in this module
  78896. */
  78897. readonly options: IWebXRBackgroundRemoverOptions;
  78898. /**
  78899. * The module's name
  78900. */
  78901. static readonly Name: string;
  78902. /**
  78903. * The (Babylon) version of this module.
  78904. * This is an integer representing the implementation version.
  78905. * This number does not correspond to the WebXR specs version
  78906. */
  78907. static readonly Version: number;
  78908. /**
  78909. * registered observers will be triggered when the background state changes
  78910. */
  78911. onBackgroundStateChangedObservable: Observable<boolean>;
  78912. /**
  78913. * constructs a new background remover module
  78914. * @param _xrSessionManager the session manager for this module
  78915. * @param options read-only options to be used in this module
  78916. */
  78917. constructor(_xrSessionManager: WebXRSessionManager,
  78918. /**
  78919. * read-only options to be used in this module
  78920. */
  78921. options?: IWebXRBackgroundRemoverOptions);
  78922. /**
  78923. * attach this feature
  78924. * Will usually be called by the features manager
  78925. *
  78926. * @returns true if successful.
  78927. */
  78928. attach(): boolean;
  78929. /**
  78930. * detach this feature.
  78931. * Will usually be called by the features manager
  78932. *
  78933. * @returns true if successful.
  78934. */
  78935. detach(): boolean;
  78936. /**
  78937. * Dispose this feature and all of the resources attached
  78938. */
  78939. dispose(): void;
  78940. protected _onXRFrame(_xrFrame: XRFrame): void;
  78941. private _setBackgroundState;
  78942. }
  78943. }
  78944. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78945. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78946. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78947. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78948. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78949. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78950. import { Nullable } from "babylonjs/types";
  78951. /**
  78952. * Options for the controller physics feature
  78953. */
  78954. export class IWebXRControllerPhysicsOptions {
  78955. /**
  78956. * Should the headset get its own impostor
  78957. */
  78958. enableHeadsetImpostor?: boolean;
  78959. /**
  78960. * Optional parameters for the headset impostor
  78961. */
  78962. headsetImpostorParams?: {
  78963. /**
  78964. * The type of impostor to create. Default is sphere
  78965. */
  78966. impostorType: number;
  78967. /**
  78968. * the size of the impostor. Defaults to 10cm
  78969. */
  78970. impostorSize?: number | {
  78971. width: number;
  78972. height: number;
  78973. depth: number;
  78974. };
  78975. /**
  78976. * Friction definitions
  78977. */
  78978. friction?: number;
  78979. /**
  78980. * Restitution
  78981. */
  78982. restitution?: number;
  78983. };
  78984. /**
  78985. * The physics properties of the future impostors
  78986. */
  78987. physicsProperties?: {
  78988. /**
  78989. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78990. * Note that this requires a physics engine that supports mesh impostors!
  78991. */
  78992. useControllerMesh?: boolean;
  78993. /**
  78994. * The type of impostor to create. Default is sphere
  78995. */
  78996. impostorType?: number;
  78997. /**
  78998. * the size of the impostor. Defaults to 10cm
  78999. */
  79000. impostorSize?: number | {
  79001. width: number;
  79002. height: number;
  79003. depth: number;
  79004. };
  79005. /**
  79006. * Friction definitions
  79007. */
  79008. friction?: number;
  79009. /**
  79010. * Restitution
  79011. */
  79012. restitution?: number;
  79013. };
  79014. /**
  79015. * the xr input to use with this pointer selection
  79016. */
  79017. xrInput: WebXRInput;
  79018. }
  79019. /**
  79020. * Add physics impostor to your webxr controllers,
  79021. * including naive calculation of their linear and angular velocity
  79022. */
  79023. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  79024. private readonly _options;
  79025. private _attachController;
  79026. private _controllers;
  79027. private _debugMode;
  79028. private _delta;
  79029. private _headsetImpostor?;
  79030. private _headsetMesh?;
  79031. private _lastTimestamp;
  79032. private _tmpQuaternion;
  79033. private _tmpVector;
  79034. /**
  79035. * The module's name
  79036. */
  79037. static readonly Name: string;
  79038. /**
  79039. * The (Babylon) version of this module.
  79040. * This is an integer representing the implementation version.
  79041. * This number does not correspond to the webxr specs version
  79042. */
  79043. static readonly Version: number;
  79044. /**
  79045. * Construct a new Controller Physics Feature
  79046. * @param _xrSessionManager the corresponding xr session manager
  79047. * @param _options options to create this feature with
  79048. */
  79049. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  79050. /**
  79051. * @hidden
  79052. * enable debugging - will show console outputs and the impostor mesh
  79053. */
  79054. _enablePhysicsDebug(): void;
  79055. /**
  79056. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  79057. * @param xrController the controller to add
  79058. */
  79059. addController(xrController: WebXRInputSource): void;
  79060. /**
  79061. * attach this feature
  79062. * Will usually be called by the features manager
  79063. *
  79064. * @returns true if successful.
  79065. */
  79066. attach(): boolean;
  79067. /**
  79068. * detach this feature.
  79069. * Will usually be called by the features manager
  79070. *
  79071. * @returns true if successful.
  79072. */
  79073. detach(): boolean;
  79074. /**
  79075. * Get the headset impostor, if enabled
  79076. * @returns the impostor
  79077. */
  79078. getHeadsetImpostor(): PhysicsImpostor | undefined;
  79079. /**
  79080. * Get the physics impostor of a specific controller.
  79081. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  79082. * @param controller the controller or the controller id of which to get the impostor
  79083. * @returns the impostor or null
  79084. */
  79085. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79086. /**
  79087. * Update the physics properties provided in the constructor
  79088. * @param newProperties the new properties object
  79089. */
  79090. setPhysicsProperties(newProperties: {
  79091. impostorType?: number;
  79092. impostorSize?: number | {
  79093. width: number;
  79094. height: number;
  79095. depth: number;
  79096. };
  79097. friction?: number;
  79098. restitution?: number;
  79099. }): void;
  79100. protected _onXRFrame(_xrFrame: any): void;
  79101. private _detachController;
  79102. }
  79103. }
  79104. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79105. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79106. import { Observable } from "babylonjs/Misc/observable";
  79107. import { Vector3 } from "babylonjs/Maths/math.vector";
  79108. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79109. /**
  79110. * A babylon interface for a "WebXR" feature point.
  79111. * Represents the position and confidence value of a given feature point.
  79112. */
  79113. export interface IWebXRFeaturePoint {
  79114. /**
  79115. * Represents the position of the feature point in world space.
  79116. */
  79117. position: Vector3;
  79118. /**
  79119. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79120. */
  79121. confidenceValue: number;
  79122. }
  79123. /**
  79124. * The feature point system is used to detect feature points from real world geometry.
  79125. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79126. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79127. */
  79128. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79129. private _enabled;
  79130. private _featurePointCloud;
  79131. /**
  79132. * The module's name
  79133. */
  79134. static readonly Name: string;
  79135. /**
  79136. * The (Babylon) version of this module.
  79137. * This is an integer representing the implementation version.
  79138. * This number does not correspond to the WebXR specs version
  79139. */
  79140. static readonly Version: number;
  79141. /**
  79142. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79143. * Will notify the observers about which feature points have been added.
  79144. */
  79145. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79146. /**
  79147. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79148. * Will notify the observers about which feature points have been updated.
  79149. */
  79150. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79151. /**
  79152. * The current feature point cloud maintained across frames.
  79153. */
  79154. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79155. /**
  79156. * construct the feature point system
  79157. * @param _xrSessionManager an instance of xr Session manager
  79158. */
  79159. constructor(_xrSessionManager: WebXRSessionManager);
  79160. /**
  79161. * Detach this feature.
  79162. * Will usually be called by the features manager
  79163. *
  79164. * @returns true if successful.
  79165. */
  79166. detach(): boolean;
  79167. /**
  79168. * Dispose this feature and all of the resources attached
  79169. */
  79170. dispose(): void;
  79171. /**
  79172. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79173. */
  79174. protected _onXRFrame(frame: XRFrame): void;
  79175. /**
  79176. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79177. */
  79178. private _init;
  79179. }
  79180. }
  79181. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79182. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79183. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79184. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79185. import { Mesh } from "babylonjs/Meshes/mesh";
  79186. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79187. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79188. import { Nullable } from "babylonjs/types";
  79189. import { IDisposable } from "babylonjs/scene";
  79190. import { Observable } from "babylonjs/Misc/observable";
  79191. /**
  79192. * Configuration interface for the hand tracking feature
  79193. */
  79194. export interface IWebXRHandTrackingOptions {
  79195. /**
  79196. * The xrInput that will be used as source for new hands
  79197. */
  79198. xrInput: WebXRInput;
  79199. /**
  79200. * Configuration object for the joint meshes
  79201. */
  79202. jointMeshes?: {
  79203. /**
  79204. * Should the meshes created be invisible (defaults to false)
  79205. */
  79206. invisible?: boolean;
  79207. /**
  79208. * A source mesh to be used to create instances. Defaults to a sphere.
  79209. * This mesh will be the source for all other (25) meshes.
  79210. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79211. */
  79212. sourceMesh?: Mesh;
  79213. /**
  79214. * Should the source mesh stay visible. Defaults to false
  79215. */
  79216. keepOriginalVisible?: boolean;
  79217. /**
  79218. * Scale factor for all instances (defaults to 2)
  79219. */
  79220. scaleFactor?: number;
  79221. /**
  79222. * Should each instance have its own physics impostor
  79223. */
  79224. enablePhysics?: boolean;
  79225. /**
  79226. * If enabled, override default physics properties
  79227. */
  79228. physicsProps?: {
  79229. friction?: number;
  79230. restitution?: number;
  79231. impostorType?: number;
  79232. };
  79233. /**
  79234. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79235. */
  79236. handMesh?: AbstractMesh;
  79237. };
  79238. }
  79239. /**
  79240. * Parts of the hands divided to writs and finger names
  79241. */
  79242. export const enum HandPart {
  79243. /**
  79244. * HandPart - Wrist
  79245. */
  79246. WRIST = "wrist",
  79247. /**
  79248. * HandPart - The THumb
  79249. */
  79250. THUMB = "thumb",
  79251. /**
  79252. * HandPart - Index finger
  79253. */
  79254. INDEX = "index",
  79255. /**
  79256. * HandPart - Middle finger
  79257. */
  79258. MIDDLE = "middle",
  79259. /**
  79260. * HandPart - Ring finger
  79261. */
  79262. RING = "ring",
  79263. /**
  79264. * HandPart - Little finger
  79265. */
  79266. LITTLE = "little"
  79267. }
  79268. /**
  79269. * Representing a single hand (with its corresponding native XRHand object)
  79270. */
  79271. export class WebXRHand implements IDisposable {
  79272. /** the controller to which the hand correlates */
  79273. readonly xrController: WebXRInputSource;
  79274. /** the meshes to be used to track the hand joints */
  79275. readonly trackedMeshes: AbstractMesh[];
  79276. /**
  79277. * Hand-parts definition (key is HandPart)
  79278. */
  79279. handPartsDefinition: {
  79280. [key: string]: number[];
  79281. };
  79282. /**
  79283. * Populate the HandPartsDefinition object.
  79284. * This is called as a side effect since certain browsers don't have XRHand defined.
  79285. */
  79286. private generateHandPartsDefinition;
  79287. /**
  79288. * Construct a new hand object
  79289. * @param xrController the controller to which the hand correlates
  79290. * @param trackedMeshes the meshes to be used to track the hand joints
  79291. */
  79292. constructor(
  79293. /** the controller to which the hand correlates */
  79294. xrController: WebXRInputSource,
  79295. /** the meshes to be used to track the hand joints */
  79296. trackedMeshes: AbstractMesh[]);
  79297. /**
  79298. * Update this hand from the latest xr frame
  79299. * @param xrFrame xrFrame to update from
  79300. * @param referenceSpace The current viewer reference space
  79301. * @param scaleFactor optional scale factor for the meshes
  79302. */
  79303. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79304. /**
  79305. * Get meshes of part of the hand
  79306. * @param part the part of hand to get
  79307. * @returns An array of meshes that correlate to the hand part requested
  79308. */
  79309. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79310. /**
  79311. * Dispose this Hand object
  79312. */
  79313. dispose(): void;
  79314. }
  79315. /**
  79316. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79317. */
  79318. export class WebXRHandTracking extends WebXRAbstractFeature {
  79319. /**
  79320. * options to use when constructing this feature
  79321. */
  79322. readonly options: IWebXRHandTrackingOptions;
  79323. private static _idCounter;
  79324. /**
  79325. * The module's name
  79326. */
  79327. static readonly Name: string;
  79328. /**
  79329. * The (Babylon) version of this module.
  79330. * This is an integer representing the implementation version.
  79331. * This number does not correspond to the WebXR specs version
  79332. */
  79333. static readonly Version: number;
  79334. /**
  79335. * This observable will notify registered observers when a new hand object was added and initialized
  79336. */
  79337. onHandAddedObservable: Observable<WebXRHand>;
  79338. /**
  79339. * This observable will notify its observers right before the hand object is disposed
  79340. */
  79341. onHandRemovedObservable: Observable<WebXRHand>;
  79342. private _hands;
  79343. /**
  79344. * Creates a new instance of the hit test feature
  79345. * @param _xrSessionManager an instance of WebXRSessionManager
  79346. * @param options options to use when constructing this feature
  79347. */
  79348. constructor(_xrSessionManager: WebXRSessionManager,
  79349. /**
  79350. * options to use when constructing this feature
  79351. */
  79352. options: IWebXRHandTrackingOptions);
  79353. /**
  79354. * Check if the needed objects are defined.
  79355. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79356. */
  79357. isCompatible(): boolean;
  79358. /**
  79359. * attach this feature
  79360. * Will usually be called by the features manager
  79361. *
  79362. * @returns true if successful.
  79363. */
  79364. attach(): boolean;
  79365. /**
  79366. * detach this feature.
  79367. * Will usually be called by the features manager
  79368. *
  79369. * @returns true if successful.
  79370. */
  79371. detach(): boolean;
  79372. /**
  79373. * Dispose this feature and all of the resources attached
  79374. */
  79375. dispose(): void;
  79376. /**
  79377. * Get the hand object according to the controller id
  79378. * @param controllerId the controller id to which we want to get the hand
  79379. * @returns null if not found or the WebXRHand object if found
  79380. */
  79381. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79382. /**
  79383. * Get a hand object according to the requested handedness
  79384. * @param handedness the handedness to request
  79385. * @returns null if not found or the WebXRHand object if found
  79386. */
  79387. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79388. protected _onXRFrame(_xrFrame: XRFrame): void;
  79389. private _attachHand;
  79390. private _detachHand;
  79391. }
  79392. }
  79393. declare module "babylonjs/XR/features/index" {
  79394. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79395. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79396. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79397. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79398. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79399. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79400. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79401. export * from "babylonjs/XR/features/WebXRHitTest";
  79402. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79403. export * from "babylonjs/XR/features/WebXRHandTracking";
  79404. }
  79405. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79406. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79408. import { Scene } from "babylonjs/scene";
  79409. /**
  79410. * The motion controller class for all microsoft mixed reality controllers
  79411. */
  79412. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79413. protected readonly _mapping: {
  79414. defaultButton: {
  79415. valueNodeName: string;
  79416. unpressedNodeName: string;
  79417. pressedNodeName: string;
  79418. };
  79419. defaultAxis: {
  79420. valueNodeName: string;
  79421. minNodeName: string;
  79422. maxNodeName: string;
  79423. };
  79424. buttons: {
  79425. "xr-standard-trigger": {
  79426. rootNodeName: string;
  79427. componentProperty: string;
  79428. states: string[];
  79429. };
  79430. "xr-standard-squeeze": {
  79431. rootNodeName: string;
  79432. componentProperty: string;
  79433. states: string[];
  79434. };
  79435. "xr-standard-touchpad": {
  79436. rootNodeName: string;
  79437. labelAnchorNodeName: string;
  79438. touchPointNodeName: string;
  79439. };
  79440. "xr-standard-thumbstick": {
  79441. rootNodeName: string;
  79442. componentProperty: string;
  79443. states: string[];
  79444. };
  79445. };
  79446. axes: {
  79447. "xr-standard-touchpad": {
  79448. "x-axis": {
  79449. rootNodeName: string;
  79450. };
  79451. "y-axis": {
  79452. rootNodeName: string;
  79453. };
  79454. };
  79455. "xr-standard-thumbstick": {
  79456. "x-axis": {
  79457. rootNodeName: string;
  79458. };
  79459. "y-axis": {
  79460. rootNodeName: string;
  79461. };
  79462. };
  79463. };
  79464. };
  79465. /**
  79466. * The base url used to load the left and right controller models
  79467. */
  79468. static MODEL_BASE_URL: string;
  79469. /**
  79470. * The name of the left controller model file
  79471. */
  79472. static MODEL_LEFT_FILENAME: string;
  79473. /**
  79474. * The name of the right controller model file
  79475. */
  79476. static MODEL_RIGHT_FILENAME: string;
  79477. profileId: string;
  79478. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79479. protected _getFilenameAndPath(): {
  79480. filename: string;
  79481. path: string;
  79482. };
  79483. protected _getModelLoadingConstraints(): boolean;
  79484. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79485. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79486. protected _updateModel(): void;
  79487. }
  79488. }
  79489. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79490. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79492. import { Scene } from "babylonjs/scene";
  79493. /**
  79494. * The motion controller class for oculus touch (quest, rift).
  79495. * This class supports legacy mapping as well the standard xr mapping
  79496. */
  79497. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79498. private _forceLegacyControllers;
  79499. private _modelRootNode;
  79500. /**
  79501. * The base url used to load the left and right controller models
  79502. */
  79503. static MODEL_BASE_URL: string;
  79504. /**
  79505. * The name of the left controller model file
  79506. */
  79507. static MODEL_LEFT_FILENAME: string;
  79508. /**
  79509. * The name of the right controller model file
  79510. */
  79511. static MODEL_RIGHT_FILENAME: string;
  79512. /**
  79513. * Base Url for the Quest controller model.
  79514. */
  79515. static QUEST_MODEL_BASE_URL: string;
  79516. profileId: string;
  79517. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79518. protected _getFilenameAndPath(): {
  79519. filename: string;
  79520. path: string;
  79521. };
  79522. protected _getModelLoadingConstraints(): boolean;
  79523. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79524. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79525. protected _updateModel(): void;
  79526. /**
  79527. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79528. * between the touch and touch 2.
  79529. */
  79530. private _isQuest;
  79531. }
  79532. }
  79533. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79534. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79535. import { Scene } from "babylonjs/scene";
  79536. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79537. /**
  79538. * The motion controller class for the standard HTC-Vive controllers
  79539. */
  79540. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79541. private _modelRootNode;
  79542. /**
  79543. * The base url used to load the left and right controller models
  79544. */
  79545. static MODEL_BASE_URL: string;
  79546. /**
  79547. * File name for the controller model.
  79548. */
  79549. static MODEL_FILENAME: string;
  79550. profileId: string;
  79551. /**
  79552. * Create a new Vive motion controller object
  79553. * @param scene the scene to use to create this controller
  79554. * @param gamepadObject the corresponding gamepad object
  79555. * @param handedness the handedness of the controller
  79556. */
  79557. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79558. protected _getFilenameAndPath(): {
  79559. filename: string;
  79560. path: string;
  79561. };
  79562. protected _getModelLoadingConstraints(): boolean;
  79563. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79564. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79565. protected _updateModel(): void;
  79566. }
  79567. }
  79568. declare module "babylonjs/XR/motionController/index" {
  79569. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79570. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79571. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79572. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79573. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79574. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79575. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79576. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79577. }
  79578. declare module "babylonjs/XR/index" {
  79579. export * from "babylonjs/XR/webXRCamera";
  79580. export * from "babylonjs/XR/webXREnterExitUI";
  79581. export * from "babylonjs/XR/webXRExperienceHelper";
  79582. export * from "babylonjs/XR/webXRInput";
  79583. export * from "babylonjs/XR/webXRInputSource";
  79584. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79585. export * from "babylonjs/XR/webXRTypes";
  79586. export * from "babylonjs/XR/webXRSessionManager";
  79587. export * from "babylonjs/XR/webXRDefaultExperience";
  79588. export * from "babylonjs/XR/webXRFeaturesManager";
  79589. export * from "babylonjs/XR/features/index";
  79590. export * from "babylonjs/XR/motionController/index";
  79591. }
  79592. declare module "babylonjs/index" {
  79593. export * from "babylonjs/abstractScene";
  79594. export * from "babylonjs/Actions/index";
  79595. export * from "babylonjs/Animations/index";
  79596. export * from "babylonjs/assetContainer";
  79597. export * from "babylonjs/Audio/index";
  79598. export * from "babylonjs/Behaviors/index";
  79599. export * from "babylonjs/Bones/index";
  79600. export * from "babylonjs/Cameras/index";
  79601. export * from "babylonjs/Collisions/index";
  79602. export * from "babylonjs/Culling/index";
  79603. export * from "babylonjs/Debug/index";
  79604. export * from "babylonjs/DeviceInput/index";
  79605. export * from "babylonjs/Engines/index";
  79606. export * from "babylonjs/Events/index";
  79607. export * from "babylonjs/Gamepads/index";
  79608. export * from "babylonjs/Gizmos/index";
  79609. export * from "babylonjs/Helpers/index";
  79610. export * from "babylonjs/Instrumentation/index";
  79611. export * from "babylonjs/Layers/index";
  79612. export * from "babylonjs/LensFlares/index";
  79613. export * from "babylonjs/Lights/index";
  79614. export * from "babylonjs/Loading/index";
  79615. export * from "babylonjs/Materials/index";
  79616. export * from "babylonjs/Maths/index";
  79617. export * from "babylonjs/Meshes/index";
  79618. export * from "babylonjs/Morph/index";
  79619. export * from "babylonjs/Navigation/index";
  79620. export * from "babylonjs/node";
  79621. export * from "babylonjs/Offline/index";
  79622. export * from "babylonjs/Particles/index";
  79623. export * from "babylonjs/Physics/index";
  79624. export * from "babylonjs/PostProcesses/index";
  79625. export * from "babylonjs/Probes/index";
  79626. export * from "babylonjs/Rendering/index";
  79627. export * from "babylonjs/scene";
  79628. export * from "babylonjs/sceneComponent";
  79629. export * from "babylonjs/Sprites/index";
  79630. export * from "babylonjs/States/index";
  79631. export * from "babylonjs/Misc/index";
  79632. export * from "babylonjs/XR/index";
  79633. export * from "babylonjs/types";
  79634. }
  79635. declare module "babylonjs/Animations/pathCursor" {
  79636. import { Vector3 } from "babylonjs/Maths/math.vector";
  79637. import { Path2 } from "babylonjs/Maths/math.path";
  79638. /**
  79639. * A cursor which tracks a point on a path
  79640. */
  79641. export class PathCursor {
  79642. private path;
  79643. /**
  79644. * Stores path cursor callbacks for when an onchange event is triggered
  79645. */
  79646. private _onchange;
  79647. /**
  79648. * The value of the path cursor
  79649. */
  79650. value: number;
  79651. /**
  79652. * The animation array of the path cursor
  79653. */
  79654. animations: Animation[];
  79655. /**
  79656. * Initializes the path cursor
  79657. * @param path The path to track
  79658. */
  79659. constructor(path: Path2);
  79660. /**
  79661. * Gets the cursor point on the path
  79662. * @returns A point on the path cursor at the cursor location
  79663. */
  79664. getPoint(): Vector3;
  79665. /**
  79666. * Moves the cursor ahead by the step amount
  79667. * @param step The amount to move the cursor forward
  79668. * @returns This path cursor
  79669. */
  79670. moveAhead(step?: number): PathCursor;
  79671. /**
  79672. * Moves the cursor behind by the step amount
  79673. * @param step The amount to move the cursor back
  79674. * @returns This path cursor
  79675. */
  79676. moveBack(step?: number): PathCursor;
  79677. /**
  79678. * Moves the cursor by the step amount
  79679. * If the step amount is greater than one, an exception is thrown
  79680. * @param step The amount to move the cursor
  79681. * @returns This path cursor
  79682. */
  79683. move(step: number): PathCursor;
  79684. /**
  79685. * Ensures that the value is limited between zero and one
  79686. * @returns This path cursor
  79687. */
  79688. private ensureLimits;
  79689. /**
  79690. * Runs onchange callbacks on change (used by the animation engine)
  79691. * @returns This path cursor
  79692. */
  79693. private raiseOnChange;
  79694. /**
  79695. * Executes a function on change
  79696. * @param f A path cursor onchange callback
  79697. * @returns This path cursor
  79698. */
  79699. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79700. }
  79701. }
  79702. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79703. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79704. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79705. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79706. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79707. }
  79708. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79709. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79710. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79711. }
  79712. declare module "babylonjs/Engines/Processors/index" {
  79713. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79714. export * from "babylonjs/Engines/Processors/Expressions/index";
  79715. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79716. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79717. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79718. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79719. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79720. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79721. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79722. }
  79723. declare module "babylonjs/Legacy/legacy" {
  79724. import * as Babylon from "babylonjs/index";
  79725. export * from "babylonjs/index";
  79726. }
  79727. declare module "babylonjs/Shaders/blur.fragment" {
  79728. /** @hidden */
  79729. export var blurPixelShader: {
  79730. name: string;
  79731. shader: string;
  79732. };
  79733. }
  79734. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79735. /** @hidden */
  79736. export var pointCloudVertexDeclaration: {
  79737. name: string;
  79738. shader: string;
  79739. };
  79740. }
  79741. declare module "babylonjs" {
  79742. export * from "babylonjs/Legacy/legacy";
  79743. }
  79744. declare module BABYLON {
  79745. /** Alias type for value that can be null */
  79746. export type Nullable<T> = T | null;
  79747. /**
  79748. * Alias type for number that are floats
  79749. * @ignorenaming
  79750. */
  79751. export type float = number;
  79752. /**
  79753. * Alias type for number that are doubles.
  79754. * @ignorenaming
  79755. */
  79756. export type double = number;
  79757. /**
  79758. * Alias type for number that are integer
  79759. * @ignorenaming
  79760. */
  79761. export type int = number;
  79762. /** Alias type for number array or Float32Array */
  79763. export type FloatArray = number[] | Float32Array;
  79764. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79765. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79766. /**
  79767. * Alias for types that can be used by a Buffer or VertexBuffer.
  79768. */
  79769. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79770. /**
  79771. * Alias type for primitive types
  79772. * @ignorenaming
  79773. */
  79774. type Primitive = undefined | null | boolean | string | number | Function;
  79775. /**
  79776. * Type modifier to make all the properties of an object Readonly
  79777. */
  79778. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79779. /**
  79780. * Type modifier to make all the properties of an object Readonly recursively
  79781. */
  79782. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79783. /**
  79784. * Type modifier to make object properties readonly.
  79785. */
  79786. export type DeepImmutableObject<T> = {
  79787. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79788. };
  79789. /** @hidden */
  79790. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79791. }
  79792. }
  79793. declare module BABYLON {
  79794. /**
  79795. * A class serves as a medium between the observable and its observers
  79796. */
  79797. export class EventState {
  79798. /**
  79799. * Create a new EventState
  79800. * @param mask defines the mask associated with this state
  79801. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79802. * @param target defines the original target of the state
  79803. * @param currentTarget defines the current target of the state
  79804. */
  79805. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79806. /**
  79807. * Initialize the current event state
  79808. * @param mask defines the mask associated with this state
  79809. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79810. * @param target defines the original target of the state
  79811. * @param currentTarget defines the current target of the state
  79812. * @returns the current event state
  79813. */
  79814. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79815. /**
  79816. * An Observer can set this property to true to prevent subsequent observers of being notified
  79817. */
  79818. skipNextObservers: boolean;
  79819. /**
  79820. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79821. */
  79822. mask: number;
  79823. /**
  79824. * The object that originally notified the event
  79825. */
  79826. target?: any;
  79827. /**
  79828. * The current object in the bubbling phase
  79829. */
  79830. currentTarget?: any;
  79831. /**
  79832. * This will be populated with the return value of the last function that was executed.
  79833. * If it is the first function in the callback chain it will be the event data.
  79834. */
  79835. lastReturnValue?: any;
  79836. }
  79837. /**
  79838. * Represent an Observer registered to a given Observable object.
  79839. */
  79840. export class Observer<T> {
  79841. /**
  79842. * Defines the callback to call when the observer is notified
  79843. */
  79844. callback: (eventData: T, eventState: EventState) => void;
  79845. /**
  79846. * Defines the mask of the observer (used to filter notifications)
  79847. */
  79848. mask: number;
  79849. /**
  79850. * Defines the current scope used to restore the JS context
  79851. */
  79852. scope: any;
  79853. /** @hidden */
  79854. _willBeUnregistered: boolean;
  79855. /**
  79856. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79857. */
  79858. unregisterOnNextCall: boolean;
  79859. /**
  79860. * Creates a new observer
  79861. * @param callback defines the callback to call when the observer is notified
  79862. * @param mask defines the mask of the observer (used to filter notifications)
  79863. * @param scope defines the current scope used to restore the JS context
  79864. */
  79865. constructor(
  79866. /**
  79867. * Defines the callback to call when the observer is notified
  79868. */
  79869. callback: (eventData: T, eventState: EventState) => void,
  79870. /**
  79871. * Defines the mask of the observer (used to filter notifications)
  79872. */
  79873. mask: number,
  79874. /**
  79875. * Defines the current scope used to restore the JS context
  79876. */
  79877. scope?: any);
  79878. }
  79879. /**
  79880. * Represent a list of observers registered to multiple Observables object.
  79881. */
  79882. export class MultiObserver<T> {
  79883. private _observers;
  79884. private _observables;
  79885. /**
  79886. * Release associated resources
  79887. */
  79888. dispose(): void;
  79889. /**
  79890. * Raise a callback when one of the observable will notify
  79891. * @param observables defines a list of observables to watch
  79892. * @param callback defines the callback to call on notification
  79893. * @param mask defines the mask used to filter notifications
  79894. * @param scope defines the current scope used to restore the JS context
  79895. * @returns the new MultiObserver
  79896. */
  79897. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79898. }
  79899. /**
  79900. * The Observable class is a simple implementation of the Observable pattern.
  79901. *
  79902. * 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.
  79903. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79904. * 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).
  79905. * 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.
  79906. */
  79907. export class Observable<T> {
  79908. private _observers;
  79909. private _eventState;
  79910. private _onObserverAdded;
  79911. /**
  79912. * Gets the list of observers
  79913. */
  79914. get observers(): Array<Observer<T>>;
  79915. /**
  79916. * Creates a new observable
  79917. * @param onObserverAdded defines a callback to call when a new observer is added
  79918. */
  79919. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79920. /**
  79921. * Create a new Observer with the specified callback
  79922. * @param callback the callback that will be executed for that Observer
  79923. * @param mask the mask used to filter observers
  79924. * @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.
  79925. * @param scope optional scope for the callback to be called from
  79926. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79927. * @returns the new observer created for the callback
  79928. */
  79929. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79930. /**
  79931. * Create a new Observer with the specified callback and unregisters after the next notification
  79932. * @param callback the callback that will be executed for that Observer
  79933. * @returns the new observer created for the callback
  79934. */
  79935. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79936. /**
  79937. * Remove an Observer from the Observable object
  79938. * @param observer the instance of the Observer to remove
  79939. * @returns false if it doesn't belong to this Observable
  79940. */
  79941. remove(observer: Nullable<Observer<T>>): boolean;
  79942. /**
  79943. * Remove a callback from the Observable object
  79944. * @param callback the callback to remove
  79945. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79946. * @returns false if it doesn't belong to this Observable
  79947. */
  79948. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79949. private _deferUnregister;
  79950. private _remove;
  79951. /**
  79952. * Moves the observable to the top of the observer list making it get called first when notified
  79953. * @param observer the observer to move
  79954. */
  79955. makeObserverTopPriority(observer: Observer<T>): void;
  79956. /**
  79957. * Moves the observable to the bottom of the observer list making it get called last when notified
  79958. * @param observer the observer to move
  79959. */
  79960. makeObserverBottomPriority(observer: Observer<T>): void;
  79961. /**
  79962. * Notify all Observers by calling their respective callback with the given data
  79963. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79964. * @param eventData defines the data to send to all observers
  79965. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79966. * @param target defines the original target of the state
  79967. * @param currentTarget defines the current target of the state
  79968. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79969. */
  79970. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79971. /**
  79972. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79973. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79974. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79975. * and it is crucial that all callbacks will be executed.
  79976. * The order of the callbacks is kept, callbacks are not executed parallel.
  79977. *
  79978. * @param eventData The data to be sent to each callback
  79979. * @param mask is used to filter observers defaults to -1
  79980. * @param target defines the callback target (see EventState)
  79981. * @param currentTarget defines he current object in the bubbling phase
  79982. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79983. */
  79984. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79985. /**
  79986. * Notify a specific observer
  79987. * @param observer defines the observer to notify
  79988. * @param eventData defines the data to be sent to each callback
  79989. * @param mask is used to filter observers defaults to -1
  79990. */
  79991. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79992. /**
  79993. * Gets a boolean indicating if the observable has at least one observer
  79994. * @returns true is the Observable has at least one Observer registered
  79995. */
  79996. hasObservers(): boolean;
  79997. /**
  79998. * Clear the list of observers
  79999. */
  80000. clear(): void;
  80001. /**
  80002. * Clone the current observable
  80003. * @returns a new observable
  80004. */
  80005. clone(): Observable<T>;
  80006. /**
  80007. * Does this observable handles observer registered with a given mask
  80008. * @param mask defines the mask to be tested
  80009. * @return whether or not one observer registered with the given mask is handeled
  80010. **/
  80011. hasSpecificMask(mask?: number): boolean;
  80012. }
  80013. }
  80014. declare module BABYLON {
  80015. /**
  80016. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  80017. * Babylon.js
  80018. */
  80019. export class DomManagement {
  80020. /**
  80021. * Checks if the window object exists
  80022. * @returns true if the window object exists
  80023. */
  80024. static IsWindowObjectExist(): boolean;
  80025. /**
  80026. * Checks if the navigator object exists
  80027. * @returns true if the navigator object exists
  80028. */
  80029. static IsNavigatorAvailable(): boolean;
  80030. /**
  80031. * Check if the document object exists
  80032. * @returns true if the document object exists
  80033. */
  80034. static IsDocumentAvailable(): boolean;
  80035. /**
  80036. * Extracts text content from a DOM element hierarchy
  80037. * @param element defines the root element
  80038. * @returns a string
  80039. */
  80040. static GetDOMTextContent(element: HTMLElement): string;
  80041. }
  80042. }
  80043. declare module BABYLON {
  80044. /**
  80045. * Logger used througouht the application to allow configuration of
  80046. * the log level required for the messages.
  80047. */
  80048. export class Logger {
  80049. /**
  80050. * No log
  80051. */
  80052. static readonly NoneLogLevel: number;
  80053. /**
  80054. * Only message logs
  80055. */
  80056. static readonly MessageLogLevel: number;
  80057. /**
  80058. * Only warning logs
  80059. */
  80060. static readonly WarningLogLevel: number;
  80061. /**
  80062. * Only error logs
  80063. */
  80064. static readonly ErrorLogLevel: number;
  80065. /**
  80066. * All logs
  80067. */
  80068. static readonly AllLogLevel: number;
  80069. private static _LogCache;
  80070. /**
  80071. * Gets a value indicating the number of loading errors
  80072. * @ignorenaming
  80073. */
  80074. static errorsCount: number;
  80075. /**
  80076. * Callback called when a new log is added
  80077. */
  80078. static OnNewCacheEntry: (entry: string) => void;
  80079. private static _AddLogEntry;
  80080. private static _FormatMessage;
  80081. private static _LogDisabled;
  80082. private static _LogEnabled;
  80083. private static _WarnDisabled;
  80084. private static _WarnEnabled;
  80085. private static _ErrorDisabled;
  80086. private static _ErrorEnabled;
  80087. /**
  80088. * Log a message to the console
  80089. */
  80090. static Log: (message: string) => void;
  80091. /**
  80092. * Write a warning message to the console
  80093. */
  80094. static Warn: (message: string) => void;
  80095. /**
  80096. * Write an error message to the console
  80097. */
  80098. static Error: (message: string) => void;
  80099. /**
  80100. * Gets current log cache (list of logs)
  80101. */
  80102. static get LogCache(): string;
  80103. /**
  80104. * Clears the log cache
  80105. */
  80106. static ClearLogCache(): void;
  80107. /**
  80108. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80109. */
  80110. static set LogLevels(level: number);
  80111. }
  80112. }
  80113. declare module BABYLON {
  80114. /** @hidden */
  80115. export class _TypeStore {
  80116. /** @hidden */
  80117. static RegisteredTypes: {
  80118. [key: string]: Object;
  80119. };
  80120. /** @hidden */
  80121. static GetClass(fqdn: string): any;
  80122. }
  80123. }
  80124. declare module BABYLON {
  80125. /**
  80126. * Helper to manipulate strings
  80127. */
  80128. export class StringTools {
  80129. /**
  80130. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80131. * @param str Source string
  80132. * @param suffix Suffix to search for in the source string
  80133. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80134. */
  80135. static EndsWith(str: string, suffix: string): boolean;
  80136. /**
  80137. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80138. * @param str Source string
  80139. * @param suffix Suffix to search for in the source string
  80140. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80141. */
  80142. static StartsWith(str: string, suffix: string): boolean;
  80143. /**
  80144. * Decodes a buffer into a string
  80145. * @param buffer The buffer to decode
  80146. * @returns The decoded string
  80147. */
  80148. static Decode(buffer: Uint8Array | Uint16Array): string;
  80149. /**
  80150. * Encode a buffer to a base64 string
  80151. * @param buffer defines the buffer to encode
  80152. * @returns the encoded string
  80153. */
  80154. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80155. /**
  80156. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80157. * @param num the number to convert and pad
  80158. * @param length the expected length of the string
  80159. * @returns the padded string
  80160. */
  80161. static PadNumber(num: number, length: number): string;
  80162. }
  80163. }
  80164. declare module BABYLON {
  80165. /**
  80166. * Class containing a set of static utilities functions for deep copy.
  80167. */
  80168. export class DeepCopier {
  80169. /**
  80170. * Tries to copy an object by duplicating every property
  80171. * @param source defines the source object
  80172. * @param destination defines the target object
  80173. * @param doNotCopyList defines a list of properties to avoid
  80174. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80175. */
  80176. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80177. }
  80178. }
  80179. declare module BABYLON {
  80180. /**
  80181. * Class containing a set of static utilities functions for precision date
  80182. */
  80183. export class PrecisionDate {
  80184. /**
  80185. * Gets either window.performance.now() if supported or Date.now() else
  80186. */
  80187. static get Now(): number;
  80188. }
  80189. }
  80190. declare module BABYLON {
  80191. /** @hidden */
  80192. export class _DevTools {
  80193. static WarnImport(name: string): string;
  80194. }
  80195. }
  80196. declare module BABYLON {
  80197. /**
  80198. * Interface used to define the mechanism to get data from the network
  80199. */
  80200. export interface IWebRequest {
  80201. /**
  80202. * Returns client's response url
  80203. */
  80204. responseURL: string;
  80205. /**
  80206. * Returns client's status
  80207. */
  80208. status: number;
  80209. /**
  80210. * Returns client's status as a text
  80211. */
  80212. statusText: string;
  80213. }
  80214. }
  80215. declare module BABYLON {
  80216. /**
  80217. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80218. */
  80219. export class WebRequest implements IWebRequest {
  80220. private _xhr;
  80221. /**
  80222. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80223. * i.e. when loading files, where the server/service expects an Authorization header
  80224. */
  80225. static CustomRequestHeaders: {
  80226. [key: string]: string;
  80227. };
  80228. /**
  80229. * Add callback functions in this array to update all the requests before they get sent to the network
  80230. */
  80231. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80232. private _injectCustomRequestHeaders;
  80233. /**
  80234. * Gets or sets a function to be called when loading progress changes
  80235. */
  80236. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80237. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80238. /**
  80239. * Returns client's state
  80240. */
  80241. get readyState(): number;
  80242. /**
  80243. * Returns client's status
  80244. */
  80245. get status(): number;
  80246. /**
  80247. * Returns client's status as a text
  80248. */
  80249. get statusText(): string;
  80250. /**
  80251. * Returns client's response
  80252. */
  80253. get response(): any;
  80254. /**
  80255. * Returns client's response url
  80256. */
  80257. get responseURL(): string;
  80258. /**
  80259. * Returns client's response as text
  80260. */
  80261. get responseText(): string;
  80262. /**
  80263. * Gets or sets the expected response type
  80264. */
  80265. get responseType(): XMLHttpRequestResponseType;
  80266. set responseType(value: XMLHttpRequestResponseType);
  80267. /** @hidden */
  80268. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80269. /** @hidden */
  80270. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80271. /**
  80272. * Cancels any network activity
  80273. */
  80274. abort(): void;
  80275. /**
  80276. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80277. * @param body defines an optional request body
  80278. */
  80279. send(body?: Document | BodyInit | null): void;
  80280. /**
  80281. * Sets the request method, request URL
  80282. * @param method defines the method to use (GET, POST, etc..)
  80283. * @param url defines the url to connect with
  80284. */
  80285. open(method: string, url: string): void;
  80286. /**
  80287. * Sets the value of a request header.
  80288. * @param name The name of the header whose value is to be set
  80289. * @param value The value to set as the body of the header
  80290. */
  80291. setRequestHeader(name: string, value: string): void;
  80292. /**
  80293. * Get the string containing the text of a particular header's value.
  80294. * @param name The name of the header
  80295. * @returns The string containing the text of the given header name
  80296. */
  80297. getResponseHeader(name: string): Nullable<string>;
  80298. }
  80299. }
  80300. declare module BABYLON {
  80301. /**
  80302. * File request interface
  80303. */
  80304. export interface IFileRequest {
  80305. /**
  80306. * Raised when the request is complete (success or error).
  80307. */
  80308. onCompleteObservable: Observable<IFileRequest>;
  80309. /**
  80310. * Aborts the request for a file.
  80311. */
  80312. abort: () => void;
  80313. }
  80314. }
  80315. declare module BABYLON {
  80316. /**
  80317. * Define options used to create a render target texture
  80318. */
  80319. export class RenderTargetCreationOptions {
  80320. /**
  80321. * Specifies is mipmaps must be generated
  80322. */
  80323. generateMipMaps?: boolean;
  80324. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80325. generateDepthBuffer?: boolean;
  80326. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80327. generateStencilBuffer?: boolean;
  80328. /** Defines texture type (int by default) */
  80329. type?: number;
  80330. /** Defines sampling mode (trilinear by default) */
  80331. samplingMode?: number;
  80332. /** Defines format (RGBA by default) */
  80333. format?: number;
  80334. }
  80335. }
  80336. declare module BABYLON {
  80337. /** Defines the cross module used constants to avoid circular dependncies */
  80338. export class Constants {
  80339. /** Defines that alpha blending is disabled */
  80340. static readonly ALPHA_DISABLE: number;
  80341. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80342. static readonly ALPHA_ADD: number;
  80343. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80344. static readonly ALPHA_COMBINE: number;
  80345. /** Defines that alpha blending is DEST - SRC * DEST */
  80346. static readonly ALPHA_SUBTRACT: number;
  80347. /** Defines that alpha blending is SRC * DEST */
  80348. static readonly ALPHA_MULTIPLY: number;
  80349. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80350. static readonly ALPHA_MAXIMIZED: number;
  80351. /** Defines that alpha blending is SRC + DEST */
  80352. static readonly ALPHA_ONEONE: number;
  80353. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80354. static readonly ALPHA_PREMULTIPLIED: number;
  80355. /**
  80356. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80357. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80358. */
  80359. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80360. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80361. static readonly ALPHA_INTERPOLATE: number;
  80362. /**
  80363. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80364. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80365. */
  80366. static readonly ALPHA_SCREENMODE: number;
  80367. /**
  80368. * Defines that alpha blending is SRC + DST
  80369. * Alpha will be set to SRC ALPHA + DST ALPHA
  80370. */
  80371. static readonly ALPHA_ONEONE_ONEONE: number;
  80372. /**
  80373. * Defines that alpha blending is SRC * DST ALPHA + DST
  80374. * Alpha will be set to 0
  80375. */
  80376. static readonly ALPHA_ALPHATOCOLOR: number;
  80377. /**
  80378. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80379. */
  80380. static readonly ALPHA_REVERSEONEMINUS: number;
  80381. /**
  80382. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80383. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80384. */
  80385. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80386. /**
  80387. * Defines that alpha blending is SRC + DST
  80388. * Alpha will be set to SRC ALPHA
  80389. */
  80390. static readonly ALPHA_ONEONE_ONEZERO: number;
  80391. /**
  80392. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80393. * Alpha will be set to DST ALPHA
  80394. */
  80395. static readonly ALPHA_EXCLUSION: number;
  80396. /** Defines that alpha blending equation a SUM */
  80397. static readonly ALPHA_EQUATION_ADD: number;
  80398. /** Defines that alpha blending equation a SUBSTRACTION */
  80399. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80400. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80401. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80402. /** Defines that alpha blending equation a MAX operation */
  80403. static readonly ALPHA_EQUATION_MAX: number;
  80404. /** Defines that alpha blending equation a MIN operation */
  80405. static readonly ALPHA_EQUATION_MIN: number;
  80406. /**
  80407. * Defines that alpha blending equation a DARKEN operation:
  80408. * It takes the min of the src and sums the alpha channels.
  80409. */
  80410. static readonly ALPHA_EQUATION_DARKEN: number;
  80411. /** Defines that the ressource is not delayed*/
  80412. static readonly DELAYLOADSTATE_NONE: number;
  80413. /** Defines that the ressource was successfully delay loaded */
  80414. static readonly DELAYLOADSTATE_LOADED: number;
  80415. /** Defines that the ressource is currently delay loading */
  80416. static readonly DELAYLOADSTATE_LOADING: number;
  80417. /** Defines that the ressource is delayed and has not started loading */
  80418. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80419. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80420. static readonly NEVER: number;
  80421. /** 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 */
  80422. static readonly ALWAYS: number;
  80423. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80424. static readonly LESS: number;
  80425. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80426. static readonly EQUAL: number;
  80427. /** 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 */
  80428. static readonly LEQUAL: number;
  80429. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80430. static readonly GREATER: number;
  80431. /** 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 */
  80432. static readonly GEQUAL: number;
  80433. /** 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 */
  80434. static readonly NOTEQUAL: number;
  80435. /** Passed to stencilOperation to specify that stencil value must be kept */
  80436. static readonly KEEP: number;
  80437. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80438. static readonly REPLACE: number;
  80439. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80440. static readonly INCR: number;
  80441. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80442. static readonly DECR: number;
  80443. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80444. static readonly INVERT: number;
  80445. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80446. static readonly INCR_WRAP: number;
  80447. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80448. static readonly DECR_WRAP: number;
  80449. /** Texture is not repeating outside of 0..1 UVs */
  80450. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80451. /** Texture is repeating outside of 0..1 UVs */
  80452. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80453. /** Texture is repeating and mirrored */
  80454. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80455. /** ALPHA */
  80456. static readonly TEXTUREFORMAT_ALPHA: number;
  80457. /** LUMINANCE */
  80458. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80459. /** LUMINANCE_ALPHA */
  80460. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80461. /** RGB */
  80462. static readonly TEXTUREFORMAT_RGB: number;
  80463. /** RGBA */
  80464. static readonly TEXTUREFORMAT_RGBA: number;
  80465. /** RED */
  80466. static readonly TEXTUREFORMAT_RED: number;
  80467. /** RED (2nd reference) */
  80468. static readonly TEXTUREFORMAT_R: number;
  80469. /** RG */
  80470. static readonly TEXTUREFORMAT_RG: number;
  80471. /** RED_INTEGER */
  80472. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80473. /** RED_INTEGER (2nd reference) */
  80474. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80475. /** RG_INTEGER */
  80476. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80477. /** RGB_INTEGER */
  80478. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80479. /** RGBA_INTEGER */
  80480. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80481. /** UNSIGNED_BYTE */
  80482. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80483. /** UNSIGNED_BYTE (2nd reference) */
  80484. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80485. /** FLOAT */
  80486. static readonly TEXTURETYPE_FLOAT: number;
  80487. /** HALF_FLOAT */
  80488. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80489. /** BYTE */
  80490. static readonly TEXTURETYPE_BYTE: number;
  80491. /** SHORT */
  80492. static readonly TEXTURETYPE_SHORT: number;
  80493. /** UNSIGNED_SHORT */
  80494. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80495. /** INT */
  80496. static readonly TEXTURETYPE_INT: number;
  80497. /** UNSIGNED_INT */
  80498. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80499. /** UNSIGNED_SHORT_4_4_4_4 */
  80500. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80501. /** UNSIGNED_SHORT_5_5_5_1 */
  80502. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80503. /** UNSIGNED_SHORT_5_6_5 */
  80504. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80505. /** UNSIGNED_INT_2_10_10_10_REV */
  80506. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80507. /** UNSIGNED_INT_24_8 */
  80508. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80509. /** UNSIGNED_INT_10F_11F_11F_REV */
  80510. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80511. /** UNSIGNED_INT_5_9_9_9_REV */
  80512. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80513. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80514. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80515. /** nearest is mag = nearest and min = nearest and no mip */
  80516. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80517. /** mag = nearest and min = nearest and mip = none */
  80518. static readonly TEXTURE_NEAREST_NEAREST: number;
  80519. /** Bilinear is mag = linear and min = linear and no mip */
  80520. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80521. /** mag = linear and min = linear and mip = none */
  80522. static readonly TEXTURE_LINEAR_LINEAR: number;
  80523. /** Trilinear is mag = linear and min = linear and mip = linear */
  80524. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80525. /** Trilinear is mag = linear and min = linear and mip = linear */
  80526. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80527. /** mag = nearest and min = nearest and mip = nearest */
  80528. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80529. /** mag = nearest and min = linear and mip = nearest */
  80530. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80531. /** mag = nearest and min = linear and mip = linear */
  80532. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80533. /** mag = nearest and min = linear and mip = none */
  80534. static readonly TEXTURE_NEAREST_LINEAR: number;
  80535. /** nearest is mag = nearest and min = nearest and mip = linear */
  80536. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80537. /** mag = linear and min = nearest and mip = nearest */
  80538. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80539. /** mag = linear and min = nearest and mip = linear */
  80540. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80541. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80542. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80543. /** mag = linear and min = nearest and mip = none */
  80544. static readonly TEXTURE_LINEAR_NEAREST: number;
  80545. /** Explicit coordinates mode */
  80546. static readonly TEXTURE_EXPLICIT_MODE: number;
  80547. /** Spherical coordinates mode */
  80548. static readonly TEXTURE_SPHERICAL_MODE: number;
  80549. /** Planar coordinates mode */
  80550. static readonly TEXTURE_PLANAR_MODE: number;
  80551. /** Cubic coordinates mode */
  80552. static readonly TEXTURE_CUBIC_MODE: number;
  80553. /** Projection coordinates mode */
  80554. static readonly TEXTURE_PROJECTION_MODE: number;
  80555. /** Skybox coordinates mode */
  80556. static readonly TEXTURE_SKYBOX_MODE: number;
  80557. /** Inverse Cubic coordinates mode */
  80558. static readonly TEXTURE_INVCUBIC_MODE: number;
  80559. /** Equirectangular coordinates mode */
  80560. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80561. /** Equirectangular Fixed coordinates mode */
  80562. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80563. /** Equirectangular Fixed Mirrored coordinates mode */
  80564. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80565. /** Offline (baking) quality for texture filtering */
  80566. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80567. /** High quality for texture filtering */
  80568. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80569. /** Medium quality for texture filtering */
  80570. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80571. /** Low quality for texture filtering */
  80572. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80573. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80574. static readonly SCALEMODE_FLOOR: number;
  80575. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80576. static readonly SCALEMODE_NEAREST: number;
  80577. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80578. static readonly SCALEMODE_CEILING: number;
  80579. /**
  80580. * The dirty texture flag value
  80581. */
  80582. static readonly MATERIAL_TextureDirtyFlag: number;
  80583. /**
  80584. * The dirty light flag value
  80585. */
  80586. static readonly MATERIAL_LightDirtyFlag: number;
  80587. /**
  80588. * The dirty fresnel flag value
  80589. */
  80590. static readonly MATERIAL_FresnelDirtyFlag: number;
  80591. /**
  80592. * The dirty attribute flag value
  80593. */
  80594. static readonly MATERIAL_AttributesDirtyFlag: number;
  80595. /**
  80596. * The dirty misc flag value
  80597. */
  80598. static readonly MATERIAL_MiscDirtyFlag: number;
  80599. /**
  80600. * The all dirty flag value
  80601. */
  80602. static readonly MATERIAL_AllDirtyFlag: number;
  80603. /**
  80604. * Returns the triangle fill mode
  80605. */
  80606. static readonly MATERIAL_TriangleFillMode: number;
  80607. /**
  80608. * Returns the wireframe mode
  80609. */
  80610. static readonly MATERIAL_WireFrameFillMode: number;
  80611. /**
  80612. * Returns the point fill mode
  80613. */
  80614. static readonly MATERIAL_PointFillMode: number;
  80615. /**
  80616. * Returns the point list draw mode
  80617. */
  80618. static readonly MATERIAL_PointListDrawMode: number;
  80619. /**
  80620. * Returns the line list draw mode
  80621. */
  80622. static readonly MATERIAL_LineListDrawMode: number;
  80623. /**
  80624. * Returns the line loop draw mode
  80625. */
  80626. static readonly MATERIAL_LineLoopDrawMode: number;
  80627. /**
  80628. * Returns the line strip draw mode
  80629. */
  80630. static readonly MATERIAL_LineStripDrawMode: number;
  80631. /**
  80632. * Returns the triangle strip draw mode
  80633. */
  80634. static readonly MATERIAL_TriangleStripDrawMode: number;
  80635. /**
  80636. * Returns the triangle fan draw mode
  80637. */
  80638. static readonly MATERIAL_TriangleFanDrawMode: number;
  80639. /**
  80640. * Stores the clock-wise side orientation
  80641. */
  80642. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80643. /**
  80644. * Stores the counter clock-wise side orientation
  80645. */
  80646. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80647. /**
  80648. * Nothing
  80649. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80650. */
  80651. static readonly ACTION_NothingTrigger: number;
  80652. /**
  80653. * On pick
  80654. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80655. */
  80656. static readonly ACTION_OnPickTrigger: number;
  80657. /**
  80658. * On left pick
  80659. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80660. */
  80661. static readonly ACTION_OnLeftPickTrigger: number;
  80662. /**
  80663. * On right pick
  80664. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80665. */
  80666. static readonly ACTION_OnRightPickTrigger: number;
  80667. /**
  80668. * On center pick
  80669. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80670. */
  80671. static readonly ACTION_OnCenterPickTrigger: number;
  80672. /**
  80673. * On pick down
  80674. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80675. */
  80676. static readonly ACTION_OnPickDownTrigger: number;
  80677. /**
  80678. * On double pick
  80679. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80680. */
  80681. static readonly ACTION_OnDoublePickTrigger: number;
  80682. /**
  80683. * On pick up
  80684. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80685. */
  80686. static readonly ACTION_OnPickUpTrigger: number;
  80687. /**
  80688. * On pick out.
  80689. * This trigger will only be raised if you also declared a OnPickDown
  80690. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80691. */
  80692. static readonly ACTION_OnPickOutTrigger: number;
  80693. /**
  80694. * On long press
  80695. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80696. */
  80697. static readonly ACTION_OnLongPressTrigger: number;
  80698. /**
  80699. * On pointer over
  80700. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80701. */
  80702. static readonly ACTION_OnPointerOverTrigger: number;
  80703. /**
  80704. * On pointer out
  80705. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80706. */
  80707. static readonly ACTION_OnPointerOutTrigger: number;
  80708. /**
  80709. * On every frame
  80710. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80711. */
  80712. static readonly ACTION_OnEveryFrameTrigger: number;
  80713. /**
  80714. * On intersection enter
  80715. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80716. */
  80717. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80718. /**
  80719. * On intersection exit
  80720. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80721. */
  80722. static readonly ACTION_OnIntersectionExitTrigger: number;
  80723. /**
  80724. * On key down
  80725. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80726. */
  80727. static readonly ACTION_OnKeyDownTrigger: number;
  80728. /**
  80729. * On key up
  80730. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80731. */
  80732. static readonly ACTION_OnKeyUpTrigger: number;
  80733. /**
  80734. * Billboard mode will only apply to Y axis
  80735. */
  80736. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80737. /**
  80738. * Billboard mode will apply to all axes
  80739. */
  80740. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80741. /**
  80742. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80743. */
  80744. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80745. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80746. * Test order :
  80747. * Is the bounding sphere outside the frustum ?
  80748. * If not, are the bounding box vertices outside the frustum ?
  80749. * It not, then the cullable object is in the frustum.
  80750. */
  80751. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80752. /** Culling strategy : Bounding Sphere Only.
  80753. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80754. * It's also less accurate than the standard because some not visible objects can still be selected.
  80755. * Test : is the bounding sphere outside the frustum ?
  80756. * If not, then the cullable object is in the frustum.
  80757. */
  80758. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80759. /** Culling strategy : Optimistic Inclusion.
  80760. * This in an inclusion test first, then the standard exclusion test.
  80761. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80762. * 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.
  80763. * Anyway, it's as accurate as the standard strategy.
  80764. * Test :
  80765. * Is the cullable object bounding sphere center in the frustum ?
  80766. * If not, apply the default culling strategy.
  80767. */
  80768. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80769. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80770. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80771. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80772. * 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.
  80773. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80774. * Test :
  80775. * Is the cullable object bounding sphere center in the frustum ?
  80776. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80777. */
  80778. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80779. /**
  80780. * No logging while loading
  80781. */
  80782. static readonly SCENELOADER_NO_LOGGING: number;
  80783. /**
  80784. * Minimal logging while loading
  80785. */
  80786. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80787. /**
  80788. * Summary logging while loading
  80789. */
  80790. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80791. /**
  80792. * Detailled logging while loading
  80793. */
  80794. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80795. /**
  80796. * Prepass texture index for color
  80797. */
  80798. static readonly PREPASS_COLOR_INDEX: number;
  80799. /**
  80800. * Prepass texture index for irradiance
  80801. */
  80802. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80803. /**
  80804. * Prepass texture index for depth + normal
  80805. */
  80806. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80807. /**
  80808. * Prepass texture index for albedo
  80809. */
  80810. static readonly PREPASS_ALBEDO_INDEX: number;
  80811. }
  80812. }
  80813. declare module BABYLON {
  80814. /**
  80815. * This represents the required contract to create a new type of texture loader.
  80816. */
  80817. export interface IInternalTextureLoader {
  80818. /**
  80819. * Defines wether the loader supports cascade loading the different faces.
  80820. */
  80821. supportCascades: boolean;
  80822. /**
  80823. * This returns if the loader support the current file information.
  80824. * @param extension defines the file extension of the file being loaded
  80825. * @param mimeType defines the optional mime type of the file being loaded
  80826. * @returns true if the loader can load the specified file
  80827. */
  80828. canLoad(extension: string, mimeType?: string): boolean;
  80829. /**
  80830. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80831. * @param data contains the texture data
  80832. * @param texture defines the BabylonJS internal texture
  80833. * @param createPolynomials will be true if polynomials have been requested
  80834. * @param onLoad defines the callback to trigger once the texture is ready
  80835. * @param onError defines the callback to trigger in case of error
  80836. */
  80837. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80838. /**
  80839. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80840. * @param data contains the texture data
  80841. * @param texture defines the BabylonJS internal texture
  80842. * @param callback defines the method to call once ready to upload
  80843. */
  80844. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80845. }
  80846. }
  80847. declare module BABYLON {
  80848. /**
  80849. * Class used to store and describe the pipeline context associated with an effect
  80850. */
  80851. export interface IPipelineContext {
  80852. /**
  80853. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80854. */
  80855. isAsync: boolean;
  80856. /**
  80857. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80858. */
  80859. isReady: boolean;
  80860. /** @hidden */
  80861. _getVertexShaderCode(): string | null;
  80862. /** @hidden */
  80863. _getFragmentShaderCode(): string | null;
  80864. /** @hidden */
  80865. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80866. }
  80867. }
  80868. declare module BABYLON {
  80869. /**
  80870. * Class used to store gfx data (like WebGLBuffer)
  80871. */
  80872. export class DataBuffer {
  80873. /**
  80874. * Gets or sets the number of objects referencing this buffer
  80875. */
  80876. references: number;
  80877. /** Gets or sets the size of the underlying buffer */
  80878. capacity: number;
  80879. /**
  80880. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80881. */
  80882. is32Bits: boolean;
  80883. /**
  80884. * Gets the underlying buffer
  80885. */
  80886. get underlyingResource(): any;
  80887. }
  80888. }
  80889. declare module BABYLON {
  80890. /** @hidden */
  80891. export interface IShaderProcessor {
  80892. attributeProcessor?: (attribute: string) => string;
  80893. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80894. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80895. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80896. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80897. lineProcessor?: (line: string, isFragment: boolean) => string;
  80898. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80899. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80900. }
  80901. }
  80902. declare module BABYLON {
  80903. /** @hidden */
  80904. export interface ProcessingOptions {
  80905. defines: string[];
  80906. indexParameters: any;
  80907. isFragment: boolean;
  80908. shouldUseHighPrecisionShader: boolean;
  80909. supportsUniformBuffers: boolean;
  80910. shadersRepository: string;
  80911. includesShadersStore: {
  80912. [key: string]: string;
  80913. };
  80914. processor?: IShaderProcessor;
  80915. version: string;
  80916. platformName: string;
  80917. lookForClosingBracketForUniformBuffer?: boolean;
  80918. }
  80919. }
  80920. declare module BABYLON {
  80921. /** @hidden */
  80922. export class ShaderCodeNode {
  80923. line: string;
  80924. children: ShaderCodeNode[];
  80925. additionalDefineKey?: string;
  80926. additionalDefineValue?: string;
  80927. isValid(preprocessors: {
  80928. [key: string]: string;
  80929. }): boolean;
  80930. process(preprocessors: {
  80931. [key: string]: string;
  80932. }, options: ProcessingOptions): string;
  80933. }
  80934. }
  80935. declare module BABYLON {
  80936. /** @hidden */
  80937. export class ShaderCodeCursor {
  80938. private _lines;
  80939. lineIndex: number;
  80940. get currentLine(): string;
  80941. get canRead(): boolean;
  80942. set lines(value: string[]);
  80943. }
  80944. }
  80945. declare module BABYLON {
  80946. /** @hidden */
  80947. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80948. process(preprocessors: {
  80949. [key: string]: string;
  80950. }, options: ProcessingOptions): string;
  80951. }
  80952. }
  80953. declare module BABYLON {
  80954. /** @hidden */
  80955. export class ShaderDefineExpression {
  80956. isTrue(preprocessors: {
  80957. [key: string]: string;
  80958. }): boolean;
  80959. private static _OperatorPriority;
  80960. private static _Stack;
  80961. static postfixToInfix(postfix: string[]): string;
  80962. static infixToPostfix(infix: string): string[];
  80963. }
  80964. }
  80965. declare module BABYLON {
  80966. /** @hidden */
  80967. export class ShaderCodeTestNode extends ShaderCodeNode {
  80968. testExpression: ShaderDefineExpression;
  80969. isValid(preprocessors: {
  80970. [key: string]: string;
  80971. }): boolean;
  80972. }
  80973. }
  80974. declare module BABYLON {
  80975. /** @hidden */
  80976. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80977. define: string;
  80978. not: boolean;
  80979. constructor(define: string, not?: boolean);
  80980. isTrue(preprocessors: {
  80981. [key: string]: string;
  80982. }): boolean;
  80983. }
  80984. }
  80985. declare module BABYLON {
  80986. /** @hidden */
  80987. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80988. leftOperand: ShaderDefineExpression;
  80989. rightOperand: ShaderDefineExpression;
  80990. isTrue(preprocessors: {
  80991. [key: string]: string;
  80992. }): boolean;
  80993. }
  80994. }
  80995. declare module BABYLON {
  80996. /** @hidden */
  80997. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80998. leftOperand: ShaderDefineExpression;
  80999. rightOperand: ShaderDefineExpression;
  81000. isTrue(preprocessors: {
  81001. [key: string]: string;
  81002. }): boolean;
  81003. }
  81004. }
  81005. declare module BABYLON {
  81006. /** @hidden */
  81007. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  81008. define: string;
  81009. operand: string;
  81010. testValue: string;
  81011. constructor(define: string, operand: string, testValue: string);
  81012. isTrue(preprocessors: {
  81013. [key: string]: string;
  81014. }): boolean;
  81015. }
  81016. }
  81017. declare module BABYLON {
  81018. /**
  81019. * Class used to enable access to offline support
  81020. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  81021. */
  81022. export interface IOfflineProvider {
  81023. /**
  81024. * Gets a boolean indicating if scene must be saved in the database
  81025. */
  81026. enableSceneOffline: boolean;
  81027. /**
  81028. * Gets a boolean indicating if textures must be saved in the database
  81029. */
  81030. enableTexturesOffline: boolean;
  81031. /**
  81032. * Open the offline support and make it available
  81033. * @param successCallback defines the callback to call on success
  81034. * @param errorCallback defines the callback to call on error
  81035. */
  81036. open(successCallback: () => void, errorCallback: () => void): void;
  81037. /**
  81038. * Loads an image from the offline support
  81039. * @param url defines the url to load from
  81040. * @param image defines the target DOM image
  81041. */
  81042. loadImage(url: string, image: HTMLImageElement): void;
  81043. /**
  81044. * Loads a file from offline support
  81045. * @param url defines the URL to load from
  81046. * @param sceneLoaded defines a callback to call on success
  81047. * @param progressCallBack defines a callback to call when progress changed
  81048. * @param errorCallback defines a callback to call on error
  81049. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  81050. */
  81051. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  81052. }
  81053. }
  81054. declare module BABYLON {
  81055. /**
  81056. * Class used to help managing file picking and drag'n'drop
  81057. * File Storage
  81058. */
  81059. export class FilesInputStore {
  81060. /**
  81061. * List of files ready to be loaded
  81062. */
  81063. static FilesToLoad: {
  81064. [key: string]: File;
  81065. };
  81066. }
  81067. }
  81068. declare module BABYLON {
  81069. /**
  81070. * Class used to define a retry strategy when error happens while loading assets
  81071. */
  81072. export class RetryStrategy {
  81073. /**
  81074. * Function used to defines an exponential back off strategy
  81075. * @param maxRetries defines the maximum number of retries (3 by default)
  81076. * @param baseInterval defines the interval between retries
  81077. * @returns the strategy function to use
  81078. */
  81079. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  81080. }
  81081. }
  81082. declare module BABYLON {
  81083. /**
  81084. * @ignore
  81085. * Application error to support additional information when loading a file
  81086. */
  81087. export abstract class BaseError extends Error {
  81088. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81089. }
  81090. }
  81091. declare module BABYLON {
  81092. /** @ignore */
  81093. export class LoadFileError extends BaseError {
  81094. request?: WebRequest;
  81095. file?: File;
  81096. /**
  81097. * Creates a new LoadFileError
  81098. * @param message defines the message of the error
  81099. * @param request defines the optional web request
  81100. * @param file defines the optional file
  81101. */
  81102. constructor(message: string, object?: WebRequest | File);
  81103. }
  81104. /** @ignore */
  81105. export class RequestFileError extends BaseError {
  81106. request: WebRequest;
  81107. /**
  81108. * Creates a new LoadFileError
  81109. * @param message defines the message of the error
  81110. * @param request defines the optional web request
  81111. */
  81112. constructor(message: string, request: WebRequest);
  81113. }
  81114. /** @ignore */
  81115. export class ReadFileError extends BaseError {
  81116. file: File;
  81117. /**
  81118. * Creates a new ReadFileError
  81119. * @param message defines the message of the error
  81120. * @param file defines the optional file
  81121. */
  81122. constructor(message: string, file: File);
  81123. }
  81124. /**
  81125. * @hidden
  81126. */
  81127. export class FileTools {
  81128. /**
  81129. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81130. */
  81131. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81132. /**
  81133. * Gets or sets the base URL to use to load assets
  81134. */
  81135. static BaseUrl: string;
  81136. /**
  81137. * Default behaviour for cors in the application.
  81138. * It can be a string if the expected behavior is identical in the entire app.
  81139. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81140. */
  81141. static CorsBehavior: string | ((url: string | string[]) => string);
  81142. /**
  81143. * Gets or sets a function used to pre-process url before using them to load assets
  81144. */
  81145. static PreprocessUrl: (url: string) => string;
  81146. /**
  81147. * Removes unwanted characters from an url
  81148. * @param url defines the url to clean
  81149. * @returns the cleaned url
  81150. */
  81151. private static _CleanUrl;
  81152. /**
  81153. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81154. * @param url define the url we are trying
  81155. * @param element define the dom element where to configure the cors policy
  81156. */
  81157. static SetCorsBehavior(url: string | string[], element: {
  81158. crossOrigin: string | null;
  81159. }): void;
  81160. /**
  81161. * Loads an image as an HTMLImageElement.
  81162. * @param input url string, ArrayBuffer, or Blob to load
  81163. * @param onLoad callback called when the image successfully loads
  81164. * @param onError callback called when the image fails to load
  81165. * @param offlineProvider offline provider for caching
  81166. * @param mimeType optional mime type
  81167. * @returns the HTMLImageElement of the loaded image
  81168. */
  81169. 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>;
  81170. /**
  81171. * Reads a file from a File object
  81172. * @param file defines the file to load
  81173. * @param onSuccess defines the callback to call when data is loaded
  81174. * @param onProgress defines the callback to call during loading process
  81175. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81176. * @param onError defines the callback to call when an error occurs
  81177. * @returns a file request object
  81178. */
  81179. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81180. /**
  81181. * Loads a file from a url
  81182. * @param url url to load
  81183. * @param onSuccess callback called when the file successfully loads
  81184. * @param onProgress callback called while file is loading (if the server supports this mode)
  81185. * @param offlineProvider defines the offline provider for caching
  81186. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81187. * @param onError callback called when the file fails to load
  81188. * @returns a file request object
  81189. */
  81190. 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;
  81191. /**
  81192. * Loads a file
  81193. * @param url url to load
  81194. * @param onSuccess callback called when the file successfully loads
  81195. * @param onProgress callback called while file is loading (if the server supports this mode)
  81196. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81197. * @param onError callback called when the file fails to load
  81198. * @param onOpened callback called when the web request is opened
  81199. * @returns a file request object
  81200. */
  81201. 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;
  81202. /**
  81203. * Checks if the loaded document was accessed via `file:`-Protocol.
  81204. * @returns boolean
  81205. */
  81206. static IsFileURL(): boolean;
  81207. }
  81208. }
  81209. declare module BABYLON {
  81210. /** @hidden */
  81211. export class ShaderProcessor {
  81212. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81213. private static _ProcessPrecision;
  81214. private static _ExtractOperation;
  81215. private static _BuildSubExpression;
  81216. private static _BuildExpression;
  81217. private static _MoveCursorWithinIf;
  81218. private static _MoveCursor;
  81219. private static _EvaluatePreProcessors;
  81220. private static _PreparePreProcessors;
  81221. private static _ProcessShaderConversion;
  81222. private static _ProcessIncludes;
  81223. /**
  81224. * Loads a file from a url
  81225. * @param url url to load
  81226. * @param onSuccess callback called when the file successfully loads
  81227. * @param onProgress callback called while file is loading (if the server supports this mode)
  81228. * @param offlineProvider defines the offline provider for caching
  81229. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81230. * @param onError callback called when the file fails to load
  81231. * @returns a file request object
  81232. * @hidden
  81233. */
  81234. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  81235. }
  81236. }
  81237. declare module BABYLON {
  81238. /**
  81239. * @hidden
  81240. */
  81241. export interface IColor4Like {
  81242. r: float;
  81243. g: float;
  81244. b: float;
  81245. a: float;
  81246. }
  81247. /**
  81248. * @hidden
  81249. */
  81250. export interface IColor3Like {
  81251. r: float;
  81252. g: float;
  81253. b: float;
  81254. }
  81255. /**
  81256. * @hidden
  81257. */
  81258. export interface IVector4Like {
  81259. x: float;
  81260. y: float;
  81261. z: float;
  81262. w: float;
  81263. }
  81264. /**
  81265. * @hidden
  81266. */
  81267. export interface IVector3Like {
  81268. x: float;
  81269. y: float;
  81270. z: float;
  81271. }
  81272. /**
  81273. * @hidden
  81274. */
  81275. export interface IVector2Like {
  81276. x: float;
  81277. y: float;
  81278. }
  81279. /**
  81280. * @hidden
  81281. */
  81282. export interface IMatrixLike {
  81283. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81284. updateFlag: int;
  81285. }
  81286. /**
  81287. * @hidden
  81288. */
  81289. export interface IViewportLike {
  81290. x: float;
  81291. y: float;
  81292. width: float;
  81293. height: float;
  81294. }
  81295. /**
  81296. * @hidden
  81297. */
  81298. export interface IPlaneLike {
  81299. normal: IVector3Like;
  81300. d: float;
  81301. normalize(): void;
  81302. }
  81303. }
  81304. declare module BABYLON {
  81305. /**
  81306. * Interface used to define common properties for effect fallbacks
  81307. */
  81308. export interface IEffectFallbacks {
  81309. /**
  81310. * Removes the defines that should be removed when falling back.
  81311. * @param currentDefines defines the current define statements for the shader.
  81312. * @param effect defines the current effect we try to compile
  81313. * @returns The resulting defines with defines of the current rank removed.
  81314. */
  81315. reduce(currentDefines: string, effect: Effect): string;
  81316. /**
  81317. * Removes the fallback from the bound mesh.
  81318. */
  81319. unBindMesh(): void;
  81320. /**
  81321. * Checks to see if more fallbacks are still availible.
  81322. */
  81323. hasMoreFallbacks: boolean;
  81324. }
  81325. }
  81326. declare module BABYLON {
  81327. /**
  81328. * Class used to evalaute queries containing `and` and `or` operators
  81329. */
  81330. export class AndOrNotEvaluator {
  81331. /**
  81332. * Evaluate a query
  81333. * @param query defines the query to evaluate
  81334. * @param evaluateCallback defines the callback used to filter result
  81335. * @returns true if the query matches
  81336. */
  81337. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81338. private static _HandleParenthesisContent;
  81339. private static _SimplifyNegation;
  81340. }
  81341. }
  81342. declare module BABYLON {
  81343. /**
  81344. * Class used to store custom tags
  81345. */
  81346. export class Tags {
  81347. /**
  81348. * Adds support for tags on the given object
  81349. * @param obj defines the object to use
  81350. */
  81351. static EnableFor(obj: any): void;
  81352. /**
  81353. * Removes tags support
  81354. * @param obj defines the object to use
  81355. */
  81356. static DisableFor(obj: any): void;
  81357. /**
  81358. * Gets a boolean indicating if the given object has tags
  81359. * @param obj defines the object to use
  81360. * @returns a boolean
  81361. */
  81362. static HasTags(obj: any): boolean;
  81363. /**
  81364. * Gets the tags available on a given object
  81365. * @param obj defines the object to use
  81366. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81367. * @returns the tags
  81368. */
  81369. static GetTags(obj: any, asString?: boolean): any;
  81370. /**
  81371. * Adds tags to an object
  81372. * @param obj defines the object to use
  81373. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81374. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81375. */
  81376. static AddTagsTo(obj: any, tagsString: string): void;
  81377. /**
  81378. * @hidden
  81379. */
  81380. static _AddTagTo(obj: any, tag: string): void;
  81381. /**
  81382. * Removes specific tags from a specific object
  81383. * @param obj defines the object to use
  81384. * @param tagsString defines the tags to remove
  81385. */
  81386. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81387. /**
  81388. * @hidden
  81389. */
  81390. static _RemoveTagFrom(obj: any, tag: string): void;
  81391. /**
  81392. * Defines if tags hosted on an object match a given query
  81393. * @param obj defines the object to use
  81394. * @param tagsQuery defines the tag query
  81395. * @returns a boolean
  81396. */
  81397. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81398. }
  81399. }
  81400. declare module BABYLON {
  81401. /**
  81402. * Scalar computation library
  81403. */
  81404. export class Scalar {
  81405. /**
  81406. * Two pi constants convenient for computation.
  81407. */
  81408. static TwoPi: number;
  81409. /**
  81410. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81411. * @param a number
  81412. * @param b number
  81413. * @param epsilon (default = 1.401298E-45)
  81414. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81415. */
  81416. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81417. /**
  81418. * Returns a string : the upper case translation of the number i to hexadecimal.
  81419. * @param i number
  81420. * @returns the upper case translation of the number i to hexadecimal.
  81421. */
  81422. static ToHex(i: number): string;
  81423. /**
  81424. * Returns -1 if value is negative and +1 is value is positive.
  81425. * @param value the value
  81426. * @returns the value itself if it's equal to zero.
  81427. */
  81428. static Sign(value: number): number;
  81429. /**
  81430. * Returns the value itself if it's between min and max.
  81431. * Returns min if the value is lower than min.
  81432. * Returns max if the value is greater than max.
  81433. * @param value the value to clmap
  81434. * @param min the min value to clamp to (default: 0)
  81435. * @param max the max value to clamp to (default: 1)
  81436. * @returns the clamped value
  81437. */
  81438. static Clamp(value: number, min?: number, max?: number): number;
  81439. /**
  81440. * the log2 of value.
  81441. * @param value the value to compute log2 of
  81442. * @returns the log2 of value.
  81443. */
  81444. static Log2(value: number): number;
  81445. /**
  81446. * Loops the value, so that it is never larger than length and never smaller than 0.
  81447. *
  81448. * This is similar to the modulo operator but it works with floating point numbers.
  81449. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81450. * With t = 5 and length = 2.5, the result would be 0.0.
  81451. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81452. * @param value the value
  81453. * @param length the length
  81454. * @returns the looped value
  81455. */
  81456. static Repeat(value: number, length: number): number;
  81457. /**
  81458. * Normalize the value between 0.0 and 1.0 using min and max values
  81459. * @param value value to normalize
  81460. * @param min max to normalize between
  81461. * @param max min to normalize between
  81462. * @returns the normalized value
  81463. */
  81464. static Normalize(value: number, min: number, max: number): number;
  81465. /**
  81466. * Denormalize the value from 0.0 and 1.0 using min and max values
  81467. * @param normalized value to denormalize
  81468. * @param min max to denormalize between
  81469. * @param max min to denormalize between
  81470. * @returns the denormalized value
  81471. */
  81472. static Denormalize(normalized: number, min: number, max: number): number;
  81473. /**
  81474. * Calculates the shortest difference between two given angles given in degrees.
  81475. * @param current current angle in degrees
  81476. * @param target target angle in degrees
  81477. * @returns the delta
  81478. */
  81479. static DeltaAngle(current: number, target: number): number;
  81480. /**
  81481. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81482. * @param tx value
  81483. * @param length length
  81484. * @returns The returned value will move back and forth between 0 and length
  81485. */
  81486. static PingPong(tx: number, length: number): number;
  81487. /**
  81488. * Interpolates between min and max with smoothing at the limits.
  81489. *
  81490. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81491. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81492. * @param from from
  81493. * @param to to
  81494. * @param tx value
  81495. * @returns the smooth stepped value
  81496. */
  81497. static SmoothStep(from: number, to: number, tx: number): number;
  81498. /**
  81499. * Moves a value current towards target.
  81500. *
  81501. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81502. * Negative values of maxDelta pushes the value away from target.
  81503. * @param current current value
  81504. * @param target target value
  81505. * @param maxDelta max distance to move
  81506. * @returns resulting value
  81507. */
  81508. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81509. /**
  81510. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81511. *
  81512. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81513. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81514. * @param current current value
  81515. * @param target target value
  81516. * @param maxDelta max distance to move
  81517. * @returns resulting angle
  81518. */
  81519. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81520. /**
  81521. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81522. * @param start start value
  81523. * @param end target value
  81524. * @param amount amount to lerp between
  81525. * @returns the lerped value
  81526. */
  81527. static Lerp(start: number, end: number, amount: number): number;
  81528. /**
  81529. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81530. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81531. * @param start start value
  81532. * @param end target value
  81533. * @param amount amount to lerp between
  81534. * @returns the lerped value
  81535. */
  81536. static LerpAngle(start: number, end: number, amount: number): number;
  81537. /**
  81538. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81539. * @param a start value
  81540. * @param b target value
  81541. * @param value value between a and b
  81542. * @returns the inverseLerp value
  81543. */
  81544. static InverseLerp(a: number, b: number, value: number): number;
  81545. /**
  81546. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81547. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81548. * @param value1 spline value
  81549. * @param tangent1 spline value
  81550. * @param value2 spline value
  81551. * @param tangent2 spline value
  81552. * @param amount input value
  81553. * @returns hermite result
  81554. */
  81555. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81556. /**
  81557. * Returns a random float number between and min and max values
  81558. * @param min min value of random
  81559. * @param max max value of random
  81560. * @returns random value
  81561. */
  81562. static RandomRange(min: number, max: number): number;
  81563. /**
  81564. * This function returns percentage of a number in a given range.
  81565. *
  81566. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81567. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81568. * @param number to convert to percentage
  81569. * @param min min range
  81570. * @param max max range
  81571. * @returns the percentage
  81572. */
  81573. static RangeToPercent(number: number, min: number, max: number): number;
  81574. /**
  81575. * This function returns number that corresponds to the percentage in a given range.
  81576. *
  81577. * PercentToRange(0.34,0,100) will return 34.
  81578. * @param percent to convert to number
  81579. * @param min min range
  81580. * @param max max range
  81581. * @returns the number
  81582. */
  81583. static PercentToRange(percent: number, min: number, max: number): number;
  81584. /**
  81585. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81586. * @param angle The angle to normalize in radian.
  81587. * @return The converted angle.
  81588. */
  81589. static NormalizeRadians(angle: number): number;
  81590. }
  81591. }
  81592. declare module BABYLON {
  81593. /**
  81594. * Constant used to convert a value to gamma space
  81595. * @ignorenaming
  81596. */
  81597. export const ToGammaSpace: number;
  81598. /**
  81599. * Constant used to convert a value to linear space
  81600. * @ignorenaming
  81601. */
  81602. export const ToLinearSpace = 2.2;
  81603. /**
  81604. * Constant used to define the minimal number value in Babylon.js
  81605. * @ignorenaming
  81606. */
  81607. let Epsilon: number;
  81608. }
  81609. declare module BABYLON {
  81610. /**
  81611. * Class used to represent a viewport on screen
  81612. */
  81613. export class Viewport {
  81614. /** viewport left coordinate */
  81615. x: number;
  81616. /** viewport top coordinate */
  81617. y: number;
  81618. /**viewport width */
  81619. width: number;
  81620. /** viewport height */
  81621. height: number;
  81622. /**
  81623. * Creates a Viewport object located at (x, y) and sized (width, height)
  81624. * @param x defines viewport left coordinate
  81625. * @param y defines viewport top coordinate
  81626. * @param width defines the viewport width
  81627. * @param height defines the viewport height
  81628. */
  81629. constructor(
  81630. /** viewport left coordinate */
  81631. x: number,
  81632. /** viewport top coordinate */
  81633. y: number,
  81634. /**viewport width */
  81635. width: number,
  81636. /** viewport height */
  81637. height: number);
  81638. /**
  81639. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81640. * @param renderWidth defines the rendering width
  81641. * @param renderHeight defines the rendering height
  81642. * @returns a new Viewport
  81643. */
  81644. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81645. /**
  81646. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81647. * @param renderWidth defines the rendering width
  81648. * @param renderHeight defines the rendering height
  81649. * @param ref defines the target viewport
  81650. * @returns the current viewport
  81651. */
  81652. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81653. /**
  81654. * Returns a new Viewport copied from the current one
  81655. * @returns a new Viewport
  81656. */
  81657. clone(): Viewport;
  81658. }
  81659. }
  81660. declare module BABYLON {
  81661. /**
  81662. * Class containing a set of static utilities functions for arrays.
  81663. */
  81664. export class ArrayTools {
  81665. /**
  81666. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81667. * @param size the number of element to construct and put in the array
  81668. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81669. * @returns a new array filled with new objects
  81670. */
  81671. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81672. }
  81673. }
  81674. declare module BABYLON {
  81675. /**
  81676. * Represents a plane by the equation ax + by + cz + d = 0
  81677. */
  81678. export class Plane {
  81679. private static _TmpMatrix;
  81680. /**
  81681. * Normal of the plane (a,b,c)
  81682. */
  81683. normal: Vector3;
  81684. /**
  81685. * d component of the plane
  81686. */
  81687. d: number;
  81688. /**
  81689. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81690. * @param a a component of the plane
  81691. * @param b b component of the plane
  81692. * @param c c component of the plane
  81693. * @param d d component of the plane
  81694. */
  81695. constructor(a: number, b: number, c: number, d: number);
  81696. /**
  81697. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81698. */
  81699. asArray(): number[];
  81700. /**
  81701. * @returns a new plane copied from the current Plane.
  81702. */
  81703. clone(): Plane;
  81704. /**
  81705. * @returns the string "Plane".
  81706. */
  81707. getClassName(): string;
  81708. /**
  81709. * @returns the Plane hash code.
  81710. */
  81711. getHashCode(): number;
  81712. /**
  81713. * Normalize the current Plane in place.
  81714. * @returns the updated Plane.
  81715. */
  81716. normalize(): Plane;
  81717. /**
  81718. * Applies a transformation the plane and returns the result
  81719. * @param transformation the transformation matrix to be applied to the plane
  81720. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81721. */
  81722. transform(transformation: DeepImmutable<Matrix>): Plane;
  81723. /**
  81724. * Compute the dot product between the point and the plane normal
  81725. * @param point point to calculate the dot product with
  81726. * @returns the dot product (float) of the point coordinates and the plane normal.
  81727. */
  81728. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81729. /**
  81730. * Updates the current Plane from the plane defined by the three given points.
  81731. * @param point1 one of the points used to contruct the plane
  81732. * @param point2 one of the points used to contruct the plane
  81733. * @param point3 one of the points used to contruct the plane
  81734. * @returns the updated Plane.
  81735. */
  81736. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81737. /**
  81738. * Checks if the plane is facing a given direction
  81739. * @param direction the direction to check if the plane is facing
  81740. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81741. * @returns True is the vector "direction" is the same side than the plane normal.
  81742. */
  81743. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81744. /**
  81745. * Calculates the distance to a point
  81746. * @param point point to calculate distance to
  81747. * @returns the signed distance (float) from the given point to the Plane.
  81748. */
  81749. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81750. /**
  81751. * Creates a plane from an array
  81752. * @param array the array to create a plane from
  81753. * @returns a new Plane from the given array.
  81754. */
  81755. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81756. /**
  81757. * Creates a plane from three points
  81758. * @param point1 point used to create the plane
  81759. * @param point2 point used to create the plane
  81760. * @param point3 point used to create the plane
  81761. * @returns a new Plane defined by the three given points.
  81762. */
  81763. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81764. /**
  81765. * Creates a plane from an origin point and a normal
  81766. * @param origin origin of the plane to be constructed
  81767. * @param normal normal of the plane to be constructed
  81768. * @returns a new Plane the normal vector to this plane at the given origin point.
  81769. * Note : the vector "normal" is updated because normalized.
  81770. */
  81771. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81772. /**
  81773. * Calculates the distance from a plane and a point
  81774. * @param origin origin of the plane to be constructed
  81775. * @param normal normal of the plane to be constructed
  81776. * @param point point to calculate distance to
  81777. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81778. */
  81779. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81780. }
  81781. }
  81782. declare module BABYLON {
  81783. /** @hidden */
  81784. export class PerformanceConfigurator {
  81785. /** @hidden */
  81786. static MatrixUse64Bits: boolean;
  81787. /** @hidden */
  81788. static MatrixTrackPrecisionChange: boolean;
  81789. /** @hidden */
  81790. static MatrixCurrentType: any;
  81791. /** @hidden */
  81792. static MatrixTrackedMatrices: Array<any> | null;
  81793. /** @hidden */
  81794. static SetMatrixPrecision(use64bits: boolean): void;
  81795. }
  81796. }
  81797. declare module BABYLON {
  81798. /**
  81799. * Class representing a vector containing 2 coordinates
  81800. */
  81801. export class Vector2 {
  81802. /** defines the first coordinate */
  81803. x: number;
  81804. /** defines the second coordinate */
  81805. y: number;
  81806. /**
  81807. * Creates a new Vector2 from the given x and y coordinates
  81808. * @param x defines the first coordinate
  81809. * @param y defines the second coordinate
  81810. */
  81811. constructor(
  81812. /** defines the first coordinate */
  81813. x?: number,
  81814. /** defines the second coordinate */
  81815. y?: number);
  81816. /**
  81817. * Gets a string with the Vector2 coordinates
  81818. * @returns a string with the Vector2 coordinates
  81819. */
  81820. toString(): string;
  81821. /**
  81822. * Gets class name
  81823. * @returns the string "Vector2"
  81824. */
  81825. getClassName(): string;
  81826. /**
  81827. * Gets current vector hash code
  81828. * @returns the Vector2 hash code as a number
  81829. */
  81830. getHashCode(): number;
  81831. /**
  81832. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81833. * @param array defines the source array
  81834. * @param index defines the offset in source array
  81835. * @returns the current Vector2
  81836. */
  81837. toArray(array: FloatArray, index?: number): Vector2;
  81838. /**
  81839. * Update the current vector from an array
  81840. * @param array defines the destination array
  81841. * @param index defines the offset in the destination array
  81842. * @returns the current Vector3
  81843. */
  81844. fromArray(array: FloatArray, index?: number): Vector2;
  81845. /**
  81846. * Copy the current vector to an array
  81847. * @returns a new array with 2 elements: the Vector2 coordinates.
  81848. */
  81849. asArray(): number[];
  81850. /**
  81851. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81852. * @param source defines the source Vector2
  81853. * @returns the current updated Vector2
  81854. */
  81855. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81856. /**
  81857. * Sets the Vector2 coordinates with the given floats
  81858. * @param x defines the first coordinate
  81859. * @param y defines the second coordinate
  81860. * @returns the current updated Vector2
  81861. */
  81862. copyFromFloats(x: number, y: number): Vector2;
  81863. /**
  81864. * Sets the Vector2 coordinates with the given floats
  81865. * @param x defines the first coordinate
  81866. * @param y defines the second coordinate
  81867. * @returns the current updated Vector2
  81868. */
  81869. set(x: number, y: number): Vector2;
  81870. /**
  81871. * Add another vector with the current one
  81872. * @param otherVector defines the other vector
  81873. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81874. */
  81875. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81876. /**
  81877. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81878. * @param otherVector defines the other vector
  81879. * @param result defines the target vector
  81880. * @returns the unmodified current Vector2
  81881. */
  81882. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81883. /**
  81884. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81885. * @param otherVector defines the other vector
  81886. * @returns the current updated Vector2
  81887. */
  81888. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81889. /**
  81890. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81891. * @param otherVector defines the other vector
  81892. * @returns a new Vector2
  81893. */
  81894. addVector3(otherVector: Vector3): Vector2;
  81895. /**
  81896. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81897. * @param otherVector defines the other vector
  81898. * @returns a new Vector2
  81899. */
  81900. subtract(otherVector: Vector2): Vector2;
  81901. /**
  81902. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81903. * @param otherVector defines the other vector
  81904. * @param result defines the target vector
  81905. * @returns the unmodified current Vector2
  81906. */
  81907. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81908. /**
  81909. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81910. * @param otherVector defines the other vector
  81911. * @returns the current updated Vector2
  81912. */
  81913. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81914. /**
  81915. * Multiplies in place the current Vector2 coordinates by the given ones
  81916. * @param otherVector defines the other vector
  81917. * @returns the current updated Vector2
  81918. */
  81919. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81920. /**
  81921. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81922. * @param otherVector defines the other vector
  81923. * @returns a new Vector2
  81924. */
  81925. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81926. /**
  81927. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81928. * @param otherVector defines the other vector
  81929. * @param result defines the target vector
  81930. * @returns the unmodified current Vector2
  81931. */
  81932. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81933. /**
  81934. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81935. * @param x defines the first coordinate
  81936. * @param y defines the second coordinate
  81937. * @returns a new Vector2
  81938. */
  81939. multiplyByFloats(x: number, y: number): Vector2;
  81940. /**
  81941. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81942. * @param otherVector defines the other vector
  81943. * @returns a new Vector2
  81944. */
  81945. divide(otherVector: Vector2): Vector2;
  81946. /**
  81947. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81948. * @param otherVector defines the other vector
  81949. * @param result defines the target vector
  81950. * @returns the unmodified current Vector2
  81951. */
  81952. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81953. /**
  81954. * Divides the current Vector2 coordinates by the given ones
  81955. * @param otherVector defines the other vector
  81956. * @returns the current updated Vector2
  81957. */
  81958. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81959. /**
  81960. * Gets a new Vector2 with current Vector2 negated coordinates
  81961. * @returns a new Vector2
  81962. */
  81963. negate(): Vector2;
  81964. /**
  81965. * Negate this vector in place
  81966. * @returns this
  81967. */
  81968. negateInPlace(): Vector2;
  81969. /**
  81970. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81971. * @param result defines the Vector3 object where to store the result
  81972. * @returns the current Vector2
  81973. */
  81974. negateToRef(result: Vector2): Vector2;
  81975. /**
  81976. * Multiply the Vector2 coordinates by scale
  81977. * @param scale defines the scaling factor
  81978. * @returns the current updated Vector2
  81979. */
  81980. scaleInPlace(scale: number): Vector2;
  81981. /**
  81982. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81983. * @param scale defines the scaling factor
  81984. * @returns a new Vector2
  81985. */
  81986. scale(scale: number): Vector2;
  81987. /**
  81988. * Scale the current Vector2 values by a factor to a given Vector2
  81989. * @param scale defines the scale factor
  81990. * @param result defines the Vector2 object where to store the result
  81991. * @returns the unmodified current Vector2
  81992. */
  81993. scaleToRef(scale: number, result: Vector2): Vector2;
  81994. /**
  81995. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81996. * @param scale defines the scale factor
  81997. * @param result defines the Vector2 object where to store the result
  81998. * @returns the unmodified current Vector2
  81999. */
  82000. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  82001. /**
  82002. * Gets a boolean if two vectors are equals
  82003. * @param otherVector defines the other vector
  82004. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  82005. */
  82006. equals(otherVector: DeepImmutable<Vector2>): boolean;
  82007. /**
  82008. * Gets a boolean if two vectors are equals (using an epsilon value)
  82009. * @param otherVector defines the other vector
  82010. * @param epsilon defines the minimal distance to consider equality
  82011. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  82012. */
  82013. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  82014. /**
  82015. * Gets a new Vector2 from current Vector2 floored values
  82016. * @returns a new Vector2
  82017. */
  82018. floor(): Vector2;
  82019. /**
  82020. * Gets a new Vector2 from current Vector2 floored values
  82021. * @returns a new Vector2
  82022. */
  82023. fract(): Vector2;
  82024. /**
  82025. * Gets the length of the vector
  82026. * @returns the vector length (float)
  82027. */
  82028. length(): number;
  82029. /**
  82030. * Gets the vector squared length
  82031. * @returns the vector squared length (float)
  82032. */
  82033. lengthSquared(): number;
  82034. /**
  82035. * Normalize the vector
  82036. * @returns the current updated Vector2
  82037. */
  82038. normalize(): Vector2;
  82039. /**
  82040. * Gets a new Vector2 copied from the Vector2
  82041. * @returns a new Vector2
  82042. */
  82043. clone(): Vector2;
  82044. /**
  82045. * Gets a new Vector2(0, 0)
  82046. * @returns a new Vector2
  82047. */
  82048. static Zero(): Vector2;
  82049. /**
  82050. * Gets a new Vector2(1, 1)
  82051. * @returns a new Vector2
  82052. */
  82053. static One(): Vector2;
  82054. /**
  82055. * Gets a new Vector2 set from the given index element of the given array
  82056. * @param array defines the data source
  82057. * @param offset defines the offset in the data source
  82058. * @returns a new Vector2
  82059. */
  82060. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  82061. /**
  82062. * Sets "result" from the given index element of the given array
  82063. * @param array defines the data source
  82064. * @param offset defines the offset in the data source
  82065. * @param result defines the target vector
  82066. */
  82067. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  82068. /**
  82069. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  82070. * @param value1 defines 1st point of control
  82071. * @param value2 defines 2nd point of control
  82072. * @param value3 defines 3rd point of control
  82073. * @param value4 defines 4th point of control
  82074. * @param amount defines the interpolation factor
  82075. * @returns a new Vector2
  82076. */
  82077. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  82078. /**
  82079. * 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".
  82080. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  82081. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  82082. * @param value defines the value to clamp
  82083. * @param min defines the lower limit
  82084. * @param max defines the upper limit
  82085. * @returns a new Vector2
  82086. */
  82087. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82088. /**
  82089. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82090. * @param value1 defines the 1st control point
  82091. * @param tangent1 defines the outgoing tangent
  82092. * @param value2 defines the 2nd control point
  82093. * @param tangent2 defines the incoming tangent
  82094. * @param amount defines the interpolation factor
  82095. * @returns a new Vector2
  82096. */
  82097. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82098. /**
  82099. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82100. * @param start defines the start vector
  82101. * @param end defines the end vector
  82102. * @param amount defines the interpolation factor
  82103. * @returns a new Vector2
  82104. */
  82105. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82106. /**
  82107. * Gets the dot product of the vector "left" and the vector "right"
  82108. * @param left defines first vector
  82109. * @param right defines second vector
  82110. * @returns the dot product (float)
  82111. */
  82112. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82113. /**
  82114. * Returns a new Vector2 equal to the normalized given vector
  82115. * @param vector defines the vector to normalize
  82116. * @returns a new Vector2
  82117. */
  82118. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82119. /**
  82120. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82121. * @param left defines 1st vector
  82122. * @param right defines 2nd vector
  82123. * @returns a new Vector2
  82124. */
  82125. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82126. /**
  82127. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82128. * @param left defines 1st vector
  82129. * @param right defines 2nd vector
  82130. * @returns a new Vector2
  82131. */
  82132. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82133. /**
  82134. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82135. * @param vector defines the vector to transform
  82136. * @param transformation defines the matrix to apply
  82137. * @returns a new Vector2
  82138. */
  82139. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82140. /**
  82141. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82142. * @param vector defines the vector to transform
  82143. * @param transformation defines the matrix to apply
  82144. * @param result defines the target vector
  82145. */
  82146. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82147. /**
  82148. * Determines if a given vector is included in a triangle
  82149. * @param p defines the vector to test
  82150. * @param p0 defines 1st triangle point
  82151. * @param p1 defines 2nd triangle point
  82152. * @param p2 defines 3rd triangle point
  82153. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82154. */
  82155. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82156. /**
  82157. * Gets the distance between the vectors "value1" and "value2"
  82158. * @param value1 defines first vector
  82159. * @param value2 defines second vector
  82160. * @returns the distance between vectors
  82161. */
  82162. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82163. /**
  82164. * Returns the squared distance between the vectors "value1" and "value2"
  82165. * @param value1 defines first vector
  82166. * @param value2 defines second vector
  82167. * @returns the squared distance between vectors
  82168. */
  82169. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82170. /**
  82171. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82172. * @param value1 defines first vector
  82173. * @param value2 defines second vector
  82174. * @returns a new Vector2
  82175. */
  82176. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82177. /**
  82178. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82179. * @param p defines the middle point
  82180. * @param segA defines one point of the segment
  82181. * @param segB defines the other point of the segment
  82182. * @returns the shortest distance
  82183. */
  82184. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82185. }
  82186. /**
  82187. * Class used to store (x,y,z) vector representation
  82188. * A Vector3 is the main object used in 3D geometry
  82189. * It can represent etiher the coordinates of a point the space, either a direction
  82190. * Reminder: js uses a left handed forward facing system
  82191. */
  82192. export class Vector3 {
  82193. private static _UpReadOnly;
  82194. private static _ZeroReadOnly;
  82195. /** @hidden */
  82196. _x: number;
  82197. /** @hidden */
  82198. _y: number;
  82199. /** @hidden */
  82200. _z: number;
  82201. /** @hidden */
  82202. _isDirty: boolean;
  82203. /** Gets or sets the x coordinate */
  82204. get x(): number;
  82205. set x(value: number);
  82206. /** Gets or sets the y coordinate */
  82207. get y(): number;
  82208. set y(value: number);
  82209. /** Gets or sets the z coordinate */
  82210. get z(): number;
  82211. set z(value: number);
  82212. /**
  82213. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82214. * @param x defines the first coordinates (on X axis)
  82215. * @param y defines the second coordinates (on Y axis)
  82216. * @param z defines the third coordinates (on Z axis)
  82217. */
  82218. constructor(x?: number, y?: number, z?: number);
  82219. /**
  82220. * Creates a string representation of the Vector3
  82221. * @returns a string with the Vector3 coordinates.
  82222. */
  82223. toString(): string;
  82224. /**
  82225. * Gets the class name
  82226. * @returns the string "Vector3"
  82227. */
  82228. getClassName(): string;
  82229. /**
  82230. * Creates the Vector3 hash code
  82231. * @returns a number which tends to be unique between Vector3 instances
  82232. */
  82233. getHashCode(): number;
  82234. /**
  82235. * Creates an array containing three elements : the coordinates of the Vector3
  82236. * @returns a new array of numbers
  82237. */
  82238. asArray(): number[];
  82239. /**
  82240. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82241. * @param array defines the destination array
  82242. * @param index defines the offset in the destination array
  82243. * @returns the current Vector3
  82244. */
  82245. toArray(array: FloatArray, index?: number): Vector3;
  82246. /**
  82247. * Update the current vector from an array
  82248. * @param array defines the destination array
  82249. * @param index defines the offset in the destination array
  82250. * @returns the current Vector3
  82251. */
  82252. fromArray(array: FloatArray, index?: number): Vector3;
  82253. /**
  82254. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82255. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82256. */
  82257. toQuaternion(): Quaternion;
  82258. /**
  82259. * Adds the given vector to the current Vector3
  82260. * @param otherVector defines the second operand
  82261. * @returns the current updated Vector3
  82262. */
  82263. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82264. /**
  82265. * Adds the given coordinates to the current Vector3
  82266. * @param x defines the x coordinate of the operand
  82267. * @param y defines the y coordinate of the operand
  82268. * @param z defines the z coordinate of the operand
  82269. * @returns the current updated Vector3
  82270. */
  82271. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82272. /**
  82273. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82274. * @param otherVector defines the second operand
  82275. * @returns the resulting Vector3
  82276. */
  82277. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82278. /**
  82279. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82280. * @param otherVector defines the second operand
  82281. * @param result defines the Vector3 object where to store the result
  82282. * @returns the current Vector3
  82283. */
  82284. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82285. /**
  82286. * Subtract the given vector from the current Vector3
  82287. * @param otherVector defines the second operand
  82288. * @returns the current updated Vector3
  82289. */
  82290. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82291. /**
  82292. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82293. * @param otherVector defines the second operand
  82294. * @returns the resulting Vector3
  82295. */
  82296. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82297. /**
  82298. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82299. * @param otherVector defines the second operand
  82300. * @param result defines the Vector3 object where to store the result
  82301. * @returns the current Vector3
  82302. */
  82303. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82304. /**
  82305. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82306. * @param x defines the x coordinate of the operand
  82307. * @param y defines the y coordinate of the operand
  82308. * @param z defines the z coordinate of the operand
  82309. * @returns the resulting Vector3
  82310. */
  82311. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82312. /**
  82313. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82314. * @param x defines the x coordinate of the operand
  82315. * @param y defines the y coordinate of the operand
  82316. * @param z defines the z coordinate of the operand
  82317. * @param result defines the Vector3 object where to store the result
  82318. * @returns the current Vector3
  82319. */
  82320. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82321. /**
  82322. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82323. * @returns a new Vector3
  82324. */
  82325. negate(): Vector3;
  82326. /**
  82327. * Negate this vector in place
  82328. * @returns this
  82329. */
  82330. negateInPlace(): Vector3;
  82331. /**
  82332. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82333. * @param result defines the Vector3 object where to store the result
  82334. * @returns the current Vector3
  82335. */
  82336. negateToRef(result: Vector3): Vector3;
  82337. /**
  82338. * Multiplies the Vector3 coordinates by the float "scale"
  82339. * @param scale defines the multiplier factor
  82340. * @returns the current updated Vector3
  82341. */
  82342. scaleInPlace(scale: number): Vector3;
  82343. /**
  82344. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82345. * @param scale defines the multiplier factor
  82346. * @returns a new Vector3
  82347. */
  82348. scale(scale: number): Vector3;
  82349. /**
  82350. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82351. * @param scale defines the multiplier factor
  82352. * @param result defines the Vector3 object where to store the result
  82353. * @returns the current Vector3
  82354. */
  82355. scaleToRef(scale: number, result: Vector3): Vector3;
  82356. /**
  82357. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82358. * @param scale defines the scale factor
  82359. * @param result defines the Vector3 object where to store the result
  82360. * @returns the unmodified current Vector3
  82361. */
  82362. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82363. /**
  82364. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82365. * @param origin defines the origin of the projection ray
  82366. * @param plane defines the plane to project to
  82367. * @returns the projected vector3
  82368. */
  82369. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82370. /**
  82371. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82372. * @param origin defines the origin of the projection ray
  82373. * @param plane defines the plane to project to
  82374. * @param result defines the Vector3 where to store the result
  82375. */
  82376. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82377. /**
  82378. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82379. * @param otherVector defines the second operand
  82380. * @returns true if both vectors are equals
  82381. */
  82382. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82383. /**
  82384. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82385. * @param otherVector defines the second operand
  82386. * @param epsilon defines the minimal distance to define values as equals
  82387. * @returns true if both vectors are distant less than epsilon
  82388. */
  82389. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82390. /**
  82391. * Returns true if the current Vector3 coordinates equals the given floats
  82392. * @param x defines the x coordinate of the operand
  82393. * @param y defines the y coordinate of the operand
  82394. * @param z defines the z coordinate of the operand
  82395. * @returns true if both vectors are equals
  82396. */
  82397. equalsToFloats(x: number, y: number, z: number): boolean;
  82398. /**
  82399. * Multiplies the current Vector3 coordinates by the given ones
  82400. * @param otherVector defines the second operand
  82401. * @returns the current updated Vector3
  82402. */
  82403. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82404. /**
  82405. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82406. * @param otherVector defines the second operand
  82407. * @returns the new Vector3
  82408. */
  82409. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82410. /**
  82411. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82412. * @param otherVector defines the second operand
  82413. * @param result defines the Vector3 object where to store the result
  82414. * @returns the current Vector3
  82415. */
  82416. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82417. /**
  82418. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82419. * @param x defines the x coordinate of the operand
  82420. * @param y defines the y coordinate of the operand
  82421. * @param z defines the z coordinate of the operand
  82422. * @returns the new Vector3
  82423. */
  82424. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82425. /**
  82426. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82427. * @param otherVector defines the second operand
  82428. * @returns the new Vector3
  82429. */
  82430. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82431. /**
  82432. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82433. * @param otherVector defines the second operand
  82434. * @param result defines the Vector3 object where to store the result
  82435. * @returns the current Vector3
  82436. */
  82437. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82438. /**
  82439. * Divides the current Vector3 coordinates by the given ones.
  82440. * @param otherVector defines the second operand
  82441. * @returns the current updated Vector3
  82442. */
  82443. divideInPlace(otherVector: Vector3): Vector3;
  82444. /**
  82445. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82446. * @param other defines the second operand
  82447. * @returns the current updated Vector3
  82448. */
  82449. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82450. /**
  82451. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82452. * @param other defines the second operand
  82453. * @returns the current updated Vector3
  82454. */
  82455. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82456. /**
  82457. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82458. * @param x defines the x coordinate of the operand
  82459. * @param y defines the y coordinate of the operand
  82460. * @param z defines the z coordinate of the operand
  82461. * @returns the current updated Vector3
  82462. */
  82463. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82464. /**
  82465. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82466. * @param x defines the x coordinate of the operand
  82467. * @param y defines the y coordinate of the operand
  82468. * @param z defines the z coordinate of the operand
  82469. * @returns the current updated Vector3
  82470. */
  82471. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82472. /**
  82473. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82474. * Check if is non uniform within a certain amount of decimal places to account for this
  82475. * @param epsilon the amount the values can differ
  82476. * @returns if the the vector is non uniform to a certain number of decimal places
  82477. */
  82478. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82479. /**
  82480. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82481. */
  82482. get isNonUniform(): boolean;
  82483. /**
  82484. * Gets a new Vector3 from current Vector3 floored values
  82485. * @returns a new Vector3
  82486. */
  82487. floor(): Vector3;
  82488. /**
  82489. * Gets a new Vector3 from current Vector3 floored values
  82490. * @returns a new Vector3
  82491. */
  82492. fract(): Vector3;
  82493. /**
  82494. * Gets the length of the Vector3
  82495. * @returns the length of the Vector3
  82496. */
  82497. length(): number;
  82498. /**
  82499. * Gets the squared length of the Vector3
  82500. * @returns squared length of the Vector3
  82501. */
  82502. lengthSquared(): number;
  82503. /**
  82504. * Normalize the current Vector3.
  82505. * Please note that this is an in place operation.
  82506. * @returns the current updated Vector3
  82507. */
  82508. normalize(): Vector3;
  82509. /**
  82510. * Reorders the x y z properties of the vector in place
  82511. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82512. * @returns the current updated vector
  82513. */
  82514. reorderInPlace(order: string): this;
  82515. /**
  82516. * Rotates the vector around 0,0,0 by a quaternion
  82517. * @param quaternion the rotation quaternion
  82518. * @param result vector to store the result
  82519. * @returns the resulting vector
  82520. */
  82521. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82522. /**
  82523. * Rotates a vector around a given point
  82524. * @param quaternion the rotation quaternion
  82525. * @param point the point to rotate around
  82526. * @param result vector to store the result
  82527. * @returns the resulting vector
  82528. */
  82529. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82530. /**
  82531. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82532. * The cross product is then orthogonal to both current and "other"
  82533. * @param other defines the right operand
  82534. * @returns the cross product
  82535. */
  82536. cross(other: Vector3): Vector3;
  82537. /**
  82538. * Normalize the current Vector3 with the given input length.
  82539. * Please note that this is an in place operation.
  82540. * @param len the length of the vector
  82541. * @returns the current updated Vector3
  82542. */
  82543. normalizeFromLength(len: number): Vector3;
  82544. /**
  82545. * Normalize the current Vector3 to a new vector
  82546. * @returns the new Vector3
  82547. */
  82548. normalizeToNew(): Vector3;
  82549. /**
  82550. * Normalize the current Vector3 to the reference
  82551. * @param reference define the Vector3 to update
  82552. * @returns the updated Vector3
  82553. */
  82554. normalizeToRef(reference: Vector3): Vector3;
  82555. /**
  82556. * Creates a new Vector3 copied from the current Vector3
  82557. * @returns the new Vector3
  82558. */
  82559. clone(): Vector3;
  82560. /**
  82561. * Copies the given vector coordinates to the current Vector3 ones
  82562. * @param source defines the source Vector3
  82563. * @returns the current updated Vector3
  82564. */
  82565. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82566. /**
  82567. * Copies the given floats to the current Vector3 coordinates
  82568. * @param x defines the x coordinate of the operand
  82569. * @param y defines the y coordinate of the operand
  82570. * @param z defines the z coordinate of the operand
  82571. * @returns the current updated Vector3
  82572. */
  82573. copyFromFloats(x: number, y: number, z: number): Vector3;
  82574. /**
  82575. * Copies the given floats to the current Vector3 coordinates
  82576. * @param x defines the x coordinate of the operand
  82577. * @param y defines the y coordinate of the operand
  82578. * @param z defines the z coordinate of the operand
  82579. * @returns the current updated Vector3
  82580. */
  82581. set(x: number, y: number, z: number): Vector3;
  82582. /**
  82583. * Copies the given float to the current Vector3 coordinates
  82584. * @param v defines the x, y and z coordinates of the operand
  82585. * @returns the current updated Vector3
  82586. */
  82587. setAll(v: number): Vector3;
  82588. /**
  82589. * Get the clip factor between two vectors
  82590. * @param vector0 defines the first operand
  82591. * @param vector1 defines the second operand
  82592. * @param axis defines the axis to use
  82593. * @param size defines the size along the axis
  82594. * @returns the clip factor
  82595. */
  82596. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82597. /**
  82598. * Get angle between two vectors
  82599. * @param vector0 angle between vector0 and vector1
  82600. * @param vector1 angle between vector0 and vector1
  82601. * @param normal direction of the normal
  82602. * @return the angle between vector0 and vector1
  82603. */
  82604. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82605. /**
  82606. * Returns a new Vector3 set from the index "offset" of the given array
  82607. * @param array defines the source array
  82608. * @param offset defines the offset in the source array
  82609. * @returns the new Vector3
  82610. */
  82611. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82612. /**
  82613. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82614. * @param array defines the source array
  82615. * @param offset defines the offset in the source array
  82616. * @returns the new Vector3
  82617. * @deprecated Please use FromArray instead.
  82618. */
  82619. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82620. /**
  82621. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82622. * @param array defines the source array
  82623. * @param offset defines the offset in the source array
  82624. * @param result defines the Vector3 where to store the result
  82625. */
  82626. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82627. /**
  82628. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82629. * @param array defines the source array
  82630. * @param offset defines the offset in the source array
  82631. * @param result defines the Vector3 where to store the result
  82632. * @deprecated Please use FromArrayToRef instead.
  82633. */
  82634. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82635. /**
  82636. * Sets the given vector "result" with the given floats.
  82637. * @param x defines the x coordinate of the source
  82638. * @param y defines the y coordinate of the source
  82639. * @param z defines the z coordinate of the source
  82640. * @param result defines the Vector3 where to store the result
  82641. */
  82642. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82643. /**
  82644. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82645. * @returns a new empty Vector3
  82646. */
  82647. static Zero(): Vector3;
  82648. /**
  82649. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82650. * @returns a new unit Vector3
  82651. */
  82652. static One(): Vector3;
  82653. /**
  82654. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82655. * @returns a new up Vector3
  82656. */
  82657. static Up(): Vector3;
  82658. /**
  82659. * Gets a up Vector3 that must not be updated
  82660. */
  82661. static get UpReadOnly(): DeepImmutable<Vector3>;
  82662. /**
  82663. * Gets a zero Vector3 that must not be updated
  82664. */
  82665. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82666. /**
  82667. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82668. * @returns a new down Vector3
  82669. */
  82670. static Down(): Vector3;
  82671. /**
  82672. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82673. * @param rightHandedSystem is the scene right-handed (negative z)
  82674. * @returns a new forward Vector3
  82675. */
  82676. static Forward(rightHandedSystem?: boolean): Vector3;
  82677. /**
  82678. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82679. * @param rightHandedSystem is the scene right-handed (negative-z)
  82680. * @returns a new forward Vector3
  82681. */
  82682. static Backward(rightHandedSystem?: boolean): Vector3;
  82683. /**
  82684. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82685. * @returns a new right Vector3
  82686. */
  82687. static Right(): Vector3;
  82688. /**
  82689. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82690. * @returns a new left Vector3
  82691. */
  82692. static Left(): Vector3;
  82693. /**
  82694. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82695. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82696. * @param vector defines the Vector3 to transform
  82697. * @param transformation defines the transformation matrix
  82698. * @returns the transformed Vector3
  82699. */
  82700. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82701. /**
  82702. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82703. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82704. * @param vector defines the Vector3 to transform
  82705. * @param transformation defines the transformation matrix
  82706. * @param result defines the Vector3 where to store the result
  82707. */
  82708. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82709. /**
  82710. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82711. * This method computes tranformed coordinates only, not transformed direction vectors
  82712. * @param x define the x coordinate of the source vector
  82713. * @param y define the y coordinate of the source vector
  82714. * @param z define the z coordinate of the source vector
  82715. * @param transformation defines the transformation matrix
  82716. * @param result defines the Vector3 where to store the result
  82717. */
  82718. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82719. /**
  82720. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82721. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82722. * @param vector defines the Vector3 to transform
  82723. * @param transformation defines the transformation matrix
  82724. * @returns the new Vector3
  82725. */
  82726. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82727. /**
  82728. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82729. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82730. * @param vector defines the Vector3 to transform
  82731. * @param transformation defines the transformation matrix
  82732. * @param result defines the Vector3 where to store the result
  82733. */
  82734. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82735. /**
  82736. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82737. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82738. * @param x define the x coordinate of the source vector
  82739. * @param y define the y coordinate of the source vector
  82740. * @param z define the z coordinate of the source vector
  82741. * @param transformation defines the transformation matrix
  82742. * @param result defines the Vector3 where to store the result
  82743. */
  82744. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82745. /**
  82746. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82747. * @param value1 defines the first control point
  82748. * @param value2 defines the second control point
  82749. * @param value3 defines the third control point
  82750. * @param value4 defines the fourth control point
  82751. * @param amount defines the amount on the spline to use
  82752. * @returns the new Vector3
  82753. */
  82754. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82755. /**
  82756. * 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"
  82757. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82758. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82759. * @param value defines the current value
  82760. * @param min defines the lower range value
  82761. * @param max defines the upper range value
  82762. * @returns the new Vector3
  82763. */
  82764. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82765. /**
  82766. * 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"
  82767. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82768. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82769. * @param value defines the current value
  82770. * @param min defines the lower range value
  82771. * @param max defines the upper range value
  82772. * @param result defines the Vector3 where to store the result
  82773. */
  82774. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82775. /**
  82776. * Checks if a given vector is inside a specific range
  82777. * @param v defines the vector to test
  82778. * @param min defines the minimum range
  82779. * @param max defines the maximum range
  82780. */
  82781. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82782. /**
  82783. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82784. * @param value1 defines the first control point
  82785. * @param tangent1 defines the first tangent vector
  82786. * @param value2 defines the second control point
  82787. * @param tangent2 defines the second tangent vector
  82788. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82789. * @returns the new Vector3
  82790. */
  82791. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82792. /**
  82793. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82794. * @param start defines the start value
  82795. * @param end defines the end value
  82796. * @param amount max defines amount between both (between 0 and 1)
  82797. * @returns the new Vector3
  82798. */
  82799. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82800. /**
  82801. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82802. * @param start defines the start value
  82803. * @param end defines the end value
  82804. * @param amount max defines amount between both (between 0 and 1)
  82805. * @param result defines the Vector3 where to store the result
  82806. */
  82807. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82808. /**
  82809. * Returns the dot product (float) between the vectors "left" and "right"
  82810. * @param left defines the left operand
  82811. * @param right defines the right operand
  82812. * @returns the dot product
  82813. */
  82814. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82815. /**
  82816. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82817. * The cross product is then orthogonal to both "left" and "right"
  82818. * @param left defines the left operand
  82819. * @param right defines the right operand
  82820. * @returns the cross product
  82821. */
  82822. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82823. /**
  82824. * Sets the given vector "result" with the cross product of "left" and "right"
  82825. * The cross product is then orthogonal to both "left" and "right"
  82826. * @param left defines the left operand
  82827. * @param right defines the right operand
  82828. * @param result defines the Vector3 where to store the result
  82829. */
  82830. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82831. /**
  82832. * Returns a new Vector3 as the normalization of the given vector
  82833. * @param vector defines the Vector3 to normalize
  82834. * @returns the new Vector3
  82835. */
  82836. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82837. /**
  82838. * Sets the given vector "result" with the normalization of the given first vector
  82839. * @param vector defines the Vector3 to normalize
  82840. * @param result defines the Vector3 where to store the result
  82841. */
  82842. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82843. /**
  82844. * Project a Vector3 onto screen space
  82845. * @param vector defines the Vector3 to project
  82846. * @param world defines the world matrix to use
  82847. * @param transform defines the transform (view x projection) matrix to use
  82848. * @param viewport defines the screen viewport to use
  82849. * @returns the new Vector3
  82850. */
  82851. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82852. /** @hidden */
  82853. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82854. /**
  82855. * Unproject from screen space to object space
  82856. * @param source defines the screen space Vector3 to use
  82857. * @param viewportWidth defines the current width of the viewport
  82858. * @param viewportHeight defines the current height of the viewport
  82859. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82860. * @param transform defines the transform (view x projection) matrix to use
  82861. * @returns the new Vector3
  82862. */
  82863. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82864. /**
  82865. * Unproject from screen space to object space
  82866. * @param source defines the screen space Vector3 to use
  82867. * @param viewportWidth defines the current width of the viewport
  82868. * @param viewportHeight defines the current height of the viewport
  82869. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82870. * @param view defines the view matrix to use
  82871. * @param projection defines the projection matrix to use
  82872. * @returns the new Vector3
  82873. */
  82874. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82875. /**
  82876. * Unproject from screen space to object space
  82877. * @param source defines the screen space Vector3 to use
  82878. * @param viewportWidth defines the current width of the viewport
  82879. * @param viewportHeight defines the current height of the viewport
  82880. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82881. * @param view defines the view matrix to use
  82882. * @param projection defines the projection matrix to use
  82883. * @param result defines the Vector3 where to store the result
  82884. */
  82885. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82886. /**
  82887. * Unproject from screen space to object space
  82888. * @param sourceX defines the screen space x coordinate to use
  82889. * @param sourceY defines the screen space y coordinate to use
  82890. * @param sourceZ defines the screen space z coordinate to use
  82891. * @param viewportWidth defines the current width of the viewport
  82892. * @param viewportHeight defines the current height of the viewport
  82893. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82894. * @param view defines the view matrix to use
  82895. * @param projection defines the projection matrix to use
  82896. * @param result defines the Vector3 where to store the result
  82897. */
  82898. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82899. /**
  82900. * Gets the minimal coordinate values between two Vector3
  82901. * @param left defines the first operand
  82902. * @param right defines the second operand
  82903. * @returns the new Vector3
  82904. */
  82905. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82906. /**
  82907. * Gets the maximal coordinate values between two Vector3
  82908. * @param left defines the first operand
  82909. * @param right defines the second operand
  82910. * @returns the new Vector3
  82911. */
  82912. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82913. /**
  82914. * Returns the distance between the vectors "value1" and "value2"
  82915. * @param value1 defines the first operand
  82916. * @param value2 defines the second operand
  82917. * @returns the distance
  82918. */
  82919. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82920. /**
  82921. * Returns the squared distance between the vectors "value1" and "value2"
  82922. * @param value1 defines the first operand
  82923. * @param value2 defines the second operand
  82924. * @returns the squared distance
  82925. */
  82926. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82927. /**
  82928. * Returns a new Vector3 located at the center between "value1" and "value2"
  82929. * @param value1 defines the first operand
  82930. * @param value2 defines the second operand
  82931. * @returns the new Vector3
  82932. */
  82933. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82934. /**
  82935. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82936. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82937. * to something in order to rotate it from its local system to the given target system
  82938. * Note: axis1, axis2 and axis3 are normalized during this operation
  82939. * @param axis1 defines the first axis
  82940. * @param axis2 defines the second axis
  82941. * @param axis3 defines the third axis
  82942. * @returns a new Vector3
  82943. */
  82944. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82945. /**
  82946. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82947. * @param axis1 defines the first axis
  82948. * @param axis2 defines the second axis
  82949. * @param axis3 defines the third axis
  82950. * @param ref defines the Vector3 where to store the result
  82951. */
  82952. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82953. }
  82954. /**
  82955. * Vector4 class created for EulerAngle class conversion to Quaternion
  82956. */
  82957. export class Vector4 {
  82958. /** x value of the vector */
  82959. x: number;
  82960. /** y value of the vector */
  82961. y: number;
  82962. /** z value of the vector */
  82963. z: number;
  82964. /** w value of the vector */
  82965. w: number;
  82966. /**
  82967. * Creates a Vector4 object from the given floats.
  82968. * @param x x value of the vector
  82969. * @param y y value of the vector
  82970. * @param z z value of the vector
  82971. * @param w w value of the vector
  82972. */
  82973. constructor(
  82974. /** x value of the vector */
  82975. x: number,
  82976. /** y value of the vector */
  82977. y: number,
  82978. /** z value of the vector */
  82979. z: number,
  82980. /** w value of the vector */
  82981. w: number);
  82982. /**
  82983. * Returns the string with the Vector4 coordinates.
  82984. * @returns a string containing all the vector values
  82985. */
  82986. toString(): string;
  82987. /**
  82988. * Returns the string "Vector4".
  82989. * @returns "Vector4"
  82990. */
  82991. getClassName(): string;
  82992. /**
  82993. * Returns the Vector4 hash code.
  82994. * @returns a unique hash code
  82995. */
  82996. getHashCode(): number;
  82997. /**
  82998. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82999. * @returns the resulting array
  83000. */
  83001. asArray(): number[];
  83002. /**
  83003. * Populates the given array from the given index with the Vector4 coordinates.
  83004. * @param array array to populate
  83005. * @param index index of the array to start at (default: 0)
  83006. * @returns the Vector4.
  83007. */
  83008. toArray(array: FloatArray, index?: number): Vector4;
  83009. /**
  83010. * Update the current vector from an array
  83011. * @param array defines the destination array
  83012. * @param index defines the offset in the destination array
  83013. * @returns the current Vector3
  83014. */
  83015. fromArray(array: FloatArray, index?: number): Vector4;
  83016. /**
  83017. * Adds the given vector to the current Vector4.
  83018. * @param otherVector the vector to add
  83019. * @returns the updated Vector4.
  83020. */
  83021. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83022. /**
  83023. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  83024. * @param otherVector the vector to add
  83025. * @returns the resulting vector
  83026. */
  83027. add(otherVector: DeepImmutable<Vector4>): Vector4;
  83028. /**
  83029. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  83030. * @param otherVector the vector to add
  83031. * @param result the vector to store the result
  83032. * @returns the current Vector4.
  83033. */
  83034. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83035. /**
  83036. * Subtract in place the given vector from the current Vector4.
  83037. * @param otherVector the vector to subtract
  83038. * @returns the updated Vector4.
  83039. */
  83040. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83041. /**
  83042. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  83043. * @param otherVector the vector to add
  83044. * @returns the new vector with the result
  83045. */
  83046. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  83047. /**
  83048. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  83049. * @param otherVector the vector to subtract
  83050. * @param result the vector to store the result
  83051. * @returns the current Vector4.
  83052. */
  83053. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83054. /**
  83055. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83056. */
  83057. /**
  83058. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83059. * @param x value to subtract
  83060. * @param y value to subtract
  83061. * @param z value to subtract
  83062. * @param w value to subtract
  83063. * @returns new vector containing the result
  83064. */
  83065. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83066. /**
  83067. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83068. * @param x value to subtract
  83069. * @param y value to subtract
  83070. * @param z value to subtract
  83071. * @param w value to subtract
  83072. * @param result the vector to store the result in
  83073. * @returns the current Vector4.
  83074. */
  83075. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  83076. /**
  83077. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  83078. * @returns a new vector with the negated values
  83079. */
  83080. negate(): Vector4;
  83081. /**
  83082. * Negate this vector in place
  83083. * @returns this
  83084. */
  83085. negateInPlace(): Vector4;
  83086. /**
  83087. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83088. * @param result defines the Vector3 object where to store the result
  83089. * @returns the current Vector4
  83090. */
  83091. negateToRef(result: Vector4): Vector4;
  83092. /**
  83093. * Multiplies the current Vector4 coordinates by scale (float).
  83094. * @param scale the number to scale with
  83095. * @returns the updated Vector4.
  83096. */
  83097. scaleInPlace(scale: number): Vector4;
  83098. /**
  83099. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83100. * @param scale the number to scale with
  83101. * @returns a new vector with the result
  83102. */
  83103. scale(scale: number): Vector4;
  83104. /**
  83105. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83106. * @param scale the number to scale with
  83107. * @param result a vector to store the result in
  83108. * @returns the current Vector4.
  83109. */
  83110. scaleToRef(scale: number, result: Vector4): Vector4;
  83111. /**
  83112. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83113. * @param scale defines the scale factor
  83114. * @param result defines the Vector4 object where to store the result
  83115. * @returns the unmodified current Vector4
  83116. */
  83117. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83118. /**
  83119. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83120. * @param otherVector the vector to compare against
  83121. * @returns true if they are equal
  83122. */
  83123. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83124. /**
  83125. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83126. * @param otherVector vector to compare against
  83127. * @param epsilon (Default: very small number)
  83128. * @returns true if they are equal
  83129. */
  83130. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83131. /**
  83132. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83133. * @param x x value to compare against
  83134. * @param y y value to compare against
  83135. * @param z z value to compare against
  83136. * @param w w value to compare against
  83137. * @returns true if equal
  83138. */
  83139. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83140. /**
  83141. * Multiplies in place the current Vector4 by the given one.
  83142. * @param otherVector vector to multiple with
  83143. * @returns the updated Vector4.
  83144. */
  83145. multiplyInPlace(otherVector: Vector4): Vector4;
  83146. /**
  83147. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83148. * @param otherVector vector to multiple with
  83149. * @returns resulting new vector
  83150. */
  83151. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83152. /**
  83153. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83154. * @param otherVector vector to multiple with
  83155. * @param result vector to store the result
  83156. * @returns the current Vector4.
  83157. */
  83158. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83159. /**
  83160. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83161. * @param x x value multiply with
  83162. * @param y y value multiply with
  83163. * @param z z value multiply with
  83164. * @param w w value multiply with
  83165. * @returns resulting new vector
  83166. */
  83167. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83168. /**
  83169. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83170. * @param otherVector vector to devide with
  83171. * @returns resulting new vector
  83172. */
  83173. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83174. /**
  83175. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83176. * @param otherVector vector to devide with
  83177. * @param result vector to store the result
  83178. * @returns the current Vector4.
  83179. */
  83180. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83181. /**
  83182. * Divides the current Vector3 coordinates by the given ones.
  83183. * @param otherVector vector to devide with
  83184. * @returns the updated Vector3.
  83185. */
  83186. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83187. /**
  83188. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83189. * @param other defines the second operand
  83190. * @returns the current updated Vector4
  83191. */
  83192. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83193. /**
  83194. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83195. * @param other defines the second operand
  83196. * @returns the current updated Vector4
  83197. */
  83198. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83199. /**
  83200. * Gets a new Vector4 from current Vector4 floored values
  83201. * @returns a new Vector4
  83202. */
  83203. floor(): Vector4;
  83204. /**
  83205. * Gets a new Vector4 from current Vector3 floored values
  83206. * @returns a new Vector4
  83207. */
  83208. fract(): Vector4;
  83209. /**
  83210. * Returns the Vector4 length (float).
  83211. * @returns the length
  83212. */
  83213. length(): number;
  83214. /**
  83215. * Returns the Vector4 squared length (float).
  83216. * @returns the length squared
  83217. */
  83218. lengthSquared(): number;
  83219. /**
  83220. * Normalizes in place the Vector4.
  83221. * @returns the updated Vector4.
  83222. */
  83223. normalize(): Vector4;
  83224. /**
  83225. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83226. * @returns this converted to a new vector3
  83227. */
  83228. toVector3(): Vector3;
  83229. /**
  83230. * Returns a new Vector4 copied from the current one.
  83231. * @returns the new cloned vector
  83232. */
  83233. clone(): Vector4;
  83234. /**
  83235. * Updates the current Vector4 with the given one coordinates.
  83236. * @param source the source vector to copy from
  83237. * @returns the updated Vector4.
  83238. */
  83239. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83240. /**
  83241. * Updates the current Vector4 coordinates with the given floats.
  83242. * @param x float to copy from
  83243. * @param y float to copy from
  83244. * @param z float to copy from
  83245. * @param w float to copy from
  83246. * @returns the updated Vector4.
  83247. */
  83248. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83249. /**
  83250. * Updates the current Vector4 coordinates with the given floats.
  83251. * @param x float to set from
  83252. * @param y float to set from
  83253. * @param z float to set from
  83254. * @param w float to set from
  83255. * @returns the updated Vector4.
  83256. */
  83257. set(x: number, y: number, z: number, w: number): Vector4;
  83258. /**
  83259. * Copies the given float to the current Vector3 coordinates
  83260. * @param v defines the x, y, z and w coordinates of the operand
  83261. * @returns the current updated Vector3
  83262. */
  83263. setAll(v: number): Vector4;
  83264. /**
  83265. * Returns a new Vector4 set from the starting index of the given array.
  83266. * @param array the array to pull values from
  83267. * @param offset the offset into the array to start at
  83268. * @returns the new vector
  83269. */
  83270. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83271. /**
  83272. * Updates the given vector "result" from the starting index of the given array.
  83273. * @param array the array to pull values from
  83274. * @param offset the offset into the array to start at
  83275. * @param result the vector to store the result in
  83276. */
  83277. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83278. /**
  83279. * Updates the given vector "result" from the starting index of the given Float32Array.
  83280. * @param array the array to pull values from
  83281. * @param offset the offset into the array to start at
  83282. * @param result the vector to store the result in
  83283. */
  83284. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83285. /**
  83286. * Updates the given vector "result" coordinates from the given floats.
  83287. * @param x float to set from
  83288. * @param y float to set from
  83289. * @param z float to set from
  83290. * @param w float to set from
  83291. * @param result the vector to the floats in
  83292. */
  83293. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83294. /**
  83295. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83296. * @returns the new vector
  83297. */
  83298. static Zero(): Vector4;
  83299. /**
  83300. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83301. * @returns the new vector
  83302. */
  83303. static One(): Vector4;
  83304. /**
  83305. * Returns a new normalized Vector4 from the given one.
  83306. * @param vector the vector to normalize
  83307. * @returns the vector
  83308. */
  83309. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83310. /**
  83311. * Updates the given vector "result" from the normalization of the given one.
  83312. * @param vector the vector to normalize
  83313. * @param result the vector to store the result in
  83314. */
  83315. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83316. /**
  83317. * Returns a vector with the minimum values from the left and right vectors
  83318. * @param left left vector to minimize
  83319. * @param right right vector to minimize
  83320. * @returns a new vector with the minimum of the left and right vector values
  83321. */
  83322. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83323. /**
  83324. * Returns a vector with the maximum values from the left and right vectors
  83325. * @param left left vector to maximize
  83326. * @param right right vector to maximize
  83327. * @returns a new vector with the maximum of the left and right vector values
  83328. */
  83329. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83330. /**
  83331. * Returns the distance (float) between the vectors "value1" and "value2".
  83332. * @param value1 value to calulate the distance between
  83333. * @param value2 value to calulate the distance between
  83334. * @return the distance between the two vectors
  83335. */
  83336. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83337. /**
  83338. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83339. * @param value1 value to calulate the distance between
  83340. * @param value2 value to calulate the distance between
  83341. * @return the distance between the two vectors squared
  83342. */
  83343. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83344. /**
  83345. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83346. * @param value1 value to calulate the center between
  83347. * @param value2 value to calulate the center between
  83348. * @return the center between the two vectors
  83349. */
  83350. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83351. /**
  83352. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83353. * This methods computes transformed normalized direction vectors only.
  83354. * @param vector the vector to transform
  83355. * @param transformation the transformation matrix to apply
  83356. * @returns the new vector
  83357. */
  83358. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83359. /**
  83360. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83361. * This methods computes transformed normalized direction vectors only.
  83362. * @param vector the vector to transform
  83363. * @param transformation the transformation matrix to apply
  83364. * @param result the vector to store the result in
  83365. */
  83366. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83367. /**
  83368. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83369. * This methods computes transformed normalized direction vectors only.
  83370. * @param x value to transform
  83371. * @param y value to transform
  83372. * @param z value to transform
  83373. * @param w value to transform
  83374. * @param transformation the transformation matrix to apply
  83375. * @param result the vector to store the results in
  83376. */
  83377. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83378. /**
  83379. * Creates a new Vector4 from a Vector3
  83380. * @param source defines the source data
  83381. * @param w defines the 4th component (default is 0)
  83382. * @returns a new Vector4
  83383. */
  83384. static FromVector3(source: Vector3, w?: number): Vector4;
  83385. }
  83386. /**
  83387. * Class used to store quaternion data
  83388. * @see https://en.wikipedia.org/wiki/Quaternion
  83389. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83390. */
  83391. export class Quaternion {
  83392. /** @hidden */
  83393. _x: number;
  83394. /** @hidden */
  83395. _y: number;
  83396. /** @hidden */
  83397. _z: number;
  83398. /** @hidden */
  83399. _w: number;
  83400. /** @hidden */
  83401. _isDirty: boolean;
  83402. /** Gets or sets the x coordinate */
  83403. get x(): number;
  83404. set x(value: number);
  83405. /** Gets or sets the y coordinate */
  83406. get y(): number;
  83407. set y(value: number);
  83408. /** Gets or sets the z coordinate */
  83409. get z(): number;
  83410. set z(value: number);
  83411. /** Gets or sets the w coordinate */
  83412. get w(): number;
  83413. set w(value: number);
  83414. /**
  83415. * Creates a new Quaternion from the given floats
  83416. * @param x defines the first component (0 by default)
  83417. * @param y defines the second component (0 by default)
  83418. * @param z defines the third component (0 by default)
  83419. * @param w defines the fourth component (1.0 by default)
  83420. */
  83421. constructor(x?: number, y?: number, z?: number, w?: number);
  83422. /**
  83423. * Gets a string representation for the current quaternion
  83424. * @returns a string with the Quaternion coordinates
  83425. */
  83426. toString(): string;
  83427. /**
  83428. * Gets the class name of the quaternion
  83429. * @returns the string "Quaternion"
  83430. */
  83431. getClassName(): string;
  83432. /**
  83433. * Gets a hash code for this quaternion
  83434. * @returns the quaternion hash code
  83435. */
  83436. getHashCode(): number;
  83437. /**
  83438. * Copy the quaternion to an array
  83439. * @returns a new array populated with 4 elements from the quaternion coordinates
  83440. */
  83441. asArray(): number[];
  83442. /**
  83443. * Check if two quaternions are equals
  83444. * @param otherQuaternion defines the second operand
  83445. * @return true if the current quaternion and the given one coordinates are strictly equals
  83446. */
  83447. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83448. /**
  83449. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83450. * @param otherQuaternion defines the other quaternion
  83451. * @param epsilon defines the minimal distance to consider equality
  83452. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83453. */
  83454. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83455. /**
  83456. * Clone the current quaternion
  83457. * @returns a new quaternion copied from the current one
  83458. */
  83459. clone(): Quaternion;
  83460. /**
  83461. * Copy a quaternion to the current one
  83462. * @param other defines the other quaternion
  83463. * @returns the updated current quaternion
  83464. */
  83465. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83466. /**
  83467. * Updates the current quaternion with the given float coordinates
  83468. * @param x defines the x coordinate
  83469. * @param y defines the y coordinate
  83470. * @param z defines the z coordinate
  83471. * @param w defines the w coordinate
  83472. * @returns the updated current quaternion
  83473. */
  83474. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83475. /**
  83476. * Updates the current quaternion from the given float coordinates
  83477. * @param x defines the x coordinate
  83478. * @param y defines the y coordinate
  83479. * @param z defines the z coordinate
  83480. * @param w defines the w coordinate
  83481. * @returns the updated current quaternion
  83482. */
  83483. set(x: number, y: number, z: number, w: number): Quaternion;
  83484. /**
  83485. * Adds two quaternions
  83486. * @param other defines the second operand
  83487. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83488. */
  83489. add(other: DeepImmutable<Quaternion>): Quaternion;
  83490. /**
  83491. * Add a quaternion to the current one
  83492. * @param other defines the quaternion to add
  83493. * @returns the current quaternion
  83494. */
  83495. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83496. /**
  83497. * Subtract two quaternions
  83498. * @param other defines the second operand
  83499. * @returns a new quaternion as the subtraction result of the given one from the current one
  83500. */
  83501. subtract(other: Quaternion): Quaternion;
  83502. /**
  83503. * Multiplies the current quaternion by a scale factor
  83504. * @param value defines the scale factor
  83505. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83506. */
  83507. scale(value: number): Quaternion;
  83508. /**
  83509. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83510. * @param scale defines the scale factor
  83511. * @param result defines the Quaternion object where to store the result
  83512. * @returns the unmodified current quaternion
  83513. */
  83514. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83515. /**
  83516. * Multiplies in place the current quaternion by a scale factor
  83517. * @param value defines the scale factor
  83518. * @returns the current modified quaternion
  83519. */
  83520. scaleInPlace(value: number): Quaternion;
  83521. /**
  83522. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83523. * @param scale defines the scale factor
  83524. * @param result defines the Quaternion object where to store the result
  83525. * @returns the unmodified current quaternion
  83526. */
  83527. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83528. /**
  83529. * Multiplies two quaternions
  83530. * @param q1 defines the second operand
  83531. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83532. */
  83533. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83534. /**
  83535. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83536. * @param q1 defines the second operand
  83537. * @param result defines the target quaternion
  83538. * @returns the current quaternion
  83539. */
  83540. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83541. /**
  83542. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83543. * @param q1 defines the second operand
  83544. * @returns the currentupdated quaternion
  83545. */
  83546. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83547. /**
  83548. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83549. * @param ref defines the target quaternion
  83550. * @returns the current quaternion
  83551. */
  83552. conjugateToRef(ref: Quaternion): Quaternion;
  83553. /**
  83554. * Conjugates in place (1-q) the current quaternion
  83555. * @returns the current updated quaternion
  83556. */
  83557. conjugateInPlace(): Quaternion;
  83558. /**
  83559. * Conjugates in place (1-q) the current quaternion
  83560. * @returns a new quaternion
  83561. */
  83562. conjugate(): Quaternion;
  83563. /**
  83564. * Gets length of current quaternion
  83565. * @returns the quaternion length (float)
  83566. */
  83567. length(): number;
  83568. /**
  83569. * Normalize in place the current quaternion
  83570. * @returns the current updated quaternion
  83571. */
  83572. normalize(): Quaternion;
  83573. /**
  83574. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83575. * @param order is a reserved parameter and is ignore for now
  83576. * @returns a new Vector3 containing the Euler angles
  83577. */
  83578. toEulerAngles(order?: string): Vector3;
  83579. /**
  83580. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83581. * @param result defines the vector which will be filled with the Euler angles
  83582. * @param order is a reserved parameter and is ignore for now
  83583. * @returns the current unchanged quaternion
  83584. */
  83585. toEulerAnglesToRef(result: Vector3): Quaternion;
  83586. /**
  83587. * Updates the given rotation matrix with the current quaternion values
  83588. * @param result defines the target matrix
  83589. * @returns the current unchanged quaternion
  83590. */
  83591. toRotationMatrix(result: Matrix): Quaternion;
  83592. /**
  83593. * Updates the current quaternion from the given rotation matrix values
  83594. * @param matrix defines the source matrix
  83595. * @returns the current updated quaternion
  83596. */
  83597. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83598. /**
  83599. * Creates a new quaternion from a rotation matrix
  83600. * @param matrix defines the source matrix
  83601. * @returns a new quaternion created from the given rotation matrix values
  83602. */
  83603. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83604. /**
  83605. * Updates the given quaternion with the given rotation matrix values
  83606. * @param matrix defines the source matrix
  83607. * @param result defines the target quaternion
  83608. */
  83609. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83610. /**
  83611. * Returns the dot product (float) between the quaternions "left" and "right"
  83612. * @param left defines the left operand
  83613. * @param right defines the right operand
  83614. * @returns the dot product
  83615. */
  83616. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83617. /**
  83618. * Checks if the two quaternions are close to each other
  83619. * @param quat0 defines the first quaternion to check
  83620. * @param quat1 defines the second quaternion to check
  83621. * @returns true if the two quaternions are close to each other
  83622. */
  83623. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83624. /**
  83625. * Creates an empty quaternion
  83626. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83627. */
  83628. static Zero(): Quaternion;
  83629. /**
  83630. * Inverse a given quaternion
  83631. * @param q defines the source quaternion
  83632. * @returns a new quaternion as the inverted current quaternion
  83633. */
  83634. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83635. /**
  83636. * Inverse a given quaternion
  83637. * @param q defines the source quaternion
  83638. * @param result the quaternion the result will be stored in
  83639. * @returns the result quaternion
  83640. */
  83641. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83642. /**
  83643. * Creates an identity quaternion
  83644. * @returns the identity quaternion
  83645. */
  83646. static Identity(): Quaternion;
  83647. /**
  83648. * Gets a boolean indicating if the given quaternion is identity
  83649. * @param quaternion defines the quaternion to check
  83650. * @returns true if the quaternion is identity
  83651. */
  83652. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83653. /**
  83654. * Creates a quaternion from a rotation around an axis
  83655. * @param axis defines the axis to use
  83656. * @param angle defines the angle to use
  83657. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83658. */
  83659. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83660. /**
  83661. * Creates a rotation around an axis and stores it into the given quaternion
  83662. * @param axis defines the axis to use
  83663. * @param angle defines the angle to use
  83664. * @param result defines the target quaternion
  83665. * @returns the target quaternion
  83666. */
  83667. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83668. /**
  83669. * Creates a new quaternion from data stored into an array
  83670. * @param array defines the data source
  83671. * @param offset defines the offset in the source array where the data starts
  83672. * @returns a new quaternion
  83673. */
  83674. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83675. /**
  83676. * Updates the given quaternion "result" from the starting index of the given array.
  83677. * @param array the array to pull values from
  83678. * @param offset the offset into the array to start at
  83679. * @param result the quaternion to store the result in
  83680. */
  83681. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83682. /**
  83683. * Create a quaternion from Euler rotation angles
  83684. * @param x Pitch
  83685. * @param y Yaw
  83686. * @param z Roll
  83687. * @returns the new Quaternion
  83688. */
  83689. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83690. /**
  83691. * Updates a quaternion from Euler rotation angles
  83692. * @param x Pitch
  83693. * @param y Yaw
  83694. * @param z Roll
  83695. * @param result the quaternion to store the result
  83696. * @returns the updated quaternion
  83697. */
  83698. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83699. /**
  83700. * Create a quaternion from Euler rotation vector
  83701. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83702. * @returns the new Quaternion
  83703. */
  83704. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83705. /**
  83706. * Updates a quaternion from Euler rotation vector
  83707. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83708. * @param result the quaternion to store the result
  83709. * @returns the updated quaternion
  83710. */
  83711. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83712. /**
  83713. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83714. * @param yaw defines the rotation around Y axis
  83715. * @param pitch defines the rotation around X axis
  83716. * @param roll defines the rotation around Z axis
  83717. * @returns the new quaternion
  83718. */
  83719. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83720. /**
  83721. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83722. * @param yaw defines the rotation around Y axis
  83723. * @param pitch defines the rotation around X axis
  83724. * @param roll defines the rotation around Z axis
  83725. * @param result defines the target quaternion
  83726. */
  83727. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83728. /**
  83729. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83730. * @param alpha defines the rotation around first axis
  83731. * @param beta defines the rotation around second axis
  83732. * @param gamma defines the rotation around third axis
  83733. * @returns the new quaternion
  83734. */
  83735. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83736. /**
  83737. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83738. * @param alpha defines the rotation around first axis
  83739. * @param beta defines the rotation around second axis
  83740. * @param gamma defines the rotation around third axis
  83741. * @param result defines the target quaternion
  83742. */
  83743. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83744. /**
  83745. * 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)
  83746. * @param axis1 defines the first axis
  83747. * @param axis2 defines the second axis
  83748. * @param axis3 defines the third axis
  83749. * @returns the new quaternion
  83750. */
  83751. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83752. /**
  83753. * 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
  83754. * @param axis1 defines the first axis
  83755. * @param axis2 defines the second axis
  83756. * @param axis3 defines the third axis
  83757. * @param ref defines the target quaternion
  83758. */
  83759. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83760. /**
  83761. * Interpolates between two quaternions
  83762. * @param left defines first quaternion
  83763. * @param right defines second quaternion
  83764. * @param amount defines the gradient to use
  83765. * @returns the new interpolated quaternion
  83766. */
  83767. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83768. /**
  83769. * Interpolates between two quaternions and stores it into a target quaternion
  83770. * @param left defines first quaternion
  83771. * @param right defines second quaternion
  83772. * @param amount defines the gradient to use
  83773. * @param result defines the target quaternion
  83774. */
  83775. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83776. /**
  83777. * Interpolate between two quaternions using Hermite interpolation
  83778. * @param value1 defines first quaternion
  83779. * @param tangent1 defines the incoming tangent
  83780. * @param value2 defines second quaternion
  83781. * @param tangent2 defines the outgoing tangent
  83782. * @param amount defines the target quaternion
  83783. * @returns the new interpolated quaternion
  83784. */
  83785. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83786. }
  83787. /**
  83788. * Class used to store matrix data (4x4)
  83789. */
  83790. export class Matrix {
  83791. /**
  83792. * Gets the precision of matrix computations
  83793. */
  83794. static get Use64Bits(): boolean;
  83795. private static _updateFlagSeed;
  83796. private static _identityReadOnly;
  83797. private _isIdentity;
  83798. private _isIdentityDirty;
  83799. private _isIdentity3x2;
  83800. private _isIdentity3x2Dirty;
  83801. /**
  83802. * Gets the update flag of the matrix which is an unique number for the matrix.
  83803. * It will be incremented every time the matrix data change.
  83804. * You can use it to speed the comparison between two versions of the same matrix.
  83805. */
  83806. updateFlag: number;
  83807. private readonly _m;
  83808. /**
  83809. * Gets the internal data of the matrix
  83810. */
  83811. get m(): DeepImmutable<Float32Array | Array<number>>;
  83812. /** @hidden */
  83813. _markAsUpdated(): void;
  83814. /** @hidden */
  83815. private _updateIdentityStatus;
  83816. /**
  83817. * Creates an empty matrix (filled with zeros)
  83818. */
  83819. constructor();
  83820. /**
  83821. * Check if the current matrix is identity
  83822. * @returns true is the matrix is the identity matrix
  83823. */
  83824. isIdentity(): boolean;
  83825. /**
  83826. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83827. * @returns true is the matrix is the identity matrix
  83828. */
  83829. isIdentityAs3x2(): boolean;
  83830. /**
  83831. * Gets the determinant of the matrix
  83832. * @returns the matrix determinant
  83833. */
  83834. determinant(): number;
  83835. /**
  83836. * Returns the matrix as a Float32Array or Array<number>
  83837. * @returns the matrix underlying array
  83838. */
  83839. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83840. /**
  83841. * Returns the matrix as a Float32Array or Array<number>
  83842. * @returns the matrix underlying array.
  83843. */
  83844. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83845. /**
  83846. * Inverts the current matrix in place
  83847. * @returns the current inverted matrix
  83848. */
  83849. invert(): Matrix;
  83850. /**
  83851. * Sets all the matrix elements to zero
  83852. * @returns the current matrix
  83853. */
  83854. reset(): Matrix;
  83855. /**
  83856. * Adds the current matrix with a second one
  83857. * @param other defines the matrix to add
  83858. * @returns a new matrix as the addition of the current matrix and the given one
  83859. */
  83860. add(other: DeepImmutable<Matrix>): Matrix;
  83861. /**
  83862. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83863. * @param other defines the matrix to add
  83864. * @param result defines the target matrix
  83865. * @returns the current matrix
  83866. */
  83867. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83868. /**
  83869. * Adds in place the given matrix to the current matrix
  83870. * @param other defines the second operand
  83871. * @returns the current updated matrix
  83872. */
  83873. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83874. /**
  83875. * Sets the given matrix to the current inverted Matrix
  83876. * @param other defines the target matrix
  83877. * @returns the unmodified current matrix
  83878. */
  83879. invertToRef(other: Matrix): Matrix;
  83880. /**
  83881. * add a value at the specified position in the current Matrix
  83882. * @param index the index of the value within the matrix. between 0 and 15.
  83883. * @param value the value to be added
  83884. * @returns the current updated matrix
  83885. */
  83886. addAtIndex(index: number, value: number): Matrix;
  83887. /**
  83888. * mutiply the specified position in the current Matrix by a value
  83889. * @param index the index of the value within the matrix. between 0 and 15.
  83890. * @param value the value to be added
  83891. * @returns the current updated matrix
  83892. */
  83893. multiplyAtIndex(index: number, value: number): Matrix;
  83894. /**
  83895. * Inserts the translation vector (using 3 floats) in the current matrix
  83896. * @param x defines the 1st component of the translation
  83897. * @param y defines the 2nd component of the translation
  83898. * @param z defines the 3rd component of the translation
  83899. * @returns the current updated matrix
  83900. */
  83901. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83902. /**
  83903. * Adds the translation vector (using 3 floats) in the current matrix
  83904. * @param x defines the 1st component of the translation
  83905. * @param y defines the 2nd component of the translation
  83906. * @param z defines the 3rd component of the translation
  83907. * @returns the current updated matrix
  83908. */
  83909. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83910. /**
  83911. * Inserts the translation vector in the current matrix
  83912. * @param vector3 defines the translation to insert
  83913. * @returns the current updated matrix
  83914. */
  83915. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83916. /**
  83917. * Gets the translation value of the current matrix
  83918. * @returns a new Vector3 as the extracted translation from the matrix
  83919. */
  83920. getTranslation(): Vector3;
  83921. /**
  83922. * Fill a Vector3 with the extracted translation from the matrix
  83923. * @param result defines the Vector3 where to store the translation
  83924. * @returns the current matrix
  83925. */
  83926. getTranslationToRef(result: Vector3): Matrix;
  83927. /**
  83928. * Remove rotation and scaling part from the matrix
  83929. * @returns the updated matrix
  83930. */
  83931. removeRotationAndScaling(): Matrix;
  83932. /**
  83933. * Multiply two matrices
  83934. * @param other defines the second operand
  83935. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83936. */
  83937. multiply(other: DeepImmutable<Matrix>): Matrix;
  83938. /**
  83939. * Copy the current matrix from the given one
  83940. * @param other defines the source matrix
  83941. * @returns the current updated matrix
  83942. */
  83943. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83944. /**
  83945. * Populates the given array from the starting index with the current matrix values
  83946. * @param array defines the target array
  83947. * @param offset defines the offset in the target array where to start storing values
  83948. * @returns the current matrix
  83949. */
  83950. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83951. /**
  83952. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83953. * @param other defines the second operand
  83954. * @param result defines the matrix where to store the multiplication
  83955. * @returns the current matrix
  83956. */
  83957. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83958. /**
  83959. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83960. * @param other defines the second operand
  83961. * @param result defines the array where to store the multiplication
  83962. * @param offset defines the offset in the target array where to start storing values
  83963. * @returns the current matrix
  83964. */
  83965. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83966. /**
  83967. * Check equality between this matrix and a second one
  83968. * @param value defines the second matrix to compare
  83969. * @returns true is the current matrix and the given one values are strictly equal
  83970. */
  83971. equals(value: DeepImmutable<Matrix>): boolean;
  83972. /**
  83973. * Clone the current matrix
  83974. * @returns a new matrix from the current matrix
  83975. */
  83976. clone(): Matrix;
  83977. /**
  83978. * Returns the name of the current matrix class
  83979. * @returns the string "Matrix"
  83980. */
  83981. getClassName(): string;
  83982. /**
  83983. * Gets the hash code of the current matrix
  83984. * @returns the hash code
  83985. */
  83986. getHashCode(): number;
  83987. /**
  83988. * Decomposes the current Matrix into a translation, rotation and scaling components
  83989. * @param scale defines the scale vector3 given as a reference to update
  83990. * @param rotation defines the rotation quaternion given as a reference to update
  83991. * @param translation defines the translation vector3 given as a reference to update
  83992. * @returns true if operation was successful
  83993. */
  83994. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83995. /**
  83996. * Gets specific row of the matrix
  83997. * @param index defines the number of the row to get
  83998. * @returns the index-th row of the current matrix as a new Vector4
  83999. */
  84000. getRow(index: number): Nullable<Vector4>;
  84001. /**
  84002. * Sets the index-th row of the current matrix to the vector4 values
  84003. * @param index defines the number of the row to set
  84004. * @param row defines the target vector4
  84005. * @returns the updated current matrix
  84006. */
  84007. setRow(index: number, row: Vector4): Matrix;
  84008. /**
  84009. * Compute the transpose of the matrix
  84010. * @returns the new transposed matrix
  84011. */
  84012. transpose(): Matrix;
  84013. /**
  84014. * Compute the transpose of the matrix and store it in a given matrix
  84015. * @param result defines the target matrix
  84016. * @returns the current matrix
  84017. */
  84018. transposeToRef(result: Matrix): Matrix;
  84019. /**
  84020. * Sets the index-th row of the current matrix with the given 4 x float values
  84021. * @param index defines the row index
  84022. * @param x defines the x component to set
  84023. * @param y defines the y component to set
  84024. * @param z defines the z component to set
  84025. * @param w defines the w component to set
  84026. * @returns the updated current matrix
  84027. */
  84028. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  84029. /**
  84030. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  84031. * @param scale defines the scale factor
  84032. * @returns a new matrix
  84033. */
  84034. scale(scale: number): Matrix;
  84035. /**
  84036. * Scale the current matrix values by a factor to a given result matrix
  84037. * @param scale defines the scale factor
  84038. * @param result defines the matrix to store the result
  84039. * @returns the current matrix
  84040. */
  84041. scaleToRef(scale: number, result: Matrix): Matrix;
  84042. /**
  84043. * Scale the current matrix values by a factor and add the result to a given matrix
  84044. * @param scale defines the scale factor
  84045. * @param result defines the Matrix to store the result
  84046. * @returns the current matrix
  84047. */
  84048. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  84049. /**
  84050. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  84051. * @param ref matrix to store the result
  84052. */
  84053. toNormalMatrix(ref: Matrix): void;
  84054. /**
  84055. * Gets only rotation part of the current matrix
  84056. * @returns a new matrix sets to the extracted rotation matrix from the current one
  84057. */
  84058. getRotationMatrix(): Matrix;
  84059. /**
  84060. * Extracts the rotation matrix from the current one and sets it as the given "result"
  84061. * @param result defines the target matrix to store data to
  84062. * @returns the current matrix
  84063. */
  84064. getRotationMatrixToRef(result: Matrix): Matrix;
  84065. /**
  84066. * Toggles model matrix from being right handed to left handed in place and vice versa
  84067. */
  84068. toggleModelMatrixHandInPlace(): void;
  84069. /**
  84070. * Toggles projection matrix from being right handed to left handed in place and vice versa
  84071. */
  84072. toggleProjectionMatrixHandInPlace(): void;
  84073. /**
  84074. * Creates a matrix from an array
  84075. * @param array defines the source array
  84076. * @param offset defines an offset in the source array
  84077. * @returns a new Matrix set from the starting index of the given array
  84078. */
  84079. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  84080. /**
  84081. * Copy the content of an array into a given matrix
  84082. * @param array defines the source array
  84083. * @param offset defines an offset in the source array
  84084. * @param result defines the target matrix
  84085. */
  84086. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84087. /**
  84088. * Stores an array into a matrix after having multiplied each component by a given factor
  84089. * @param array defines the source array
  84090. * @param offset defines the offset in the source array
  84091. * @param scale defines the scaling factor
  84092. * @param result defines the target matrix
  84093. */
  84094. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84095. /**
  84096. * Gets an identity matrix that must not be updated
  84097. */
  84098. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84099. /**
  84100. * Stores a list of values (16) inside a given matrix
  84101. * @param initialM11 defines 1st value of 1st row
  84102. * @param initialM12 defines 2nd value of 1st row
  84103. * @param initialM13 defines 3rd value of 1st row
  84104. * @param initialM14 defines 4th value of 1st row
  84105. * @param initialM21 defines 1st value of 2nd row
  84106. * @param initialM22 defines 2nd value of 2nd row
  84107. * @param initialM23 defines 3rd value of 2nd row
  84108. * @param initialM24 defines 4th value of 2nd row
  84109. * @param initialM31 defines 1st value of 3rd row
  84110. * @param initialM32 defines 2nd value of 3rd row
  84111. * @param initialM33 defines 3rd value of 3rd row
  84112. * @param initialM34 defines 4th value of 3rd row
  84113. * @param initialM41 defines 1st value of 4th row
  84114. * @param initialM42 defines 2nd value of 4th row
  84115. * @param initialM43 defines 3rd value of 4th row
  84116. * @param initialM44 defines 4th value of 4th row
  84117. * @param result defines the target matrix
  84118. */
  84119. 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;
  84120. /**
  84121. * Creates new matrix from a list of values (16)
  84122. * @param initialM11 defines 1st value of 1st row
  84123. * @param initialM12 defines 2nd value of 1st row
  84124. * @param initialM13 defines 3rd value of 1st row
  84125. * @param initialM14 defines 4th value of 1st row
  84126. * @param initialM21 defines 1st value of 2nd row
  84127. * @param initialM22 defines 2nd value of 2nd row
  84128. * @param initialM23 defines 3rd value of 2nd row
  84129. * @param initialM24 defines 4th value of 2nd row
  84130. * @param initialM31 defines 1st value of 3rd row
  84131. * @param initialM32 defines 2nd value of 3rd row
  84132. * @param initialM33 defines 3rd value of 3rd row
  84133. * @param initialM34 defines 4th value of 3rd row
  84134. * @param initialM41 defines 1st value of 4th row
  84135. * @param initialM42 defines 2nd value of 4th row
  84136. * @param initialM43 defines 3rd value of 4th row
  84137. * @param initialM44 defines 4th value of 4th row
  84138. * @returns the new matrix
  84139. */
  84140. 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;
  84141. /**
  84142. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84143. * @param scale defines the scale vector3
  84144. * @param rotation defines the rotation quaternion
  84145. * @param translation defines the translation vector3
  84146. * @returns a new matrix
  84147. */
  84148. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84149. /**
  84150. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84151. * @param scale defines the scale vector3
  84152. * @param rotation defines the rotation quaternion
  84153. * @param translation defines the translation vector3
  84154. * @param result defines the target matrix
  84155. */
  84156. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84157. /**
  84158. * Creates a new identity matrix
  84159. * @returns a new identity matrix
  84160. */
  84161. static Identity(): Matrix;
  84162. /**
  84163. * Creates a new identity matrix and stores the result in a given matrix
  84164. * @param result defines the target matrix
  84165. */
  84166. static IdentityToRef(result: Matrix): void;
  84167. /**
  84168. * Creates a new zero matrix
  84169. * @returns a new zero matrix
  84170. */
  84171. static Zero(): Matrix;
  84172. /**
  84173. * Creates a new rotation matrix for "angle" radians around the X axis
  84174. * @param angle defines the angle (in radians) to use
  84175. * @return the new matrix
  84176. */
  84177. static RotationX(angle: number): Matrix;
  84178. /**
  84179. * Creates a new matrix as the invert of a given matrix
  84180. * @param source defines the source matrix
  84181. * @returns the new matrix
  84182. */
  84183. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84184. /**
  84185. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84186. * @param angle defines the angle (in radians) to use
  84187. * @param result defines the target matrix
  84188. */
  84189. static RotationXToRef(angle: number, result: Matrix): void;
  84190. /**
  84191. * Creates a new rotation matrix for "angle" radians around the Y axis
  84192. * @param angle defines the angle (in radians) to use
  84193. * @return the new matrix
  84194. */
  84195. static RotationY(angle: number): Matrix;
  84196. /**
  84197. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84198. * @param angle defines the angle (in radians) to use
  84199. * @param result defines the target matrix
  84200. */
  84201. static RotationYToRef(angle: number, result: Matrix): void;
  84202. /**
  84203. * Creates a new rotation matrix for "angle" radians around the Z axis
  84204. * @param angle defines the angle (in radians) to use
  84205. * @return the new matrix
  84206. */
  84207. static RotationZ(angle: number): Matrix;
  84208. /**
  84209. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84210. * @param angle defines the angle (in radians) to use
  84211. * @param result defines the target matrix
  84212. */
  84213. static RotationZToRef(angle: number, result: Matrix): void;
  84214. /**
  84215. * Creates a new rotation matrix for "angle" radians around the given axis
  84216. * @param axis defines the axis to use
  84217. * @param angle defines the angle (in radians) to use
  84218. * @return the new matrix
  84219. */
  84220. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84221. /**
  84222. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84223. * @param axis defines the axis to use
  84224. * @param angle defines the angle (in radians) to use
  84225. * @param result defines the target matrix
  84226. */
  84227. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84228. /**
  84229. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84230. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84231. * @param from defines the vector to align
  84232. * @param to defines the vector to align to
  84233. * @param result defines the target matrix
  84234. */
  84235. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84236. /**
  84237. * Creates a rotation matrix
  84238. * @param yaw defines the yaw angle in radians (Y axis)
  84239. * @param pitch defines the pitch angle in radians (X axis)
  84240. * @param roll defines the roll angle in radians (Z axis)
  84241. * @returns the new rotation matrix
  84242. */
  84243. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84244. /**
  84245. * Creates a rotation matrix and stores it in a given matrix
  84246. * @param yaw defines the yaw angle in radians (Y axis)
  84247. * @param pitch defines the pitch angle in radians (X axis)
  84248. * @param roll defines the roll angle in radians (Z axis)
  84249. * @param result defines the target matrix
  84250. */
  84251. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84252. /**
  84253. * Creates a scaling matrix
  84254. * @param x defines the scale factor on X axis
  84255. * @param y defines the scale factor on Y axis
  84256. * @param z defines the scale factor on Z axis
  84257. * @returns the new matrix
  84258. */
  84259. static Scaling(x: number, y: number, z: number): Matrix;
  84260. /**
  84261. * Creates a scaling matrix and stores it in a given matrix
  84262. * @param x defines the scale factor on X axis
  84263. * @param y defines the scale factor on Y axis
  84264. * @param z defines the scale factor on Z axis
  84265. * @param result defines the target matrix
  84266. */
  84267. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84268. /**
  84269. * Creates a translation matrix
  84270. * @param x defines the translation on X axis
  84271. * @param y defines the translation on Y axis
  84272. * @param z defines the translationon Z axis
  84273. * @returns the new matrix
  84274. */
  84275. static Translation(x: number, y: number, z: number): Matrix;
  84276. /**
  84277. * Creates a translation matrix and stores it in a given matrix
  84278. * @param x defines the translation on X axis
  84279. * @param y defines the translation on Y axis
  84280. * @param z defines the translationon Z axis
  84281. * @param result defines the target matrix
  84282. */
  84283. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84284. /**
  84285. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84286. * @param startValue defines the start value
  84287. * @param endValue defines the end value
  84288. * @param gradient defines the gradient factor
  84289. * @returns the new matrix
  84290. */
  84291. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84292. /**
  84293. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84294. * @param startValue defines the start value
  84295. * @param endValue defines the end value
  84296. * @param gradient defines the gradient factor
  84297. * @param result defines the Matrix object where to store data
  84298. */
  84299. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84300. /**
  84301. * Builds a new matrix whose values are computed by:
  84302. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84303. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84304. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84305. * @param startValue defines the first matrix
  84306. * @param endValue defines the second matrix
  84307. * @param gradient defines the gradient between the two matrices
  84308. * @returns the new matrix
  84309. */
  84310. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84311. /**
  84312. * Update a matrix to values which are computed by:
  84313. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84314. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84315. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84316. * @param startValue defines the first matrix
  84317. * @param endValue defines the second matrix
  84318. * @param gradient defines the gradient between the two matrices
  84319. * @param result defines the target matrix
  84320. */
  84321. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84322. /**
  84323. * 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"
  84324. * This function works in left handed mode
  84325. * @param eye defines the final position of the entity
  84326. * @param target defines where the entity should look at
  84327. * @param up defines the up vector for the entity
  84328. * @returns the new matrix
  84329. */
  84330. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84331. /**
  84332. * 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".
  84333. * This function works in left handed mode
  84334. * @param eye defines the final position of the entity
  84335. * @param target defines where the entity should look at
  84336. * @param up defines the up vector for the entity
  84337. * @param result defines the target matrix
  84338. */
  84339. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84340. /**
  84341. * 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"
  84342. * This function works in right handed mode
  84343. * @param eye defines the final position of the entity
  84344. * @param target defines where the entity should look at
  84345. * @param up defines the up vector for the entity
  84346. * @returns the new matrix
  84347. */
  84348. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84349. /**
  84350. * 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".
  84351. * This function works in right handed mode
  84352. * @param eye defines the final position of the entity
  84353. * @param target defines where the entity should look at
  84354. * @param up defines the up vector for the entity
  84355. * @param result defines the target matrix
  84356. */
  84357. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84358. /**
  84359. * Create a left-handed orthographic projection matrix
  84360. * @param width defines the viewport width
  84361. * @param height defines the viewport height
  84362. * @param znear defines the near clip plane
  84363. * @param zfar defines the far clip plane
  84364. * @returns a new matrix as a left-handed orthographic projection matrix
  84365. */
  84366. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84367. /**
  84368. * Store a left-handed orthographic projection to a given matrix
  84369. * @param width defines the viewport width
  84370. * @param height defines the viewport height
  84371. * @param znear defines the near clip plane
  84372. * @param zfar defines the far clip plane
  84373. * @param result defines the target matrix
  84374. */
  84375. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84376. /**
  84377. * Create a left-handed orthographic projection matrix
  84378. * @param left defines the viewport left coordinate
  84379. * @param right defines the viewport right coordinate
  84380. * @param bottom defines the viewport bottom coordinate
  84381. * @param top defines the viewport top coordinate
  84382. * @param znear defines the near clip plane
  84383. * @param zfar defines the far clip plane
  84384. * @returns a new matrix as a left-handed orthographic projection matrix
  84385. */
  84386. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84387. /**
  84388. * Stores a left-handed orthographic projection into a given matrix
  84389. * @param left defines the viewport left coordinate
  84390. * @param right defines the viewport right coordinate
  84391. * @param bottom defines the viewport bottom coordinate
  84392. * @param top defines the viewport top coordinate
  84393. * @param znear defines the near clip plane
  84394. * @param zfar defines the far clip plane
  84395. * @param result defines the target matrix
  84396. */
  84397. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84398. /**
  84399. * Creates a right-handed orthographic projection matrix
  84400. * @param left defines the viewport left coordinate
  84401. * @param right defines the viewport right coordinate
  84402. * @param bottom defines the viewport bottom coordinate
  84403. * @param top defines the viewport top coordinate
  84404. * @param znear defines the near clip plane
  84405. * @param zfar defines the far clip plane
  84406. * @returns a new matrix as a right-handed orthographic projection matrix
  84407. */
  84408. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84409. /**
  84410. * Stores a right-handed orthographic projection into a given matrix
  84411. * @param left defines the viewport left coordinate
  84412. * @param right defines the viewport right coordinate
  84413. * @param bottom defines the viewport bottom coordinate
  84414. * @param top defines the viewport top coordinate
  84415. * @param znear defines the near clip plane
  84416. * @param zfar defines the far clip plane
  84417. * @param result defines the target matrix
  84418. */
  84419. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84420. /**
  84421. * Creates a left-handed perspective projection matrix
  84422. * @param width defines the viewport width
  84423. * @param height defines the viewport height
  84424. * @param znear defines the near clip plane
  84425. * @param zfar defines the far clip plane
  84426. * @returns a new matrix as a left-handed perspective projection matrix
  84427. */
  84428. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84429. /**
  84430. * Creates a left-handed perspective projection matrix
  84431. * @param fov defines the horizontal field of view
  84432. * @param aspect defines the aspect ratio
  84433. * @param znear defines the near clip plane
  84434. * @param zfar defines the far clip plane
  84435. * @returns a new matrix as a left-handed perspective projection matrix
  84436. */
  84437. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84438. /**
  84439. * Stores a left-handed perspective projection into a given matrix
  84440. * @param fov defines the horizontal field of view
  84441. * @param aspect defines the aspect ratio
  84442. * @param znear defines the near clip plane
  84443. * @param zfar defines the far clip plane
  84444. * @param result defines the target matrix
  84445. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84446. */
  84447. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84448. /**
  84449. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84450. * @param fov defines the horizontal field of view
  84451. * @param aspect defines the aspect ratio
  84452. * @param znear defines the near clip plane
  84453. * @param zfar not used as infinity is used as far clip
  84454. * @param result defines the target matrix
  84455. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84456. */
  84457. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84458. /**
  84459. * Creates a right-handed perspective projection matrix
  84460. * @param fov defines the horizontal field of view
  84461. * @param aspect defines the aspect ratio
  84462. * @param znear defines the near clip plane
  84463. * @param zfar defines the far clip plane
  84464. * @returns a new matrix as a right-handed perspective projection matrix
  84465. */
  84466. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84467. /**
  84468. * Stores a right-handed perspective projection into a given matrix
  84469. * @param fov defines the horizontal field of view
  84470. * @param aspect defines the aspect ratio
  84471. * @param znear defines the near clip plane
  84472. * @param zfar defines the far clip plane
  84473. * @param result defines the target matrix
  84474. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84475. */
  84476. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84477. /**
  84478. * Stores a right-handed perspective projection into a given matrix
  84479. * @param fov defines the horizontal field of view
  84480. * @param aspect defines the aspect ratio
  84481. * @param znear defines the near clip plane
  84482. * @param zfar not used as infinity is used as far clip
  84483. * @param result defines the target matrix
  84484. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84485. */
  84486. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84487. /**
  84488. * Stores a perspective projection for WebVR info a given matrix
  84489. * @param fov defines the field of view
  84490. * @param znear defines the near clip plane
  84491. * @param zfar defines the far clip plane
  84492. * @param result defines the target matrix
  84493. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84494. */
  84495. static PerspectiveFovWebVRToRef(fov: {
  84496. upDegrees: number;
  84497. downDegrees: number;
  84498. leftDegrees: number;
  84499. rightDegrees: number;
  84500. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84501. /**
  84502. * Computes a complete transformation matrix
  84503. * @param viewport defines the viewport to use
  84504. * @param world defines the world matrix
  84505. * @param view defines the view matrix
  84506. * @param projection defines the projection matrix
  84507. * @param zmin defines the near clip plane
  84508. * @param zmax defines the far clip plane
  84509. * @returns the transformation matrix
  84510. */
  84511. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84512. /**
  84513. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84514. * @param matrix defines the matrix to use
  84515. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84516. */
  84517. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84518. /**
  84519. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84520. * @param matrix defines the matrix to use
  84521. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84522. */
  84523. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84524. /**
  84525. * Compute the transpose of a given matrix
  84526. * @param matrix defines the matrix to transpose
  84527. * @returns the new matrix
  84528. */
  84529. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84530. /**
  84531. * Compute the transpose of a matrix and store it in a target matrix
  84532. * @param matrix defines the matrix to transpose
  84533. * @param result defines the target matrix
  84534. */
  84535. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84536. /**
  84537. * Computes a reflection matrix from a plane
  84538. * @param plane defines the reflection plane
  84539. * @returns a new matrix
  84540. */
  84541. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84542. /**
  84543. * Computes a reflection matrix from a plane
  84544. * @param plane defines the reflection plane
  84545. * @param result defines the target matrix
  84546. */
  84547. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84548. /**
  84549. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84550. * @param xaxis defines the value of the 1st axis
  84551. * @param yaxis defines the value of the 2nd axis
  84552. * @param zaxis defines the value of the 3rd axis
  84553. * @param result defines the target matrix
  84554. */
  84555. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84556. /**
  84557. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84558. * @param quat defines the quaternion to use
  84559. * @param result defines the target matrix
  84560. */
  84561. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84562. }
  84563. /**
  84564. * @hidden
  84565. */
  84566. export class TmpVectors {
  84567. static Vector2: Vector2[];
  84568. static Vector3: Vector3[];
  84569. static Vector4: Vector4[];
  84570. static Quaternion: Quaternion[];
  84571. static Matrix: Matrix[];
  84572. }
  84573. }
  84574. declare module BABYLON {
  84575. /**
  84576. * Defines potential orientation for back face culling
  84577. */
  84578. export enum Orientation {
  84579. /**
  84580. * Clockwise
  84581. */
  84582. CW = 0,
  84583. /** Counter clockwise */
  84584. CCW = 1
  84585. }
  84586. /** Class used to represent a Bezier curve */
  84587. export class BezierCurve {
  84588. /**
  84589. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84590. * @param t defines the time
  84591. * @param x1 defines the left coordinate on X axis
  84592. * @param y1 defines the left coordinate on Y axis
  84593. * @param x2 defines the right coordinate on X axis
  84594. * @param y2 defines the right coordinate on Y axis
  84595. * @returns the interpolated value
  84596. */
  84597. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84598. }
  84599. /**
  84600. * Defines angle representation
  84601. */
  84602. export class Angle {
  84603. private _radians;
  84604. /**
  84605. * Creates an Angle object of "radians" radians (float).
  84606. * @param radians the angle in radians
  84607. */
  84608. constructor(radians: number);
  84609. /**
  84610. * Get value in degrees
  84611. * @returns the Angle value in degrees (float)
  84612. */
  84613. degrees(): number;
  84614. /**
  84615. * Get value in radians
  84616. * @returns the Angle value in radians (float)
  84617. */
  84618. radians(): number;
  84619. /**
  84620. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84621. * @param a defines first point as the origin
  84622. * @param b defines point
  84623. * @returns a new Angle
  84624. */
  84625. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84626. /**
  84627. * Gets a new Angle object from the given float in radians
  84628. * @param radians defines the angle value in radians
  84629. * @returns a new Angle
  84630. */
  84631. static FromRadians(radians: number): Angle;
  84632. /**
  84633. * Gets a new Angle object from the given float in degrees
  84634. * @param degrees defines the angle value in degrees
  84635. * @returns a new Angle
  84636. */
  84637. static FromDegrees(degrees: number): Angle;
  84638. }
  84639. /**
  84640. * This represents an arc in a 2d space.
  84641. */
  84642. export class Arc2 {
  84643. /** Defines the start point of the arc */
  84644. startPoint: Vector2;
  84645. /** Defines the mid point of the arc */
  84646. midPoint: Vector2;
  84647. /** Defines the end point of the arc */
  84648. endPoint: Vector2;
  84649. /**
  84650. * Defines the center point of the arc.
  84651. */
  84652. centerPoint: Vector2;
  84653. /**
  84654. * Defines the radius of the arc.
  84655. */
  84656. radius: number;
  84657. /**
  84658. * Defines the angle of the arc (from mid point to end point).
  84659. */
  84660. angle: Angle;
  84661. /**
  84662. * Defines the start angle of the arc (from start point to middle point).
  84663. */
  84664. startAngle: Angle;
  84665. /**
  84666. * Defines the orientation of the arc (clock wise/counter clock wise).
  84667. */
  84668. orientation: Orientation;
  84669. /**
  84670. * Creates an Arc object from the three given points : start, middle and end.
  84671. * @param startPoint Defines the start point of the arc
  84672. * @param midPoint Defines the midlle point of the arc
  84673. * @param endPoint Defines the end point of the arc
  84674. */
  84675. constructor(
  84676. /** Defines the start point of the arc */
  84677. startPoint: Vector2,
  84678. /** Defines the mid point of the arc */
  84679. midPoint: Vector2,
  84680. /** Defines the end point of the arc */
  84681. endPoint: Vector2);
  84682. }
  84683. /**
  84684. * Represents a 2D path made up of multiple 2D points
  84685. */
  84686. export class Path2 {
  84687. private _points;
  84688. private _length;
  84689. /**
  84690. * If the path start and end point are the same
  84691. */
  84692. closed: boolean;
  84693. /**
  84694. * Creates a Path2 object from the starting 2D coordinates x and y.
  84695. * @param x the starting points x value
  84696. * @param y the starting points y value
  84697. */
  84698. constructor(x: number, y: number);
  84699. /**
  84700. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84701. * @param x the added points x value
  84702. * @param y the added points y value
  84703. * @returns the updated Path2.
  84704. */
  84705. addLineTo(x: number, y: number): Path2;
  84706. /**
  84707. * 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.
  84708. * @param midX middle point x value
  84709. * @param midY middle point y value
  84710. * @param endX end point x value
  84711. * @param endY end point y value
  84712. * @param numberOfSegments (default: 36)
  84713. * @returns the updated Path2.
  84714. */
  84715. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84716. /**
  84717. * Closes the Path2.
  84718. * @returns the Path2.
  84719. */
  84720. close(): Path2;
  84721. /**
  84722. * Gets the sum of the distance between each sequential point in the path
  84723. * @returns the Path2 total length (float).
  84724. */
  84725. length(): number;
  84726. /**
  84727. * Gets the points which construct the path
  84728. * @returns the Path2 internal array of points.
  84729. */
  84730. getPoints(): Vector2[];
  84731. /**
  84732. * Retreives the point at the distance aways from the starting point
  84733. * @param normalizedLengthPosition the length along the path to retreive the point from
  84734. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84735. */
  84736. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84737. /**
  84738. * Creates a new path starting from an x and y position
  84739. * @param x starting x value
  84740. * @param y starting y value
  84741. * @returns a new Path2 starting at the coordinates (x, y).
  84742. */
  84743. static StartingAt(x: number, y: number): Path2;
  84744. }
  84745. /**
  84746. * Represents a 3D path made up of multiple 3D points
  84747. */
  84748. export class Path3D {
  84749. /**
  84750. * an array of Vector3, the curve axis of the Path3D
  84751. */
  84752. path: Vector3[];
  84753. private _curve;
  84754. private _distances;
  84755. private _tangents;
  84756. private _normals;
  84757. private _binormals;
  84758. private _raw;
  84759. private _alignTangentsWithPath;
  84760. private readonly _pointAtData;
  84761. /**
  84762. * new Path3D(path, normal, raw)
  84763. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84764. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84765. * @param path an array of Vector3, the curve axis of the Path3D
  84766. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84767. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84768. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84769. */
  84770. constructor(
  84771. /**
  84772. * an array of Vector3, the curve axis of the Path3D
  84773. */
  84774. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84775. /**
  84776. * Returns the Path3D array of successive Vector3 designing its curve.
  84777. * @returns the Path3D array of successive Vector3 designing its curve.
  84778. */
  84779. getCurve(): Vector3[];
  84780. /**
  84781. * Returns the Path3D array of successive Vector3 designing its curve.
  84782. * @returns the Path3D array of successive Vector3 designing its curve.
  84783. */
  84784. getPoints(): Vector3[];
  84785. /**
  84786. * @returns the computed length (float) of the path.
  84787. */
  84788. length(): number;
  84789. /**
  84790. * Returns an array populated with tangent vectors on each Path3D curve point.
  84791. * @returns an array populated with tangent vectors on each Path3D curve point.
  84792. */
  84793. getTangents(): Vector3[];
  84794. /**
  84795. * Returns an array populated with normal vectors on each Path3D curve point.
  84796. * @returns an array populated with normal vectors on each Path3D curve point.
  84797. */
  84798. getNormals(): Vector3[];
  84799. /**
  84800. * Returns an array populated with binormal vectors on each Path3D curve point.
  84801. * @returns an array populated with binormal vectors on each Path3D curve point.
  84802. */
  84803. getBinormals(): Vector3[];
  84804. /**
  84805. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84806. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84807. */
  84808. getDistances(): number[];
  84809. /**
  84810. * Returns an interpolated point along this path
  84811. * @param position the position of the point along this path, from 0.0 to 1.0
  84812. * @returns a new Vector3 as the point
  84813. */
  84814. getPointAt(position: number): Vector3;
  84815. /**
  84816. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84817. * @param position the position of the point along this path, from 0.0 to 1.0
  84818. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84819. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84820. */
  84821. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84822. /**
  84823. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84824. * @param position the position of the point along this path, from 0.0 to 1.0
  84825. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84826. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84827. */
  84828. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84829. /**
  84830. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84831. * @param position the position of the point along this path, from 0.0 to 1.0
  84832. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84833. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84834. */
  84835. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84836. /**
  84837. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84838. * @param position the position of the point along this path, from 0.0 to 1.0
  84839. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84840. */
  84841. getDistanceAt(position: number): number;
  84842. /**
  84843. * Returns the array index of the previous point of an interpolated point along this path
  84844. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84845. * @returns the array index
  84846. */
  84847. getPreviousPointIndexAt(position: number): number;
  84848. /**
  84849. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  84850. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84851. * @returns the sub position
  84852. */
  84853. getSubPositionAt(position: number): number;
  84854. /**
  84855. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84856. * @param target the vector of which to get the closest position to
  84857. * @returns the position of the closest virtual point on this path to the target vector
  84858. */
  84859. getClosestPositionTo(target: Vector3): number;
  84860. /**
  84861. * Returns a sub path (slice) of this path
  84862. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  84863. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  84864. * @returns a sub path (slice) of this path
  84865. */
  84866. slice(start?: number, end?: number): Path3D;
  84867. /**
  84868. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84869. * @param path path which all values are copied into the curves points
  84870. * @param firstNormal which should be projected onto the curve
  84871. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84872. * @returns the same object updated.
  84873. */
  84874. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84875. private _compute;
  84876. private _getFirstNonNullVector;
  84877. private _getLastNonNullVector;
  84878. private _normalVector;
  84879. /**
  84880. * Updates the point at data for an interpolated point along this curve
  84881. * @param position the position of the point along this curve, from 0.0 to 1.0
  84882. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84883. * @returns the (updated) point at data
  84884. */
  84885. private _updatePointAtData;
  84886. /**
  84887. * Updates the point at data from the specified parameters
  84888. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84889. * @param point the interpolated point
  84890. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84891. */
  84892. private _setPointAtData;
  84893. /**
  84894. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84895. */
  84896. private _updateInterpolationMatrix;
  84897. }
  84898. /**
  84899. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84900. * A Curve3 is designed from a series of successive Vector3.
  84901. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84902. */
  84903. export class Curve3 {
  84904. private _points;
  84905. private _length;
  84906. /**
  84907. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84908. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84909. * @param v1 (Vector3) the control point
  84910. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84911. * @param nbPoints (integer) the wanted number of points in the curve
  84912. * @returns the created Curve3
  84913. */
  84914. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84915. /**
  84916. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84917. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84918. * @param v1 (Vector3) the first control point
  84919. * @param v2 (Vector3) the second control point
  84920. * @param v3 (Vector3) the end point of the Cubic Bezier
  84921. * @param nbPoints (integer) the wanted number of points in the curve
  84922. * @returns the created Curve3
  84923. */
  84924. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84925. /**
  84926. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84927. * @param p1 (Vector3) the origin point of the Hermite Spline
  84928. * @param t1 (Vector3) the tangent vector at the origin point
  84929. * @param p2 (Vector3) the end point of the Hermite Spline
  84930. * @param t2 (Vector3) the tangent vector at the end point
  84931. * @param nbPoints (integer) the wanted number of points in the curve
  84932. * @returns the created Curve3
  84933. */
  84934. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84935. /**
  84936. * Returns a Curve3 object along a CatmullRom Spline curve :
  84937. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84938. * @param nbPoints (integer) the wanted number of points between each curve control points
  84939. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84940. * @returns the created Curve3
  84941. */
  84942. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84943. /**
  84944. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84945. * A Curve3 is designed from a series of successive Vector3.
  84946. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84947. * @param points points which make up the curve
  84948. */
  84949. constructor(points: Vector3[]);
  84950. /**
  84951. * @returns the Curve3 stored array of successive Vector3
  84952. */
  84953. getPoints(): Vector3[];
  84954. /**
  84955. * @returns the computed length (float) of the curve.
  84956. */
  84957. length(): number;
  84958. /**
  84959. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84960. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84961. * curveA and curveB keep unchanged.
  84962. * @param curve the curve to continue from this curve
  84963. * @returns the newly constructed curve
  84964. */
  84965. continue(curve: DeepImmutable<Curve3>): Curve3;
  84966. private _computeLength;
  84967. }
  84968. }
  84969. declare module BABYLON {
  84970. /**
  84971. * This represents the main contract an easing function should follow.
  84972. * Easing functions are used throughout the animation system.
  84973. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84974. */
  84975. export interface IEasingFunction {
  84976. /**
  84977. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84978. * of the easing function.
  84979. * The link below provides some of the most common examples of easing functions.
  84980. * @see https://easings.net/
  84981. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84982. * @returns the corresponding value on the curve defined by the easing function
  84983. */
  84984. ease(gradient: number): number;
  84985. }
  84986. /**
  84987. * Base class used for every default easing function.
  84988. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84989. */
  84990. export class EasingFunction implements IEasingFunction {
  84991. /**
  84992. * Interpolation follows the mathematical formula associated with the easing function.
  84993. */
  84994. static readonly EASINGMODE_EASEIN: number;
  84995. /**
  84996. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84997. */
  84998. static readonly EASINGMODE_EASEOUT: number;
  84999. /**
  85000. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  85001. */
  85002. static readonly EASINGMODE_EASEINOUT: number;
  85003. private _easingMode;
  85004. /**
  85005. * Sets the easing mode of the current function.
  85006. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  85007. */
  85008. setEasingMode(easingMode: number): void;
  85009. /**
  85010. * Gets the current easing mode.
  85011. * @returns the easing mode
  85012. */
  85013. getEasingMode(): number;
  85014. /**
  85015. * @hidden
  85016. */
  85017. easeInCore(gradient: number): number;
  85018. /**
  85019. * Given an input gradient between 0 and 1, this returns the corresponding value
  85020. * of the easing function.
  85021. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85022. * @returns the corresponding value on the curve defined by the easing function
  85023. */
  85024. ease(gradient: number): number;
  85025. }
  85026. /**
  85027. * Easing function with a circle shape (see link below).
  85028. * @see https://easings.net/#easeInCirc
  85029. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85030. */
  85031. export class CircleEase extends EasingFunction implements IEasingFunction {
  85032. /** @hidden */
  85033. easeInCore(gradient: number): number;
  85034. }
  85035. /**
  85036. * Easing function with a ease back shape (see link below).
  85037. * @see https://easings.net/#easeInBack
  85038. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85039. */
  85040. export class BackEase extends EasingFunction implements IEasingFunction {
  85041. /** Defines the amplitude of the function */
  85042. amplitude: number;
  85043. /**
  85044. * Instantiates a back ease easing
  85045. * @see https://easings.net/#easeInBack
  85046. * @param amplitude Defines the amplitude of the function
  85047. */
  85048. constructor(
  85049. /** Defines the amplitude of the function */
  85050. amplitude?: number);
  85051. /** @hidden */
  85052. easeInCore(gradient: number): number;
  85053. }
  85054. /**
  85055. * Easing function with a bouncing shape (see link below).
  85056. * @see https://easings.net/#easeInBounce
  85057. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85058. */
  85059. export class BounceEase extends EasingFunction implements IEasingFunction {
  85060. /** Defines the number of bounces */
  85061. bounces: number;
  85062. /** Defines the amplitude of the bounce */
  85063. bounciness: number;
  85064. /**
  85065. * Instantiates a bounce easing
  85066. * @see https://easings.net/#easeInBounce
  85067. * @param bounces Defines the number of bounces
  85068. * @param bounciness Defines the amplitude of the bounce
  85069. */
  85070. constructor(
  85071. /** Defines the number of bounces */
  85072. bounces?: number,
  85073. /** Defines the amplitude of the bounce */
  85074. bounciness?: number);
  85075. /** @hidden */
  85076. easeInCore(gradient: number): number;
  85077. }
  85078. /**
  85079. * Easing function with a power of 3 shape (see link below).
  85080. * @see https://easings.net/#easeInCubic
  85081. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85082. */
  85083. export class CubicEase extends EasingFunction implements IEasingFunction {
  85084. /** @hidden */
  85085. easeInCore(gradient: number): number;
  85086. }
  85087. /**
  85088. * Easing function with an elastic shape (see link below).
  85089. * @see https://easings.net/#easeInElastic
  85090. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85091. */
  85092. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85093. /** Defines the number of oscillations*/
  85094. oscillations: number;
  85095. /** Defines the amplitude of the oscillations*/
  85096. springiness: number;
  85097. /**
  85098. * Instantiates an elastic easing function
  85099. * @see https://easings.net/#easeInElastic
  85100. * @param oscillations Defines the number of oscillations
  85101. * @param springiness Defines the amplitude of the oscillations
  85102. */
  85103. constructor(
  85104. /** Defines the number of oscillations*/
  85105. oscillations?: number,
  85106. /** Defines the amplitude of the oscillations*/
  85107. springiness?: number);
  85108. /** @hidden */
  85109. easeInCore(gradient: number): number;
  85110. }
  85111. /**
  85112. * Easing function with an exponential shape (see link below).
  85113. * @see https://easings.net/#easeInExpo
  85114. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85115. */
  85116. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85117. /** Defines the exponent of the function */
  85118. exponent: number;
  85119. /**
  85120. * Instantiates an exponential easing function
  85121. * @see https://easings.net/#easeInExpo
  85122. * @param exponent Defines the exponent of the function
  85123. */
  85124. constructor(
  85125. /** Defines the exponent of the function */
  85126. exponent?: number);
  85127. /** @hidden */
  85128. easeInCore(gradient: number): number;
  85129. }
  85130. /**
  85131. * Easing function with a power shape (see link below).
  85132. * @see https://easings.net/#easeInQuad
  85133. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85134. */
  85135. export class PowerEase extends EasingFunction implements IEasingFunction {
  85136. /** Defines the power of the function */
  85137. power: number;
  85138. /**
  85139. * Instantiates an power base easing function
  85140. * @see https://easings.net/#easeInQuad
  85141. * @param power Defines the power of the function
  85142. */
  85143. constructor(
  85144. /** Defines the power of the function */
  85145. power?: number);
  85146. /** @hidden */
  85147. easeInCore(gradient: number): number;
  85148. }
  85149. /**
  85150. * Easing function with a power of 2 shape (see link below).
  85151. * @see https://easings.net/#easeInQuad
  85152. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85153. */
  85154. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85155. /** @hidden */
  85156. easeInCore(gradient: number): number;
  85157. }
  85158. /**
  85159. * Easing function with a power of 4 shape (see link below).
  85160. * @see https://easings.net/#easeInQuart
  85161. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85162. */
  85163. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85164. /** @hidden */
  85165. easeInCore(gradient: number): number;
  85166. }
  85167. /**
  85168. * Easing function with a power of 5 shape (see link below).
  85169. * @see https://easings.net/#easeInQuint
  85170. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85171. */
  85172. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85173. /** @hidden */
  85174. easeInCore(gradient: number): number;
  85175. }
  85176. /**
  85177. * Easing function with a sin shape (see link below).
  85178. * @see https://easings.net/#easeInSine
  85179. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85180. */
  85181. export class SineEase extends EasingFunction implements IEasingFunction {
  85182. /** @hidden */
  85183. easeInCore(gradient: number): number;
  85184. }
  85185. /**
  85186. * Easing function with a bezier shape (see link below).
  85187. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85188. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85189. */
  85190. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85191. /** Defines the x component of the start tangent in the bezier curve */
  85192. x1: number;
  85193. /** Defines the y component of the start tangent in the bezier curve */
  85194. y1: number;
  85195. /** Defines the x component of the end tangent in the bezier curve */
  85196. x2: number;
  85197. /** Defines the y component of the end tangent in the bezier curve */
  85198. y2: number;
  85199. /**
  85200. * Instantiates a bezier function
  85201. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85202. * @param x1 Defines the x component of the start tangent in the bezier curve
  85203. * @param y1 Defines the y component of the start tangent in the bezier curve
  85204. * @param x2 Defines the x component of the end tangent in the bezier curve
  85205. * @param y2 Defines the y component of the end tangent in the bezier curve
  85206. */
  85207. constructor(
  85208. /** Defines the x component of the start tangent in the bezier curve */
  85209. x1?: number,
  85210. /** Defines the y component of the start tangent in the bezier curve */
  85211. y1?: number,
  85212. /** Defines the x component of the end tangent in the bezier curve */
  85213. x2?: number,
  85214. /** Defines the y component of the end tangent in the bezier curve */
  85215. y2?: number);
  85216. /** @hidden */
  85217. easeInCore(gradient: number): number;
  85218. }
  85219. }
  85220. declare module BABYLON {
  85221. /**
  85222. * Class used to hold a RBG color
  85223. */
  85224. export class Color3 {
  85225. /**
  85226. * Defines the red component (between 0 and 1, default is 0)
  85227. */
  85228. r: number;
  85229. /**
  85230. * Defines the green component (between 0 and 1, default is 0)
  85231. */
  85232. g: number;
  85233. /**
  85234. * Defines the blue component (between 0 and 1, default is 0)
  85235. */
  85236. b: number;
  85237. /**
  85238. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85239. * @param r defines the red component (between 0 and 1, default is 0)
  85240. * @param g defines the green component (between 0 and 1, default is 0)
  85241. * @param b defines the blue component (between 0 and 1, default is 0)
  85242. */
  85243. constructor(
  85244. /**
  85245. * Defines the red component (between 0 and 1, default is 0)
  85246. */
  85247. r?: number,
  85248. /**
  85249. * Defines the green component (between 0 and 1, default is 0)
  85250. */
  85251. g?: number,
  85252. /**
  85253. * Defines the blue component (between 0 and 1, default is 0)
  85254. */
  85255. b?: number);
  85256. /**
  85257. * Creates a string with the Color3 current values
  85258. * @returns the string representation of the Color3 object
  85259. */
  85260. toString(): string;
  85261. /**
  85262. * Returns the string "Color3"
  85263. * @returns "Color3"
  85264. */
  85265. getClassName(): string;
  85266. /**
  85267. * Compute the Color3 hash code
  85268. * @returns an unique number that can be used to hash Color3 objects
  85269. */
  85270. getHashCode(): number;
  85271. /**
  85272. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85273. * @param array defines the array where to store the r,g,b components
  85274. * @param index defines an optional index in the target array to define where to start storing values
  85275. * @returns the current Color3 object
  85276. */
  85277. toArray(array: FloatArray, index?: number): Color3;
  85278. /**
  85279. * Update the current color with values stored in an array from the starting index of the given array
  85280. * @param array defines the source array
  85281. * @param offset defines an offset in the source array
  85282. * @returns the current Color3 object
  85283. */
  85284. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85285. /**
  85286. * Returns a new Color4 object from the current Color3 and the given alpha
  85287. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85288. * @returns a new Color4 object
  85289. */
  85290. toColor4(alpha?: number): Color4;
  85291. /**
  85292. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85293. * @returns the new array
  85294. */
  85295. asArray(): number[];
  85296. /**
  85297. * Returns the luminance value
  85298. * @returns a float value
  85299. */
  85300. toLuminance(): number;
  85301. /**
  85302. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85303. * @param otherColor defines the second operand
  85304. * @returns the new Color3 object
  85305. */
  85306. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85307. /**
  85308. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85309. * @param otherColor defines the second operand
  85310. * @param result defines the Color3 object where to store the result
  85311. * @returns the current Color3
  85312. */
  85313. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85314. /**
  85315. * Determines equality between Color3 objects
  85316. * @param otherColor defines the second operand
  85317. * @returns true if the rgb values are equal to the given ones
  85318. */
  85319. equals(otherColor: DeepImmutable<Color3>): boolean;
  85320. /**
  85321. * Determines equality between the current Color3 object and a set of r,b,g values
  85322. * @param r defines the red component to check
  85323. * @param g defines the green component to check
  85324. * @param b defines the blue component to check
  85325. * @returns true if the rgb values are equal to the given ones
  85326. */
  85327. equalsFloats(r: number, g: number, b: number): boolean;
  85328. /**
  85329. * Multiplies in place each rgb value by scale
  85330. * @param scale defines the scaling factor
  85331. * @returns the updated Color3
  85332. */
  85333. scale(scale: number): Color3;
  85334. /**
  85335. * Multiplies the rgb values by scale and stores the result into "result"
  85336. * @param scale defines the scaling factor
  85337. * @param result defines the Color3 object where to store the result
  85338. * @returns the unmodified current Color3
  85339. */
  85340. scaleToRef(scale: number, result: Color3): Color3;
  85341. /**
  85342. * Scale the current Color3 values by a factor and add the result to a given Color3
  85343. * @param scale defines the scale factor
  85344. * @param result defines color to store the result into
  85345. * @returns the unmodified current Color3
  85346. */
  85347. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85348. /**
  85349. * Clamps the rgb values by the min and max values and stores the result into "result"
  85350. * @param min defines minimum clamping value (default is 0)
  85351. * @param max defines maximum clamping value (default is 1)
  85352. * @param result defines color to store the result into
  85353. * @returns the original Color3
  85354. */
  85355. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85356. /**
  85357. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85358. * @param otherColor defines the second operand
  85359. * @returns the new Color3
  85360. */
  85361. add(otherColor: DeepImmutable<Color3>): Color3;
  85362. /**
  85363. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85364. * @param otherColor defines the second operand
  85365. * @param result defines Color3 object to store the result into
  85366. * @returns the unmodified current Color3
  85367. */
  85368. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85369. /**
  85370. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85371. * @param otherColor defines the second operand
  85372. * @returns the new Color3
  85373. */
  85374. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85375. /**
  85376. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85377. * @param otherColor defines the second operand
  85378. * @param result defines Color3 object to store the result into
  85379. * @returns the unmodified current Color3
  85380. */
  85381. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85382. /**
  85383. * Copy the current object
  85384. * @returns a new Color3 copied the current one
  85385. */
  85386. clone(): Color3;
  85387. /**
  85388. * Copies the rgb values from the source in the current Color3
  85389. * @param source defines the source Color3 object
  85390. * @returns the updated Color3 object
  85391. */
  85392. copyFrom(source: DeepImmutable<Color3>): Color3;
  85393. /**
  85394. * Updates the Color3 rgb values from the given floats
  85395. * @param r defines the red component to read from
  85396. * @param g defines the green component to read from
  85397. * @param b defines the blue component to read from
  85398. * @returns the current Color3 object
  85399. */
  85400. copyFromFloats(r: number, g: number, b: number): Color3;
  85401. /**
  85402. * Updates the Color3 rgb values from the given floats
  85403. * @param r defines the red component to read from
  85404. * @param g defines the green component to read from
  85405. * @param b defines the blue component to read from
  85406. * @returns the current Color3 object
  85407. */
  85408. set(r: number, g: number, b: number): Color3;
  85409. /**
  85410. * Compute the Color3 hexadecimal code as a string
  85411. * @returns a string containing the hexadecimal representation of the Color3 object
  85412. */
  85413. toHexString(): string;
  85414. /**
  85415. * Computes a new Color3 converted from the current one to linear space
  85416. * @returns a new Color3 object
  85417. */
  85418. toLinearSpace(): Color3;
  85419. /**
  85420. * Converts current color in rgb space to HSV values
  85421. * @returns a new color3 representing the HSV values
  85422. */
  85423. toHSV(): Color3;
  85424. /**
  85425. * Converts current color in rgb space to HSV values
  85426. * @param result defines the Color3 where to store the HSV values
  85427. */
  85428. toHSVToRef(result: Color3): void;
  85429. /**
  85430. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85431. * @param convertedColor defines the Color3 object where to store the linear space version
  85432. * @returns the unmodified Color3
  85433. */
  85434. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85435. /**
  85436. * Computes a new Color3 converted from the current one to gamma space
  85437. * @returns a new Color3 object
  85438. */
  85439. toGammaSpace(): Color3;
  85440. /**
  85441. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85442. * @param convertedColor defines the Color3 object where to store the gamma space version
  85443. * @returns the unmodified Color3
  85444. */
  85445. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85446. private static _BlackReadOnly;
  85447. /**
  85448. * Convert Hue, saturation and value to a Color3 (RGB)
  85449. * @param hue defines the hue
  85450. * @param saturation defines the saturation
  85451. * @param value defines the value
  85452. * @param result defines the Color3 where to store the RGB values
  85453. */
  85454. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85455. /**
  85456. * Creates a new Color3 from the string containing valid hexadecimal values
  85457. * @param hex defines a string containing valid hexadecimal values
  85458. * @returns a new Color3 object
  85459. */
  85460. static FromHexString(hex: string): Color3;
  85461. /**
  85462. * Creates a new Color3 from the starting index of the given array
  85463. * @param array defines the source array
  85464. * @param offset defines an offset in the source array
  85465. * @returns a new Color3 object
  85466. */
  85467. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85468. /**
  85469. * Creates a new Color3 from the starting index element of the given array
  85470. * @param array defines the source array to read from
  85471. * @param offset defines the offset in the source array
  85472. * @param result defines the target Color3 object
  85473. */
  85474. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85475. /**
  85476. * Creates a new Color3 from integer values (< 256)
  85477. * @param r defines the red component to read from (value between 0 and 255)
  85478. * @param g defines the green component to read from (value between 0 and 255)
  85479. * @param b defines the blue component to read from (value between 0 and 255)
  85480. * @returns a new Color3 object
  85481. */
  85482. static FromInts(r: number, g: number, b: number): Color3;
  85483. /**
  85484. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85485. * @param start defines the start Color3 value
  85486. * @param end defines the end Color3 value
  85487. * @param amount defines the gradient value between start and end
  85488. * @returns a new Color3 object
  85489. */
  85490. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85491. /**
  85492. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85493. * @param left defines the start value
  85494. * @param right defines the end value
  85495. * @param amount defines the gradient factor
  85496. * @param result defines the Color3 object where to store the result
  85497. */
  85498. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85499. /**
  85500. * Returns a Color3 value containing a red color
  85501. * @returns a new Color3 object
  85502. */
  85503. static Red(): Color3;
  85504. /**
  85505. * Returns a Color3 value containing a green color
  85506. * @returns a new Color3 object
  85507. */
  85508. static Green(): Color3;
  85509. /**
  85510. * Returns a Color3 value containing a blue color
  85511. * @returns a new Color3 object
  85512. */
  85513. static Blue(): Color3;
  85514. /**
  85515. * Returns a Color3 value containing a black color
  85516. * @returns a new Color3 object
  85517. */
  85518. static Black(): Color3;
  85519. /**
  85520. * Gets a Color3 value containing a black color that must not be updated
  85521. */
  85522. static get BlackReadOnly(): DeepImmutable<Color3>;
  85523. /**
  85524. * Returns a Color3 value containing a white color
  85525. * @returns a new Color3 object
  85526. */
  85527. static White(): Color3;
  85528. /**
  85529. * Returns a Color3 value containing a purple color
  85530. * @returns a new Color3 object
  85531. */
  85532. static Purple(): Color3;
  85533. /**
  85534. * Returns a Color3 value containing a magenta color
  85535. * @returns a new Color3 object
  85536. */
  85537. static Magenta(): Color3;
  85538. /**
  85539. * Returns a Color3 value containing a yellow color
  85540. * @returns a new Color3 object
  85541. */
  85542. static Yellow(): Color3;
  85543. /**
  85544. * Returns a Color3 value containing a gray color
  85545. * @returns a new Color3 object
  85546. */
  85547. static Gray(): Color3;
  85548. /**
  85549. * Returns a Color3 value containing a teal color
  85550. * @returns a new Color3 object
  85551. */
  85552. static Teal(): Color3;
  85553. /**
  85554. * Returns a Color3 value containing a random color
  85555. * @returns a new Color3 object
  85556. */
  85557. static Random(): Color3;
  85558. }
  85559. /**
  85560. * Class used to hold a RBGA color
  85561. */
  85562. export class Color4 {
  85563. /**
  85564. * Defines the red component (between 0 and 1, default is 0)
  85565. */
  85566. r: number;
  85567. /**
  85568. * Defines the green component (between 0 and 1, default is 0)
  85569. */
  85570. g: number;
  85571. /**
  85572. * Defines the blue component (between 0 and 1, default is 0)
  85573. */
  85574. b: number;
  85575. /**
  85576. * Defines the alpha component (between 0 and 1, default is 1)
  85577. */
  85578. a: number;
  85579. /**
  85580. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85581. * @param r defines the red component (between 0 and 1, default is 0)
  85582. * @param g defines the green component (between 0 and 1, default is 0)
  85583. * @param b defines the blue component (between 0 and 1, default is 0)
  85584. * @param a defines the alpha component (between 0 and 1, default is 1)
  85585. */
  85586. constructor(
  85587. /**
  85588. * Defines the red component (between 0 and 1, default is 0)
  85589. */
  85590. r?: number,
  85591. /**
  85592. * Defines the green component (between 0 and 1, default is 0)
  85593. */
  85594. g?: number,
  85595. /**
  85596. * Defines the blue component (between 0 and 1, default is 0)
  85597. */
  85598. b?: number,
  85599. /**
  85600. * Defines the alpha component (between 0 and 1, default is 1)
  85601. */
  85602. a?: number);
  85603. /**
  85604. * Adds in place the given Color4 values to the current Color4 object
  85605. * @param right defines the second operand
  85606. * @returns the current updated Color4 object
  85607. */
  85608. addInPlace(right: DeepImmutable<Color4>): Color4;
  85609. /**
  85610. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85611. * @returns the new array
  85612. */
  85613. asArray(): number[];
  85614. /**
  85615. * Stores from the starting index in the given array the Color4 successive values
  85616. * @param array defines the array where to store the r,g,b components
  85617. * @param index defines an optional index in the target array to define where to start storing values
  85618. * @returns the current Color4 object
  85619. */
  85620. toArray(array: number[], index?: number): Color4;
  85621. /**
  85622. * Update the current color with values stored in an array from the starting index of the given array
  85623. * @param array defines the source array
  85624. * @param offset defines an offset in the source array
  85625. * @returns the current Color4 object
  85626. */
  85627. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85628. /**
  85629. * Determines equality between Color4 objects
  85630. * @param otherColor defines the second operand
  85631. * @returns true if the rgba values are equal to the given ones
  85632. */
  85633. equals(otherColor: DeepImmutable<Color4>): boolean;
  85634. /**
  85635. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85636. * @param right defines the second operand
  85637. * @returns a new Color4 object
  85638. */
  85639. add(right: DeepImmutable<Color4>): Color4;
  85640. /**
  85641. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85642. * @param right defines the second operand
  85643. * @returns a new Color4 object
  85644. */
  85645. subtract(right: DeepImmutable<Color4>): Color4;
  85646. /**
  85647. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85648. * @param right defines the second operand
  85649. * @param result defines the Color4 object where to store the result
  85650. * @returns the current Color4 object
  85651. */
  85652. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85653. /**
  85654. * Creates a new Color4 with the current Color4 values multiplied by scale
  85655. * @param scale defines the scaling factor to apply
  85656. * @returns a new Color4 object
  85657. */
  85658. scale(scale: number): Color4;
  85659. /**
  85660. * Multiplies the current Color4 values by scale and stores the result in "result"
  85661. * @param scale defines the scaling factor to apply
  85662. * @param result defines the Color4 object where to store the result
  85663. * @returns the current unmodified Color4
  85664. */
  85665. scaleToRef(scale: number, result: Color4): Color4;
  85666. /**
  85667. * Scale the current Color4 values by a factor and add the result to a given Color4
  85668. * @param scale defines the scale factor
  85669. * @param result defines the Color4 object where to store the result
  85670. * @returns the unmodified current Color4
  85671. */
  85672. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85673. /**
  85674. * Clamps the rgb values by the min and max values and stores the result into "result"
  85675. * @param min defines minimum clamping value (default is 0)
  85676. * @param max defines maximum clamping value (default is 1)
  85677. * @param result defines color to store the result into.
  85678. * @returns the cuurent Color4
  85679. */
  85680. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85681. /**
  85682. * Multipy an Color4 value by another and return a new Color4 object
  85683. * @param color defines the Color4 value to multiply by
  85684. * @returns a new Color4 object
  85685. */
  85686. multiply(color: Color4): Color4;
  85687. /**
  85688. * Multipy a Color4 value by another and push the result in a reference value
  85689. * @param color defines the Color4 value to multiply by
  85690. * @param result defines the Color4 to fill the result in
  85691. * @returns the result Color4
  85692. */
  85693. multiplyToRef(color: Color4, result: Color4): Color4;
  85694. /**
  85695. * Creates a string with the Color4 current values
  85696. * @returns the string representation of the Color4 object
  85697. */
  85698. toString(): string;
  85699. /**
  85700. * Returns the string "Color4"
  85701. * @returns "Color4"
  85702. */
  85703. getClassName(): string;
  85704. /**
  85705. * Compute the Color4 hash code
  85706. * @returns an unique number that can be used to hash Color4 objects
  85707. */
  85708. getHashCode(): number;
  85709. /**
  85710. * Creates a new Color4 copied from the current one
  85711. * @returns a new Color4 object
  85712. */
  85713. clone(): Color4;
  85714. /**
  85715. * Copies the given Color4 values into the current one
  85716. * @param source defines the source Color4 object
  85717. * @returns the current updated Color4 object
  85718. */
  85719. copyFrom(source: Color4): Color4;
  85720. /**
  85721. * Copies the given float values into the current one
  85722. * @param r defines the red component to read from
  85723. * @param g defines the green component to read from
  85724. * @param b defines the blue component to read from
  85725. * @param a defines the alpha component to read from
  85726. * @returns the current updated Color4 object
  85727. */
  85728. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85729. /**
  85730. * Copies the given float values into the current one
  85731. * @param r defines the red component to read from
  85732. * @param g defines the green component to read from
  85733. * @param b defines the blue component to read from
  85734. * @param a defines the alpha component to read from
  85735. * @returns the current updated Color4 object
  85736. */
  85737. set(r: number, g: number, b: number, a: number): Color4;
  85738. /**
  85739. * Compute the Color4 hexadecimal code as a string
  85740. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85741. * @returns a string containing the hexadecimal representation of the Color4 object
  85742. */
  85743. toHexString(returnAsColor3?: boolean): string;
  85744. /**
  85745. * Computes a new Color4 converted from the current one to linear space
  85746. * @returns a new Color4 object
  85747. */
  85748. toLinearSpace(): Color4;
  85749. /**
  85750. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85751. * @param convertedColor defines the Color4 object where to store the linear space version
  85752. * @returns the unmodified Color4
  85753. */
  85754. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85755. /**
  85756. * Computes a new Color4 converted from the current one to gamma space
  85757. * @returns a new Color4 object
  85758. */
  85759. toGammaSpace(): Color4;
  85760. /**
  85761. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85762. * @param convertedColor defines the Color4 object where to store the gamma space version
  85763. * @returns the unmodified Color4
  85764. */
  85765. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85766. /**
  85767. * Creates a new Color4 from the string containing valid hexadecimal values
  85768. * @param hex defines a string containing valid hexadecimal values
  85769. * @returns a new Color4 object
  85770. */
  85771. static FromHexString(hex: string): Color4;
  85772. /**
  85773. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85774. * @param left defines the start value
  85775. * @param right defines the end value
  85776. * @param amount defines the gradient factor
  85777. * @returns a new Color4 object
  85778. */
  85779. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85780. /**
  85781. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85782. * @param left defines the start value
  85783. * @param right defines the end value
  85784. * @param amount defines the gradient factor
  85785. * @param result defines the Color4 object where to store data
  85786. */
  85787. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85788. /**
  85789. * Creates a new Color4 from a Color3 and an alpha value
  85790. * @param color3 defines the source Color3 to read from
  85791. * @param alpha defines the alpha component (1.0 by default)
  85792. * @returns a new Color4 object
  85793. */
  85794. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85795. /**
  85796. * Creates a new Color4 from the starting index element of the given array
  85797. * @param array defines the source array to read from
  85798. * @param offset defines the offset in the source array
  85799. * @returns a new Color4 object
  85800. */
  85801. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85802. /**
  85803. * Creates a new Color4 from the starting index element of the given array
  85804. * @param array defines the source array to read from
  85805. * @param offset defines the offset in the source array
  85806. * @param result defines the target Color4 object
  85807. */
  85808. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85809. /**
  85810. * Creates a new Color3 from integer values (< 256)
  85811. * @param r defines the red component to read from (value between 0 and 255)
  85812. * @param g defines the green component to read from (value between 0 and 255)
  85813. * @param b defines the blue component to read from (value between 0 and 255)
  85814. * @param a defines the alpha component to read from (value between 0 and 255)
  85815. * @returns a new Color3 object
  85816. */
  85817. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85818. /**
  85819. * Check the content of a given array and convert it to an array containing RGBA data
  85820. * If the original array was already containing count * 4 values then it is returned directly
  85821. * @param colors defines the array to check
  85822. * @param count defines the number of RGBA data to expect
  85823. * @returns an array containing count * 4 values (RGBA)
  85824. */
  85825. static CheckColors4(colors: number[], count: number): number[];
  85826. }
  85827. /**
  85828. * @hidden
  85829. */
  85830. export class TmpColors {
  85831. static Color3: Color3[];
  85832. static Color4: Color4[];
  85833. }
  85834. }
  85835. declare module BABYLON {
  85836. /**
  85837. * Defines an interface which represents an animation key frame
  85838. */
  85839. export interface IAnimationKey {
  85840. /**
  85841. * Frame of the key frame
  85842. */
  85843. frame: number;
  85844. /**
  85845. * Value at the specifies key frame
  85846. */
  85847. value: any;
  85848. /**
  85849. * The input tangent for the cubic hermite spline
  85850. */
  85851. inTangent?: any;
  85852. /**
  85853. * The output tangent for the cubic hermite spline
  85854. */
  85855. outTangent?: any;
  85856. /**
  85857. * The animation interpolation type
  85858. */
  85859. interpolation?: AnimationKeyInterpolation;
  85860. }
  85861. /**
  85862. * Enum for the animation key frame interpolation type
  85863. */
  85864. export enum AnimationKeyInterpolation {
  85865. /**
  85866. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85867. */
  85868. STEP = 1
  85869. }
  85870. }
  85871. declare module BABYLON {
  85872. /**
  85873. * Represents the range of an animation
  85874. */
  85875. export class AnimationRange {
  85876. /**The name of the animation range**/
  85877. name: string;
  85878. /**The starting frame of the animation */
  85879. from: number;
  85880. /**The ending frame of the animation*/
  85881. to: number;
  85882. /**
  85883. * Initializes the range of an animation
  85884. * @param name The name of the animation range
  85885. * @param from The starting frame of the animation
  85886. * @param to The ending frame of the animation
  85887. */
  85888. constructor(
  85889. /**The name of the animation range**/
  85890. name: string,
  85891. /**The starting frame of the animation */
  85892. from: number,
  85893. /**The ending frame of the animation*/
  85894. to: number);
  85895. /**
  85896. * Makes a copy of the animation range
  85897. * @returns A copy of the animation range
  85898. */
  85899. clone(): AnimationRange;
  85900. }
  85901. }
  85902. declare module BABYLON {
  85903. /**
  85904. * Composed of a frame, and an action function
  85905. */
  85906. export class AnimationEvent {
  85907. /** The frame for which the event is triggered **/
  85908. frame: number;
  85909. /** The event to perform when triggered **/
  85910. action: (currentFrame: number) => void;
  85911. /** Specifies if the event should be triggered only once**/
  85912. onlyOnce?: boolean | undefined;
  85913. /**
  85914. * Specifies if the animation event is done
  85915. */
  85916. isDone: boolean;
  85917. /**
  85918. * Initializes the animation event
  85919. * @param frame The frame for which the event is triggered
  85920. * @param action The event to perform when triggered
  85921. * @param onlyOnce Specifies if the event should be triggered only once
  85922. */
  85923. constructor(
  85924. /** The frame for which the event is triggered **/
  85925. frame: number,
  85926. /** The event to perform when triggered **/
  85927. action: (currentFrame: number) => void,
  85928. /** Specifies if the event should be triggered only once**/
  85929. onlyOnce?: boolean | undefined);
  85930. /** @hidden */
  85931. _clone(): AnimationEvent;
  85932. }
  85933. }
  85934. declare module BABYLON {
  85935. /**
  85936. * Interface used to define a behavior
  85937. */
  85938. export interface Behavior<T> {
  85939. /** gets or sets behavior's name */
  85940. name: string;
  85941. /**
  85942. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85943. */
  85944. init(): void;
  85945. /**
  85946. * Called when the behavior is attached to a target
  85947. * @param target defines the target where the behavior is attached to
  85948. */
  85949. attach(target: T): void;
  85950. /**
  85951. * Called when the behavior is detached from its target
  85952. */
  85953. detach(): void;
  85954. }
  85955. /**
  85956. * Interface implemented by classes supporting behaviors
  85957. */
  85958. export interface IBehaviorAware<T> {
  85959. /**
  85960. * Attach a behavior
  85961. * @param behavior defines the behavior to attach
  85962. * @returns the current host
  85963. */
  85964. addBehavior(behavior: Behavior<T>): T;
  85965. /**
  85966. * Remove a behavior from the current object
  85967. * @param behavior defines the behavior to detach
  85968. * @returns the current host
  85969. */
  85970. removeBehavior(behavior: Behavior<T>): T;
  85971. /**
  85972. * Gets a behavior using its name to search
  85973. * @param name defines the name to search
  85974. * @returns the behavior or null if not found
  85975. */
  85976. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85977. }
  85978. }
  85979. declare module BABYLON {
  85980. /**
  85981. * Defines an array and its length.
  85982. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85983. */
  85984. export interface ISmartArrayLike<T> {
  85985. /**
  85986. * The data of the array.
  85987. */
  85988. data: Array<T>;
  85989. /**
  85990. * The active length of the array.
  85991. */
  85992. length: number;
  85993. }
  85994. /**
  85995. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85996. */
  85997. export class SmartArray<T> implements ISmartArrayLike<T> {
  85998. /**
  85999. * The full set of data from the array.
  86000. */
  86001. data: Array<T>;
  86002. /**
  86003. * The active length of the array.
  86004. */
  86005. length: number;
  86006. protected _id: number;
  86007. /**
  86008. * Instantiates a Smart Array.
  86009. * @param capacity defines the default capacity of the array.
  86010. */
  86011. constructor(capacity: number);
  86012. /**
  86013. * Pushes a value at the end of the active data.
  86014. * @param value defines the object to push in the array.
  86015. */
  86016. push(value: T): void;
  86017. /**
  86018. * Iterates over the active data and apply the lambda to them.
  86019. * @param func defines the action to apply on each value.
  86020. */
  86021. forEach(func: (content: T) => void): void;
  86022. /**
  86023. * Sorts the full sets of data.
  86024. * @param compareFn defines the comparison function to apply.
  86025. */
  86026. sort(compareFn: (a: T, b: T) => number): void;
  86027. /**
  86028. * Resets the active data to an empty array.
  86029. */
  86030. reset(): void;
  86031. /**
  86032. * Releases all the data from the array as well as the array.
  86033. */
  86034. dispose(): void;
  86035. /**
  86036. * Concats the active data with a given array.
  86037. * @param array defines the data to concatenate with.
  86038. */
  86039. concat(array: any): void;
  86040. /**
  86041. * Returns the position of a value in the active data.
  86042. * @param value defines the value to find the index for
  86043. * @returns the index if found in the active data otherwise -1
  86044. */
  86045. indexOf(value: T): number;
  86046. /**
  86047. * Returns whether an element is part of the active data.
  86048. * @param value defines the value to look for
  86049. * @returns true if found in the active data otherwise false
  86050. */
  86051. contains(value: T): boolean;
  86052. private static _GlobalId;
  86053. }
  86054. /**
  86055. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86056. * The data in this array can only be present once
  86057. */
  86058. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  86059. private _duplicateId;
  86060. /**
  86061. * Pushes a value at the end of the active data.
  86062. * THIS DOES NOT PREVENT DUPPLICATE DATA
  86063. * @param value defines the object to push in the array.
  86064. */
  86065. push(value: T): void;
  86066. /**
  86067. * Pushes a value at the end of the active data.
  86068. * If the data is already present, it won t be added again
  86069. * @param value defines the object to push in the array.
  86070. * @returns true if added false if it was already present
  86071. */
  86072. pushNoDuplicate(value: T): boolean;
  86073. /**
  86074. * Resets the active data to an empty array.
  86075. */
  86076. reset(): void;
  86077. /**
  86078. * Concats the active data with a given array.
  86079. * This ensures no dupplicate will be present in the result.
  86080. * @param array defines the data to concatenate with.
  86081. */
  86082. concatWithNoDuplicate(array: any): void;
  86083. }
  86084. }
  86085. declare module BABYLON {
  86086. /**
  86087. * @ignore
  86088. * This is a list of all the different input types that are available in the application.
  86089. * Fo instance: ArcRotateCameraGamepadInput...
  86090. */
  86091. export var CameraInputTypes: {};
  86092. /**
  86093. * This is the contract to implement in order to create a new input class.
  86094. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86095. */
  86096. export interface ICameraInput<TCamera extends Camera> {
  86097. /**
  86098. * Defines the camera the input is attached to.
  86099. */
  86100. camera: Nullable<TCamera>;
  86101. /**
  86102. * Gets the class name of the current intput.
  86103. * @returns the class name
  86104. */
  86105. getClassName(): string;
  86106. /**
  86107. * Get the friendly name associated with the input class.
  86108. * @returns the input friendly name
  86109. */
  86110. getSimpleName(): string;
  86111. /**
  86112. * Attach the input controls to a specific dom element to get the input from.
  86113. * @param element Defines the element the controls should be listened from
  86114. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86115. */
  86116. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86117. /**
  86118. * Detach the current controls from the specified dom element.
  86119. * @param element Defines the element to stop listening the inputs from
  86120. */
  86121. detachControl(element: Nullable<HTMLElement>): void;
  86122. /**
  86123. * Update the current camera state depending on the inputs that have been used this frame.
  86124. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86125. */
  86126. checkInputs?: () => void;
  86127. }
  86128. /**
  86129. * Represents a map of input types to input instance or input index to input instance.
  86130. */
  86131. export interface CameraInputsMap<TCamera extends Camera> {
  86132. /**
  86133. * Accessor to the input by input type.
  86134. */
  86135. [name: string]: ICameraInput<TCamera>;
  86136. /**
  86137. * Accessor to the input by input index.
  86138. */
  86139. [idx: number]: ICameraInput<TCamera>;
  86140. }
  86141. /**
  86142. * This represents the input manager used within a camera.
  86143. * It helps dealing with all the different kind of input attached to a camera.
  86144. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86145. */
  86146. export class CameraInputsManager<TCamera extends Camera> {
  86147. /**
  86148. * Defines the list of inputs attahed to the camera.
  86149. */
  86150. attached: CameraInputsMap<TCamera>;
  86151. /**
  86152. * Defines the dom element the camera is collecting inputs from.
  86153. * This is null if the controls have not been attached.
  86154. */
  86155. attachedElement: Nullable<HTMLElement>;
  86156. /**
  86157. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86158. */
  86159. noPreventDefault: boolean;
  86160. /**
  86161. * Defined the camera the input manager belongs to.
  86162. */
  86163. camera: TCamera;
  86164. /**
  86165. * Update the current camera state depending on the inputs that have been used this frame.
  86166. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86167. */
  86168. checkInputs: () => void;
  86169. /**
  86170. * Instantiate a new Camera Input Manager.
  86171. * @param camera Defines the camera the input manager blongs to
  86172. */
  86173. constructor(camera: TCamera);
  86174. /**
  86175. * Add an input method to a camera
  86176. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86177. * @param input camera input method
  86178. */
  86179. add(input: ICameraInput<TCamera>): void;
  86180. /**
  86181. * Remove a specific input method from a camera
  86182. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86183. * @param inputToRemove camera input method
  86184. */
  86185. remove(inputToRemove: ICameraInput<TCamera>): void;
  86186. /**
  86187. * Remove a specific input type from a camera
  86188. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86189. * @param inputType the type of the input to remove
  86190. */
  86191. removeByType(inputType: string): void;
  86192. private _addCheckInputs;
  86193. /**
  86194. * Attach the input controls to the currently attached dom element to listen the events from.
  86195. * @param input Defines the input to attach
  86196. */
  86197. attachInput(input: ICameraInput<TCamera>): void;
  86198. /**
  86199. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86200. * @param element Defines the dom element to collect the events from
  86201. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86202. */
  86203. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86204. /**
  86205. * Detach the current manager inputs controls from a specific dom element.
  86206. * @param element Defines the dom element to collect the events from
  86207. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86208. */
  86209. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86210. /**
  86211. * Rebuild the dynamic inputCheck function from the current list of
  86212. * defined inputs in the manager.
  86213. */
  86214. rebuildInputCheck(): void;
  86215. /**
  86216. * Remove all attached input methods from a camera
  86217. */
  86218. clear(): void;
  86219. /**
  86220. * Serialize the current input manager attached to a camera.
  86221. * This ensures than once parsed,
  86222. * the input associated to the camera will be identical to the current ones
  86223. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86224. */
  86225. serialize(serializedCamera: any): void;
  86226. /**
  86227. * Parses an input manager serialized JSON to restore the previous list of inputs
  86228. * and states associated to a camera.
  86229. * @param parsedCamera Defines the JSON to parse
  86230. */
  86231. parse(parsedCamera: any): void;
  86232. }
  86233. }
  86234. declare module BABYLON {
  86235. /**
  86236. * Class used to store data that will be store in GPU memory
  86237. */
  86238. export class Buffer {
  86239. private _engine;
  86240. private _buffer;
  86241. /** @hidden */
  86242. _data: Nullable<DataArray>;
  86243. private _updatable;
  86244. private _instanced;
  86245. private _divisor;
  86246. /**
  86247. * Gets the byte stride.
  86248. */
  86249. readonly byteStride: number;
  86250. /**
  86251. * Constructor
  86252. * @param engine the engine
  86253. * @param data the data to use for this buffer
  86254. * @param updatable whether the data is updatable
  86255. * @param stride the stride (optional)
  86256. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86257. * @param instanced whether the buffer is instanced (optional)
  86258. * @param useBytes set to true if the stride in in bytes (optional)
  86259. * @param divisor sets an optional divisor for instances (1 by default)
  86260. */
  86261. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86262. /**
  86263. * Create a new VertexBuffer based on the current buffer
  86264. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86265. * @param offset defines offset in the buffer (0 by default)
  86266. * @param size defines the size in floats of attributes (position is 3 for instance)
  86267. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86268. * @param instanced defines if the vertex buffer contains indexed data
  86269. * @param useBytes defines if the offset and stride are in bytes *
  86270. * @param divisor sets an optional divisor for instances (1 by default)
  86271. * @returns the new vertex buffer
  86272. */
  86273. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86274. /**
  86275. * Gets a boolean indicating if the Buffer is updatable?
  86276. * @returns true if the buffer is updatable
  86277. */
  86278. isUpdatable(): boolean;
  86279. /**
  86280. * Gets current buffer's data
  86281. * @returns a DataArray or null
  86282. */
  86283. getData(): Nullable<DataArray>;
  86284. /**
  86285. * Gets underlying native buffer
  86286. * @returns underlying native buffer
  86287. */
  86288. getBuffer(): Nullable<DataBuffer>;
  86289. /**
  86290. * Gets the stride in float32 units (i.e. byte stride / 4).
  86291. * May not be an integer if the byte stride is not divisible by 4.
  86292. * @returns the stride in float32 units
  86293. * @deprecated Please use byteStride instead.
  86294. */
  86295. getStrideSize(): number;
  86296. /**
  86297. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86298. * @param data defines the data to store
  86299. */
  86300. create(data?: Nullable<DataArray>): void;
  86301. /** @hidden */
  86302. _rebuild(): void;
  86303. /**
  86304. * Update current buffer data
  86305. * @param data defines the data to store
  86306. */
  86307. update(data: DataArray): void;
  86308. /**
  86309. * Updates the data directly.
  86310. * @param data the new data
  86311. * @param offset the new offset
  86312. * @param vertexCount the vertex count (optional)
  86313. * @param useBytes set to true if the offset is in bytes
  86314. */
  86315. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86316. /**
  86317. * Release all resources
  86318. */
  86319. dispose(): void;
  86320. }
  86321. /**
  86322. * Specialized buffer used to store vertex data
  86323. */
  86324. export class VertexBuffer {
  86325. /** @hidden */
  86326. _buffer: Buffer;
  86327. private _kind;
  86328. private _size;
  86329. private _ownsBuffer;
  86330. private _instanced;
  86331. private _instanceDivisor;
  86332. /**
  86333. * The byte type.
  86334. */
  86335. static readonly BYTE: number;
  86336. /**
  86337. * The unsigned byte type.
  86338. */
  86339. static readonly UNSIGNED_BYTE: number;
  86340. /**
  86341. * The short type.
  86342. */
  86343. static readonly SHORT: number;
  86344. /**
  86345. * The unsigned short type.
  86346. */
  86347. static readonly UNSIGNED_SHORT: number;
  86348. /**
  86349. * The integer type.
  86350. */
  86351. static readonly INT: number;
  86352. /**
  86353. * The unsigned integer type.
  86354. */
  86355. static readonly UNSIGNED_INT: number;
  86356. /**
  86357. * The float type.
  86358. */
  86359. static readonly FLOAT: number;
  86360. /**
  86361. * Gets or sets the instance divisor when in instanced mode
  86362. */
  86363. get instanceDivisor(): number;
  86364. set instanceDivisor(value: number);
  86365. /**
  86366. * Gets the byte stride.
  86367. */
  86368. readonly byteStride: number;
  86369. /**
  86370. * Gets the byte offset.
  86371. */
  86372. readonly byteOffset: number;
  86373. /**
  86374. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86375. */
  86376. readonly normalized: boolean;
  86377. /**
  86378. * Gets the data type of each component in the array.
  86379. */
  86380. readonly type: number;
  86381. /**
  86382. * Constructor
  86383. * @param engine the engine
  86384. * @param data the data to use for this vertex buffer
  86385. * @param kind the vertex buffer kind
  86386. * @param updatable whether the data is updatable
  86387. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86388. * @param stride the stride (optional)
  86389. * @param instanced whether the buffer is instanced (optional)
  86390. * @param offset the offset of the data (optional)
  86391. * @param size the number of components (optional)
  86392. * @param type the type of the component (optional)
  86393. * @param normalized whether the data contains normalized data (optional)
  86394. * @param useBytes set to true if stride and offset are in bytes (optional)
  86395. * @param divisor defines the instance divisor to use (1 by default)
  86396. */
  86397. 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);
  86398. /** @hidden */
  86399. _rebuild(): void;
  86400. /**
  86401. * Returns the kind of the VertexBuffer (string)
  86402. * @returns a string
  86403. */
  86404. getKind(): string;
  86405. /**
  86406. * Gets a boolean indicating if the VertexBuffer is updatable?
  86407. * @returns true if the buffer is updatable
  86408. */
  86409. isUpdatable(): boolean;
  86410. /**
  86411. * Gets current buffer's data
  86412. * @returns a DataArray or null
  86413. */
  86414. getData(): Nullable<DataArray>;
  86415. /**
  86416. * Gets underlying native buffer
  86417. * @returns underlying native buffer
  86418. */
  86419. getBuffer(): Nullable<DataBuffer>;
  86420. /**
  86421. * Gets the stride in float32 units (i.e. byte stride / 4).
  86422. * May not be an integer if the byte stride is not divisible by 4.
  86423. * @returns the stride in float32 units
  86424. * @deprecated Please use byteStride instead.
  86425. */
  86426. getStrideSize(): number;
  86427. /**
  86428. * Returns the offset as a multiple of the type byte length.
  86429. * @returns the offset in bytes
  86430. * @deprecated Please use byteOffset instead.
  86431. */
  86432. getOffset(): number;
  86433. /**
  86434. * Returns the number of components per vertex attribute (integer)
  86435. * @returns the size in float
  86436. */
  86437. getSize(): number;
  86438. /**
  86439. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86440. * @returns true if this buffer is instanced
  86441. */
  86442. getIsInstanced(): boolean;
  86443. /**
  86444. * Returns the instancing divisor, zero for non-instanced (integer).
  86445. * @returns a number
  86446. */
  86447. getInstanceDivisor(): number;
  86448. /**
  86449. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86450. * @param data defines the data to store
  86451. */
  86452. create(data?: DataArray): void;
  86453. /**
  86454. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86455. * This function will create a new buffer if the current one is not updatable
  86456. * @param data defines the data to store
  86457. */
  86458. update(data: DataArray): void;
  86459. /**
  86460. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86461. * Returns the directly updated WebGLBuffer.
  86462. * @param data the new data
  86463. * @param offset the new offset
  86464. * @param useBytes set to true if the offset is in bytes
  86465. */
  86466. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86467. /**
  86468. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86469. */
  86470. dispose(): void;
  86471. /**
  86472. * Enumerates each value of this vertex buffer as numbers.
  86473. * @param count the number of values to enumerate
  86474. * @param callback the callback function called for each value
  86475. */
  86476. forEach(count: number, callback: (value: number, index: number) => void): void;
  86477. /**
  86478. * Positions
  86479. */
  86480. static readonly PositionKind: string;
  86481. /**
  86482. * Normals
  86483. */
  86484. static readonly NormalKind: string;
  86485. /**
  86486. * Tangents
  86487. */
  86488. static readonly TangentKind: string;
  86489. /**
  86490. * Texture coordinates
  86491. */
  86492. static readonly UVKind: string;
  86493. /**
  86494. * Texture coordinates 2
  86495. */
  86496. static readonly UV2Kind: string;
  86497. /**
  86498. * Texture coordinates 3
  86499. */
  86500. static readonly UV3Kind: string;
  86501. /**
  86502. * Texture coordinates 4
  86503. */
  86504. static readonly UV4Kind: string;
  86505. /**
  86506. * Texture coordinates 5
  86507. */
  86508. static readonly UV5Kind: string;
  86509. /**
  86510. * Texture coordinates 6
  86511. */
  86512. static readonly UV6Kind: string;
  86513. /**
  86514. * Colors
  86515. */
  86516. static readonly ColorKind: string;
  86517. /**
  86518. * Matrix indices (for bones)
  86519. */
  86520. static readonly MatricesIndicesKind: string;
  86521. /**
  86522. * Matrix weights (for bones)
  86523. */
  86524. static readonly MatricesWeightsKind: string;
  86525. /**
  86526. * Additional matrix indices (for bones)
  86527. */
  86528. static readonly MatricesIndicesExtraKind: string;
  86529. /**
  86530. * Additional matrix weights (for bones)
  86531. */
  86532. static readonly MatricesWeightsExtraKind: string;
  86533. /**
  86534. * Deduces the stride given a kind.
  86535. * @param kind The kind string to deduce
  86536. * @returns The deduced stride
  86537. */
  86538. static DeduceStride(kind: string): number;
  86539. /**
  86540. * Gets the byte length of the given type.
  86541. * @param type the type
  86542. * @returns the number of bytes
  86543. */
  86544. static GetTypeByteLength(type: number): number;
  86545. /**
  86546. * Enumerates each value of the given parameters as numbers.
  86547. * @param data the data to enumerate
  86548. * @param byteOffset the byte offset of the data
  86549. * @param byteStride the byte stride of the data
  86550. * @param componentCount the number of components per element
  86551. * @param componentType the type of the component
  86552. * @param count the number of values to enumerate
  86553. * @param normalized whether the data is normalized
  86554. * @param callback the callback function called for each value
  86555. */
  86556. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86557. private static _GetFloatValue;
  86558. }
  86559. }
  86560. declare module BABYLON {
  86561. /**
  86562. * @hidden
  86563. */
  86564. export class IntersectionInfo {
  86565. bu: Nullable<number>;
  86566. bv: Nullable<number>;
  86567. distance: number;
  86568. faceId: number;
  86569. subMeshId: number;
  86570. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86571. }
  86572. }
  86573. declare module BABYLON {
  86574. /**
  86575. * Class used to store bounding sphere information
  86576. */
  86577. export class BoundingSphere {
  86578. /**
  86579. * Gets the center of the bounding sphere in local space
  86580. */
  86581. readonly center: Vector3;
  86582. /**
  86583. * Radius of the bounding sphere in local space
  86584. */
  86585. radius: number;
  86586. /**
  86587. * Gets the center of the bounding sphere in world space
  86588. */
  86589. readonly centerWorld: Vector3;
  86590. /**
  86591. * Radius of the bounding sphere in world space
  86592. */
  86593. radiusWorld: number;
  86594. /**
  86595. * Gets the minimum vector in local space
  86596. */
  86597. readonly minimum: Vector3;
  86598. /**
  86599. * Gets the maximum vector in local space
  86600. */
  86601. readonly maximum: Vector3;
  86602. private _worldMatrix;
  86603. private static readonly TmpVector3;
  86604. /**
  86605. * Creates a new bounding sphere
  86606. * @param min defines the minimum vector (in local space)
  86607. * @param max defines the maximum vector (in local space)
  86608. * @param worldMatrix defines the new world matrix
  86609. */
  86610. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86611. /**
  86612. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86613. * @param min defines the new minimum vector (in local space)
  86614. * @param max defines the new maximum vector (in local space)
  86615. * @param worldMatrix defines the new world matrix
  86616. */
  86617. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86618. /**
  86619. * Scale the current bounding sphere by applying a scale factor
  86620. * @param factor defines the scale factor to apply
  86621. * @returns the current bounding box
  86622. */
  86623. scale(factor: number): BoundingSphere;
  86624. /**
  86625. * Gets the world matrix of the bounding box
  86626. * @returns a matrix
  86627. */
  86628. getWorldMatrix(): DeepImmutable<Matrix>;
  86629. /** @hidden */
  86630. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86631. /**
  86632. * Tests if the bounding sphere is intersecting the frustum planes
  86633. * @param frustumPlanes defines the frustum planes to test
  86634. * @returns true if there is an intersection
  86635. */
  86636. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86637. /**
  86638. * Tests if the bounding sphere center is in between the frustum planes.
  86639. * Used for optimistic fast inclusion.
  86640. * @param frustumPlanes defines the frustum planes to test
  86641. * @returns true if the sphere center is in between the frustum planes
  86642. */
  86643. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86644. /**
  86645. * Tests if a point is inside the bounding sphere
  86646. * @param point defines the point to test
  86647. * @returns true if the point is inside the bounding sphere
  86648. */
  86649. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86650. /**
  86651. * Checks if two sphere intersct
  86652. * @param sphere0 sphere 0
  86653. * @param sphere1 sphere 1
  86654. * @returns true if the speres intersect
  86655. */
  86656. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86657. }
  86658. }
  86659. declare module BABYLON {
  86660. /**
  86661. * Class used to store bounding box information
  86662. */
  86663. export class BoundingBox implements ICullable {
  86664. /**
  86665. * Gets the 8 vectors representing the bounding box in local space
  86666. */
  86667. readonly vectors: Vector3[];
  86668. /**
  86669. * Gets the center of the bounding box in local space
  86670. */
  86671. readonly center: Vector3;
  86672. /**
  86673. * Gets the center of the bounding box in world space
  86674. */
  86675. readonly centerWorld: Vector3;
  86676. /**
  86677. * Gets the extend size in local space
  86678. */
  86679. readonly extendSize: Vector3;
  86680. /**
  86681. * Gets the extend size in world space
  86682. */
  86683. readonly extendSizeWorld: Vector3;
  86684. /**
  86685. * Gets the OBB (object bounding box) directions
  86686. */
  86687. readonly directions: Vector3[];
  86688. /**
  86689. * Gets the 8 vectors representing the bounding box in world space
  86690. */
  86691. readonly vectorsWorld: Vector3[];
  86692. /**
  86693. * Gets the minimum vector in world space
  86694. */
  86695. readonly minimumWorld: Vector3;
  86696. /**
  86697. * Gets the maximum vector in world space
  86698. */
  86699. readonly maximumWorld: Vector3;
  86700. /**
  86701. * Gets the minimum vector in local space
  86702. */
  86703. readonly minimum: Vector3;
  86704. /**
  86705. * Gets the maximum vector in local space
  86706. */
  86707. readonly maximum: Vector3;
  86708. private _worldMatrix;
  86709. private static readonly TmpVector3;
  86710. /**
  86711. * @hidden
  86712. */
  86713. _tag: number;
  86714. /**
  86715. * Creates a new bounding box
  86716. * @param min defines the minimum vector (in local space)
  86717. * @param max defines the maximum vector (in local space)
  86718. * @param worldMatrix defines the new world matrix
  86719. */
  86720. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86721. /**
  86722. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86723. * @param min defines the new minimum vector (in local space)
  86724. * @param max defines the new maximum vector (in local space)
  86725. * @param worldMatrix defines the new world matrix
  86726. */
  86727. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86728. /**
  86729. * Scale the current bounding box by applying a scale factor
  86730. * @param factor defines the scale factor to apply
  86731. * @returns the current bounding box
  86732. */
  86733. scale(factor: number): BoundingBox;
  86734. /**
  86735. * Gets the world matrix of the bounding box
  86736. * @returns a matrix
  86737. */
  86738. getWorldMatrix(): DeepImmutable<Matrix>;
  86739. /** @hidden */
  86740. _update(world: DeepImmutable<Matrix>): void;
  86741. /**
  86742. * Tests if the bounding box is intersecting the frustum planes
  86743. * @param frustumPlanes defines the frustum planes to test
  86744. * @returns true if there is an intersection
  86745. */
  86746. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86747. /**
  86748. * Tests if the bounding box is entirely inside the frustum planes
  86749. * @param frustumPlanes defines the frustum planes to test
  86750. * @returns true if there is an inclusion
  86751. */
  86752. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86753. /**
  86754. * Tests if a point is inside the bounding box
  86755. * @param point defines the point to test
  86756. * @returns true if the point is inside the bounding box
  86757. */
  86758. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86759. /**
  86760. * Tests if the bounding box intersects with a bounding sphere
  86761. * @param sphere defines the sphere to test
  86762. * @returns true if there is an intersection
  86763. */
  86764. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86765. /**
  86766. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86767. * @param min defines the min vector to use
  86768. * @param max defines the max vector to use
  86769. * @returns true if there is an intersection
  86770. */
  86771. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86772. /**
  86773. * Tests if two bounding boxes are intersections
  86774. * @param box0 defines the first box to test
  86775. * @param box1 defines the second box to test
  86776. * @returns true if there is an intersection
  86777. */
  86778. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86779. /**
  86780. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86781. * @param minPoint defines the minimum vector of the bounding box
  86782. * @param maxPoint defines the maximum vector of the bounding box
  86783. * @param sphereCenter defines the sphere center
  86784. * @param sphereRadius defines the sphere radius
  86785. * @returns true if there is an intersection
  86786. */
  86787. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86788. /**
  86789. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86790. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86791. * @param frustumPlanes defines the frustum planes to test
  86792. * @return true if there is an inclusion
  86793. */
  86794. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86795. /**
  86796. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86797. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86798. * @param frustumPlanes defines the frustum planes to test
  86799. * @return true if there is an intersection
  86800. */
  86801. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86802. }
  86803. }
  86804. declare module BABYLON {
  86805. /** @hidden */
  86806. export class Collider {
  86807. /** Define if a collision was found */
  86808. collisionFound: boolean;
  86809. /**
  86810. * Define last intersection point in local space
  86811. */
  86812. intersectionPoint: Vector3;
  86813. /**
  86814. * Define last collided mesh
  86815. */
  86816. collidedMesh: Nullable<AbstractMesh>;
  86817. private _collisionPoint;
  86818. private _planeIntersectionPoint;
  86819. private _tempVector;
  86820. private _tempVector2;
  86821. private _tempVector3;
  86822. private _tempVector4;
  86823. private _edge;
  86824. private _baseToVertex;
  86825. private _destinationPoint;
  86826. private _slidePlaneNormal;
  86827. private _displacementVector;
  86828. /** @hidden */
  86829. _radius: Vector3;
  86830. /** @hidden */
  86831. _retry: number;
  86832. private _velocity;
  86833. private _basePoint;
  86834. private _epsilon;
  86835. /** @hidden */
  86836. _velocityWorldLength: number;
  86837. /** @hidden */
  86838. _basePointWorld: Vector3;
  86839. private _velocityWorld;
  86840. private _normalizedVelocity;
  86841. /** @hidden */
  86842. _initialVelocity: Vector3;
  86843. /** @hidden */
  86844. _initialPosition: Vector3;
  86845. private _nearestDistance;
  86846. private _collisionMask;
  86847. get collisionMask(): number;
  86848. set collisionMask(mask: number);
  86849. /**
  86850. * Gets the plane normal used to compute the sliding response (in local space)
  86851. */
  86852. get slidePlaneNormal(): Vector3;
  86853. /** @hidden */
  86854. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86855. /** @hidden */
  86856. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86857. /** @hidden */
  86858. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86859. /** @hidden */
  86860. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86861. /** @hidden */
  86862. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86863. /** @hidden */
  86864. _getResponse(pos: Vector3, vel: Vector3): void;
  86865. }
  86866. }
  86867. declare module BABYLON {
  86868. /**
  86869. * Interface for cullable objects
  86870. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86871. */
  86872. export interface ICullable {
  86873. /**
  86874. * Checks if the object or part of the object is in the frustum
  86875. * @param frustumPlanes Camera near/planes
  86876. * @returns true if the object is in frustum otherwise false
  86877. */
  86878. isInFrustum(frustumPlanes: Plane[]): boolean;
  86879. /**
  86880. * Checks if a cullable object (mesh...) is in the camera frustum
  86881. * Unlike isInFrustum this cheks the full bounding box
  86882. * @param frustumPlanes Camera near/planes
  86883. * @returns true if the object is in frustum otherwise false
  86884. */
  86885. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86886. }
  86887. /**
  86888. * Info for a bounding data of a mesh
  86889. */
  86890. export class BoundingInfo implements ICullable {
  86891. /**
  86892. * Bounding box for the mesh
  86893. */
  86894. readonly boundingBox: BoundingBox;
  86895. /**
  86896. * Bounding sphere for the mesh
  86897. */
  86898. readonly boundingSphere: BoundingSphere;
  86899. private _isLocked;
  86900. private static readonly TmpVector3;
  86901. /**
  86902. * Constructs bounding info
  86903. * @param minimum min vector of the bounding box/sphere
  86904. * @param maximum max vector of the bounding box/sphere
  86905. * @param worldMatrix defines the new world matrix
  86906. */
  86907. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86908. /**
  86909. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86910. * @param min defines the new minimum vector (in local space)
  86911. * @param max defines the new maximum vector (in local space)
  86912. * @param worldMatrix defines the new world matrix
  86913. */
  86914. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86915. /**
  86916. * min vector of the bounding box/sphere
  86917. */
  86918. get minimum(): Vector3;
  86919. /**
  86920. * max vector of the bounding box/sphere
  86921. */
  86922. get maximum(): Vector3;
  86923. /**
  86924. * If the info is locked and won't be updated to avoid perf overhead
  86925. */
  86926. get isLocked(): boolean;
  86927. set isLocked(value: boolean);
  86928. /**
  86929. * Updates the bounding sphere and box
  86930. * @param world world matrix to be used to update
  86931. */
  86932. update(world: DeepImmutable<Matrix>): void;
  86933. /**
  86934. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86935. * @param center New center of the bounding info
  86936. * @param extend New extend of the bounding info
  86937. * @returns the current bounding info
  86938. */
  86939. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86940. /**
  86941. * Scale the current bounding info by applying a scale factor
  86942. * @param factor defines the scale factor to apply
  86943. * @returns the current bounding info
  86944. */
  86945. scale(factor: number): BoundingInfo;
  86946. /**
  86947. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86948. * @param frustumPlanes defines the frustum to test
  86949. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86950. * @returns true if the bounding info is in the frustum planes
  86951. */
  86952. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86953. /**
  86954. * Gets the world distance between the min and max points of the bounding box
  86955. */
  86956. get diagonalLength(): number;
  86957. /**
  86958. * Checks if a cullable object (mesh...) is in the camera frustum
  86959. * Unlike isInFrustum this cheks the full bounding box
  86960. * @param frustumPlanes Camera near/planes
  86961. * @returns true if the object is in frustum otherwise false
  86962. */
  86963. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86964. /** @hidden */
  86965. _checkCollision(collider: Collider): boolean;
  86966. /**
  86967. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86968. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86969. * @param point the point to check intersection with
  86970. * @returns if the point intersects
  86971. */
  86972. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86973. /**
  86974. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86975. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86976. * @param boundingInfo the bounding info to check intersection with
  86977. * @param precise if the intersection should be done using OBB
  86978. * @returns if the bounding info intersects
  86979. */
  86980. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86981. }
  86982. }
  86983. declare module BABYLON {
  86984. /**
  86985. * Extracts minimum and maximum values from a list of indexed positions
  86986. * @param positions defines the positions to use
  86987. * @param indices defines the indices to the positions
  86988. * @param indexStart defines the start index
  86989. * @param indexCount defines the end index
  86990. * @param bias defines bias value to add to the result
  86991. * @return minimum and maximum values
  86992. */
  86993. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86994. minimum: Vector3;
  86995. maximum: Vector3;
  86996. };
  86997. /**
  86998. * Extracts minimum and maximum values from a list of positions
  86999. * @param positions defines the positions to use
  87000. * @param start defines the start index in the positions array
  87001. * @param count defines the number of positions to handle
  87002. * @param bias defines bias value to add to the result
  87003. * @param stride defines the stride size to use (distance between two positions in the positions array)
  87004. * @return minimum and maximum values
  87005. */
  87006. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  87007. minimum: Vector3;
  87008. maximum: Vector3;
  87009. };
  87010. }
  87011. declare module BABYLON {
  87012. /** @hidden */
  87013. export class WebGLDataBuffer extends DataBuffer {
  87014. private _buffer;
  87015. constructor(resource: WebGLBuffer);
  87016. get underlyingResource(): any;
  87017. }
  87018. }
  87019. declare module BABYLON {
  87020. /** @hidden */
  87021. export class WebGLPipelineContext implements IPipelineContext {
  87022. engine: ThinEngine;
  87023. program: Nullable<WebGLProgram>;
  87024. context?: WebGLRenderingContext;
  87025. vertexShader?: WebGLShader;
  87026. fragmentShader?: WebGLShader;
  87027. isParallelCompiled: boolean;
  87028. onCompiled?: () => void;
  87029. transformFeedback?: WebGLTransformFeedback | null;
  87030. vertexCompilationError: Nullable<string>;
  87031. fragmentCompilationError: Nullable<string>;
  87032. programLinkError: Nullable<string>;
  87033. programValidationError: Nullable<string>;
  87034. get isAsync(): boolean;
  87035. get isReady(): boolean;
  87036. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  87037. _getVertexShaderCode(): string | null;
  87038. _getFragmentShaderCode(): string | null;
  87039. }
  87040. }
  87041. declare module BABYLON {
  87042. interface ThinEngine {
  87043. /**
  87044. * Create an uniform buffer
  87045. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87046. * @param elements defines the content of the uniform buffer
  87047. * @returns the webGL uniform buffer
  87048. */
  87049. createUniformBuffer(elements: FloatArray): DataBuffer;
  87050. /**
  87051. * Create a dynamic uniform buffer
  87052. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87053. * @param elements defines the content of the uniform buffer
  87054. * @returns the webGL uniform buffer
  87055. */
  87056. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  87057. /**
  87058. * Update an existing uniform buffer
  87059. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87060. * @param uniformBuffer defines the target uniform buffer
  87061. * @param elements defines the content to update
  87062. * @param offset defines the offset in the uniform buffer where update should start
  87063. * @param count defines the size of the data to update
  87064. */
  87065. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  87066. /**
  87067. * Bind an uniform buffer to the current webGL context
  87068. * @param buffer defines the buffer to bind
  87069. */
  87070. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  87071. /**
  87072. * Bind a buffer to the current webGL context at a given location
  87073. * @param buffer defines the buffer to bind
  87074. * @param location defines the index where to bind the buffer
  87075. */
  87076. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  87077. /**
  87078. * Bind a specific block at a given index in a specific shader program
  87079. * @param pipelineContext defines the pipeline context to use
  87080. * @param blockName defines the block name
  87081. * @param index defines the index where to bind the block
  87082. */
  87083. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  87084. }
  87085. }
  87086. declare module BABYLON {
  87087. /**
  87088. * Uniform buffer objects.
  87089. *
  87090. * Handles blocks of uniform on the GPU.
  87091. *
  87092. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87093. *
  87094. * For more information, please refer to :
  87095. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87096. */
  87097. export class UniformBuffer {
  87098. private _engine;
  87099. private _buffer;
  87100. private _data;
  87101. private _bufferData;
  87102. private _dynamic?;
  87103. private _uniformLocations;
  87104. private _uniformSizes;
  87105. private _uniformLocationPointer;
  87106. private _needSync;
  87107. private _noUBO;
  87108. private _currentEffect;
  87109. /** @hidden */
  87110. _alreadyBound: boolean;
  87111. private static _MAX_UNIFORM_SIZE;
  87112. private static _tempBuffer;
  87113. /**
  87114. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87115. * This is dynamic to allow compat with webgl 1 and 2.
  87116. * You will need to pass the name of the uniform as well as the value.
  87117. */
  87118. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87119. /**
  87120. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87121. * This is dynamic to allow compat with webgl 1 and 2.
  87122. * You will need to pass the name of the uniform as well as the value.
  87123. */
  87124. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87125. /**
  87126. * Lambda to Update a single float in a uniform buffer.
  87127. * This is dynamic to allow compat with webgl 1 and 2.
  87128. * You will need to pass the name of the uniform as well as the value.
  87129. */
  87130. updateFloat: (name: string, x: number) => void;
  87131. /**
  87132. * Lambda to Update a vec2 of float in a uniform buffer.
  87133. * This is dynamic to allow compat with webgl 1 and 2.
  87134. * You will need to pass the name of the uniform as well as the value.
  87135. */
  87136. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87137. /**
  87138. * Lambda to Update a vec3 of float in a uniform buffer.
  87139. * This is dynamic to allow compat with webgl 1 and 2.
  87140. * You will need to pass the name of the uniform as well as the value.
  87141. */
  87142. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87143. /**
  87144. * Lambda to Update a vec4 of float in a uniform buffer.
  87145. * This is dynamic to allow compat with webgl 1 and 2.
  87146. * You will need to pass the name of the uniform as well as the value.
  87147. */
  87148. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87149. /**
  87150. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87151. * This is dynamic to allow compat with webgl 1 and 2.
  87152. * You will need to pass the name of the uniform as well as the value.
  87153. */
  87154. updateMatrix: (name: string, mat: Matrix) => void;
  87155. /**
  87156. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87157. * This is dynamic to allow compat with webgl 1 and 2.
  87158. * You will need to pass the name of the uniform as well as the value.
  87159. */
  87160. updateVector3: (name: string, vector: Vector3) => void;
  87161. /**
  87162. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87163. * This is dynamic to allow compat with webgl 1 and 2.
  87164. * You will need to pass the name of the uniform as well as the value.
  87165. */
  87166. updateVector4: (name: string, vector: Vector4) => void;
  87167. /**
  87168. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87169. * This is dynamic to allow compat with webgl 1 and 2.
  87170. * You will need to pass the name of the uniform as well as the value.
  87171. */
  87172. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87173. /**
  87174. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87175. * This is dynamic to allow compat with webgl 1 and 2.
  87176. * You will need to pass the name of the uniform as well as the value.
  87177. */
  87178. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87179. /**
  87180. * Instantiates a new Uniform buffer objects.
  87181. *
  87182. * Handles blocks of uniform on the GPU.
  87183. *
  87184. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87185. *
  87186. * For more information, please refer to :
  87187. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87188. * @param engine Define the engine the buffer is associated with
  87189. * @param data Define the data contained in the buffer
  87190. * @param dynamic Define if the buffer is updatable
  87191. */
  87192. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87193. /**
  87194. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87195. * or just falling back on setUniformXXX calls.
  87196. */
  87197. get useUbo(): boolean;
  87198. /**
  87199. * Indicates if the WebGL underlying uniform buffer is in sync
  87200. * with the javascript cache data.
  87201. */
  87202. get isSync(): boolean;
  87203. /**
  87204. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87205. * Also, a dynamic UniformBuffer will disable cache verification and always
  87206. * update the underlying WebGL uniform buffer to the GPU.
  87207. * @returns if Dynamic, otherwise false
  87208. */
  87209. isDynamic(): boolean;
  87210. /**
  87211. * The data cache on JS side.
  87212. * @returns the underlying data as a float array
  87213. */
  87214. getData(): Float32Array;
  87215. /**
  87216. * The underlying WebGL Uniform buffer.
  87217. * @returns the webgl buffer
  87218. */
  87219. getBuffer(): Nullable<DataBuffer>;
  87220. /**
  87221. * std140 layout specifies how to align data within an UBO structure.
  87222. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87223. * for specs.
  87224. */
  87225. private _fillAlignment;
  87226. /**
  87227. * Adds an uniform in the buffer.
  87228. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87229. * for the layout to be correct !
  87230. * @param name Name of the uniform, as used in the uniform block in the shader.
  87231. * @param size Data size, or data directly.
  87232. */
  87233. addUniform(name: string, size: number | number[]): void;
  87234. /**
  87235. * Adds a Matrix 4x4 to the uniform buffer.
  87236. * @param name Name of the uniform, as used in the uniform block in the shader.
  87237. * @param mat A 4x4 matrix.
  87238. */
  87239. addMatrix(name: string, mat: Matrix): void;
  87240. /**
  87241. * Adds a vec2 to the uniform buffer.
  87242. * @param name Name of the uniform, as used in the uniform block in the shader.
  87243. * @param x Define the x component value of the vec2
  87244. * @param y Define the y component value of the vec2
  87245. */
  87246. addFloat2(name: string, x: number, y: number): void;
  87247. /**
  87248. * Adds a vec3 to the uniform buffer.
  87249. * @param name Name of the uniform, as used in the uniform block in the shader.
  87250. * @param x Define the x component value of the vec3
  87251. * @param y Define the y component value of the vec3
  87252. * @param z Define the z component value of the vec3
  87253. */
  87254. addFloat3(name: string, x: number, y: number, z: number): void;
  87255. /**
  87256. * Adds a vec3 to the uniform buffer.
  87257. * @param name Name of the uniform, as used in the uniform block in the shader.
  87258. * @param color Define the vec3 from a Color
  87259. */
  87260. addColor3(name: string, color: Color3): void;
  87261. /**
  87262. * Adds a vec4 to the uniform buffer.
  87263. * @param name Name of the uniform, as used in the uniform block in the shader.
  87264. * @param color Define the rgb components from a Color
  87265. * @param alpha Define the a component of the vec4
  87266. */
  87267. addColor4(name: string, color: Color3, alpha: number): void;
  87268. /**
  87269. * Adds a vec3 to the uniform buffer.
  87270. * @param name Name of the uniform, as used in the uniform block in the shader.
  87271. * @param vector Define the vec3 components from a Vector
  87272. */
  87273. addVector3(name: string, vector: Vector3): void;
  87274. /**
  87275. * Adds a Matrix 3x3 to the uniform buffer.
  87276. * @param name Name of the uniform, as used in the uniform block in the shader.
  87277. */
  87278. addMatrix3x3(name: string): void;
  87279. /**
  87280. * Adds a Matrix 2x2 to the uniform buffer.
  87281. * @param name Name of the uniform, as used in the uniform block in the shader.
  87282. */
  87283. addMatrix2x2(name: string): void;
  87284. /**
  87285. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87286. */
  87287. create(): void;
  87288. /** @hidden */
  87289. _rebuild(): void;
  87290. /**
  87291. * Updates the WebGL Uniform Buffer on the GPU.
  87292. * If the `dynamic` flag is set to true, no cache comparison is done.
  87293. * Otherwise, the buffer will be updated only if the cache differs.
  87294. */
  87295. update(): void;
  87296. /**
  87297. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87298. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87299. * @param data Define the flattened data
  87300. * @param size Define the size of the data.
  87301. */
  87302. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87303. private _valueCache;
  87304. private _cacheMatrix;
  87305. private _updateMatrix3x3ForUniform;
  87306. private _updateMatrix3x3ForEffect;
  87307. private _updateMatrix2x2ForEffect;
  87308. private _updateMatrix2x2ForUniform;
  87309. private _updateFloatForEffect;
  87310. private _updateFloatForUniform;
  87311. private _updateFloat2ForEffect;
  87312. private _updateFloat2ForUniform;
  87313. private _updateFloat3ForEffect;
  87314. private _updateFloat3ForUniform;
  87315. private _updateFloat4ForEffect;
  87316. private _updateFloat4ForUniform;
  87317. private _updateMatrixForEffect;
  87318. private _updateMatrixForUniform;
  87319. private _updateVector3ForEffect;
  87320. private _updateVector3ForUniform;
  87321. private _updateVector4ForEffect;
  87322. private _updateVector4ForUniform;
  87323. private _updateColor3ForEffect;
  87324. private _updateColor3ForUniform;
  87325. private _updateColor4ForEffect;
  87326. private _updateColor4ForUniform;
  87327. /**
  87328. * Sets a sampler uniform on the effect.
  87329. * @param name Define the name of the sampler.
  87330. * @param texture Define the texture to set in the sampler
  87331. */
  87332. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87333. /**
  87334. * Directly updates the value of the uniform in the cache AND on the GPU.
  87335. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87336. * @param data Define the flattened data
  87337. */
  87338. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87339. /**
  87340. * Binds this uniform buffer to an effect.
  87341. * @param effect Define the effect to bind the buffer to
  87342. * @param name Name of the uniform block in the shader.
  87343. */
  87344. bindToEffect(effect: Effect, name: string): void;
  87345. /**
  87346. * Disposes the uniform buffer.
  87347. */
  87348. dispose(): void;
  87349. }
  87350. }
  87351. declare module BABYLON {
  87352. /**
  87353. * Enum that determines the text-wrapping mode to use.
  87354. */
  87355. export enum InspectableType {
  87356. /**
  87357. * Checkbox for booleans
  87358. */
  87359. Checkbox = 0,
  87360. /**
  87361. * Sliders for numbers
  87362. */
  87363. Slider = 1,
  87364. /**
  87365. * Vector3
  87366. */
  87367. Vector3 = 2,
  87368. /**
  87369. * Quaternions
  87370. */
  87371. Quaternion = 3,
  87372. /**
  87373. * Color3
  87374. */
  87375. Color3 = 4,
  87376. /**
  87377. * String
  87378. */
  87379. String = 5
  87380. }
  87381. /**
  87382. * Interface used to define custom inspectable properties.
  87383. * This interface is used by the inspector to display custom property grids
  87384. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87385. */
  87386. export interface IInspectable {
  87387. /**
  87388. * Gets the label to display
  87389. */
  87390. label: string;
  87391. /**
  87392. * Gets the name of the property to edit
  87393. */
  87394. propertyName: string;
  87395. /**
  87396. * Gets the type of the editor to use
  87397. */
  87398. type: InspectableType;
  87399. /**
  87400. * Gets the minimum value of the property when using in "slider" mode
  87401. */
  87402. min?: number;
  87403. /**
  87404. * Gets the maximum value of the property when using in "slider" mode
  87405. */
  87406. max?: number;
  87407. /**
  87408. * Gets the setp to use when using in "slider" mode
  87409. */
  87410. step?: number;
  87411. }
  87412. }
  87413. declare module BABYLON {
  87414. /**
  87415. * Class used to provide helper for timing
  87416. */
  87417. export class TimingTools {
  87418. /**
  87419. * Polyfill for setImmediate
  87420. * @param action defines the action to execute after the current execution block
  87421. */
  87422. static SetImmediate(action: () => void): void;
  87423. }
  87424. }
  87425. declare module BABYLON {
  87426. /**
  87427. * Class used to enable instatition of objects by class name
  87428. */
  87429. export class InstantiationTools {
  87430. /**
  87431. * Use this object to register external classes like custom textures or material
  87432. * to allow the laoders to instantiate them
  87433. */
  87434. static RegisteredExternalClasses: {
  87435. [key: string]: Object;
  87436. };
  87437. /**
  87438. * Tries to instantiate a new object from a given class name
  87439. * @param className defines the class name to instantiate
  87440. * @returns the new object or null if the system was not able to do the instantiation
  87441. */
  87442. static Instantiate(className: string): any;
  87443. }
  87444. }
  87445. declare module BABYLON {
  87446. /**
  87447. * Define options used to create a depth texture
  87448. */
  87449. export class DepthTextureCreationOptions {
  87450. /** Specifies whether or not a stencil should be allocated in the texture */
  87451. generateStencil?: boolean;
  87452. /** Specifies whether or not bilinear filtering is enable on the texture */
  87453. bilinearFiltering?: boolean;
  87454. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87455. comparisonFunction?: number;
  87456. /** Specifies if the created texture is a cube texture */
  87457. isCube?: boolean;
  87458. }
  87459. }
  87460. declare module BABYLON {
  87461. interface ThinEngine {
  87462. /**
  87463. * Creates a depth stencil cube texture.
  87464. * This is only available in WebGL 2.
  87465. * @param size The size of face edge in the cube texture.
  87466. * @param options The options defining the cube texture.
  87467. * @returns The cube texture
  87468. */
  87469. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87470. /**
  87471. * Creates a cube texture
  87472. * @param rootUrl defines the url where the files to load is located
  87473. * @param scene defines the current scene
  87474. * @param files defines the list of files to load (1 per face)
  87475. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87476. * @param onLoad defines an optional callback raised when the texture is loaded
  87477. * @param onError defines an optional callback raised if there is an issue to load the texture
  87478. * @param format defines the format of the data
  87479. * @param forcedExtension defines the extension to use to pick the right loader
  87480. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87481. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87482. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87483. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87484. * @returns the cube texture as an InternalTexture
  87485. */
  87486. 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>): InternalTexture;
  87487. /**
  87488. * Creates a cube texture
  87489. * @param rootUrl defines the url where the files to load is located
  87490. * @param scene defines the current scene
  87491. * @param files defines the list of files to load (1 per face)
  87492. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87493. * @param onLoad defines an optional callback raised when the texture is loaded
  87494. * @param onError defines an optional callback raised if there is an issue to load the texture
  87495. * @param format defines the format of the data
  87496. * @param forcedExtension defines the extension to use to pick the right loader
  87497. * @returns the cube texture as an InternalTexture
  87498. */
  87499. 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;
  87500. /**
  87501. * Creates a cube texture
  87502. * @param rootUrl defines the url where the files to load is located
  87503. * @param scene defines the current scene
  87504. * @param files defines the list of files to load (1 per face)
  87505. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87506. * @param onLoad defines an optional callback raised when the texture is loaded
  87507. * @param onError defines an optional callback raised if there is an issue to load the texture
  87508. * @param format defines the format of the data
  87509. * @param forcedExtension defines the extension to use to pick the right loader
  87510. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87511. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87512. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87513. * @returns the cube texture as an InternalTexture
  87514. */
  87515. 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;
  87516. /** @hidden */
  87517. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87518. /** @hidden */
  87519. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87520. /** @hidden */
  87521. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87522. /** @hidden */
  87523. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87524. /**
  87525. * @hidden
  87526. */
  87527. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87528. }
  87529. }
  87530. declare module BABYLON {
  87531. /**
  87532. * Class for creating a cube texture
  87533. */
  87534. export class CubeTexture extends BaseTexture {
  87535. private _delayedOnLoad;
  87536. /**
  87537. * Observable triggered once the texture has been loaded.
  87538. */
  87539. onLoadObservable: Observable<CubeTexture>;
  87540. /**
  87541. * The url of the texture
  87542. */
  87543. url: string;
  87544. /**
  87545. * Gets or sets the center of the bounding box associated with the cube texture.
  87546. * It must define where the camera used to render the texture was set
  87547. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87548. */
  87549. boundingBoxPosition: Vector3;
  87550. private _boundingBoxSize;
  87551. /**
  87552. * Gets or sets the size of the bounding box associated with the cube texture
  87553. * When defined, the cubemap will switch to local mode
  87554. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87555. * @example https://www.babylonjs-playground.com/#RNASML
  87556. */
  87557. set boundingBoxSize(value: Vector3);
  87558. /**
  87559. * Returns the bounding box size
  87560. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87561. */
  87562. get boundingBoxSize(): Vector3;
  87563. protected _rotationY: number;
  87564. /**
  87565. * Sets texture matrix rotation angle around Y axis in radians.
  87566. */
  87567. set rotationY(value: number);
  87568. /**
  87569. * Gets texture matrix rotation angle around Y axis radians.
  87570. */
  87571. get rotationY(): number;
  87572. /**
  87573. * Are mip maps generated for this texture or not.
  87574. */
  87575. get noMipmap(): boolean;
  87576. private _noMipmap;
  87577. private _files;
  87578. protected _forcedExtension: Nullable<string>;
  87579. private _extensions;
  87580. private _textureMatrix;
  87581. private _format;
  87582. private _createPolynomials;
  87583. /**
  87584. * Creates a cube texture from an array of image urls
  87585. * @param files defines an array of image urls
  87586. * @param scene defines the hosting scene
  87587. * @param noMipmap specifies if mip maps are not used
  87588. * @returns a cube texture
  87589. */
  87590. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87591. /**
  87592. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87593. * @param url defines the url of the prefiltered texture
  87594. * @param scene defines the scene the texture is attached to
  87595. * @param forcedExtension defines the extension of the file if different from the url
  87596. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87597. * @return the prefiltered texture
  87598. */
  87599. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87600. /**
  87601. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87602. * as prefiltered data.
  87603. * @param rootUrl defines the url of the texture or the root name of the six images
  87604. * @param null defines the scene or engine the texture is attached to
  87605. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87606. * @param noMipmap defines if mipmaps should be created or not
  87607. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87608. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87609. * @param onError defines a callback triggered in case of error during load
  87610. * @param format defines the internal format to use for the texture once loaded
  87611. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87612. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87613. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87614. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87615. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87616. * @return the cube texture
  87617. */
  87618. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, 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);
  87619. /**
  87620. * Get the current class name of the texture useful for serialization or dynamic coding.
  87621. * @returns "CubeTexture"
  87622. */
  87623. getClassName(): string;
  87624. /**
  87625. * Update the url (and optional buffer) of this texture if url was null during construction.
  87626. * @param url the url of the texture
  87627. * @param forcedExtension defines the extension to use
  87628. * @param onLoad callback called when the texture is loaded (defaults to null)
  87629. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87630. */
  87631. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87632. /**
  87633. * Delays loading of the cube texture
  87634. * @param forcedExtension defines the extension to use
  87635. */
  87636. delayLoad(forcedExtension?: string): void;
  87637. /**
  87638. * Returns the reflection texture matrix
  87639. * @returns the reflection texture matrix
  87640. */
  87641. getReflectionTextureMatrix(): Matrix;
  87642. /**
  87643. * Sets the reflection texture matrix
  87644. * @param value Reflection texture matrix
  87645. */
  87646. setReflectionTextureMatrix(value: Matrix): void;
  87647. /**
  87648. * Parses text to create a cube texture
  87649. * @param parsedTexture define the serialized text to read from
  87650. * @param scene defines the hosting scene
  87651. * @param rootUrl defines the root url of the cube texture
  87652. * @returns a cube texture
  87653. */
  87654. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87655. /**
  87656. * Makes a clone, or deep copy, of the cube texture
  87657. * @returns a new cube texture
  87658. */
  87659. clone(): CubeTexture;
  87660. }
  87661. }
  87662. declare module BABYLON {
  87663. /**
  87664. * Manages the defines for the Material
  87665. */
  87666. export class MaterialDefines {
  87667. /** @hidden */
  87668. protected _keys: string[];
  87669. private _isDirty;
  87670. /** @hidden */
  87671. _renderId: number;
  87672. /** @hidden */
  87673. _areLightsDirty: boolean;
  87674. /** @hidden */
  87675. _areLightsDisposed: boolean;
  87676. /** @hidden */
  87677. _areAttributesDirty: boolean;
  87678. /** @hidden */
  87679. _areTexturesDirty: boolean;
  87680. /** @hidden */
  87681. _areFresnelDirty: boolean;
  87682. /** @hidden */
  87683. _areMiscDirty: boolean;
  87684. /** @hidden */
  87685. _areImageProcessingDirty: boolean;
  87686. /** @hidden */
  87687. _normals: boolean;
  87688. /** @hidden */
  87689. _uvs: boolean;
  87690. /** @hidden */
  87691. _needNormals: boolean;
  87692. /** @hidden */
  87693. _needUVs: boolean;
  87694. [id: string]: any;
  87695. /**
  87696. * Specifies if the material needs to be re-calculated
  87697. */
  87698. get isDirty(): boolean;
  87699. /**
  87700. * Marks the material to indicate that it has been re-calculated
  87701. */
  87702. markAsProcessed(): void;
  87703. /**
  87704. * Marks the material to indicate that it needs to be re-calculated
  87705. */
  87706. markAsUnprocessed(): void;
  87707. /**
  87708. * Marks the material to indicate all of its defines need to be re-calculated
  87709. */
  87710. markAllAsDirty(): void;
  87711. /**
  87712. * Marks the material to indicate that image processing needs to be re-calculated
  87713. */
  87714. markAsImageProcessingDirty(): void;
  87715. /**
  87716. * Marks the material to indicate the lights need to be re-calculated
  87717. * @param disposed Defines whether the light is dirty due to dispose or not
  87718. */
  87719. markAsLightDirty(disposed?: boolean): void;
  87720. /**
  87721. * Marks the attribute state as changed
  87722. */
  87723. markAsAttributesDirty(): void;
  87724. /**
  87725. * Marks the texture state as changed
  87726. */
  87727. markAsTexturesDirty(): void;
  87728. /**
  87729. * Marks the fresnel state as changed
  87730. */
  87731. markAsFresnelDirty(): void;
  87732. /**
  87733. * Marks the misc state as changed
  87734. */
  87735. markAsMiscDirty(): void;
  87736. /**
  87737. * Rebuilds the material defines
  87738. */
  87739. rebuild(): void;
  87740. /**
  87741. * Specifies if two material defines are equal
  87742. * @param other - A material define instance to compare to
  87743. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87744. */
  87745. isEqual(other: MaterialDefines): boolean;
  87746. /**
  87747. * Clones this instance's defines to another instance
  87748. * @param other - material defines to clone values to
  87749. */
  87750. cloneTo(other: MaterialDefines): void;
  87751. /**
  87752. * Resets the material define values
  87753. */
  87754. reset(): void;
  87755. /**
  87756. * Converts the material define values to a string
  87757. * @returns - String of material define information
  87758. */
  87759. toString(): string;
  87760. }
  87761. }
  87762. declare module BABYLON {
  87763. /**
  87764. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87765. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87766. * 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;
  87767. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87768. */
  87769. export class ColorCurves {
  87770. private _dirty;
  87771. private _tempColor;
  87772. private _globalCurve;
  87773. private _highlightsCurve;
  87774. private _midtonesCurve;
  87775. private _shadowsCurve;
  87776. private _positiveCurve;
  87777. private _negativeCurve;
  87778. private _globalHue;
  87779. private _globalDensity;
  87780. private _globalSaturation;
  87781. private _globalExposure;
  87782. /**
  87783. * Gets the global Hue value.
  87784. * 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).
  87785. */
  87786. get globalHue(): number;
  87787. /**
  87788. * Sets the global Hue value.
  87789. * 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).
  87790. */
  87791. set globalHue(value: number);
  87792. /**
  87793. * Gets the global Density value.
  87794. * 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.
  87795. * Values less than zero provide a filter of opposite hue.
  87796. */
  87797. get globalDensity(): number;
  87798. /**
  87799. * Sets the global Density value.
  87800. * 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.
  87801. * Values less than zero provide a filter of opposite hue.
  87802. */
  87803. set globalDensity(value: number);
  87804. /**
  87805. * Gets the global Saturation value.
  87806. * 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.
  87807. */
  87808. get globalSaturation(): number;
  87809. /**
  87810. * Sets the global Saturation value.
  87811. * 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.
  87812. */
  87813. set globalSaturation(value: number);
  87814. /**
  87815. * Gets the global Exposure value.
  87816. * 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.
  87817. */
  87818. get globalExposure(): number;
  87819. /**
  87820. * Sets the global Exposure value.
  87821. * 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.
  87822. */
  87823. set globalExposure(value: number);
  87824. private _highlightsHue;
  87825. private _highlightsDensity;
  87826. private _highlightsSaturation;
  87827. private _highlightsExposure;
  87828. /**
  87829. * Gets the highlights Hue value.
  87830. * 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).
  87831. */
  87832. get highlightsHue(): number;
  87833. /**
  87834. * Sets the highlights Hue value.
  87835. * 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).
  87836. */
  87837. set highlightsHue(value: number);
  87838. /**
  87839. * Gets the highlights Density value.
  87840. * 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.
  87841. * Values less than zero provide a filter of opposite hue.
  87842. */
  87843. get highlightsDensity(): number;
  87844. /**
  87845. * Sets the highlights Density value.
  87846. * 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.
  87847. * Values less than zero provide a filter of opposite hue.
  87848. */
  87849. set highlightsDensity(value: number);
  87850. /**
  87851. * Gets the highlights Saturation value.
  87852. * 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.
  87853. */
  87854. get highlightsSaturation(): number;
  87855. /**
  87856. * Sets the highlights Saturation value.
  87857. * 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.
  87858. */
  87859. set highlightsSaturation(value: number);
  87860. /**
  87861. * Gets the highlights Exposure value.
  87862. * 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.
  87863. */
  87864. get highlightsExposure(): number;
  87865. /**
  87866. * Sets the highlights Exposure value.
  87867. * 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.
  87868. */
  87869. set highlightsExposure(value: number);
  87870. private _midtonesHue;
  87871. private _midtonesDensity;
  87872. private _midtonesSaturation;
  87873. private _midtonesExposure;
  87874. /**
  87875. * Gets the midtones Hue value.
  87876. * 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).
  87877. */
  87878. get midtonesHue(): number;
  87879. /**
  87880. * Sets the midtones Hue value.
  87881. * 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).
  87882. */
  87883. set midtonesHue(value: number);
  87884. /**
  87885. * Gets the midtones Density value.
  87886. * 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.
  87887. * Values less than zero provide a filter of opposite hue.
  87888. */
  87889. get midtonesDensity(): number;
  87890. /**
  87891. * Sets the midtones Density value.
  87892. * 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.
  87893. * Values less than zero provide a filter of opposite hue.
  87894. */
  87895. set midtonesDensity(value: number);
  87896. /**
  87897. * Gets the midtones Saturation value.
  87898. * 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.
  87899. */
  87900. get midtonesSaturation(): number;
  87901. /**
  87902. * Sets the midtones Saturation value.
  87903. * 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.
  87904. */
  87905. set midtonesSaturation(value: number);
  87906. /**
  87907. * Gets the midtones Exposure value.
  87908. * 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.
  87909. */
  87910. get midtonesExposure(): number;
  87911. /**
  87912. * Sets the midtones Exposure value.
  87913. * 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.
  87914. */
  87915. set midtonesExposure(value: number);
  87916. private _shadowsHue;
  87917. private _shadowsDensity;
  87918. private _shadowsSaturation;
  87919. private _shadowsExposure;
  87920. /**
  87921. * Gets the shadows Hue value.
  87922. * 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).
  87923. */
  87924. get shadowsHue(): number;
  87925. /**
  87926. * Sets the shadows Hue value.
  87927. * 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).
  87928. */
  87929. set shadowsHue(value: number);
  87930. /**
  87931. * Gets the shadows Density value.
  87932. * 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.
  87933. * Values less than zero provide a filter of opposite hue.
  87934. */
  87935. get shadowsDensity(): number;
  87936. /**
  87937. * Sets the shadows Density value.
  87938. * 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.
  87939. * Values less than zero provide a filter of opposite hue.
  87940. */
  87941. set shadowsDensity(value: number);
  87942. /**
  87943. * Gets the shadows Saturation value.
  87944. * 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.
  87945. */
  87946. get shadowsSaturation(): number;
  87947. /**
  87948. * Sets the shadows Saturation value.
  87949. * 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.
  87950. */
  87951. set shadowsSaturation(value: number);
  87952. /**
  87953. * Gets the shadows Exposure value.
  87954. * 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.
  87955. */
  87956. get shadowsExposure(): number;
  87957. /**
  87958. * Sets the shadows Exposure value.
  87959. * 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.
  87960. */
  87961. set shadowsExposure(value: number);
  87962. /**
  87963. * Returns the class name
  87964. * @returns The class name
  87965. */
  87966. getClassName(): string;
  87967. /**
  87968. * Binds the color curves to the shader.
  87969. * @param colorCurves The color curve to bind
  87970. * @param effect The effect to bind to
  87971. * @param positiveUniform The positive uniform shader parameter
  87972. * @param neutralUniform The neutral uniform shader parameter
  87973. * @param negativeUniform The negative uniform shader parameter
  87974. */
  87975. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87976. /**
  87977. * Prepare the list of uniforms associated with the ColorCurves effects.
  87978. * @param uniformsList The list of uniforms used in the effect
  87979. */
  87980. static PrepareUniforms(uniformsList: string[]): void;
  87981. /**
  87982. * Returns color grading data based on a hue, density, saturation and exposure value.
  87983. * @param filterHue The hue of the color filter.
  87984. * @param filterDensity The density of the color filter.
  87985. * @param saturation The saturation.
  87986. * @param exposure The exposure.
  87987. * @param result The result data container.
  87988. */
  87989. private getColorGradingDataToRef;
  87990. /**
  87991. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87992. * @param value The input slider value in range [-100,100].
  87993. * @returns Adjusted value.
  87994. */
  87995. private static applyColorGradingSliderNonlinear;
  87996. /**
  87997. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87998. * @param hue The hue (H) input.
  87999. * @param saturation The saturation (S) input.
  88000. * @param brightness The brightness (B) input.
  88001. * @result An RGBA color represented as Vector4.
  88002. */
  88003. private static fromHSBToRef;
  88004. /**
  88005. * Returns a value clamped between min and max
  88006. * @param value The value to clamp
  88007. * @param min The minimum of value
  88008. * @param max The maximum of value
  88009. * @returns The clamped value.
  88010. */
  88011. private static clamp;
  88012. /**
  88013. * Clones the current color curve instance.
  88014. * @return The cloned curves
  88015. */
  88016. clone(): ColorCurves;
  88017. /**
  88018. * Serializes the current color curve instance to a json representation.
  88019. * @return a JSON representation
  88020. */
  88021. serialize(): any;
  88022. /**
  88023. * Parses the color curve from a json representation.
  88024. * @param source the JSON source to parse
  88025. * @return The parsed curves
  88026. */
  88027. static Parse(source: any): ColorCurves;
  88028. }
  88029. }
  88030. declare module BABYLON {
  88031. /**
  88032. * Interface to follow in your material defines to integrate easily the
  88033. * Image proccessing functions.
  88034. * @hidden
  88035. */
  88036. export interface IImageProcessingConfigurationDefines {
  88037. IMAGEPROCESSING: boolean;
  88038. VIGNETTE: boolean;
  88039. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88040. VIGNETTEBLENDMODEOPAQUE: boolean;
  88041. TONEMAPPING: boolean;
  88042. TONEMAPPING_ACES: boolean;
  88043. CONTRAST: boolean;
  88044. EXPOSURE: boolean;
  88045. COLORCURVES: boolean;
  88046. COLORGRADING: boolean;
  88047. COLORGRADING3D: boolean;
  88048. SAMPLER3DGREENDEPTH: boolean;
  88049. SAMPLER3DBGRMAP: boolean;
  88050. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88051. }
  88052. /**
  88053. * @hidden
  88054. */
  88055. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  88056. IMAGEPROCESSING: boolean;
  88057. VIGNETTE: boolean;
  88058. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88059. VIGNETTEBLENDMODEOPAQUE: boolean;
  88060. TONEMAPPING: boolean;
  88061. TONEMAPPING_ACES: boolean;
  88062. CONTRAST: boolean;
  88063. COLORCURVES: boolean;
  88064. COLORGRADING: boolean;
  88065. COLORGRADING3D: boolean;
  88066. SAMPLER3DGREENDEPTH: boolean;
  88067. SAMPLER3DBGRMAP: boolean;
  88068. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88069. EXPOSURE: boolean;
  88070. constructor();
  88071. }
  88072. /**
  88073. * This groups together the common properties used for image processing either in direct forward pass
  88074. * or through post processing effect depending on the use of the image processing pipeline in your scene
  88075. * or not.
  88076. */
  88077. export class ImageProcessingConfiguration {
  88078. /**
  88079. * Default tone mapping applied in BabylonJS.
  88080. */
  88081. static readonly TONEMAPPING_STANDARD: number;
  88082. /**
  88083. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  88084. * to other engines rendering to increase portability.
  88085. */
  88086. static readonly TONEMAPPING_ACES: number;
  88087. /**
  88088. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88089. */
  88090. colorCurves: Nullable<ColorCurves>;
  88091. private _colorCurvesEnabled;
  88092. /**
  88093. * Gets wether the color curves effect is enabled.
  88094. */
  88095. get colorCurvesEnabled(): boolean;
  88096. /**
  88097. * Sets wether the color curves effect is enabled.
  88098. */
  88099. set colorCurvesEnabled(value: boolean);
  88100. private _colorGradingTexture;
  88101. /**
  88102. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88103. */
  88104. get colorGradingTexture(): Nullable<BaseTexture>;
  88105. /**
  88106. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88107. */
  88108. set colorGradingTexture(value: Nullable<BaseTexture>);
  88109. private _colorGradingEnabled;
  88110. /**
  88111. * Gets wether the color grading effect is enabled.
  88112. */
  88113. get colorGradingEnabled(): boolean;
  88114. /**
  88115. * Sets wether the color grading effect is enabled.
  88116. */
  88117. set colorGradingEnabled(value: boolean);
  88118. private _colorGradingWithGreenDepth;
  88119. /**
  88120. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88121. */
  88122. get colorGradingWithGreenDepth(): boolean;
  88123. /**
  88124. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88125. */
  88126. set colorGradingWithGreenDepth(value: boolean);
  88127. private _colorGradingBGR;
  88128. /**
  88129. * Gets wether the color grading texture contains BGR values.
  88130. */
  88131. get colorGradingBGR(): boolean;
  88132. /**
  88133. * Sets wether the color grading texture contains BGR values.
  88134. */
  88135. set colorGradingBGR(value: boolean);
  88136. /** @hidden */
  88137. _exposure: number;
  88138. /**
  88139. * Gets the Exposure used in the effect.
  88140. */
  88141. get exposure(): number;
  88142. /**
  88143. * Sets the Exposure used in the effect.
  88144. */
  88145. set exposure(value: number);
  88146. private _toneMappingEnabled;
  88147. /**
  88148. * Gets wether the tone mapping effect is enabled.
  88149. */
  88150. get toneMappingEnabled(): boolean;
  88151. /**
  88152. * Sets wether the tone mapping effect is enabled.
  88153. */
  88154. set toneMappingEnabled(value: boolean);
  88155. private _toneMappingType;
  88156. /**
  88157. * Gets the type of tone mapping effect.
  88158. */
  88159. get toneMappingType(): number;
  88160. /**
  88161. * Sets the type of tone mapping effect used in BabylonJS.
  88162. */
  88163. set toneMappingType(value: number);
  88164. protected _contrast: number;
  88165. /**
  88166. * Gets the contrast used in the effect.
  88167. */
  88168. get contrast(): number;
  88169. /**
  88170. * Sets the contrast used in the effect.
  88171. */
  88172. set contrast(value: number);
  88173. /**
  88174. * Vignette stretch size.
  88175. */
  88176. vignetteStretch: number;
  88177. /**
  88178. * Vignette centre X Offset.
  88179. */
  88180. vignetteCentreX: number;
  88181. /**
  88182. * Vignette centre Y Offset.
  88183. */
  88184. vignetteCentreY: number;
  88185. /**
  88186. * Vignette weight or intensity of the vignette effect.
  88187. */
  88188. vignetteWeight: number;
  88189. /**
  88190. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88191. * if vignetteEnabled is set to true.
  88192. */
  88193. vignetteColor: Color4;
  88194. /**
  88195. * Camera field of view used by the Vignette effect.
  88196. */
  88197. vignetteCameraFov: number;
  88198. private _vignetteBlendMode;
  88199. /**
  88200. * Gets the vignette blend mode allowing different kind of effect.
  88201. */
  88202. get vignetteBlendMode(): number;
  88203. /**
  88204. * Sets the vignette blend mode allowing different kind of effect.
  88205. */
  88206. set vignetteBlendMode(value: number);
  88207. private _vignetteEnabled;
  88208. /**
  88209. * Gets wether the vignette effect is enabled.
  88210. */
  88211. get vignetteEnabled(): boolean;
  88212. /**
  88213. * Sets wether the vignette effect is enabled.
  88214. */
  88215. set vignetteEnabled(value: boolean);
  88216. private _applyByPostProcess;
  88217. /**
  88218. * Gets wether the image processing is applied through a post process or not.
  88219. */
  88220. get applyByPostProcess(): boolean;
  88221. /**
  88222. * Sets wether the image processing is applied through a post process or not.
  88223. */
  88224. set applyByPostProcess(value: boolean);
  88225. private _isEnabled;
  88226. /**
  88227. * Gets wether the image processing is enabled or not.
  88228. */
  88229. get isEnabled(): boolean;
  88230. /**
  88231. * Sets wether the image processing is enabled or not.
  88232. */
  88233. set isEnabled(value: boolean);
  88234. /**
  88235. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88236. */
  88237. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88238. /**
  88239. * Method called each time the image processing information changes requires to recompile the effect.
  88240. */
  88241. protected _updateParameters(): void;
  88242. /**
  88243. * Gets the current class name.
  88244. * @return "ImageProcessingConfiguration"
  88245. */
  88246. getClassName(): string;
  88247. /**
  88248. * Prepare the list of uniforms associated with the Image Processing effects.
  88249. * @param uniforms The list of uniforms used in the effect
  88250. * @param defines the list of defines currently in use
  88251. */
  88252. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88253. /**
  88254. * Prepare the list of samplers associated with the Image Processing effects.
  88255. * @param samplersList The list of uniforms used in the effect
  88256. * @param defines the list of defines currently in use
  88257. */
  88258. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88259. /**
  88260. * Prepare the list of defines associated to the shader.
  88261. * @param defines the list of defines to complete
  88262. * @param forPostProcess Define if we are currently in post process mode or not
  88263. */
  88264. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88265. /**
  88266. * Returns true if all the image processing information are ready.
  88267. * @returns True if ready, otherwise, false
  88268. */
  88269. isReady(): boolean;
  88270. /**
  88271. * Binds the image processing to the shader.
  88272. * @param effect The effect to bind to
  88273. * @param overrideAspectRatio Override the aspect ratio of the effect
  88274. */
  88275. bind(effect: Effect, overrideAspectRatio?: number): void;
  88276. /**
  88277. * Clones the current image processing instance.
  88278. * @return The cloned image processing
  88279. */
  88280. clone(): ImageProcessingConfiguration;
  88281. /**
  88282. * Serializes the current image processing instance to a json representation.
  88283. * @return a JSON representation
  88284. */
  88285. serialize(): any;
  88286. /**
  88287. * Parses the image processing from a json representation.
  88288. * @param source the JSON source to parse
  88289. * @return The parsed image processing
  88290. */
  88291. static Parse(source: any): ImageProcessingConfiguration;
  88292. private static _VIGNETTEMODE_MULTIPLY;
  88293. private static _VIGNETTEMODE_OPAQUE;
  88294. /**
  88295. * Used to apply the vignette as a mix with the pixel color.
  88296. */
  88297. static get VIGNETTEMODE_MULTIPLY(): number;
  88298. /**
  88299. * Used to apply the vignette as a replacement of the pixel color.
  88300. */
  88301. static get VIGNETTEMODE_OPAQUE(): number;
  88302. }
  88303. }
  88304. declare module BABYLON {
  88305. /** @hidden */
  88306. export var postprocessVertexShader: {
  88307. name: string;
  88308. shader: string;
  88309. };
  88310. }
  88311. declare module BABYLON {
  88312. interface ThinEngine {
  88313. /**
  88314. * Creates a new render target texture
  88315. * @param size defines the size of the texture
  88316. * @param options defines the options used to create the texture
  88317. * @returns a new render target texture stored in an InternalTexture
  88318. */
  88319. createRenderTargetTexture(size: number | {
  88320. width: number;
  88321. height: number;
  88322. layers?: number;
  88323. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88324. /**
  88325. * Creates a depth stencil texture.
  88326. * This is only available in WebGL 2 or with the depth texture extension available.
  88327. * @param size The size of face edge in the texture.
  88328. * @param options The options defining the texture.
  88329. * @returns The texture
  88330. */
  88331. createDepthStencilTexture(size: number | {
  88332. width: number;
  88333. height: number;
  88334. layers?: number;
  88335. }, options: DepthTextureCreationOptions): InternalTexture;
  88336. /** @hidden */
  88337. _createDepthStencilTexture(size: number | {
  88338. width: number;
  88339. height: number;
  88340. layers?: number;
  88341. }, options: DepthTextureCreationOptions): InternalTexture;
  88342. }
  88343. }
  88344. declare module BABYLON {
  88345. /**
  88346. * Defines the kind of connection point for node based material
  88347. */
  88348. export enum NodeMaterialBlockConnectionPointTypes {
  88349. /** Float */
  88350. Float = 1,
  88351. /** Int */
  88352. Int = 2,
  88353. /** Vector2 */
  88354. Vector2 = 4,
  88355. /** Vector3 */
  88356. Vector3 = 8,
  88357. /** Vector4 */
  88358. Vector4 = 16,
  88359. /** Color3 */
  88360. Color3 = 32,
  88361. /** Color4 */
  88362. Color4 = 64,
  88363. /** Matrix */
  88364. Matrix = 128,
  88365. /** Custom object */
  88366. Object = 256,
  88367. /** Detect type based on connection */
  88368. AutoDetect = 1024,
  88369. /** Output type that will be defined by input type */
  88370. BasedOnInput = 2048
  88371. }
  88372. }
  88373. declare module BABYLON {
  88374. /**
  88375. * Enum used to define the target of a block
  88376. */
  88377. export enum NodeMaterialBlockTargets {
  88378. /** Vertex shader */
  88379. Vertex = 1,
  88380. /** Fragment shader */
  88381. Fragment = 2,
  88382. /** Neutral */
  88383. Neutral = 4,
  88384. /** Vertex and Fragment */
  88385. VertexAndFragment = 3
  88386. }
  88387. }
  88388. declare module BABYLON {
  88389. /**
  88390. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88391. */
  88392. export enum NodeMaterialBlockConnectionPointMode {
  88393. /** Value is an uniform */
  88394. Uniform = 0,
  88395. /** Value is a mesh attribute */
  88396. Attribute = 1,
  88397. /** Value is a varying between vertex and fragment shaders */
  88398. Varying = 2,
  88399. /** Mode is undefined */
  88400. Undefined = 3
  88401. }
  88402. }
  88403. declare module BABYLON {
  88404. /**
  88405. * Enum used to define system values e.g. values automatically provided by the system
  88406. */
  88407. export enum NodeMaterialSystemValues {
  88408. /** World */
  88409. World = 1,
  88410. /** View */
  88411. View = 2,
  88412. /** Projection */
  88413. Projection = 3,
  88414. /** ViewProjection */
  88415. ViewProjection = 4,
  88416. /** WorldView */
  88417. WorldView = 5,
  88418. /** WorldViewProjection */
  88419. WorldViewProjection = 6,
  88420. /** CameraPosition */
  88421. CameraPosition = 7,
  88422. /** Fog Color */
  88423. FogColor = 8,
  88424. /** Delta time */
  88425. DeltaTime = 9
  88426. }
  88427. }
  88428. declare module BABYLON {
  88429. /** Defines supported spaces */
  88430. export enum Space {
  88431. /** Local (object) space */
  88432. LOCAL = 0,
  88433. /** World space */
  88434. WORLD = 1,
  88435. /** Bone space */
  88436. BONE = 2
  88437. }
  88438. /** Defines the 3 main axes */
  88439. export class Axis {
  88440. /** X axis */
  88441. static X: Vector3;
  88442. /** Y axis */
  88443. static Y: Vector3;
  88444. /** Z axis */
  88445. static Z: Vector3;
  88446. }
  88447. }
  88448. declare module BABYLON {
  88449. /**
  88450. * Represents a camera frustum
  88451. */
  88452. export class Frustum {
  88453. /**
  88454. * Gets the planes representing the frustum
  88455. * @param transform matrix to be applied to the returned planes
  88456. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88457. */
  88458. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88459. /**
  88460. * Gets the near frustum plane transformed by the transform matrix
  88461. * @param transform transformation matrix to be applied to the resulting frustum plane
  88462. * @param frustumPlane the resuling frustum plane
  88463. */
  88464. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88465. /**
  88466. * Gets the far frustum plane transformed by the transform matrix
  88467. * @param transform transformation matrix to be applied to the resulting frustum plane
  88468. * @param frustumPlane the resuling frustum plane
  88469. */
  88470. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88471. /**
  88472. * Gets the left frustum plane transformed by the transform matrix
  88473. * @param transform transformation matrix to be applied to the resulting frustum plane
  88474. * @param frustumPlane the resuling frustum plane
  88475. */
  88476. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88477. /**
  88478. * Gets the right frustum plane transformed by the transform matrix
  88479. * @param transform transformation matrix to be applied to the resulting frustum plane
  88480. * @param frustumPlane the resuling frustum plane
  88481. */
  88482. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88483. /**
  88484. * Gets the top frustum plane transformed by the transform matrix
  88485. * @param transform transformation matrix to be applied to the resulting frustum plane
  88486. * @param frustumPlane the resuling frustum plane
  88487. */
  88488. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88489. /**
  88490. * Gets the bottom frustum plane transformed by the transform matrix
  88491. * @param transform transformation matrix to be applied to the resulting frustum plane
  88492. * @param frustumPlane the resuling frustum plane
  88493. */
  88494. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88495. /**
  88496. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88497. * @param transform transformation matrix to be applied to the resulting frustum planes
  88498. * @param frustumPlanes the resuling frustum planes
  88499. */
  88500. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88501. }
  88502. }
  88503. declare module BABYLON {
  88504. /**
  88505. * Interface for the size containing width and height
  88506. */
  88507. export interface ISize {
  88508. /**
  88509. * Width
  88510. */
  88511. width: number;
  88512. /**
  88513. * Heighht
  88514. */
  88515. height: number;
  88516. }
  88517. /**
  88518. * Size containing widht and height
  88519. */
  88520. export class Size implements ISize {
  88521. /**
  88522. * Width
  88523. */
  88524. width: number;
  88525. /**
  88526. * Height
  88527. */
  88528. height: number;
  88529. /**
  88530. * Creates a Size object from the given width and height (floats).
  88531. * @param width width of the new size
  88532. * @param height height of the new size
  88533. */
  88534. constructor(width: number, height: number);
  88535. /**
  88536. * Returns a string with the Size width and height
  88537. * @returns a string with the Size width and height
  88538. */
  88539. toString(): string;
  88540. /**
  88541. * "Size"
  88542. * @returns the string "Size"
  88543. */
  88544. getClassName(): string;
  88545. /**
  88546. * Returns the Size hash code.
  88547. * @returns a hash code for a unique width and height
  88548. */
  88549. getHashCode(): number;
  88550. /**
  88551. * Updates the current size from the given one.
  88552. * @param src the given size
  88553. */
  88554. copyFrom(src: Size): void;
  88555. /**
  88556. * Updates in place the current Size from the given floats.
  88557. * @param width width of the new size
  88558. * @param height height of the new size
  88559. * @returns the updated Size.
  88560. */
  88561. copyFromFloats(width: number, height: number): Size;
  88562. /**
  88563. * Updates in place the current Size from the given floats.
  88564. * @param width width to set
  88565. * @param height height to set
  88566. * @returns the updated Size.
  88567. */
  88568. set(width: number, height: number): Size;
  88569. /**
  88570. * Multiplies the width and height by numbers
  88571. * @param w factor to multiple the width by
  88572. * @param h factor to multiple the height by
  88573. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88574. */
  88575. multiplyByFloats(w: number, h: number): Size;
  88576. /**
  88577. * Clones the size
  88578. * @returns a new Size copied from the given one.
  88579. */
  88580. clone(): Size;
  88581. /**
  88582. * True if the current Size and the given one width and height are strictly equal.
  88583. * @param other the other size to compare against
  88584. * @returns True if the current Size and the given one width and height are strictly equal.
  88585. */
  88586. equals(other: Size): boolean;
  88587. /**
  88588. * The surface of the Size : width * height (float).
  88589. */
  88590. get surface(): number;
  88591. /**
  88592. * Create a new size of zero
  88593. * @returns a new Size set to (0.0, 0.0)
  88594. */
  88595. static Zero(): Size;
  88596. /**
  88597. * Sums the width and height of two sizes
  88598. * @param otherSize size to add to this size
  88599. * @returns a new Size set as the addition result of the current Size and the given one.
  88600. */
  88601. add(otherSize: Size): Size;
  88602. /**
  88603. * Subtracts the width and height of two
  88604. * @param otherSize size to subtract to this size
  88605. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88606. */
  88607. subtract(otherSize: Size): Size;
  88608. /**
  88609. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88610. * @param start starting size to lerp between
  88611. * @param end end size to lerp between
  88612. * @param amount amount to lerp between the start and end values
  88613. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88614. */
  88615. static Lerp(start: Size, end: Size, amount: number): Size;
  88616. }
  88617. }
  88618. declare module BABYLON {
  88619. /**
  88620. * Contains position and normal vectors for a vertex
  88621. */
  88622. export class PositionNormalVertex {
  88623. /** the position of the vertex (defaut: 0,0,0) */
  88624. position: Vector3;
  88625. /** the normal of the vertex (defaut: 0,1,0) */
  88626. normal: Vector3;
  88627. /**
  88628. * Creates a PositionNormalVertex
  88629. * @param position the position of the vertex (defaut: 0,0,0)
  88630. * @param normal the normal of the vertex (defaut: 0,1,0)
  88631. */
  88632. constructor(
  88633. /** the position of the vertex (defaut: 0,0,0) */
  88634. position?: Vector3,
  88635. /** the normal of the vertex (defaut: 0,1,0) */
  88636. normal?: Vector3);
  88637. /**
  88638. * Clones the PositionNormalVertex
  88639. * @returns the cloned PositionNormalVertex
  88640. */
  88641. clone(): PositionNormalVertex;
  88642. }
  88643. /**
  88644. * Contains position, normal and uv vectors for a vertex
  88645. */
  88646. export class PositionNormalTextureVertex {
  88647. /** the position of the vertex (defaut: 0,0,0) */
  88648. position: Vector3;
  88649. /** the normal of the vertex (defaut: 0,1,0) */
  88650. normal: Vector3;
  88651. /** the uv of the vertex (default: 0,0) */
  88652. uv: Vector2;
  88653. /**
  88654. * Creates a PositionNormalTextureVertex
  88655. * @param position the position of the vertex (defaut: 0,0,0)
  88656. * @param normal the normal of the vertex (defaut: 0,1,0)
  88657. * @param uv the uv of the vertex (default: 0,0)
  88658. */
  88659. constructor(
  88660. /** the position of the vertex (defaut: 0,0,0) */
  88661. position?: Vector3,
  88662. /** the normal of the vertex (defaut: 0,1,0) */
  88663. normal?: Vector3,
  88664. /** the uv of the vertex (default: 0,0) */
  88665. uv?: Vector2);
  88666. /**
  88667. * Clones the PositionNormalTextureVertex
  88668. * @returns the cloned PositionNormalTextureVertex
  88669. */
  88670. clone(): PositionNormalTextureVertex;
  88671. }
  88672. }
  88673. declare module BABYLON {
  88674. /**
  88675. * Enum defining the type of animations supported by InputBlock
  88676. */
  88677. export enum AnimatedInputBlockTypes {
  88678. /** No animation */
  88679. None = 0,
  88680. /** Time based animation. Will only work for floats */
  88681. Time = 1
  88682. }
  88683. }
  88684. declare module BABYLON {
  88685. /**
  88686. * Interface describing all the common properties and methods a shadow light needs to implement.
  88687. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88688. * as well as binding the different shadow properties to the effects.
  88689. */
  88690. export interface IShadowLight extends Light {
  88691. /**
  88692. * The light id in the scene (used in scene.findLighById for instance)
  88693. */
  88694. id: string;
  88695. /**
  88696. * The position the shdow will be casted from.
  88697. */
  88698. position: Vector3;
  88699. /**
  88700. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88701. */
  88702. direction: Vector3;
  88703. /**
  88704. * The transformed position. Position of the light in world space taking parenting in account.
  88705. */
  88706. transformedPosition: Vector3;
  88707. /**
  88708. * The transformed direction. Direction of the light in world space taking parenting in account.
  88709. */
  88710. transformedDirection: Vector3;
  88711. /**
  88712. * The friendly name of the light in the scene.
  88713. */
  88714. name: string;
  88715. /**
  88716. * Defines the shadow projection clipping minimum z value.
  88717. */
  88718. shadowMinZ: number;
  88719. /**
  88720. * Defines the shadow projection clipping maximum z value.
  88721. */
  88722. shadowMaxZ: number;
  88723. /**
  88724. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88725. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88726. */
  88727. computeTransformedInformation(): boolean;
  88728. /**
  88729. * Gets the scene the light belongs to.
  88730. * @returns The scene
  88731. */
  88732. getScene(): Scene;
  88733. /**
  88734. * Callback defining a custom Projection Matrix Builder.
  88735. * This can be used to override the default projection matrix computation.
  88736. */
  88737. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88738. /**
  88739. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88740. * @param matrix The materix to updated with the projection information
  88741. * @param viewMatrix The transform matrix of the light
  88742. * @param renderList The list of mesh to render in the map
  88743. * @returns The current light
  88744. */
  88745. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88746. /**
  88747. * Gets the current depth scale used in ESM.
  88748. * @returns The scale
  88749. */
  88750. getDepthScale(): number;
  88751. /**
  88752. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88753. * @returns true if a cube texture needs to be use
  88754. */
  88755. needCube(): boolean;
  88756. /**
  88757. * Detects if the projection matrix requires to be recomputed this frame.
  88758. * @returns true if it requires to be recomputed otherwise, false.
  88759. */
  88760. needProjectionMatrixCompute(): boolean;
  88761. /**
  88762. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88763. */
  88764. forceProjectionMatrixCompute(): void;
  88765. /**
  88766. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88767. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88768. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88769. */
  88770. getShadowDirection(faceIndex?: number): Vector3;
  88771. /**
  88772. * Gets the minZ used for shadow according to both the scene and the light.
  88773. * @param activeCamera The camera we are returning the min for
  88774. * @returns the depth min z
  88775. */
  88776. getDepthMinZ(activeCamera: Camera): number;
  88777. /**
  88778. * Gets the maxZ used for shadow according to both the scene and the light.
  88779. * @param activeCamera The camera we are returning the max for
  88780. * @returns the depth max z
  88781. */
  88782. getDepthMaxZ(activeCamera: Camera): number;
  88783. }
  88784. /**
  88785. * Base implementation IShadowLight
  88786. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88787. */
  88788. export abstract class ShadowLight extends Light implements IShadowLight {
  88789. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88790. protected _position: Vector3;
  88791. protected _setPosition(value: Vector3): void;
  88792. /**
  88793. * Sets the position the shadow will be casted from. Also use as the light position for both
  88794. * point and spot lights.
  88795. */
  88796. get position(): Vector3;
  88797. /**
  88798. * Sets the position the shadow will be casted from. Also use as the light position for both
  88799. * point and spot lights.
  88800. */
  88801. set position(value: Vector3);
  88802. protected _direction: Vector3;
  88803. protected _setDirection(value: Vector3): void;
  88804. /**
  88805. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88806. * Also use as the light direction on spot and directional lights.
  88807. */
  88808. get direction(): Vector3;
  88809. /**
  88810. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88811. * Also use as the light direction on spot and directional lights.
  88812. */
  88813. set direction(value: Vector3);
  88814. protected _shadowMinZ: number;
  88815. /**
  88816. * Gets the shadow projection clipping minimum z value.
  88817. */
  88818. get shadowMinZ(): number;
  88819. /**
  88820. * Sets the shadow projection clipping minimum z value.
  88821. */
  88822. set shadowMinZ(value: number);
  88823. protected _shadowMaxZ: number;
  88824. /**
  88825. * Sets the shadow projection clipping maximum z value.
  88826. */
  88827. get shadowMaxZ(): number;
  88828. /**
  88829. * Gets the shadow projection clipping maximum z value.
  88830. */
  88831. set shadowMaxZ(value: number);
  88832. /**
  88833. * Callback defining a custom Projection Matrix Builder.
  88834. * This can be used to override the default projection matrix computation.
  88835. */
  88836. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88837. /**
  88838. * The transformed position. Position of the light in world space taking parenting in account.
  88839. */
  88840. transformedPosition: Vector3;
  88841. /**
  88842. * The transformed direction. Direction of the light in world space taking parenting in account.
  88843. */
  88844. transformedDirection: Vector3;
  88845. private _needProjectionMatrixCompute;
  88846. /**
  88847. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88848. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88849. */
  88850. computeTransformedInformation(): boolean;
  88851. /**
  88852. * Return the depth scale used for the shadow map.
  88853. * @returns the depth scale.
  88854. */
  88855. getDepthScale(): number;
  88856. /**
  88857. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88858. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88859. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88860. */
  88861. getShadowDirection(faceIndex?: number): Vector3;
  88862. /**
  88863. * Returns the ShadowLight absolute position in the World.
  88864. * @returns the position vector in world space
  88865. */
  88866. getAbsolutePosition(): Vector3;
  88867. /**
  88868. * Sets the ShadowLight direction toward the passed target.
  88869. * @param target The point to target in local space
  88870. * @returns the updated ShadowLight direction
  88871. */
  88872. setDirectionToTarget(target: Vector3): Vector3;
  88873. /**
  88874. * Returns the light rotation in euler definition.
  88875. * @returns the x y z rotation in local space.
  88876. */
  88877. getRotation(): Vector3;
  88878. /**
  88879. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88880. * @returns true if a cube texture needs to be use
  88881. */
  88882. needCube(): boolean;
  88883. /**
  88884. * Detects if the projection matrix requires to be recomputed this frame.
  88885. * @returns true if it requires to be recomputed otherwise, false.
  88886. */
  88887. needProjectionMatrixCompute(): boolean;
  88888. /**
  88889. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88890. */
  88891. forceProjectionMatrixCompute(): void;
  88892. /** @hidden */
  88893. _initCache(): void;
  88894. /** @hidden */
  88895. _isSynchronized(): boolean;
  88896. /**
  88897. * Computes the world matrix of the node
  88898. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88899. * @returns the world matrix
  88900. */
  88901. computeWorldMatrix(force?: boolean): Matrix;
  88902. /**
  88903. * Gets the minZ used for shadow according to both the scene and the light.
  88904. * @param activeCamera The camera we are returning the min for
  88905. * @returns the depth min z
  88906. */
  88907. getDepthMinZ(activeCamera: Camera): number;
  88908. /**
  88909. * Gets the maxZ used for shadow according to both the scene and the light.
  88910. * @param activeCamera The camera we are returning the max for
  88911. * @returns the depth max z
  88912. */
  88913. getDepthMaxZ(activeCamera: Camera): number;
  88914. /**
  88915. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88916. * @param matrix The materix to updated with the projection information
  88917. * @param viewMatrix The transform matrix of the light
  88918. * @param renderList The list of mesh to render in the map
  88919. * @returns The current light
  88920. */
  88921. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88922. }
  88923. }
  88924. declare module BABYLON {
  88925. /** @hidden */
  88926. export var packingFunctions: {
  88927. name: string;
  88928. shader: string;
  88929. };
  88930. }
  88931. declare module BABYLON {
  88932. /** @hidden */
  88933. export var bayerDitherFunctions: {
  88934. name: string;
  88935. shader: string;
  88936. };
  88937. }
  88938. declare module BABYLON {
  88939. /** @hidden */
  88940. export var shadowMapFragmentDeclaration: {
  88941. name: string;
  88942. shader: string;
  88943. };
  88944. }
  88945. declare module BABYLON {
  88946. /** @hidden */
  88947. export var clipPlaneFragmentDeclaration: {
  88948. name: string;
  88949. shader: string;
  88950. };
  88951. }
  88952. declare module BABYLON {
  88953. /** @hidden */
  88954. export var clipPlaneFragment: {
  88955. name: string;
  88956. shader: string;
  88957. };
  88958. }
  88959. declare module BABYLON {
  88960. /** @hidden */
  88961. export var shadowMapFragment: {
  88962. name: string;
  88963. shader: string;
  88964. };
  88965. }
  88966. declare module BABYLON {
  88967. /** @hidden */
  88968. export var shadowMapPixelShader: {
  88969. name: string;
  88970. shader: string;
  88971. };
  88972. }
  88973. declare module BABYLON {
  88974. /** @hidden */
  88975. export var bonesDeclaration: {
  88976. name: string;
  88977. shader: string;
  88978. };
  88979. }
  88980. declare module BABYLON {
  88981. /** @hidden */
  88982. export var morphTargetsVertexGlobalDeclaration: {
  88983. name: string;
  88984. shader: string;
  88985. };
  88986. }
  88987. declare module BABYLON {
  88988. /** @hidden */
  88989. export var morphTargetsVertexDeclaration: {
  88990. name: string;
  88991. shader: string;
  88992. };
  88993. }
  88994. declare module BABYLON {
  88995. /** @hidden */
  88996. export var instancesDeclaration: {
  88997. name: string;
  88998. shader: string;
  88999. };
  89000. }
  89001. declare module BABYLON {
  89002. /** @hidden */
  89003. export var helperFunctions: {
  89004. name: string;
  89005. shader: string;
  89006. };
  89007. }
  89008. declare module BABYLON {
  89009. /** @hidden */
  89010. export var shadowMapVertexDeclaration: {
  89011. name: string;
  89012. shader: string;
  89013. };
  89014. }
  89015. declare module BABYLON {
  89016. /** @hidden */
  89017. export var clipPlaneVertexDeclaration: {
  89018. name: string;
  89019. shader: string;
  89020. };
  89021. }
  89022. declare module BABYLON {
  89023. /** @hidden */
  89024. export var morphTargetsVertex: {
  89025. name: string;
  89026. shader: string;
  89027. };
  89028. }
  89029. declare module BABYLON {
  89030. /** @hidden */
  89031. export var instancesVertex: {
  89032. name: string;
  89033. shader: string;
  89034. };
  89035. }
  89036. declare module BABYLON {
  89037. /** @hidden */
  89038. export var bonesVertex: {
  89039. name: string;
  89040. shader: string;
  89041. };
  89042. }
  89043. declare module BABYLON {
  89044. /** @hidden */
  89045. export var shadowMapVertexNormalBias: {
  89046. name: string;
  89047. shader: string;
  89048. };
  89049. }
  89050. declare module BABYLON {
  89051. /** @hidden */
  89052. export var shadowMapVertexMetric: {
  89053. name: string;
  89054. shader: string;
  89055. };
  89056. }
  89057. declare module BABYLON {
  89058. /** @hidden */
  89059. export var clipPlaneVertex: {
  89060. name: string;
  89061. shader: string;
  89062. };
  89063. }
  89064. declare module BABYLON {
  89065. /** @hidden */
  89066. export var shadowMapVertexShader: {
  89067. name: string;
  89068. shader: string;
  89069. };
  89070. }
  89071. declare module BABYLON {
  89072. /** @hidden */
  89073. export var depthBoxBlurPixelShader: {
  89074. name: string;
  89075. shader: string;
  89076. };
  89077. }
  89078. declare module BABYLON {
  89079. /** @hidden */
  89080. export var shadowMapFragmentSoftTransparentShadow: {
  89081. name: string;
  89082. shader: string;
  89083. };
  89084. }
  89085. declare module BABYLON {
  89086. /**
  89087. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89088. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89089. */
  89090. export class EffectFallbacks implements IEffectFallbacks {
  89091. private _defines;
  89092. private _currentRank;
  89093. private _maxRank;
  89094. private _mesh;
  89095. /**
  89096. * Removes the fallback from the bound mesh.
  89097. */
  89098. unBindMesh(): void;
  89099. /**
  89100. * Adds a fallback on the specified property.
  89101. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89102. * @param define The name of the define in the shader
  89103. */
  89104. addFallback(rank: number, define: string): void;
  89105. /**
  89106. * Sets the mesh to use CPU skinning when needing to fallback.
  89107. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89108. * @param mesh The mesh to use the fallbacks.
  89109. */
  89110. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89111. /**
  89112. * Checks to see if more fallbacks are still availible.
  89113. */
  89114. get hasMoreFallbacks(): boolean;
  89115. /**
  89116. * Removes the defines that should be removed when falling back.
  89117. * @param currentDefines defines the current define statements for the shader.
  89118. * @param effect defines the current effect we try to compile
  89119. * @returns The resulting defines with defines of the current rank removed.
  89120. */
  89121. reduce(currentDefines: string, effect: Effect): string;
  89122. }
  89123. }
  89124. declare module BABYLON {
  89125. /**
  89126. * Interface used to define Action
  89127. */
  89128. export interface IAction {
  89129. /**
  89130. * Trigger for the action
  89131. */
  89132. trigger: number;
  89133. /** Options of the trigger */
  89134. triggerOptions: any;
  89135. /**
  89136. * Gets the trigger parameters
  89137. * @returns the trigger parameters
  89138. */
  89139. getTriggerParameter(): any;
  89140. /**
  89141. * Internal only - executes current action event
  89142. * @hidden
  89143. */
  89144. _executeCurrent(evt?: ActionEvent): void;
  89145. /**
  89146. * Serialize placeholder for child classes
  89147. * @param parent of child
  89148. * @returns the serialized object
  89149. */
  89150. serialize(parent: any): any;
  89151. /**
  89152. * Internal only
  89153. * @hidden
  89154. */
  89155. _prepare(): void;
  89156. /**
  89157. * Internal only - manager for action
  89158. * @hidden
  89159. */
  89160. _actionManager: Nullable<AbstractActionManager>;
  89161. /**
  89162. * Adds action to chain of actions, may be a DoNothingAction
  89163. * @param action defines the next action to execute
  89164. * @returns The action passed in
  89165. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89166. */
  89167. then(action: IAction): IAction;
  89168. }
  89169. /**
  89170. * The action to be carried out following a trigger
  89171. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89172. */
  89173. export class Action implements IAction {
  89174. /** the trigger, with or without parameters, for the action */
  89175. triggerOptions: any;
  89176. /**
  89177. * Trigger for the action
  89178. */
  89179. trigger: number;
  89180. /**
  89181. * Internal only - manager for action
  89182. * @hidden
  89183. */
  89184. _actionManager: ActionManager;
  89185. private _nextActiveAction;
  89186. private _child;
  89187. private _condition?;
  89188. private _triggerParameter;
  89189. /**
  89190. * An event triggered prior to action being executed.
  89191. */
  89192. onBeforeExecuteObservable: Observable<Action>;
  89193. /**
  89194. * Creates a new Action
  89195. * @param triggerOptions the trigger, with or without parameters, for the action
  89196. * @param condition an optional determinant of action
  89197. */
  89198. constructor(
  89199. /** the trigger, with or without parameters, for the action */
  89200. triggerOptions: any, condition?: Condition);
  89201. /**
  89202. * Internal only
  89203. * @hidden
  89204. */
  89205. _prepare(): void;
  89206. /**
  89207. * Gets the trigger parameters
  89208. * @returns the trigger parameters
  89209. */
  89210. getTriggerParameter(): any;
  89211. /**
  89212. * Internal only - executes current action event
  89213. * @hidden
  89214. */
  89215. _executeCurrent(evt?: ActionEvent): void;
  89216. /**
  89217. * Execute placeholder for child classes
  89218. * @param evt optional action event
  89219. */
  89220. execute(evt?: ActionEvent): void;
  89221. /**
  89222. * Skips to next active action
  89223. */
  89224. skipToNextActiveAction(): void;
  89225. /**
  89226. * Adds action to chain of actions, may be a DoNothingAction
  89227. * @param action defines the next action to execute
  89228. * @returns The action passed in
  89229. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89230. */
  89231. then(action: Action): Action;
  89232. /**
  89233. * Internal only
  89234. * @hidden
  89235. */
  89236. _getProperty(propertyPath: string): string;
  89237. /**
  89238. * Internal only
  89239. * @hidden
  89240. */
  89241. _getEffectiveTarget(target: any, propertyPath: string): any;
  89242. /**
  89243. * Serialize placeholder for child classes
  89244. * @param parent of child
  89245. * @returns the serialized object
  89246. */
  89247. serialize(parent: any): any;
  89248. /**
  89249. * Internal only called by serialize
  89250. * @hidden
  89251. */
  89252. protected _serialize(serializedAction: any, parent?: any): any;
  89253. /**
  89254. * Internal only
  89255. * @hidden
  89256. */
  89257. static _SerializeValueAsString: (value: any) => string;
  89258. /**
  89259. * Internal only
  89260. * @hidden
  89261. */
  89262. static _GetTargetProperty: (target: Scene | Node) => {
  89263. name: string;
  89264. targetType: string;
  89265. value: string;
  89266. };
  89267. }
  89268. }
  89269. declare module BABYLON {
  89270. /**
  89271. * A Condition applied to an Action
  89272. */
  89273. export class Condition {
  89274. /**
  89275. * Internal only - manager for action
  89276. * @hidden
  89277. */
  89278. _actionManager: ActionManager;
  89279. /**
  89280. * Internal only
  89281. * @hidden
  89282. */
  89283. _evaluationId: number;
  89284. /**
  89285. * Internal only
  89286. * @hidden
  89287. */
  89288. _currentResult: boolean;
  89289. /**
  89290. * Creates a new Condition
  89291. * @param actionManager the manager of the action the condition is applied to
  89292. */
  89293. constructor(actionManager: ActionManager);
  89294. /**
  89295. * Check if the current condition is valid
  89296. * @returns a boolean
  89297. */
  89298. isValid(): boolean;
  89299. /**
  89300. * Internal only
  89301. * @hidden
  89302. */
  89303. _getProperty(propertyPath: string): string;
  89304. /**
  89305. * Internal only
  89306. * @hidden
  89307. */
  89308. _getEffectiveTarget(target: any, propertyPath: string): any;
  89309. /**
  89310. * Serialize placeholder for child classes
  89311. * @returns the serialized object
  89312. */
  89313. serialize(): any;
  89314. /**
  89315. * Internal only
  89316. * @hidden
  89317. */
  89318. protected _serialize(serializedCondition: any): any;
  89319. }
  89320. /**
  89321. * Defines specific conditional operators as extensions of Condition
  89322. */
  89323. export class ValueCondition extends Condition {
  89324. /** path to specify the property of the target the conditional operator uses */
  89325. propertyPath: string;
  89326. /** the value compared by the conditional operator against the current value of the property */
  89327. value: any;
  89328. /** the conditional operator, default ValueCondition.IsEqual */
  89329. operator: number;
  89330. /**
  89331. * Internal only
  89332. * @hidden
  89333. */
  89334. private static _IsEqual;
  89335. /**
  89336. * Internal only
  89337. * @hidden
  89338. */
  89339. private static _IsDifferent;
  89340. /**
  89341. * Internal only
  89342. * @hidden
  89343. */
  89344. private static _IsGreater;
  89345. /**
  89346. * Internal only
  89347. * @hidden
  89348. */
  89349. private static _IsLesser;
  89350. /**
  89351. * returns the number for IsEqual
  89352. */
  89353. static get IsEqual(): number;
  89354. /**
  89355. * Returns the number for IsDifferent
  89356. */
  89357. static get IsDifferent(): number;
  89358. /**
  89359. * Returns the number for IsGreater
  89360. */
  89361. static get IsGreater(): number;
  89362. /**
  89363. * Returns the number for IsLesser
  89364. */
  89365. static get IsLesser(): number;
  89366. /**
  89367. * Internal only The action manager for the condition
  89368. * @hidden
  89369. */
  89370. _actionManager: ActionManager;
  89371. /**
  89372. * Internal only
  89373. * @hidden
  89374. */
  89375. private _target;
  89376. /**
  89377. * Internal only
  89378. * @hidden
  89379. */
  89380. private _effectiveTarget;
  89381. /**
  89382. * Internal only
  89383. * @hidden
  89384. */
  89385. private _property;
  89386. /**
  89387. * Creates a new ValueCondition
  89388. * @param actionManager manager for the action the condition applies to
  89389. * @param target for the action
  89390. * @param propertyPath path to specify the property of the target the conditional operator uses
  89391. * @param value the value compared by the conditional operator against the current value of the property
  89392. * @param operator the conditional operator, default ValueCondition.IsEqual
  89393. */
  89394. constructor(actionManager: ActionManager, target: any,
  89395. /** path to specify the property of the target the conditional operator uses */
  89396. propertyPath: string,
  89397. /** the value compared by the conditional operator against the current value of the property */
  89398. value: any,
  89399. /** the conditional operator, default ValueCondition.IsEqual */
  89400. operator?: number);
  89401. /**
  89402. * Compares the given value with the property value for the specified conditional operator
  89403. * @returns the result of the comparison
  89404. */
  89405. isValid(): boolean;
  89406. /**
  89407. * Serialize the ValueCondition into a JSON compatible object
  89408. * @returns serialization object
  89409. */
  89410. serialize(): any;
  89411. /**
  89412. * Gets the name of the conditional operator for the ValueCondition
  89413. * @param operator the conditional operator
  89414. * @returns the name
  89415. */
  89416. static GetOperatorName(operator: number): string;
  89417. }
  89418. /**
  89419. * Defines a predicate condition as an extension of Condition
  89420. */
  89421. export class PredicateCondition extends Condition {
  89422. /** defines the predicate function used to validate the condition */
  89423. predicate: () => boolean;
  89424. /**
  89425. * Internal only - manager for action
  89426. * @hidden
  89427. */
  89428. _actionManager: ActionManager;
  89429. /**
  89430. * Creates a new PredicateCondition
  89431. * @param actionManager manager for the action the condition applies to
  89432. * @param predicate defines the predicate function used to validate the condition
  89433. */
  89434. constructor(actionManager: ActionManager,
  89435. /** defines the predicate function used to validate the condition */
  89436. predicate: () => boolean);
  89437. /**
  89438. * @returns the validity of the predicate condition
  89439. */
  89440. isValid(): boolean;
  89441. }
  89442. /**
  89443. * Defines a state condition as an extension of Condition
  89444. */
  89445. export class StateCondition extends Condition {
  89446. /** Value to compare with target state */
  89447. value: string;
  89448. /**
  89449. * Internal only - manager for action
  89450. * @hidden
  89451. */
  89452. _actionManager: ActionManager;
  89453. /**
  89454. * Internal only
  89455. * @hidden
  89456. */
  89457. private _target;
  89458. /**
  89459. * Creates a new StateCondition
  89460. * @param actionManager manager for the action the condition applies to
  89461. * @param target of the condition
  89462. * @param value to compare with target state
  89463. */
  89464. constructor(actionManager: ActionManager, target: any,
  89465. /** Value to compare with target state */
  89466. value: string);
  89467. /**
  89468. * Gets a boolean indicating if the current condition is met
  89469. * @returns the validity of the state
  89470. */
  89471. isValid(): boolean;
  89472. /**
  89473. * Serialize the StateCondition into a JSON compatible object
  89474. * @returns serialization object
  89475. */
  89476. serialize(): any;
  89477. }
  89478. }
  89479. declare module BABYLON {
  89480. /**
  89481. * This defines an action responsible to toggle a boolean once triggered.
  89482. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89483. */
  89484. export class SwitchBooleanAction extends Action {
  89485. /**
  89486. * The path to the boolean property in the target object
  89487. */
  89488. propertyPath: string;
  89489. private _target;
  89490. private _effectiveTarget;
  89491. private _property;
  89492. /**
  89493. * Instantiate the action
  89494. * @param triggerOptions defines the trigger options
  89495. * @param target defines the object containing the boolean
  89496. * @param propertyPath defines the path to the boolean property in the target object
  89497. * @param condition defines the trigger related conditions
  89498. */
  89499. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89500. /** @hidden */
  89501. _prepare(): void;
  89502. /**
  89503. * Execute the action toggle the boolean value.
  89504. */
  89505. execute(): void;
  89506. /**
  89507. * Serializes the actions and its related information.
  89508. * @param parent defines the object to serialize in
  89509. * @returns the serialized object
  89510. */
  89511. serialize(parent: any): any;
  89512. }
  89513. /**
  89514. * This defines an action responsible to set a the state field of the target
  89515. * to a desired value once triggered.
  89516. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89517. */
  89518. export class SetStateAction extends Action {
  89519. /**
  89520. * The value to store in the state field.
  89521. */
  89522. value: string;
  89523. private _target;
  89524. /**
  89525. * Instantiate the action
  89526. * @param triggerOptions defines the trigger options
  89527. * @param target defines the object containing the state property
  89528. * @param value defines the value to store in the state field
  89529. * @param condition defines the trigger related conditions
  89530. */
  89531. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89532. /**
  89533. * Execute the action and store the value on the target state property.
  89534. */
  89535. execute(): void;
  89536. /**
  89537. * Serializes the actions and its related information.
  89538. * @param parent defines the object to serialize in
  89539. * @returns the serialized object
  89540. */
  89541. serialize(parent: any): any;
  89542. }
  89543. /**
  89544. * This defines an action responsible to set a property of the target
  89545. * to a desired value once triggered.
  89546. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89547. */
  89548. export class SetValueAction extends Action {
  89549. /**
  89550. * The path of the property to set in the target.
  89551. */
  89552. propertyPath: string;
  89553. /**
  89554. * The value to set in the property
  89555. */
  89556. value: any;
  89557. private _target;
  89558. private _effectiveTarget;
  89559. private _property;
  89560. /**
  89561. * Instantiate the action
  89562. * @param triggerOptions defines the trigger options
  89563. * @param target defines the object containing the property
  89564. * @param propertyPath defines the path of the property to set in the target
  89565. * @param value defines the value to set in the property
  89566. * @param condition defines the trigger related conditions
  89567. */
  89568. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89569. /** @hidden */
  89570. _prepare(): void;
  89571. /**
  89572. * Execute the action and set the targetted property to the desired value.
  89573. */
  89574. execute(): void;
  89575. /**
  89576. * Serializes the actions and its related information.
  89577. * @param parent defines the object to serialize in
  89578. * @returns the serialized object
  89579. */
  89580. serialize(parent: any): any;
  89581. }
  89582. /**
  89583. * This defines an action responsible to increment the target value
  89584. * to a desired value once triggered.
  89585. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89586. */
  89587. export class IncrementValueAction extends Action {
  89588. /**
  89589. * The path of the property to increment in the target.
  89590. */
  89591. propertyPath: string;
  89592. /**
  89593. * The value we should increment the property by.
  89594. */
  89595. value: any;
  89596. private _target;
  89597. private _effectiveTarget;
  89598. private _property;
  89599. /**
  89600. * Instantiate the action
  89601. * @param triggerOptions defines the trigger options
  89602. * @param target defines the object containing the property
  89603. * @param propertyPath defines the path of the property to increment in the target
  89604. * @param value defines the value value we should increment the property by
  89605. * @param condition defines the trigger related conditions
  89606. */
  89607. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89608. /** @hidden */
  89609. _prepare(): void;
  89610. /**
  89611. * Execute the action and increment the target of the value amount.
  89612. */
  89613. execute(): void;
  89614. /**
  89615. * Serializes the actions and its related information.
  89616. * @param parent defines the object to serialize in
  89617. * @returns the serialized object
  89618. */
  89619. serialize(parent: any): any;
  89620. }
  89621. /**
  89622. * This defines an action responsible to start an animation once triggered.
  89623. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89624. */
  89625. export class PlayAnimationAction extends Action {
  89626. /**
  89627. * Where the animation should start (animation frame)
  89628. */
  89629. from: number;
  89630. /**
  89631. * Where the animation should stop (animation frame)
  89632. */
  89633. to: number;
  89634. /**
  89635. * Define if the animation should loop or stop after the first play.
  89636. */
  89637. loop?: boolean;
  89638. private _target;
  89639. /**
  89640. * Instantiate the action
  89641. * @param triggerOptions defines the trigger options
  89642. * @param target defines the target animation or animation name
  89643. * @param from defines from where the animation should start (animation frame)
  89644. * @param end defines where the animation should stop (animation frame)
  89645. * @param loop defines if the animation should loop or stop after the first play
  89646. * @param condition defines the trigger related conditions
  89647. */
  89648. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89649. /** @hidden */
  89650. _prepare(): void;
  89651. /**
  89652. * Execute the action and play the animation.
  89653. */
  89654. execute(): void;
  89655. /**
  89656. * Serializes the actions and its related information.
  89657. * @param parent defines the object to serialize in
  89658. * @returns the serialized object
  89659. */
  89660. serialize(parent: any): any;
  89661. }
  89662. /**
  89663. * This defines an action responsible to stop an animation once triggered.
  89664. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89665. */
  89666. export class StopAnimationAction extends Action {
  89667. private _target;
  89668. /**
  89669. * Instantiate the action
  89670. * @param triggerOptions defines the trigger options
  89671. * @param target defines the target animation or animation name
  89672. * @param condition defines the trigger related conditions
  89673. */
  89674. constructor(triggerOptions: any, target: any, condition?: Condition);
  89675. /** @hidden */
  89676. _prepare(): void;
  89677. /**
  89678. * Execute the action and stop the animation.
  89679. */
  89680. execute(): void;
  89681. /**
  89682. * Serializes the actions and its related information.
  89683. * @param parent defines the object to serialize in
  89684. * @returns the serialized object
  89685. */
  89686. serialize(parent: any): any;
  89687. }
  89688. /**
  89689. * This defines an action responsible that does nothing once triggered.
  89690. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89691. */
  89692. export class DoNothingAction extends Action {
  89693. /**
  89694. * Instantiate the action
  89695. * @param triggerOptions defines the trigger options
  89696. * @param condition defines the trigger related conditions
  89697. */
  89698. constructor(triggerOptions?: any, condition?: Condition);
  89699. /**
  89700. * Execute the action and do nothing.
  89701. */
  89702. execute(): void;
  89703. /**
  89704. * Serializes the actions and its related information.
  89705. * @param parent defines the object to serialize in
  89706. * @returns the serialized object
  89707. */
  89708. serialize(parent: any): any;
  89709. }
  89710. /**
  89711. * This defines an action responsible to trigger several actions once triggered.
  89712. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89713. */
  89714. export class CombineAction extends Action {
  89715. /**
  89716. * The list of aggregated animations to run.
  89717. */
  89718. children: Action[];
  89719. /**
  89720. * Instantiate the action
  89721. * @param triggerOptions defines the trigger options
  89722. * @param children defines the list of aggregated animations to run
  89723. * @param condition defines the trigger related conditions
  89724. */
  89725. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89726. /** @hidden */
  89727. _prepare(): void;
  89728. /**
  89729. * Execute the action and executes all the aggregated actions.
  89730. */
  89731. execute(evt: ActionEvent): void;
  89732. /**
  89733. * Serializes the actions and its related information.
  89734. * @param parent defines the object to serialize in
  89735. * @returns the serialized object
  89736. */
  89737. serialize(parent: any): any;
  89738. }
  89739. /**
  89740. * This defines an action responsible to run code (external event) once triggered.
  89741. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89742. */
  89743. export class ExecuteCodeAction extends Action {
  89744. /**
  89745. * The callback function to run.
  89746. */
  89747. func: (evt: ActionEvent) => void;
  89748. /**
  89749. * Instantiate the action
  89750. * @param triggerOptions defines the trigger options
  89751. * @param func defines the callback function to run
  89752. * @param condition defines the trigger related conditions
  89753. */
  89754. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89755. /**
  89756. * Execute the action and run the attached code.
  89757. */
  89758. execute(evt: ActionEvent): void;
  89759. }
  89760. /**
  89761. * This defines an action responsible to set the parent property of the target once triggered.
  89762. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89763. */
  89764. export class SetParentAction extends Action {
  89765. private _parent;
  89766. private _target;
  89767. /**
  89768. * Instantiate the action
  89769. * @param triggerOptions defines the trigger options
  89770. * @param target defines the target containing the parent property
  89771. * @param parent defines from where the animation should start (animation frame)
  89772. * @param condition defines the trigger related conditions
  89773. */
  89774. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89775. /** @hidden */
  89776. _prepare(): void;
  89777. /**
  89778. * Execute the action and set the parent property.
  89779. */
  89780. execute(): void;
  89781. /**
  89782. * Serializes the actions and its related information.
  89783. * @param parent defines the object to serialize in
  89784. * @returns the serialized object
  89785. */
  89786. serialize(parent: any): any;
  89787. }
  89788. }
  89789. declare module BABYLON {
  89790. /**
  89791. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89792. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89793. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89794. */
  89795. export class ActionManager extends AbstractActionManager {
  89796. /**
  89797. * Nothing
  89798. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89799. */
  89800. static readonly NothingTrigger: number;
  89801. /**
  89802. * On pick
  89803. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89804. */
  89805. static readonly OnPickTrigger: number;
  89806. /**
  89807. * On left pick
  89808. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89809. */
  89810. static readonly OnLeftPickTrigger: number;
  89811. /**
  89812. * On right pick
  89813. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89814. */
  89815. static readonly OnRightPickTrigger: number;
  89816. /**
  89817. * On center pick
  89818. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89819. */
  89820. static readonly OnCenterPickTrigger: number;
  89821. /**
  89822. * On pick down
  89823. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89824. */
  89825. static readonly OnPickDownTrigger: number;
  89826. /**
  89827. * On double pick
  89828. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89829. */
  89830. static readonly OnDoublePickTrigger: number;
  89831. /**
  89832. * On pick up
  89833. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89834. */
  89835. static readonly OnPickUpTrigger: number;
  89836. /**
  89837. * On pick out.
  89838. * This trigger will only be raised if you also declared a OnPickDown
  89839. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89840. */
  89841. static readonly OnPickOutTrigger: number;
  89842. /**
  89843. * On long press
  89844. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89845. */
  89846. static readonly OnLongPressTrigger: number;
  89847. /**
  89848. * On pointer over
  89849. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89850. */
  89851. static readonly OnPointerOverTrigger: number;
  89852. /**
  89853. * On pointer out
  89854. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89855. */
  89856. static readonly OnPointerOutTrigger: number;
  89857. /**
  89858. * On every frame
  89859. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89860. */
  89861. static readonly OnEveryFrameTrigger: number;
  89862. /**
  89863. * On intersection enter
  89864. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89865. */
  89866. static readonly OnIntersectionEnterTrigger: number;
  89867. /**
  89868. * On intersection exit
  89869. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89870. */
  89871. static readonly OnIntersectionExitTrigger: number;
  89872. /**
  89873. * On key down
  89874. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89875. */
  89876. static readonly OnKeyDownTrigger: number;
  89877. /**
  89878. * On key up
  89879. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89880. */
  89881. static readonly OnKeyUpTrigger: number;
  89882. private _scene;
  89883. /**
  89884. * Creates a new action manager
  89885. * @param scene defines the hosting scene
  89886. */
  89887. constructor(scene: Scene);
  89888. /**
  89889. * Releases all associated resources
  89890. */
  89891. dispose(): void;
  89892. /**
  89893. * Gets hosting scene
  89894. * @returns the hosting scene
  89895. */
  89896. getScene(): Scene;
  89897. /**
  89898. * Does this action manager handles actions of any of the given triggers
  89899. * @param triggers defines the triggers to be tested
  89900. * @return a boolean indicating whether one (or more) of the triggers is handled
  89901. */
  89902. hasSpecificTriggers(triggers: number[]): boolean;
  89903. /**
  89904. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89905. * speed.
  89906. * @param triggerA defines the trigger to be tested
  89907. * @param triggerB defines the trigger to be tested
  89908. * @return a boolean indicating whether one (or more) of the triggers is handled
  89909. */
  89910. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89911. /**
  89912. * Does this action manager handles actions of a given trigger
  89913. * @param trigger defines the trigger to be tested
  89914. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89915. * @return whether the trigger is handled
  89916. */
  89917. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89918. /**
  89919. * Does this action manager has pointer triggers
  89920. */
  89921. get hasPointerTriggers(): boolean;
  89922. /**
  89923. * Does this action manager has pick triggers
  89924. */
  89925. get hasPickTriggers(): boolean;
  89926. /**
  89927. * Registers an action to this action manager
  89928. * @param action defines the action to be registered
  89929. * @return the action amended (prepared) after registration
  89930. */
  89931. registerAction(action: IAction): Nullable<IAction>;
  89932. /**
  89933. * Unregisters an action to this action manager
  89934. * @param action defines the action to be unregistered
  89935. * @return a boolean indicating whether the action has been unregistered
  89936. */
  89937. unregisterAction(action: IAction): Boolean;
  89938. /**
  89939. * Process a specific trigger
  89940. * @param trigger defines the trigger to process
  89941. * @param evt defines the event details to be processed
  89942. */
  89943. processTrigger(trigger: number, evt?: IActionEvent): void;
  89944. /** @hidden */
  89945. _getEffectiveTarget(target: any, propertyPath: string): any;
  89946. /** @hidden */
  89947. _getProperty(propertyPath: string): string;
  89948. /**
  89949. * Serialize this manager to a JSON object
  89950. * @param name defines the property name to store this manager
  89951. * @returns a JSON representation of this manager
  89952. */
  89953. serialize(name: string): any;
  89954. /**
  89955. * Creates a new ActionManager from a JSON data
  89956. * @param parsedActions defines the JSON data to read from
  89957. * @param object defines the hosting mesh
  89958. * @param scene defines the hosting scene
  89959. */
  89960. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89961. /**
  89962. * Get a trigger name by index
  89963. * @param trigger defines the trigger index
  89964. * @returns a trigger name
  89965. */
  89966. static GetTriggerName(trigger: number): string;
  89967. }
  89968. }
  89969. declare module BABYLON {
  89970. /**
  89971. * Class used to represent a sprite
  89972. * @see https://doc.babylonjs.com/babylon101/sprites
  89973. */
  89974. export class Sprite implements IAnimatable {
  89975. /** defines the name */
  89976. name: string;
  89977. /** Gets or sets the current world position */
  89978. position: Vector3;
  89979. /** Gets or sets the main color */
  89980. color: Color4;
  89981. /** Gets or sets the width */
  89982. width: number;
  89983. /** Gets or sets the height */
  89984. height: number;
  89985. /** Gets or sets rotation angle */
  89986. angle: number;
  89987. /** Gets or sets the cell index in the sprite sheet */
  89988. cellIndex: number;
  89989. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89990. cellRef: string;
  89991. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89992. invertU: boolean;
  89993. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89994. invertV: boolean;
  89995. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89996. disposeWhenFinishedAnimating: boolean;
  89997. /** Gets the list of attached animations */
  89998. animations: Nullable<Array<Animation>>;
  89999. /** Gets or sets a boolean indicating if the sprite can be picked */
  90000. isPickable: boolean;
  90001. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  90002. useAlphaForPicking: boolean;
  90003. /** @hidden */
  90004. _xOffset: number;
  90005. /** @hidden */
  90006. _yOffset: number;
  90007. /** @hidden */
  90008. _xSize: number;
  90009. /** @hidden */
  90010. _ySize: number;
  90011. /**
  90012. * Gets or sets the associated action manager
  90013. */
  90014. actionManager: Nullable<ActionManager>;
  90015. /**
  90016. * An event triggered when the control has been disposed
  90017. */
  90018. onDisposeObservable: Observable<Sprite>;
  90019. private _animationStarted;
  90020. private _loopAnimation;
  90021. private _fromIndex;
  90022. private _toIndex;
  90023. private _delay;
  90024. private _direction;
  90025. private _manager;
  90026. private _time;
  90027. private _onAnimationEnd;
  90028. /**
  90029. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  90030. */
  90031. isVisible: boolean;
  90032. /**
  90033. * Gets or sets the sprite size
  90034. */
  90035. get size(): number;
  90036. set size(value: number);
  90037. /**
  90038. * Returns a boolean indicating if the animation is started
  90039. */
  90040. get animationStarted(): boolean;
  90041. /**
  90042. * Gets or sets the unique id of the sprite
  90043. */
  90044. uniqueId: number;
  90045. /**
  90046. * Gets the manager of this sprite
  90047. */
  90048. get manager(): ISpriteManager;
  90049. /**
  90050. * Creates a new Sprite
  90051. * @param name defines the name
  90052. * @param manager defines the manager
  90053. */
  90054. constructor(
  90055. /** defines the name */
  90056. name: string, manager: ISpriteManager);
  90057. /**
  90058. * Returns the string "Sprite"
  90059. * @returns "Sprite"
  90060. */
  90061. getClassName(): string;
  90062. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  90063. get fromIndex(): number;
  90064. set fromIndex(value: number);
  90065. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  90066. get toIndex(): number;
  90067. set toIndex(value: number);
  90068. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  90069. get loopAnimation(): boolean;
  90070. set loopAnimation(value: boolean);
  90071. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  90072. get delay(): number;
  90073. set delay(value: number);
  90074. /**
  90075. * Starts an animation
  90076. * @param from defines the initial key
  90077. * @param to defines the end key
  90078. * @param loop defines if the animation must loop
  90079. * @param delay defines the start delay (in ms)
  90080. * @param onAnimationEnd defines a callback to call when animation ends
  90081. */
  90082. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  90083. /** Stops current animation (if any) */
  90084. stopAnimation(): void;
  90085. /** @hidden */
  90086. _animate(deltaTime: number): void;
  90087. /** Release associated resources */
  90088. dispose(): void;
  90089. /**
  90090. * Serializes the sprite to a JSON object
  90091. * @returns the JSON object
  90092. */
  90093. serialize(): any;
  90094. /**
  90095. * Parses a JSON object to create a new sprite
  90096. * @param parsedSprite The JSON object to parse
  90097. * @param manager defines the hosting manager
  90098. * @returns the new sprite
  90099. */
  90100. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90101. }
  90102. }
  90103. declare module BABYLON {
  90104. /**
  90105. * Information about the result of picking within a scene
  90106. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90107. */
  90108. export class PickingInfo {
  90109. /** @hidden */
  90110. _pickingUnavailable: boolean;
  90111. /**
  90112. * If the pick collided with an object
  90113. */
  90114. hit: boolean;
  90115. /**
  90116. * Distance away where the pick collided
  90117. */
  90118. distance: number;
  90119. /**
  90120. * The location of pick collision
  90121. */
  90122. pickedPoint: Nullable<Vector3>;
  90123. /**
  90124. * The mesh corresponding the the pick collision
  90125. */
  90126. pickedMesh: Nullable<AbstractMesh>;
  90127. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90128. bu: number;
  90129. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90130. bv: number;
  90131. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90132. faceId: number;
  90133. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90134. subMeshFaceId: number;
  90135. /** Id of the the submesh that was picked */
  90136. subMeshId: number;
  90137. /** If a sprite was picked, this will be the sprite the pick collided with */
  90138. pickedSprite: Nullable<Sprite>;
  90139. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90140. thinInstanceIndex: number;
  90141. /**
  90142. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90143. */
  90144. originMesh: Nullable<AbstractMesh>;
  90145. /**
  90146. * The ray that was used to perform the picking.
  90147. */
  90148. ray: Nullable<Ray>;
  90149. /**
  90150. * Gets the normal correspodning to the face the pick collided with
  90151. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90152. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90153. * @returns The normal correspodning to the face the pick collided with
  90154. */
  90155. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90156. /**
  90157. * Gets the texture coordinates of where the pick occured
  90158. * @returns the vector containing the coordnates of the texture
  90159. */
  90160. getTextureCoordinates(): Nullable<Vector2>;
  90161. }
  90162. }
  90163. declare module BABYLON {
  90164. /**
  90165. * Class representing a ray with position and direction
  90166. */
  90167. export class Ray {
  90168. /** origin point */
  90169. origin: Vector3;
  90170. /** direction */
  90171. direction: Vector3;
  90172. /** length of the ray */
  90173. length: number;
  90174. private static readonly _TmpVector3;
  90175. private _tmpRay;
  90176. /**
  90177. * Creates a new ray
  90178. * @param origin origin point
  90179. * @param direction direction
  90180. * @param length length of the ray
  90181. */
  90182. constructor(
  90183. /** origin point */
  90184. origin: Vector3,
  90185. /** direction */
  90186. direction: Vector3,
  90187. /** length of the ray */
  90188. length?: number);
  90189. /**
  90190. * Checks if the ray intersects a box
  90191. * This does not account for the ray lenght by design to improve perfs.
  90192. * @param minimum bound of the box
  90193. * @param maximum bound of the box
  90194. * @param intersectionTreshold extra extend to be added to the box in all direction
  90195. * @returns if the box was hit
  90196. */
  90197. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90198. /**
  90199. * Checks if the ray intersects a box
  90200. * This does not account for the ray lenght by design to improve perfs.
  90201. * @param box the bounding box to check
  90202. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90203. * @returns if the box was hit
  90204. */
  90205. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90206. /**
  90207. * If the ray hits a sphere
  90208. * @param sphere the bounding sphere to check
  90209. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90210. * @returns true if it hits the sphere
  90211. */
  90212. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90213. /**
  90214. * If the ray hits a triange
  90215. * @param vertex0 triangle vertex
  90216. * @param vertex1 triangle vertex
  90217. * @param vertex2 triangle vertex
  90218. * @returns intersection information if hit
  90219. */
  90220. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90221. /**
  90222. * Checks if ray intersects a plane
  90223. * @param plane the plane to check
  90224. * @returns the distance away it was hit
  90225. */
  90226. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90227. /**
  90228. * Calculate the intercept of a ray on a given axis
  90229. * @param axis to check 'x' | 'y' | 'z'
  90230. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90231. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90232. */
  90233. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90234. /**
  90235. * Checks if ray intersects a mesh
  90236. * @param mesh the mesh to check
  90237. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90238. * @returns picking info of the intersecton
  90239. */
  90240. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90241. /**
  90242. * Checks if ray intersects a mesh
  90243. * @param meshes the meshes to check
  90244. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90245. * @param results array to store result in
  90246. * @returns Array of picking infos
  90247. */
  90248. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90249. private _comparePickingInfo;
  90250. private static smallnum;
  90251. private static rayl;
  90252. /**
  90253. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90254. * @param sega the first point of the segment to test the intersection against
  90255. * @param segb the second point of the segment to test the intersection against
  90256. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90257. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90258. */
  90259. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90260. /**
  90261. * Update the ray from viewport position
  90262. * @param x position
  90263. * @param y y position
  90264. * @param viewportWidth viewport width
  90265. * @param viewportHeight viewport height
  90266. * @param world world matrix
  90267. * @param view view matrix
  90268. * @param projection projection matrix
  90269. * @returns this ray updated
  90270. */
  90271. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90272. /**
  90273. * Creates a ray with origin and direction of 0,0,0
  90274. * @returns the new ray
  90275. */
  90276. static Zero(): Ray;
  90277. /**
  90278. * Creates a new ray from screen space and viewport
  90279. * @param x position
  90280. * @param y y position
  90281. * @param viewportWidth viewport width
  90282. * @param viewportHeight viewport height
  90283. * @param world world matrix
  90284. * @param view view matrix
  90285. * @param projection projection matrix
  90286. * @returns new ray
  90287. */
  90288. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90289. /**
  90290. * 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
  90291. * transformed to the given world matrix.
  90292. * @param origin The origin point
  90293. * @param end The end point
  90294. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90295. * @returns the new ray
  90296. */
  90297. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90298. /**
  90299. * Transforms a ray by a matrix
  90300. * @param ray ray to transform
  90301. * @param matrix matrix to apply
  90302. * @returns the resulting new ray
  90303. */
  90304. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90305. /**
  90306. * Transforms a ray by a matrix
  90307. * @param ray ray to transform
  90308. * @param matrix matrix to apply
  90309. * @param result ray to store result in
  90310. */
  90311. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90312. /**
  90313. * Unproject a ray from screen space to object space
  90314. * @param sourceX defines the screen space x coordinate to use
  90315. * @param sourceY defines the screen space y coordinate to use
  90316. * @param viewportWidth defines the current width of the viewport
  90317. * @param viewportHeight defines the current height of the viewport
  90318. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90319. * @param view defines the view matrix to use
  90320. * @param projection defines the projection matrix to use
  90321. */
  90322. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90323. }
  90324. /**
  90325. * Type used to define predicate used to select faces when a mesh intersection is detected
  90326. */
  90327. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90328. interface Scene {
  90329. /** @hidden */
  90330. _tempPickingRay: Nullable<Ray>;
  90331. /** @hidden */
  90332. _cachedRayForTransform: Ray;
  90333. /** @hidden */
  90334. _pickWithRayInverseMatrix: Matrix;
  90335. /** @hidden */
  90336. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90337. /** @hidden */
  90338. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90339. /** @hidden */
  90340. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90341. }
  90342. }
  90343. declare module BABYLON {
  90344. /**
  90345. * Groups all the scene component constants in one place to ease maintenance.
  90346. * @hidden
  90347. */
  90348. export class SceneComponentConstants {
  90349. static readonly NAME_EFFECTLAYER: string;
  90350. static readonly NAME_LAYER: string;
  90351. static readonly NAME_LENSFLARESYSTEM: string;
  90352. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90353. static readonly NAME_PARTICLESYSTEM: string;
  90354. static readonly NAME_GAMEPAD: string;
  90355. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90356. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90357. static readonly NAME_PREPASSRENDERER: string;
  90358. static readonly NAME_DEPTHRENDERER: string;
  90359. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90360. static readonly NAME_SPRITE: string;
  90361. static readonly NAME_OUTLINERENDERER: string;
  90362. static readonly NAME_PROCEDURALTEXTURE: string;
  90363. static readonly NAME_SHADOWGENERATOR: string;
  90364. static readonly NAME_OCTREE: string;
  90365. static readonly NAME_PHYSICSENGINE: string;
  90366. static readonly NAME_AUDIO: string;
  90367. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90368. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90369. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90370. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90371. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90372. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90373. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90374. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90375. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90376. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90377. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90378. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90379. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90380. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90381. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90382. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90383. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90384. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90385. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90386. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90387. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90388. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90389. static readonly STEP_AFTERRENDER_AUDIO: number;
  90390. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90391. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90392. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90393. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90394. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90395. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90396. static readonly STEP_POINTERMOVE_SPRITE: number;
  90397. static readonly STEP_POINTERDOWN_SPRITE: number;
  90398. static readonly STEP_POINTERUP_SPRITE: number;
  90399. }
  90400. /**
  90401. * This represents a scene component.
  90402. *
  90403. * This is used to decouple the dependency the scene is having on the different workloads like
  90404. * layers, post processes...
  90405. */
  90406. export interface ISceneComponent {
  90407. /**
  90408. * The name of the component. Each component must have a unique name.
  90409. */
  90410. name: string;
  90411. /**
  90412. * The scene the component belongs to.
  90413. */
  90414. scene: Scene;
  90415. /**
  90416. * Register the component to one instance of a scene.
  90417. */
  90418. register(): void;
  90419. /**
  90420. * Rebuilds the elements related to this component in case of
  90421. * context lost for instance.
  90422. */
  90423. rebuild(): void;
  90424. /**
  90425. * Disposes the component and the associated ressources.
  90426. */
  90427. dispose(): void;
  90428. }
  90429. /**
  90430. * This represents a SERIALIZABLE scene component.
  90431. *
  90432. * This extends Scene Component to add Serialization methods on top.
  90433. */
  90434. export interface ISceneSerializableComponent extends ISceneComponent {
  90435. /**
  90436. * Adds all the elements from the container to the scene
  90437. * @param container the container holding the elements
  90438. */
  90439. addFromContainer(container: AbstractScene): void;
  90440. /**
  90441. * Removes all the elements in the container from the scene
  90442. * @param container contains the elements to remove
  90443. * @param dispose if the removed element should be disposed (default: false)
  90444. */
  90445. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90446. /**
  90447. * Serializes the component data to the specified json object
  90448. * @param serializationObject The object to serialize to
  90449. */
  90450. serialize(serializationObject: any): void;
  90451. }
  90452. /**
  90453. * Strong typing of a Mesh related stage step action
  90454. */
  90455. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90456. /**
  90457. * Strong typing of a Evaluate Sub Mesh related stage step action
  90458. */
  90459. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90460. /**
  90461. * Strong typing of a Active Mesh related stage step action
  90462. */
  90463. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90464. /**
  90465. * Strong typing of a Camera related stage step action
  90466. */
  90467. export type CameraStageAction = (camera: Camera) => void;
  90468. /**
  90469. * Strong typing of a Camera Frame buffer related stage step action
  90470. */
  90471. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90472. /**
  90473. * Strong typing of a Render Target related stage step action
  90474. */
  90475. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90476. /**
  90477. * Strong typing of a RenderingGroup related stage step action
  90478. */
  90479. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90480. /**
  90481. * Strong typing of a Mesh Render related stage step action
  90482. */
  90483. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90484. /**
  90485. * Strong typing of a simple stage step action
  90486. */
  90487. export type SimpleStageAction = () => void;
  90488. /**
  90489. * Strong typing of a render target action.
  90490. */
  90491. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90492. /**
  90493. * Strong typing of a pointer move action.
  90494. */
  90495. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90496. /**
  90497. * Strong typing of a pointer up/down action.
  90498. */
  90499. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90500. /**
  90501. * Representation of a stage in the scene (Basically a list of ordered steps)
  90502. * @hidden
  90503. */
  90504. export class Stage<T extends Function> extends Array<{
  90505. index: number;
  90506. component: ISceneComponent;
  90507. action: T;
  90508. }> {
  90509. /**
  90510. * Hide ctor from the rest of the world.
  90511. * @param items The items to add.
  90512. */
  90513. private constructor();
  90514. /**
  90515. * Creates a new Stage.
  90516. * @returns A new instance of a Stage
  90517. */
  90518. static Create<T extends Function>(): Stage<T>;
  90519. /**
  90520. * Registers a step in an ordered way in the targeted stage.
  90521. * @param index Defines the position to register the step in
  90522. * @param component Defines the component attached to the step
  90523. * @param action Defines the action to launch during the step
  90524. */
  90525. registerStep(index: number, component: ISceneComponent, action: T): void;
  90526. /**
  90527. * Clears all the steps from the stage.
  90528. */
  90529. clear(): void;
  90530. }
  90531. }
  90532. declare module BABYLON {
  90533. interface Scene {
  90534. /** @hidden */
  90535. _pointerOverSprite: Nullable<Sprite>;
  90536. /** @hidden */
  90537. _pickedDownSprite: Nullable<Sprite>;
  90538. /** @hidden */
  90539. _tempSpritePickingRay: Nullable<Ray>;
  90540. /**
  90541. * All of the sprite managers added to this scene
  90542. * @see https://doc.babylonjs.com/babylon101/sprites
  90543. */
  90544. spriteManagers: Array<ISpriteManager>;
  90545. /**
  90546. * An event triggered when sprites rendering is about to start
  90547. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90548. */
  90549. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90550. /**
  90551. * An event triggered when sprites rendering is done
  90552. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90553. */
  90554. onAfterSpritesRenderingObservable: Observable<Scene>;
  90555. /** @hidden */
  90556. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90557. /** Launch a ray to try to pick a sprite in the scene
  90558. * @param x position on screen
  90559. * @param y position on screen
  90560. * @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
  90561. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90562. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90563. * @returns a PickingInfo
  90564. */
  90565. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90566. /** Use the given ray to pick a sprite in the scene
  90567. * @param ray The ray (in world space) to use to pick meshes
  90568. * @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
  90569. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90570. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90571. * @returns a PickingInfo
  90572. */
  90573. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90574. /** @hidden */
  90575. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90576. /** Launch a ray to try to pick sprites in the scene
  90577. * @param x position on screen
  90578. * @param y position on screen
  90579. * @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
  90580. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90581. * @returns a PickingInfo array
  90582. */
  90583. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90584. /** Use the given ray to pick sprites in the scene
  90585. * @param ray The ray (in world space) to use to pick meshes
  90586. * @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
  90587. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90588. * @returns a PickingInfo array
  90589. */
  90590. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90591. /**
  90592. * Force the sprite under the pointer
  90593. * @param sprite defines the sprite to use
  90594. */
  90595. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90596. /**
  90597. * Gets the sprite under the pointer
  90598. * @returns a Sprite or null if no sprite is under the pointer
  90599. */
  90600. getPointerOverSprite(): Nullable<Sprite>;
  90601. }
  90602. /**
  90603. * Defines the sprite scene component responsible to manage sprites
  90604. * in a given scene.
  90605. */
  90606. export class SpriteSceneComponent implements ISceneComponent {
  90607. /**
  90608. * The component name helpfull to identify the component in the list of scene components.
  90609. */
  90610. readonly name: string;
  90611. /**
  90612. * The scene the component belongs to.
  90613. */
  90614. scene: Scene;
  90615. /** @hidden */
  90616. private _spritePredicate;
  90617. /**
  90618. * Creates a new instance of the component for the given scene
  90619. * @param scene Defines the scene to register the component in
  90620. */
  90621. constructor(scene: Scene);
  90622. /**
  90623. * Registers the component in a given scene
  90624. */
  90625. register(): void;
  90626. /**
  90627. * Rebuilds the elements related to this component in case of
  90628. * context lost for instance.
  90629. */
  90630. rebuild(): void;
  90631. /**
  90632. * Disposes the component and the associated ressources.
  90633. */
  90634. dispose(): void;
  90635. private _pickSpriteButKeepRay;
  90636. private _pointerMove;
  90637. private _pointerDown;
  90638. private _pointerUp;
  90639. }
  90640. }
  90641. declare module BABYLON {
  90642. /** @hidden */
  90643. export var fogFragmentDeclaration: {
  90644. name: string;
  90645. shader: string;
  90646. };
  90647. }
  90648. declare module BABYLON {
  90649. /** @hidden */
  90650. export var fogFragment: {
  90651. name: string;
  90652. shader: string;
  90653. };
  90654. }
  90655. declare module BABYLON {
  90656. /** @hidden */
  90657. export var spritesPixelShader: {
  90658. name: string;
  90659. shader: string;
  90660. };
  90661. }
  90662. declare module BABYLON {
  90663. /** @hidden */
  90664. export var fogVertexDeclaration: {
  90665. name: string;
  90666. shader: string;
  90667. };
  90668. }
  90669. declare module BABYLON {
  90670. /** @hidden */
  90671. export var spritesVertexShader: {
  90672. name: string;
  90673. shader: string;
  90674. };
  90675. }
  90676. declare module BABYLON {
  90677. /**
  90678. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90679. */
  90680. export interface ISpriteManager extends IDisposable {
  90681. /**
  90682. * Gets manager's name
  90683. */
  90684. name: string;
  90685. /**
  90686. * Restricts the camera to viewing objects with the same layerMask.
  90687. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90688. */
  90689. layerMask: number;
  90690. /**
  90691. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90692. */
  90693. isPickable: boolean;
  90694. /**
  90695. * Gets the hosting scene
  90696. */
  90697. scene: Scene;
  90698. /**
  90699. * Specifies the rendering group id for this mesh (0 by default)
  90700. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90701. */
  90702. renderingGroupId: number;
  90703. /**
  90704. * Defines the list of sprites managed by the manager.
  90705. */
  90706. sprites: Array<Sprite>;
  90707. /**
  90708. * Gets or sets the spritesheet texture
  90709. */
  90710. texture: Texture;
  90711. /** Defines the default width of a cell in the spritesheet */
  90712. cellWidth: number;
  90713. /** Defines the default height of a cell in the spritesheet */
  90714. cellHeight: number;
  90715. /**
  90716. * Tests the intersection of a sprite with a specific ray.
  90717. * @param ray The ray we are sending to test the collision
  90718. * @param camera The camera space we are sending rays in
  90719. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90720. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90721. * @returns picking info or null.
  90722. */
  90723. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90724. /**
  90725. * Intersects the sprites with a ray
  90726. * @param ray defines the ray to intersect with
  90727. * @param camera defines the current active camera
  90728. * @param predicate defines a predicate used to select candidate sprites
  90729. * @returns null if no hit or a PickingInfo array
  90730. */
  90731. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90732. /**
  90733. * Renders the list of sprites on screen.
  90734. */
  90735. render(): void;
  90736. }
  90737. /**
  90738. * Class used to manage multiple sprites on the same spritesheet
  90739. * @see https://doc.babylonjs.com/babylon101/sprites
  90740. */
  90741. export class SpriteManager implements ISpriteManager {
  90742. /** defines the manager's name */
  90743. name: string;
  90744. /** Define the Url to load snippets */
  90745. static SnippetUrl: string;
  90746. /** Snippet ID if the manager was created from the snippet server */
  90747. snippetId: string;
  90748. /** Gets the list of sprites */
  90749. sprites: Sprite[];
  90750. /** Gets or sets the rendering group id (0 by default) */
  90751. renderingGroupId: number;
  90752. /** Gets or sets camera layer mask */
  90753. layerMask: number;
  90754. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90755. fogEnabled: boolean;
  90756. /** Gets or sets a boolean indicating if the sprites are pickable */
  90757. isPickable: boolean;
  90758. /** Defines the default width of a cell in the spritesheet */
  90759. cellWidth: number;
  90760. /** Defines the default height of a cell in the spritesheet */
  90761. cellHeight: number;
  90762. /** Associative array from JSON sprite data file */
  90763. private _cellData;
  90764. /** Array of sprite names from JSON sprite data file */
  90765. private _spriteMap;
  90766. /** True when packed cell data from JSON file is ready*/
  90767. private _packedAndReady;
  90768. private _textureContent;
  90769. private _useInstancing;
  90770. /**
  90771. * An event triggered when the manager is disposed.
  90772. */
  90773. onDisposeObservable: Observable<SpriteManager>;
  90774. private _onDisposeObserver;
  90775. /**
  90776. * Callback called when the manager is disposed
  90777. */
  90778. set onDispose(callback: () => void);
  90779. private _capacity;
  90780. private _fromPacked;
  90781. private _spriteTexture;
  90782. private _epsilon;
  90783. private _scene;
  90784. private _vertexData;
  90785. private _buffer;
  90786. private _vertexBuffers;
  90787. private _spriteBuffer;
  90788. private _indexBuffer;
  90789. private _effectBase;
  90790. private _effectFog;
  90791. private _vertexBufferSize;
  90792. /**
  90793. * Gets or sets the unique id of the sprite
  90794. */
  90795. uniqueId: number;
  90796. /**
  90797. * Gets the array of sprites
  90798. */
  90799. get children(): Sprite[];
  90800. /**
  90801. * Gets the hosting scene
  90802. */
  90803. get scene(): Scene;
  90804. /**
  90805. * Gets the capacity of the manager
  90806. */
  90807. get capacity(): number;
  90808. /**
  90809. * Gets or sets the spritesheet texture
  90810. */
  90811. get texture(): Texture;
  90812. set texture(value: Texture);
  90813. private _blendMode;
  90814. /**
  90815. * Blend mode use to render the particle, it can be any of
  90816. * the static Constants.ALPHA_x properties provided in this class.
  90817. * Default value is Constants.ALPHA_COMBINE
  90818. */
  90819. get blendMode(): number;
  90820. set blendMode(blendMode: number);
  90821. /** Disables writing to the depth buffer when rendering the sprites.
  90822. * It can be handy to disable depth writing when using textures without alpha channel
  90823. * and setting some specific blend modes.
  90824. */
  90825. disableDepthWrite: boolean;
  90826. /**
  90827. * Creates a new sprite manager
  90828. * @param name defines the manager's name
  90829. * @param imgUrl defines the sprite sheet url
  90830. * @param capacity defines the maximum allowed number of sprites
  90831. * @param cellSize defines the size of a sprite cell
  90832. * @param scene defines the hosting scene
  90833. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90834. * @param samplingMode defines the smapling mode to use with spritesheet
  90835. * @param fromPacked set to false; do not alter
  90836. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90837. */
  90838. constructor(
  90839. /** defines the manager's name */
  90840. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90841. /**
  90842. * Returns the string "SpriteManager"
  90843. * @returns "SpriteManager"
  90844. */
  90845. getClassName(): string;
  90846. private _makePacked;
  90847. private _appendSpriteVertex;
  90848. private _checkTextureAlpha;
  90849. /**
  90850. * Intersects the sprites with a ray
  90851. * @param ray defines the ray to intersect with
  90852. * @param camera defines the current active camera
  90853. * @param predicate defines a predicate used to select candidate sprites
  90854. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90855. * @returns null if no hit or a PickingInfo
  90856. */
  90857. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90858. /**
  90859. * Intersects the sprites with a ray
  90860. * @param ray defines the ray to intersect with
  90861. * @param camera defines the current active camera
  90862. * @param predicate defines a predicate used to select candidate sprites
  90863. * @returns null if no hit or a PickingInfo array
  90864. */
  90865. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90866. /**
  90867. * Render all child sprites
  90868. */
  90869. render(): void;
  90870. /**
  90871. * Release associated resources
  90872. */
  90873. dispose(): void;
  90874. /**
  90875. * Serializes the sprite manager to a JSON object
  90876. * @param serializeTexture defines if the texture must be serialized as well
  90877. * @returns the JSON object
  90878. */
  90879. serialize(serializeTexture?: boolean): any;
  90880. /**
  90881. * Parses a JSON object to create a new sprite manager.
  90882. * @param parsedManager The JSON object to parse
  90883. * @param scene The scene to create the sprite managerin
  90884. * @param rootUrl The root url to use to load external dependencies like texture
  90885. * @returns the new sprite manager
  90886. */
  90887. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90888. /**
  90889. * Creates a sprite manager from a snippet saved in a remote file
  90890. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90891. * @param url defines the url to load from
  90892. * @param scene defines the hosting scene
  90893. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90894. * @returns a promise that will resolve to the new sprite manager
  90895. */
  90896. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90897. /**
  90898. * Creates a sprite manager from a snippet saved by the sprite editor
  90899. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90900. * @param scene defines the hosting scene
  90901. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90902. * @returns a promise that will resolve to the new sprite manager
  90903. */
  90904. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90905. }
  90906. }
  90907. declare module BABYLON {
  90908. /** Interface used by value gradients (color, factor, ...) */
  90909. export interface IValueGradient {
  90910. /**
  90911. * Gets or sets the gradient value (between 0 and 1)
  90912. */
  90913. gradient: number;
  90914. }
  90915. /** Class used to store color4 gradient */
  90916. export class ColorGradient implements IValueGradient {
  90917. /**
  90918. * Gets or sets the gradient value (between 0 and 1)
  90919. */
  90920. gradient: number;
  90921. /**
  90922. * Gets or sets first associated color
  90923. */
  90924. color1: Color4;
  90925. /**
  90926. * Gets or sets second associated color
  90927. */
  90928. color2?: Color4 | undefined;
  90929. /**
  90930. * Creates a new color4 gradient
  90931. * @param gradient gets or sets the gradient value (between 0 and 1)
  90932. * @param color1 gets or sets first associated color
  90933. * @param color2 gets or sets first second color
  90934. */
  90935. constructor(
  90936. /**
  90937. * Gets or sets the gradient value (between 0 and 1)
  90938. */
  90939. gradient: number,
  90940. /**
  90941. * Gets or sets first associated color
  90942. */
  90943. color1: Color4,
  90944. /**
  90945. * Gets or sets second associated color
  90946. */
  90947. color2?: Color4 | undefined);
  90948. /**
  90949. * Will get a color picked randomly between color1 and color2.
  90950. * If color2 is undefined then color1 will be used
  90951. * @param result defines the target Color4 to store the result in
  90952. */
  90953. getColorToRef(result: Color4): void;
  90954. }
  90955. /** Class used to store color 3 gradient */
  90956. export class Color3Gradient implements IValueGradient {
  90957. /**
  90958. * Gets or sets the gradient value (between 0 and 1)
  90959. */
  90960. gradient: number;
  90961. /**
  90962. * Gets or sets the associated color
  90963. */
  90964. color: Color3;
  90965. /**
  90966. * Creates a new color3 gradient
  90967. * @param gradient gets or sets the gradient value (between 0 and 1)
  90968. * @param color gets or sets associated color
  90969. */
  90970. constructor(
  90971. /**
  90972. * Gets or sets the gradient value (between 0 and 1)
  90973. */
  90974. gradient: number,
  90975. /**
  90976. * Gets or sets the associated color
  90977. */
  90978. color: Color3);
  90979. }
  90980. /** Class used to store factor gradient */
  90981. export class FactorGradient implements IValueGradient {
  90982. /**
  90983. * Gets or sets the gradient value (between 0 and 1)
  90984. */
  90985. gradient: number;
  90986. /**
  90987. * Gets or sets first associated factor
  90988. */
  90989. factor1: number;
  90990. /**
  90991. * Gets or sets second associated factor
  90992. */
  90993. factor2?: number | undefined;
  90994. /**
  90995. * Creates a new factor gradient
  90996. * @param gradient gets or sets the gradient value (between 0 and 1)
  90997. * @param factor1 gets or sets first associated factor
  90998. * @param factor2 gets or sets second associated factor
  90999. */
  91000. constructor(
  91001. /**
  91002. * Gets or sets the gradient value (between 0 and 1)
  91003. */
  91004. gradient: number,
  91005. /**
  91006. * Gets or sets first associated factor
  91007. */
  91008. factor1: number,
  91009. /**
  91010. * Gets or sets second associated factor
  91011. */
  91012. factor2?: number | undefined);
  91013. /**
  91014. * Will get a number picked randomly between factor1 and factor2.
  91015. * If factor2 is undefined then factor1 will be used
  91016. * @returns the picked number
  91017. */
  91018. getFactor(): number;
  91019. }
  91020. /**
  91021. * Helper used to simplify some generic gradient tasks
  91022. */
  91023. export class GradientHelper {
  91024. /**
  91025. * Gets the current gradient from an array of IValueGradient
  91026. * @param ratio defines the current ratio to get
  91027. * @param gradients defines the array of IValueGradient
  91028. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  91029. */
  91030. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  91031. }
  91032. }
  91033. declare module BABYLON {
  91034. interface ThinEngine {
  91035. /**
  91036. * Creates a raw texture
  91037. * @param data defines the data to store in the texture
  91038. * @param width defines the width of the texture
  91039. * @param height defines the height of the texture
  91040. * @param format defines the format of the data
  91041. * @param generateMipMaps defines if the engine should generate the mip levels
  91042. * @param invertY defines if data must be stored with Y axis inverted
  91043. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  91044. * @param compression defines the compression used (null by default)
  91045. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91046. * @returns the raw texture inside an InternalTexture
  91047. */
  91048. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  91049. /**
  91050. * Update a raw texture
  91051. * @param texture defines the texture to update
  91052. * @param data defines the data to store in the texture
  91053. * @param format defines the format of the data
  91054. * @param invertY defines if data must be stored with Y axis inverted
  91055. */
  91056. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91057. /**
  91058. * Update a raw texture
  91059. * @param texture defines the texture to update
  91060. * @param data defines the data to store in the texture
  91061. * @param format defines the format of the data
  91062. * @param invertY defines if data must be stored with Y axis inverted
  91063. * @param compression defines the compression used (null by default)
  91064. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91065. */
  91066. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  91067. /**
  91068. * Creates a new raw cube texture
  91069. * @param data defines the array of data to use to create each face
  91070. * @param size defines the size of the textures
  91071. * @param format defines the format of the data
  91072. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91073. * @param generateMipMaps defines if the engine should generate the mip levels
  91074. * @param invertY defines if data must be stored with Y axis inverted
  91075. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91076. * @param compression defines the compression used (null by default)
  91077. * @returns the cube texture as an InternalTexture
  91078. */
  91079. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  91080. /**
  91081. * Update a raw cube texture
  91082. * @param texture defines the texture to udpdate
  91083. * @param data defines the data to store
  91084. * @param format defines the data format
  91085. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91086. * @param invertY defines if data must be stored with Y axis inverted
  91087. */
  91088. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91089. /**
  91090. * Update a raw cube texture
  91091. * @param texture defines the texture to udpdate
  91092. * @param data defines the data to store
  91093. * @param format defines the data format
  91094. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91095. * @param invertY defines if data must be stored with Y axis inverted
  91096. * @param compression defines the compression used (null by default)
  91097. */
  91098. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91099. /**
  91100. * Update a raw cube texture
  91101. * @param texture defines the texture to udpdate
  91102. * @param data defines the data to store
  91103. * @param format defines the data format
  91104. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91105. * @param invertY defines if data must be stored with Y axis inverted
  91106. * @param compression defines the compression used (null by default)
  91107. * @param level defines which level of the texture to update
  91108. */
  91109. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91110. /**
  91111. * Creates a new raw cube texture from a specified url
  91112. * @param url defines the url where the data is located
  91113. * @param scene defines the current scene
  91114. * @param size defines the size of the textures
  91115. * @param format defines the format of the data
  91116. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91117. * @param noMipmap defines if the engine should avoid generating the mip levels
  91118. * @param callback defines a callback used to extract texture data from loaded data
  91119. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91120. * @param onLoad defines a callback called when texture is loaded
  91121. * @param onError defines a callback called if there is an error
  91122. * @returns the cube texture as an InternalTexture
  91123. */
  91124. createRawCubeTextureFromUrl(url: string, scene: Nullable<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;
  91125. /**
  91126. * Creates a new raw cube texture from a specified url
  91127. * @param url defines the url where the data is located
  91128. * @param scene defines the current scene
  91129. * @param size defines the size of the textures
  91130. * @param format defines the format of the data
  91131. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91132. * @param noMipmap defines if the engine should avoid generating the mip levels
  91133. * @param callback defines a callback used to extract texture data from loaded data
  91134. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91135. * @param onLoad defines a callback called when texture is loaded
  91136. * @param onError defines a callback called if there is an error
  91137. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91138. * @param invertY defines if data must be stored with Y axis inverted
  91139. * @returns the cube texture as an InternalTexture
  91140. */
  91141. createRawCubeTextureFromUrl(url: string, scene: Nullable<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;
  91142. /**
  91143. * Creates a new raw 3D texture
  91144. * @param data defines the data used to create the texture
  91145. * @param width defines the width of the texture
  91146. * @param height defines the height of the texture
  91147. * @param depth defines the depth of the texture
  91148. * @param format defines the format of the texture
  91149. * @param generateMipMaps defines if the engine must generate mip levels
  91150. * @param invertY defines if data must be stored with Y axis inverted
  91151. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91152. * @param compression defines the compressed used (can be null)
  91153. * @param textureType defines the compressed used (can be null)
  91154. * @returns a new raw 3D texture (stored in an InternalTexture)
  91155. */
  91156. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91157. /**
  91158. * Update a raw 3D texture
  91159. * @param texture defines the texture to update
  91160. * @param data defines the data to store
  91161. * @param format defines the data format
  91162. * @param invertY defines if data must be stored with Y axis inverted
  91163. */
  91164. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91165. /**
  91166. * Update a raw 3D texture
  91167. * @param texture defines the texture to update
  91168. * @param data defines the data to store
  91169. * @param format defines the data format
  91170. * @param invertY defines if data must be stored with Y axis inverted
  91171. * @param compression defines the used compression (can be null)
  91172. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91173. */
  91174. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91175. /**
  91176. * Creates a new raw 2D array texture
  91177. * @param data defines the data used to create the texture
  91178. * @param width defines the width of the texture
  91179. * @param height defines the height of the texture
  91180. * @param depth defines the number of layers of the texture
  91181. * @param format defines the format of the texture
  91182. * @param generateMipMaps defines if the engine must generate mip levels
  91183. * @param invertY defines if data must be stored with Y axis inverted
  91184. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91185. * @param compression defines the compressed used (can be null)
  91186. * @param textureType defines the compressed used (can be null)
  91187. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91188. */
  91189. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91190. /**
  91191. * Update a raw 2D array texture
  91192. * @param texture defines the texture to update
  91193. * @param data defines the data to store
  91194. * @param format defines the data format
  91195. * @param invertY defines if data must be stored with Y axis inverted
  91196. */
  91197. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91198. /**
  91199. * Update a raw 2D array texture
  91200. * @param texture defines the texture to update
  91201. * @param data defines the data to store
  91202. * @param format defines the data format
  91203. * @param invertY defines if data must be stored with Y axis inverted
  91204. * @param compression defines the used compression (can be null)
  91205. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91206. */
  91207. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91208. }
  91209. }
  91210. declare module BABYLON {
  91211. /**
  91212. * Raw texture can help creating a texture directly from an array of data.
  91213. * This can be super useful if you either get the data from an uncompressed source or
  91214. * if you wish to create your texture pixel by pixel.
  91215. */
  91216. export class RawTexture extends Texture {
  91217. /**
  91218. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91219. */
  91220. format: number;
  91221. /**
  91222. * Instantiates a new RawTexture.
  91223. * Raw texture can help creating a texture directly from an array of data.
  91224. * This can be super useful if you either get the data from an uncompressed source or
  91225. * if you wish to create your texture pixel by pixel.
  91226. * @param data define the array of data to use to create the texture
  91227. * @param width define the width of the texture
  91228. * @param height define the height of the texture
  91229. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91230. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91231. * @param generateMipMaps define whether mip maps should be generated or not
  91232. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91233. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91234. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91235. */
  91236. constructor(data: ArrayBufferView, width: number, height: number,
  91237. /**
  91238. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91239. */
  91240. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91241. /**
  91242. * Updates the texture underlying data.
  91243. * @param data Define the new data of the texture
  91244. */
  91245. update(data: ArrayBufferView): void;
  91246. /**
  91247. * Creates a luminance texture from some data.
  91248. * @param data Define the texture data
  91249. * @param width Define the width of the texture
  91250. * @param height Define the height of the texture
  91251. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91252. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91253. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91254. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91255. * @returns the luminance texture
  91256. */
  91257. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91258. /**
  91259. * Creates a luminance alpha texture from some data.
  91260. * @param data Define the texture data
  91261. * @param width Define the width of the texture
  91262. * @param height Define the height of the texture
  91263. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91264. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91265. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91266. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91267. * @returns the luminance alpha texture
  91268. */
  91269. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91270. /**
  91271. * Creates an alpha texture from some data.
  91272. * @param data Define the texture data
  91273. * @param width Define the width of the texture
  91274. * @param height Define the height of the texture
  91275. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91276. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91277. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91278. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91279. * @returns the alpha texture
  91280. */
  91281. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91282. /**
  91283. * Creates a RGB texture from some data.
  91284. * @param data Define the texture data
  91285. * @param width Define the width of the texture
  91286. * @param height Define the height of the texture
  91287. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91288. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91289. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91290. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91291. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91292. * @returns the RGB alpha texture
  91293. */
  91294. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91295. /**
  91296. * Creates a RGBA texture from some data.
  91297. * @param data Define the texture data
  91298. * @param width Define the width of the texture
  91299. * @param height Define the height of the texture
  91300. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91301. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91302. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91303. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91304. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91305. * @returns the RGBA texture
  91306. */
  91307. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91308. /**
  91309. * Creates a R texture from some data.
  91310. * @param data Define the texture data
  91311. * @param width Define the width of the texture
  91312. * @param height Define the height of the texture
  91313. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91314. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91315. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91316. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91317. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91318. * @returns the R texture
  91319. */
  91320. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91321. }
  91322. }
  91323. declare module BABYLON {
  91324. interface ThinEngine {
  91325. /**
  91326. * Update a dynamic index buffer
  91327. * @param indexBuffer defines the target index buffer
  91328. * @param indices defines the data to update
  91329. * @param offset defines the offset in the target index buffer where update should start
  91330. */
  91331. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91332. /**
  91333. * Updates a dynamic vertex buffer.
  91334. * @param vertexBuffer the vertex buffer to update
  91335. * @param data the data used to update the vertex buffer
  91336. * @param byteOffset the byte offset of the data
  91337. * @param byteLength the byte length of the data
  91338. */
  91339. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91340. }
  91341. }
  91342. declare module BABYLON {
  91343. interface AbstractScene {
  91344. /**
  91345. * The list of procedural textures added to the scene
  91346. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91347. */
  91348. proceduralTextures: Array<ProceduralTexture>;
  91349. }
  91350. /**
  91351. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91352. * in a given scene.
  91353. */
  91354. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91355. /**
  91356. * The component name helpfull to identify the component in the list of scene components.
  91357. */
  91358. readonly name: string;
  91359. /**
  91360. * The scene the component belongs to.
  91361. */
  91362. scene: Scene;
  91363. /**
  91364. * Creates a new instance of the component for the given scene
  91365. * @param scene Defines the scene to register the component in
  91366. */
  91367. constructor(scene: Scene);
  91368. /**
  91369. * Registers the component in a given scene
  91370. */
  91371. register(): void;
  91372. /**
  91373. * Rebuilds the elements related to this component in case of
  91374. * context lost for instance.
  91375. */
  91376. rebuild(): void;
  91377. /**
  91378. * Disposes the component and the associated ressources.
  91379. */
  91380. dispose(): void;
  91381. private _beforeClear;
  91382. }
  91383. }
  91384. declare module BABYLON {
  91385. interface ThinEngine {
  91386. /**
  91387. * Creates a new render target cube texture
  91388. * @param size defines the size of the texture
  91389. * @param options defines the options used to create the texture
  91390. * @returns a new render target cube texture stored in an InternalTexture
  91391. */
  91392. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91393. }
  91394. }
  91395. declare module BABYLON {
  91396. /** @hidden */
  91397. export var proceduralVertexShader: {
  91398. name: string;
  91399. shader: string;
  91400. };
  91401. }
  91402. declare module BABYLON {
  91403. /**
  91404. * 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.
  91405. * This is the base class of any Procedural texture and contains most of the shareable code.
  91406. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91407. */
  91408. export class ProceduralTexture extends Texture {
  91409. /**
  91410. * Define if the texture is enabled or not (disabled texture will not render)
  91411. */
  91412. isEnabled: boolean;
  91413. /**
  91414. * Define if the texture must be cleared before rendering (default is true)
  91415. */
  91416. autoClear: boolean;
  91417. /**
  91418. * Callback called when the texture is generated
  91419. */
  91420. onGenerated: () => void;
  91421. /**
  91422. * Event raised when the texture is generated
  91423. */
  91424. onGeneratedObservable: Observable<ProceduralTexture>;
  91425. /** @hidden */
  91426. _generateMipMaps: boolean;
  91427. /** @hidden **/
  91428. _effect: Effect;
  91429. /** @hidden */
  91430. _textures: {
  91431. [key: string]: Texture;
  91432. };
  91433. /** @hidden */
  91434. protected _fallbackTexture: Nullable<Texture>;
  91435. private _size;
  91436. private _currentRefreshId;
  91437. private _frameId;
  91438. private _refreshRate;
  91439. private _vertexBuffers;
  91440. private _indexBuffer;
  91441. private _uniforms;
  91442. private _samplers;
  91443. private _fragment;
  91444. private _floats;
  91445. private _ints;
  91446. private _floatsArrays;
  91447. private _colors3;
  91448. private _colors4;
  91449. private _vectors2;
  91450. private _vectors3;
  91451. private _matrices;
  91452. private _fallbackTextureUsed;
  91453. private _fullEngine;
  91454. private _cachedDefines;
  91455. private _contentUpdateId;
  91456. private _contentData;
  91457. /**
  91458. * Instantiates a new procedural texture.
  91459. * 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.
  91460. * This is the base class of any Procedural texture and contains most of the shareable code.
  91461. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91462. * @param name Define the name of the texture
  91463. * @param size Define the size of the texture to create
  91464. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91465. * @param scene Define the scene the texture belongs to
  91466. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91467. * @param generateMipMaps Define if the texture should creates mip maps or not
  91468. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91469. */
  91470. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91471. /**
  91472. * The effect that is created when initializing the post process.
  91473. * @returns The created effect corresponding the the postprocess.
  91474. */
  91475. getEffect(): Effect;
  91476. /**
  91477. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91478. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91479. */
  91480. getContent(): Nullable<ArrayBufferView>;
  91481. private _createIndexBuffer;
  91482. /** @hidden */
  91483. _rebuild(): void;
  91484. /**
  91485. * Resets the texture in order to recreate its associated resources.
  91486. * This can be called in case of context loss
  91487. */
  91488. reset(): void;
  91489. protected _getDefines(): string;
  91490. /**
  91491. * Is the texture ready to be used ? (rendered at least once)
  91492. * @returns true if ready, otherwise, false.
  91493. */
  91494. isReady(): boolean;
  91495. /**
  91496. * Resets the refresh counter of the texture and start bak from scratch.
  91497. * Could be useful to regenerate the texture if it is setup to render only once.
  91498. */
  91499. resetRefreshCounter(): void;
  91500. /**
  91501. * Set the fragment shader to use in order to render the texture.
  91502. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91503. */
  91504. setFragment(fragment: any): void;
  91505. /**
  91506. * Define the refresh rate of the texture or the rendering frequency.
  91507. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91508. */
  91509. get refreshRate(): number;
  91510. set refreshRate(value: number);
  91511. /** @hidden */
  91512. _shouldRender(): boolean;
  91513. /**
  91514. * Get the size the texture is rendering at.
  91515. * @returns the size (texture is always squared)
  91516. */
  91517. getRenderSize(): number;
  91518. /**
  91519. * Resize the texture to new value.
  91520. * @param size Define the new size the texture should have
  91521. * @param generateMipMaps Define whether the new texture should create mip maps
  91522. */
  91523. resize(size: number, generateMipMaps: boolean): void;
  91524. private _checkUniform;
  91525. /**
  91526. * Set a texture in the shader program used to render.
  91527. * @param name Define the name of the uniform samplers as defined in the shader
  91528. * @param texture Define the texture to bind to this sampler
  91529. * @return the texture itself allowing "fluent" like uniform updates
  91530. */
  91531. setTexture(name: string, texture: Texture): ProceduralTexture;
  91532. /**
  91533. * Set a float in the shader.
  91534. * @param name Define the name of the uniform as defined in the shader
  91535. * @param value Define the value to give to the uniform
  91536. * @return the texture itself allowing "fluent" like uniform updates
  91537. */
  91538. setFloat(name: string, value: number): ProceduralTexture;
  91539. /**
  91540. * Set a int in the shader.
  91541. * @param name Define the name of the uniform as defined in the shader
  91542. * @param value Define the value to give to the uniform
  91543. * @return the texture itself allowing "fluent" like uniform updates
  91544. */
  91545. setInt(name: string, value: number): ProceduralTexture;
  91546. /**
  91547. * Set an array of floats in the shader.
  91548. * @param name Define the name of the uniform as defined in the shader
  91549. * @param value Define the value to give to the uniform
  91550. * @return the texture itself allowing "fluent" like uniform updates
  91551. */
  91552. setFloats(name: string, value: number[]): ProceduralTexture;
  91553. /**
  91554. * Set a vec3 in the shader from a Color3.
  91555. * @param name Define the name of the uniform as defined in the shader
  91556. * @param value Define the value to give to the uniform
  91557. * @return the texture itself allowing "fluent" like uniform updates
  91558. */
  91559. setColor3(name: string, value: Color3): ProceduralTexture;
  91560. /**
  91561. * Set a vec4 in the shader from a Color4.
  91562. * @param name Define the name of the uniform as defined in the shader
  91563. * @param value Define the value to give to the uniform
  91564. * @return the texture itself allowing "fluent" like uniform updates
  91565. */
  91566. setColor4(name: string, value: Color4): ProceduralTexture;
  91567. /**
  91568. * Set a vec2 in the shader from a Vector2.
  91569. * @param name Define the name of the uniform as defined in the shader
  91570. * @param value Define the value to give to the uniform
  91571. * @return the texture itself allowing "fluent" like uniform updates
  91572. */
  91573. setVector2(name: string, value: Vector2): ProceduralTexture;
  91574. /**
  91575. * Set a vec3 in the shader from a Vector3.
  91576. * @param name Define the name of the uniform as defined in the shader
  91577. * @param value Define the value to give to the uniform
  91578. * @return the texture itself allowing "fluent" like uniform updates
  91579. */
  91580. setVector3(name: string, value: Vector3): ProceduralTexture;
  91581. /**
  91582. * Set a mat4 in the shader from a MAtrix.
  91583. * @param name Define the name of the uniform as defined in the shader
  91584. * @param value Define the value to give to the uniform
  91585. * @return the texture itself allowing "fluent" like uniform updates
  91586. */
  91587. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91588. /**
  91589. * Render the texture to its associated render target.
  91590. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91591. */
  91592. render(useCameraPostProcess?: boolean): void;
  91593. /**
  91594. * Clone the texture.
  91595. * @returns the cloned texture
  91596. */
  91597. clone(): ProceduralTexture;
  91598. /**
  91599. * Dispose the texture and release its asoociated resources.
  91600. */
  91601. dispose(): void;
  91602. }
  91603. }
  91604. declare module BABYLON {
  91605. /**
  91606. * This represents the base class for particle system in Babylon.
  91607. * 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.
  91608. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91609. * @example https://doc.babylonjs.com/babylon101/particles
  91610. */
  91611. export class BaseParticleSystem {
  91612. /**
  91613. * Source color is added to the destination color without alpha affecting the result
  91614. */
  91615. static BLENDMODE_ONEONE: number;
  91616. /**
  91617. * Blend current color and particle color using particle’s alpha
  91618. */
  91619. static BLENDMODE_STANDARD: number;
  91620. /**
  91621. * Add current color and particle color multiplied by particle’s alpha
  91622. */
  91623. static BLENDMODE_ADD: number;
  91624. /**
  91625. * Multiply current color with particle color
  91626. */
  91627. static BLENDMODE_MULTIPLY: number;
  91628. /**
  91629. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91630. */
  91631. static BLENDMODE_MULTIPLYADD: number;
  91632. /**
  91633. * List of animations used by the particle system.
  91634. */
  91635. animations: Animation[];
  91636. /**
  91637. * Gets or sets the unique id of the particle system
  91638. */
  91639. uniqueId: number;
  91640. /**
  91641. * The id of the Particle system.
  91642. */
  91643. id: string;
  91644. /**
  91645. * The friendly name of the Particle system.
  91646. */
  91647. name: string;
  91648. /**
  91649. * Snippet ID if the particle system was created from the snippet server
  91650. */
  91651. snippetId: string;
  91652. /**
  91653. * The rendering group used by the Particle system to chose when to render.
  91654. */
  91655. renderingGroupId: number;
  91656. /**
  91657. * The emitter represents the Mesh or position we are attaching the particle system to.
  91658. */
  91659. emitter: Nullable<AbstractMesh | Vector3>;
  91660. /**
  91661. * The maximum number of particles to emit per frame
  91662. */
  91663. emitRate: number;
  91664. /**
  91665. * If you want to launch only a few particles at once, that can be done, as well.
  91666. */
  91667. manualEmitCount: number;
  91668. /**
  91669. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91670. */
  91671. updateSpeed: number;
  91672. /**
  91673. * The amount of time the particle system is running (depends of the overall update speed).
  91674. */
  91675. targetStopDuration: number;
  91676. /**
  91677. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91678. */
  91679. disposeOnStop: boolean;
  91680. /**
  91681. * Minimum power of emitting particles.
  91682. */
  91683. minEmitPower: number;
  91684. /**
  91685. * Maximum power of emitting particles.
  91686. */
  91687. maxEmitPower: number;
  91688. /**
  91689. * Minimum life time of emitting particles.
  91690. */
  91691. minLifeTime: number;
  91692. /**
  91693. * Maximum life time of emitting particles.
  91694. */
  91695. maxLifeTime: number;
  91696. /**
  91697. * Minimum Size of emitting particles.
  91698. */
  91699. minSize: number;
  91700. /**
  91701. * Maximum Size of emitting particles.
  91702. */
  91703. maxSize: number;
  91704. /**
  91705. * Minimum scale of emitting particles on X axis.
  91706. */
  91707. minScaleX: number;
  91708. /**
  91709. * Maximum scale of emitting particles on X axis.
  91710. */
  91711. maxScaleX: number;
  91712. /**
  91713. * Minimum scale of emitting particles on Y axis.
  91714. */
  91715. minScaleY: number;
  91716. /**
  91717. * Maximum scale of emitting particles on Y axis.
  91718. */
  91719. maxScaleY: number;
  91720. /**
  91721. * Gets or sets the minimal initial rotation in radians.
  91722. */
  91723. minInitialRotation: number;
  91724. /**
  91725. * Gets or sets the maximal initial rotation in radians.
  91726. */
  91727. maxInitialRotation: number;
  91728. /**
  91729. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91730. */
  91731. minAngularSpeed: number;
  91732. /**
  91733. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91734. */
  91735. maxAngularSpeed: number;
  91736. /**
  91737. * The texture used to render each particle. (this can be a spritesheet)
  91738. */
  91739. particleTexture: Nullable<BaseTexture>;
  91740. /**
  91741. * The layer mask we are rendering the particles through.
  91742. */
  91743. layerMask: number;
  91744. /**
  91745. * This can help using your own shader to render the particle system.
  91746. * The according effect will be created
  91747. */
  91748. customShader: any;
  91749. /**
  91750. * By default particle system starts as soon as they are created. This prevents the
  91751. * automatic start to happen and let you decide when to start emitting particles.
  91752. */
  91753. preventAutoStart: boolean;
  91754. private _noiseTexture;
  91755. /**
  91756. * Gets or sets a texture used to add random noise to particle positions
  91757. */
  91758. get noiseTexture(): Nullable<ProceduralTexture>;
  91759. set noiseTexture(value: Nullable<ProceduralTexture>);
  91760. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91761. noiseStrength: Vector3;
  91762. /**
  91763. * Callback triggered when the particle animation is ending.
  91764. */
  91765. onAnimationEnd: Nullable<() => void>;
  91766. /**
  91767. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91768. */
  91769. blendMode: number;
  91770. /**
  91771. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91772. * to override the particles.
  91773. */
  91774. forceDepthWrite: boolean;
  91775. /** 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 */
  91776. preWarmCycles: number;
  91777. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91778. preWarmStepOffset: number;
  91779. /**
  91780. * 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)
  91781. */
  91782. spriteCellChangeSpeed: number;
  91783. /**
  91784. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91785. */
  91786. startSpriteCellID: number;
  91787. /**
  91788. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91789. */
  91790. endSpriteCellID: number;
  91791. /**
  91792. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91793. */
  91794. spriteCellWidth: number;
  91795. /**
  91796. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91797. */
  91798. spriteCellHeight: number;
  91799. /**
  91800. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91801. */
  91802. spriteRandomStartCell: boolean;
  91803. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91804. translationPivot: Vector2;
  91805. /** @hidden */
  91806. protected _isAnimationSheetEnabled: boolean;
  91807. /**
  91808. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91809. */
  91810. beginAnimationOnStart: boolean;
  91811. /**
  91812. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91813. */
  91814. beginAnimationFrom: number;
  91815. /**
  91816. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91817. */
  91818. beginAnimationTo: number;
  91819. /**
  91820. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91821. */
  91822. beginAnimationLoop: boolean;
  91823. /**
  91824. * Gets or sets a world offset applied to all particles
  91825. */
  91826. worldOffset: Vector3;
  91827. /**
  91828. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91829. */
  91830. get isAnimationSheetEnabled(): boolean;
  91831. set isAnimationSheetEnabled(value: boolean);
  91832. /**
  91833. * Get hosting scene
  91834. * @returns the scene
  91835. */
  91836. getScene(): Nullable<Scene>;
  91837. /**
  91838. * You can use gravity if you want to give an orientation to your particles.
  91839. */
  91840. gravity: Vector3;
  91841. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91842. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91843. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91844. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91845. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91846. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91847. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91848. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91849. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91850. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91851. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91852. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91853. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91854. /**
  91855. * Defines the delay in milliseconds before starting the system (0 by default)
  91856. */
  91857. startDelay: number;
  91858. /**
  91859. * Gets the current list of drag gradients.
  91860. * You must use addDragGradient and removeDragGradient to udpate this list
  91861. * @returns the list of drag gradients
  91862. */
  91863. getDragGradients(): Nullable<Array<FactorGradient>>;
  91864. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91865. limitVelocityDamping: number;
  91866. /**
  91867. * Gets the current list of limit velocity gradients.
  91868. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91869. * @returns the list of limit velocity gradients
  91870. */
  91871. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91872. /**
  91873. * Gets the current list of color gradients.
  91874. * You must use addColorGradient and removeColorGradient to udpate this list
  91875. * @returns the list of color gradients
  91876. */
  91877. getColorGradients(): Nullable<Array<ColorGradient>>;
  91878. /**
  91879. * Gets the current list of size gradients.
  91880. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91881. * @returns the list of size gradients
  91882. */
  91883. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91884. /**
  91885. * Gets the current list of color remap gradients.
  91886. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91887. * @returns the list of color remap gradients
  91888. */
  91889. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91890. /**
  91891. * Gets the current list of alpha remap gradients.
  91892. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91893. * @returns the list of alpha remap gradients
  91894. */
  91895. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91896. /**
  91897. * Gets the current list of life time gradients.
  91898. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91899. * @returns the list of life time gradients
  91900. */
  91901. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91902. /**
  91903. * Gets the current list of angular speed gradients.
  91904. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91905. * @returns the list of angular speed gradients
  91906. */
  91907. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91908. /**
  91909. * Gets the current list of velocity gradients.
  91910. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91911. * @returns the list of velocity gradients
  91912. */
  91913. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91914. /**
  91915. * Gets the current list of start size gradients.
  91916. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91917. * @returns the list of start size gradients
  91918. */
  91919. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91920. /**
  91921. * Gets the current list of emit rate gradients.
  91922. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91923. * @returns the list of emit rate gradients
  91924. */
  91925. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91926. /**
  91927. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91928. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91929. */
  91930. get direction1(): Vector3;
  91931. set direction1(value: Vector3);
  91932. /**
  91933. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91934. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91935. */
  91936. get direction2(): Vector3;
  91937. set direction2(value: Vector3);
  91938. /**
  91939. * 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.
  91940. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91941. */
  91942. get minEmitBox(): Vector3;
  91943. set minEmitBox(value: Vector3);
  91944. /**
  91945. * 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.
  91946. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91947. */
  91948. get maxEmitBox(): Vector3;
  91949. set maxEmitBox(value: Vector3);
  91950. /**
  91951. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91952. */
  91953. color1: Color4;
  91954. /**
  91955. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91956. */
  91957. color2: Color4;
  91958. /**
  91959. * Color the particle will have at the end of its lifetime
  91960. */
  91961. colorDead: Color4;
  91962. /**
  91963. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91964. */
  91965. textureMask: Color4;
  91966. /**
  91967. * The particle emitter type defines the emitter used by the particle system.
  91968. * It can be for example box, sphere, or cone...
  91969. */
  91970. particleEmitterType: IParticleEmitterType;
  91971. /** @hidden */
  91972. _isSubEmitter: boolean;
  91973. /**
  91974. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91975. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91976. */
  91977. billboardMode: number;
  91978. protected _isBillboardBased: boolean;
  91979. /**
  91980. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91981. */
  91982. get isBillboardBased(): boolean;
  91983. set isBillboardBased(value: boolean);
  91984. /**
  91985. * The scene the particle system belongs to.
  91986. */
  91987. protected _scene: Nullable<Scene>;
  91988. /**
  91989. * The engine the particle system belongs to.
  91990. */
  91991. protected _engine: ThinEngine;
  91992. /**
  91993. * Local cache of defines for image processing.
  91994. */
  91995. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91996. /**
  91997. * Default configuration related to image processing available in the standard Material.
  91998. */
  91999. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  92000. /**
  92001. * Gets the image processing configuration used either in this material.
  92002. */
  92003. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  92004. /**
  92005. * Sets the Default image processing configuration used either in the this material.
  92006. *
  92007. * If sets to null, the scene one is in use.
  92008. */
  92009. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  92010. /**
  92011. * Attaches a new image processing configuration to the Standard Material.
  92012. * @param configuration
  92013. */
  92014. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  92015. /** @hidden */
  92016. protected _reset(): void;
  92017. /** @hidden */
  92018. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  92019. /**
  92020. * Instantiates a particle system.
  92021. * 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.
  92022. * @param name The name of the particle system
  92023. */
  92024. constructor(name: string);
  92025. /**
  92026. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92027. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92028. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92029. * @returns the emitter
  92030. */
  92031. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92032. /**
  92033. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92034. * @param radius The radius of the hemisphere to emit from
  92035. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92036. * @returns the emitter
  92037. */
  92038. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  92039. /**
  92040. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92041. * @param radius The radius of the sphere to emit from
  92042. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92043. * @returns the emitter
  92044. */
  92045. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  92046. /**
  92047. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92048. * @param radius The radius of the sphere to emit from
  92049. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92050. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92051. * @returns the emitter
  92052. */
  92053. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  92054. /**
  92055. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92056. * @param radius The radius of the emission cylinder
  92057. * @param height The height of the emission cylinder
  92058. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92059. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92060. * @returns the emitter
  92061. */
  92062. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  92063. /**
  92064. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92065. * @param radius The radius of the cylinder to emit from
  92066. * @param height The height of the emission cylinder
  92067. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92068. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92069. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92070. * @returns the emitter
  92071. */
  92072. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  92073. /**
  92074. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92075. * @param radius The radius of the cone to emit from
  92076. * @param angle The base angle of the cone
  92077. * @returns the emitter
  92078. */
  92079. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  92080. /**
  92081. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92082. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92083. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92084. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92085. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92086. * @returns the emitter
  92087. */
  92088. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92089. }
  92090. }
  92091. declare module BABYLON {
  92092. /**
  92093. * Type of sub emitter
  92094. */
  92095. export enum SubEmitterType {
  92096. /**
  92097. * Attached to the particle over it's lifetime
  92098. */
  92099. ATTACHED = 0,
  92100. /**
  92101. * Created when the particle dies
  92102. */
  92103. END = 1
  92104. }
  92105. /**
  92106. * Sub emitter class used to emit particles from an existing particle
  92107. */
  92108. export class SubEmitter {
  92109. /**
  92110. * the particle system to be used by the sub emitter
  92111. */
  92112. particleSystem: ParticleSystem;
  92113. /**
  92114. * Type of the submitter (Default: END)
  92115. */
  92116. type: SubEmitterType;
  92117. /**
  92118. * 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)
  92119. * Note: This only is supported when using an emitter of type Mesh
  92120. */
  92121. inheritDirection: boolean;
  92122. /**
  92123. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92124. */
  92125. inheritedVelocityAmount: number;
  92126. /**
  92127. * Creates a sub emitter
  92128. * @param particleSystem the particle system to be used by the sub emitter
  92129. */
  92130. constructor(
  92131. /**
  92132. * the particle system to be used by the sub emitter
  92133. */
  92134. particleSystem: ParticleSystem);
  92135. /**
  92136. * Clones the sub emitter
  92137. * @returns the cloned sub emitter
  92138. */
  92139. clone(): SubEmitter;
  92140. /**
  92141. * Serialize current object to a JSON object
  92142. * @returns the serialized object
  92143. */
  92144. serialize(): any;
  92145. /** @hidden */
  92146. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92147. /**
  92148. * Creates a new SubEmitter from a serialized JSON version
  92149. * @param serializationObject defines the JSON object to read from
  92150. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92151. * @param rootUrl defines the rootUrl for data loading
  92152. * @returns a new SubEmitter
  92153. */
  92154. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92155. /** Release associated resources */
  92156. dispose(): void;
  92157. }
  92158. }
  92159. declare module BABYLON {
  92160. /** @hidden */
  92161. export var imageProcessingDeclaration: {
  92162. name: string;
  92163. shader: string;
  92164. };
  92165. }
  92166. declare module BABYLON {
  92167. /** @hidden */
  92168. export var imageProcessingFunctions: {
  92169. name: string;
  92170. shader: string;
  92171. };
  92172. }
  92173. declare module BABYLON {
  92174. /** @hidden */
  92175. export var particlesPixelShader: {
  92176. name: string;
  92177. shader: string;
  92178. };
  92179. }
  92180. declare module BABYLON {
  92181. /** @hidden */
  92182. export var particlesVertexShader: {
  92183. name: string;
  92184. shader: string;
  92185. };
  92186. }
  92187. declare module BABYLON {
  92188. /**
  92189. * Interface used to define entities containing multiple clip planes
  92190. */
  92191. export interface IClipPlanesHolder {
  92192. /**
  92193. * Gets or sets the active clipplane 1
  92194. */
  92195. clipPlane: Nullable<Plane>;
  92196. /**
  92197. * Gets or sets the active clipplane 2
  92198. */
  92199. clipPlane2: Nullable<Plane>;
  92200. /**
  92201. * Gets or sets the active clipplane 3
  92202. */
  92203. clipPlane3: Nullable<Plane>;
  92204. /**
  92205. * Gets or sets the active clipplane 4
  92206. */
  92207. clipPlane4: Nullable<Plane>;
  92208. /**
  92209. * Gets or sets the active clipplane 5
  92210. */
  92211. clipPlane5: Nullable<Plane>;
  92212. /**
  92213. * Gets or sets the active clipplane 6
  92214. */
  92215. clipPlane6: Nullable<Plane>;
  92216. }
  92217. }
  92218. declare module BABYLON {
  92219. /**
  92220. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92221. *
  92222. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92223. *
  92224. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92225. */
  92226. export class ThinMaterialHelper {
  92227. /**
  92228. * Binds the clip plane information from the holder to the effect.
  92229. * @param effect The effect we are binding the data to
  92230. * @param holder The entity containing the clip plane information
  92231. */
  92232. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92233. }
  92234. }
  92235. declare module BABYLON {
  92236. interface ThinEngine {
  92237. /**
  92238. * Sets alpha constants used by some alpha blending modes
  92239. * @param r defines the red component
  92240. * @param g defines the green component
  92241. * @param b defines the blue component
  92242. * @param a defines the alpha component
  92243. */
  92244. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92245. /**
  92246. * Sets the current alpha mode
  92247. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92248. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92249. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92250. */
  92251. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92252. /**
  92253. * Gets the current alpha mode
  92254. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92255. * @returns the current alpha mode
  92256. */
  92257. getAlphaMode(): number;
  92258. /**
  92259. * Sets the current alpha equation
  92260. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92261. */
  92262. setAlphaEquation(equation: number): void;
  92263. /**
  92264. * Gets the current alpha equation.
  92265. * @returns the current alpha equation
  92266. */
  92267. getAlphaEquation(): number;
  92268. }
  92269. }
  92270. declare module BABYLON {
  92271. /**
  92272. * This represents a particle system in Babylon.
  92273. * 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.
  92274. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92275. * @example https://doc.babylonjs.com/babylon101/particles
  92276. */
  92277. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92278. /**
  92279. * Billboard mode will only apply to Y axis
  92280. */
  92281. static readonly BILLBOARDMODE_Y: number;
  92282. /**
  92283. * Billboard mode will apply to all axes
  92284. */
  92285. static readonly BILLBOARDMODE_ALL: number;
  92286. /**
  92287. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92288. */
  92289. static readonly BILLBOARDMODE_STRETCHED: number;
  92290. /**
  92291. * This function can be defined to provide custom update for active particles.
  92292. * This function will be called instead of regular update (age, position, color, etc.).
  92293. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92294. */
  92295. updateFunction: (particles: Particle[]) => void;
  92296. private _emitterWorldMatrix;
  92297. /**
  92298. * This function can be defined to specify initial direction for every new particle.
  92299. * It by default use the emitterType defined function
  92300. */
  92301. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92302. /**
  92303. * This function can be defined to specify initial position for every new particle.
  92304. * It by default use the emitterType defined function
  92305. */
  92306. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92307. /**
  92308. * @hidden
  92309. */
  92310. _inheritedVelocityOffset: Vector3;
  92311. /**
  92312. * An event triggered when the system is disposed
  92313. */
  92314. onDisposeObservable: Observable<IParticleSystem>;
  92315. private _onDisposeObserver;
  92316. /**
  92317. * Sets a callback that will be triggered when the system is disposed
  92318. */
  92319. set onDispose(callback: () => void);
  92320. private _particles;
  92321. private _epsilon;
  92322. private _capacity;
  92323. private _stockParticles;
  92324. private _newPartsExcess;
  92325. private _vertexData;
  92326. private _vertexBuffer;
  92327. private _vertexBuffers;
  92328. private _spriteBuffer;
  92329. private _indexBuffer;
  92330. private _effect;
  92331. private _customEffect;
  92332. private _cachedDefines;
  92333. private _scaledColorStep;
  92334. private _colorDiff;
  92335. private _scaledDirection;
  92336. private _scaledGravity;
  92337. private _currentRenderId;
  92338. private _alive;
  92339. private _useInstancing;
  92340. private _started;
  92341. private _stopped;
  92342. private _actualFrame;
  92343. private _scaledUpdateSpeed;
  92344. private _vertexBufferSize;
  92345. /** @hidden */
  92346. _currentEmitRateGradient: Nullable<FactorGradient>;
  92347. /** @hidden */
  92348. _currentEmitRate1: number;
  92349. /** @hidden */
  92350. _currentEmitRate2: number;
  92351. /** @hidden */
  92352. _currentStartSizeGradient: Nullable<FactorGradient>;
  92353. /** @hidden */
  92354. _currentStartSize1: number;
  92355. /** @hidden */
  92356. _currentStartSize2: number;
  92357. private readonly _rawTextureWidth;
  92358. private _rampGradientsTexture;
  92359. private _useRampGradients;
  92360. /** Gets or sets a matrix to use to compute projection */
  92361. defaultProjectionMatrix: Matrix;
  92362. /** Gets or sets a matrix to use to compute view */
  92363. defaultViewMatrix: Matrix;
  92364. /** Gets or sets a boolean indicating that ramp gradients must be used
  92365. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92366. */
  92367. get useRampGradients(): boolean;
  92368. set useRampGradients(value: boolean);
  92369. /**
  92370. * 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.
  92371. * 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: [])
  92372. */
  92373. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92374. private _subEmitters;
  92375. /**
  92376. * @hidden
  92377. * If the particle systems emitter should be disposed when the particle system is disposed
  92378. */
  92379. _disposeEmitterOnDispose: boolean;
  92380. /**
  92381. * The current active Sub-systems, this property is used by the root particle system only.
  92382. */
  92383. activeSubSystems: Array<ParticleSystem>;
  92384. /**
  92385. * Specifies if the particles are updated in emitter local space or world space
  92386. */
  92387. isLocal: boolean;
  92388. private _rootParticleSystem;
  92389. /**
  92390. * Gets the current list of active particles
  92391. */
  92392. get particles(): Particle[];
  92393. /**
  92394. * Gets the number of particles active at the same time.
  92395. * @returns The number of active particles.
  92396. */
  92397. getActiveCount(): number;
  92398. /**
  92399. * Returns the string "ParticleSystem"
  92400. * @returns a string containing the class name
  92401. */
  92402. getClassName(): string;
  92403. /**
  92404. * Gets a boolean indicating that the system is stopping
  92405. * @returns true if the system is currently stopping
  92406. */
  92407. isStopping(): boolean;
  92408. /**
  92409. * Gets the custom effect used to render the particles
  92410. * @param blendMode Blend mode for which the effect should be retrieved
  92411. * @returns The effect
  92412. */
  92413. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92414. /**
  92415. * Sets the custom effect used to render the particles
  92416. * @param effect The effect to set
  92417. * @param blendMode Blend mode for which the effect should be set
  92418. */
  92419. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92420. /** @hidden */
  92421. private _onBeforeDrawParticlesObservable;
  92422. /**
  92423. * Observable that will be called just before the particles are drawn
  92424. */
  92425. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92426. /**
  92427. * Gets the name of the particle vertex shader
  92428. */
  92429. get vertexShaderName(): string;
  92430. /**
  92431. * Instantiates a particle system.
  92432. * 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.
  92433. * @param name The name of the particle system
  92434. * @param capacity The max number of particles alive at the same time
  92435. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92436. * @param customEffect a custom effect used to change the way particles are rendered by default
  92437. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92438. * @param epsilon Offset used to render the particles
  92439. */
  92440. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92441. private _addFactorGradient;
  92442. private _removeFactorGradient;
  92443. /**
  92444. * Adds a new life time gradient
  92445. * @param gradient defines the gradient to use (between 0 and 1)
  92446. * @param factor defines the life time factor to affect to the specified gradient
  92447. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92448. * @returns the current particle system
  92449. */
  92450. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92451. /**
  92452. * Remove a specific life time gradient
  92453. * @param gradient defines the gradient to remove
  92454. * @returns the current particle system
  92455. */
  92456. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92457. /**
  92458. * Adds a new size gradient
  92459. * @param gradient defines the gradient to use (between 0 and 1)
  92460. * @param factor defines the size factor to affect to the specified gradient
  92461. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92462. * @returns the current particle system
  92463. */
  92464. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92465. /**
  92466. * Remove a specific size gradient
  92467. * @param gradient defines the gradient to remove
  92468. * @returns the current particle system
  92469. */
  92470. removeSizeGradient(gradient: number): IParticleSystem;
  92471. /**
  92472. * Adds a new color remap gradient
  92473. * @param gradient defines the gradient to use (between 0 and 1)
  92474. * @param min defines the color remap minimal range
  92475. * @param max defines the color remap maximal range
  92476. * @returns the current particle system
  92477. */
  92478. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92479. /**
  92480. * Remove a specific color remap gradient
  92481. * @param gradient defines the gradient to remove
  92482. * @returns the current particle system
  92483. */
  92484. removeColorRemapGradient(gradient: number): IParticleSystem;
  92485. /**
  92486. * Adds a new alpha remap gradient
  92487. * @param gradient defines the gradient to use (between 0 and 1)
  92488. * @param min defines the alpha remap minimal range
  92489. * @param max defines the alpha remap maximal range
  92490. * @returns the current particle system
  92491. */
  92492. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92493. /**
  92494. * Remove a specific alpha remap gradient
  92495. * @param gradient defines the gradient to remove
  92496. * @returns the current particle system
  92497. */
  92498. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92499. /**
  92500. * Adds a new angular speed gradient
  92501. * @param gradient defines the gradient to use (between 0 and 1)
  92502. * @param factor defines the angular speed to affect to the specified gradient
  92503. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92504. * @returns the current particle system
  92505. */
  92506. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92507. /**
  92508. * Remove a specific angular speed gradient
  92509. * @param gradient defines the gradient to remove
  92510. * @returns the current particle system
  92511. */
  92512. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92513. /**
  92514. * Adds a new velocity gradient
  92515. * @param gradient defines the gradient to use (between 0 and 1)
  92516. * @param factor defines the velocity to affect to the specified gradient
  92517. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92518. * @returns the current particle system
  92519. */
  92520. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92521. /**
  92522. * Remove a specific velocity gradient
  92523. * @param gradient defines the gradient to remove
  92524. * @returns the current particle system
  92525. */
  92526. removeVelocityGradient(gradient: number): IParticleSystem;
  92527. /**
  92528. * Adds a new limit velocity gradient
  92529. * @param gradient defines the gradient to use (between 0 and 1)
  92530. * @param factor defines the limit velocity value to affect to the specified gradient
  92531. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92532. * @returns the current particle system
  92533. */
  92534. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92535. /**
  92536. * Remove a specific limit velocity gradient
  92537. * @param gradient defines the gradient to remove
  92538. * @returns the current particle system
  92539. */
  92540. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92541. /**
  92542. * Adds a new drag gradient
  92543. * @param gradient defines the gradient to use (between 0 and 1)
  92544. * @param factor defines the drag value to affect to the specified gradient
  92545. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92546. * @returns the current particle system
  92547. */
  92548. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92549. /**
  92550. * Remove a specific drag gradient
  92551. * @param gradient defines the gradient to remove
  92552. * @returns the current particle system
  92553. */
  92554. removeDragGradient(gradient: number): IParticleSystem;
  92555. /**
  92556. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92557. * @param gradient defines the gradient to use (between 0 and 1)
  92558. * @param factor defines the emit rate value to affect to the specified gradient
  92559. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92560. * @returns the current particle system
  92561. */
  92562. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92563. /**
  92564. * Remove a specific emit rate gradient
  92565. * @param gradient defines the gradient to remove
  92566. * @returns the current particle system
  92567. */
  92568. removeEmitRateGradient(gradient: number): IParticleSystem;
  92569. /**
  92570. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92571. * @param gradient defines the gradient to use (between 0 and 1)
  92572. * @param factor defines the start size value to affect to the specified gradient
  92573. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92574. * @returns the current particle system
  92575. */
  92576. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92577. /**
  92578. * Remove a specific start size gradient
  92579. * @param gradient defines the gradient to remove
  92580. * @returns the current particle system
  92581. */
  92582. removeStartSizeGradient(gradient: number): IParticleSystem;
  92583. private _createRampGradientTexture;
  92584. /**
  92585. * Gets the current list of ramp gradients.
  92586. * You must use addRampGradient and removeRampGradient to udpate this list
  92587. * @returns the list of ramp gradients
  92588. */
  92589. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92590. /** Force the system to rebuild all gradients that need to be resync */
  92591. forceRefreshGradients(): void;
  92592. private _syncRampGradientTexture;
  92593. /**
  92594. * Adds a new ramp gradient used to remap particle colors
  92595. * @param gradient defines the gradient to use (between 0 and 1)
  92596. * @param color defines the color to affect to the specified gradient
  92597. * @returns the current particle system
  92598. */
  92599. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92600. /**
  92601. * Remove a specific ramp gradient
  92602. * @param gradient defines the gradient to remove
  92603. * @returns the current particle system
  92604. */
  92605. removeRampGradient(gradient: number): ParticleSystem;
  92606. /**
  92607. * Adds a new color gradient
  92608. * @param gradient defines the gradient to use (between 0 and 1)
  92609. * @param color1 defines the color to affect to the specified gradient
  92610. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92611. * @returns this particle system
  92612. */
  92613. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92614. /**
  92615. * Remove a specific color gradient
  92616. * @param gradient defines the gradient to remove
  92617. * @returns this particle system
  92618. */
  92619. removeColorGradient(gradient: number): IParticleSystem;
  92620. private _fetchR;
  92621. protected _reset(): void;
  92622. private _resetEffect;
  92623. private _createVertexBuffers;
  92624. private _createIndexBuffer;
  92625. /**
  92626. * Gets the maximum number of particles active at the same time.
  92627. * @returns The max number of active particles.
  92628. */
  92629. getCapacity(): number;
  92630. /**
  92631. * Gets whether there are still active particles in the system.
  92632. * @returns True if it is alive, otherwise false.
  92633. */
  92634. isAlive(): boolean;
  92635. /**
  92636. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92637. * @returns True if it has been started, otherwise false.
  92638. */
  92639. isStarted(): boolean;
  92640. private _prepareSubEmitterInternalArray;
  92641. /**
  92642. * Starts the particle system and begins to emit
  92643. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92644. */
  92645. start(delay?: number): void;
  92646. /**
  92647. * Stops the particle system.
  92648. * @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.
  92649. */
  92650. stop(stopSubEmitters?: boolean): void;
  92651. /**
  92652. * Remove all active particles
  92653. */
  92654. reset(): void;
  92655. /**
  92656. * @hidden (for internal use only)
  92657. */
  92658. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92659. /**
  92660. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92661. * Its lifetime will start back at 0.
  92662. */
  92663. recycleParticle: (particle: Particle) => void;
  92664. private _stopSubEmitters;
  92665. private _createParticle;
  92666. private _removeFromRoot;
  92667. private _emitFromParticle;
  92668. private _update;
  92669. /** @hidden */
  92670. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92671. /** @hidden */
  92672. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92673. /**
  92674. * Fill the defines array according to the current settings of the particle system
  92675. * @param defines Array to be updated
  92676. * @param blendMode blend mode to take into account when updating the array
  92677. */
  92678. fillDefines(defines: Array<string>, blendMode: number): void;
  92679. /**
  92680. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92681. * @param uniforms Uniforms array to fill
  92682. * @param attributes Attributes array to fill
  92683. * @param samplers Samplers array to fill
  92684. */
  92685. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92686. /** @hidden */
  92687. private _getEffect;
  92688. /**
  92689. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92690. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92691. */
  92692. animate(preWarmOnly?: boolean): void;
  92693. private _appendParticleVertices;
  92694. /**
  92695. * Rebuilds the particle system.
  92696. */
  92697. rebuild(): void;
  92698. /**
  92699. * Is this system ready to be used/rendered
  92700. * @return true if the system is ready
  92701. */
  92702. isReady(): boolean;
  92703. private _render;
  92704. /**
  92705. * Renders the particle system in its current state.
  92706. * @returns the current number of particles
  92707. */
  92708. render(): number;
  92709. /**
  92710. * Disposes the particle system and free the associated resources
  92711. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92712. */
  92713. dispose(disposeTexture?: boolean): void;
  92714. /**
  92715. * Clones the particle system.
  92716. * @param name The name of the cloned object
  92717. * @param newEmitter The new emitter to use
  92718. * @returns the cloned particle system
  92719. */
  92720. clone(name: string, newEmitter: any): ParticleSystem;
  92721. /**
  92722. * Serializes the particle system to a JSON object
  92723. * @param serializeTexture defines if the texture must be serialized as well
  92724. * @returns the JSON object
  92725. */
  92726. serialize(serializeTexture?: boolean): any;
  92727. /** @hidden */
  92728. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92729. /** @hidden */
  92730. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92731. /**
  92732. * Parses a JSON object to create a particle system.
  92733. * @param parsedParticleSystem The JSON object to parse
  92734. * @param sceneOrEngine The scene or the engine to create the particle system in
  92735. * @param rootUrl The root url to use to load external dependencies like texture
  92736. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92737. * @returns the Parsed particle system
  92738. */
  92739. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92740. }
  92741. }
  92742. declare module BABYLON {
  92743. /**
  92744. * A particle represents one of the element emitted by a particle system.
  92745. * This is mainly define by its coordinates, direction, velocity and age.
  92746. */
  92747. export class Particle {
  92748. /**
  92749. * The particle system the particle belongs to.
  92750. */
  92751. particleSystem: ParticleSystem;
  92752. private static _Count;
  92753. /**
  92754. * Unique ID of the particle
  92755. */
  92756. id: number;
  92757. /**
  92758. * The world position of the particle in the scene.
  92759. */
  92760. position: Vector3;
  92761. /**
  92762. * The world direction of the particle in the scene.
  92763. */
  92764. direction: Vector3;
  92765. /**
  92766. * The color of the particle.
  92767. */
  92768. color: Color4;
  92769. /**
  92770. * The color change of the particle per step.
  92771. */
  92772. colorStep: Color4;
  92773. /**
  92774. * Defines how long will the life of the particle be.
  92775. */
  92776. lifeTime: number;
  92777. /**
  92778. * The current age of the particle.
  92779. */
  92780. age: number;
  92781. /**
  92782. * The current size of the particle.
  92783. */
  92784. size: number;
  92785. /**
  92786. * The current scale of the particle.
  92787. */
  92788. scale: Vector2;
  92789. /**
  92790. * The current angle of the particle.
  92791. */
  92792. angle: number;
  92793. /**
  92794. * Defines how fast is the angle changing.
  92795. */
  92796. angularSpeed: number;
  92797. /**
  92798. * Defines the cell index used by the particle to be rendered from a sprite.
  92799. */
  92800. cellIndex: number;
  92801. /**
  92802. * The information required to support color remapping
  92803. */
  92804. remapData: Vector4;
  92805. /** @hidden */
  92806. _randomCellOffset?: number;
  92807. /** @hidden */
  92808. _initialDirection: Nullable<Vector3>;
  92809. /** @hidden */
  92810. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92811. /** @hidden */
  92812. _initialStartSpriteCellID: number;
  92813. /** @hidden */
  92814. _initialEndSpriteCellID: number;
  92815. /** @hidden */
  92816. _currentColorGradient: Nullable<ColorGradient>;
  92817. /** @hidden */
  92818. _currentColor1: Color4;
  92819. /** @hidden */
  92820. _currentColor2: Color4;
  92821. /** @hidden */
  92822. _currentSizeGradient: Nullable<FactorGradient>;
  92823. /** @hidden */
  92824. _currentSize1: number;
  92825. /** @hidden */
  92826. _currentSize2: number;
  92827. /** @hidden */
  92828. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92829. /** @hidden */
  92830. _currentAngularSpeed1: number;
  92831. /** @hidden */
  92832. _currentAngularSpeed2: number;
  92833. /** @hidden */
  92834. _currentVelocityGradient: Nullable<FactorGradient>;
  92835. /** @hidden */
  92836. _currentVelocity1: number;
  92837. /** @hidden */
  92838. _currentVelocity2: number;
  92839. /** @hidden */
  92840. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92841. /** @hidden */
  92842. _currentLimitVelocity1: number;
  92843. /** @hidden */
  92844. _currentLimitVelocity2: number;
  92845. /** @hidden */
  92846. _currentDragGradient: Nullable<FactorGradient>;
  92847. /** @hidden */
  92848. _currentDrag1: number;
  92849. /** @hidden */
  92850. _currentDrag2: number;
  92851. /** @hidden */
  92852. _randomNoiseCoordinates1: Vector3;
  92853. /** @hidden */
  92854. _randomNoiseCoordinates2: Vector3;
  92855. /** @hidden */
  92856. _localPosition?: Vector3;
  92857. /**
  92858. * Creates a new instance Particle
  92859. * @param particleSystem the particle system the particle belongs to
  92860. */
  92861. constructor(
  92862. /**
  92863. * The particle system the particle belongs to.
  92864. */
  92865. particleSystem: ParticleSystem);
  92866. private updateCellInfoFromSystem;
  92867. /**
  92868. * Defines how the sprite cell index is updated for the particle
  92869. */
  92870. updateCellIndex(): void;
  92871. /** @hidden */
  92872. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92873. /** @hidden */
  92874. _inheritParticleInfoToSubEmitters(): void;
  92875. /** @hidden */
  92876. _reset(): void;
  92877. /**
  92878. * Copy the properties of particle to another one.
  92879. * @param other the particle to copy the information to.
  92880. */
  92881. copyTo(other: Particle): void;
  92882. }
  92883. }
  92884. declare module BABYLON {
  92885. /**
  92886. * Particle emitter represents a volume emitting particles.
  92887. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92888. */
  92889. export interface IParticleEmitterType {
  92890. /**
  92891. * Called by the particle System when the direction is computed for the created particle.
  92892. * @param worldMatrix is the world matrix of the particle system
  92893. * @param directionToUpdate is the direction vector to update with the result
  92894. * @param particle is the particle we are computed the direction for
  92895. * @param isLocal defines if the direction should be set in local space
  92896. */
  92897. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92898. /**
  92899. * Called by the particle System when the position is computed for the created particle.
  92900. * @param worldMatrix is the world matrix of the particle system
  92901. * @param positionToUpdate is the position vector to update with the result
  92902. * @param particle is the particle we are computed the position for
  92903. * @param isLocal defines if the position should be set in local space
  92904. */
  92905. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92906. /**
  92907. * Clones the current emitter and returns a copy of it
  92908. * @returns the new emitter
  92909. */
  92910. clone(): IParticleEmitterType;
  92911. /**
  92912. * Called by the GPUParticleSystem to setup the update shader
  92913. * @param effect defines the update shader
  92914. */
  92915. applyToShader(effect: Effect): void;
  92916. /**
  92917. * Returns a string to use to update the GPU particles update shader
  92918. * @returns the effect defines string
  92919. */
  92920. getEffectDefines(): string;
  92921. /**
  92922. * Returns a string representing the class name
  92923. * @returns a string containing the class name
  92924. */
  92925. getClassName(): string;
  92926. /**
  92927. * Serializes the particle system to a JSON object.
  92928. * @returns the JSON object
  92929. */
  92930. serialize(): any;
  92931. /**
  92932. * Parse properties from a JSON object
  92933. * @param serializationObject defines the JSON object
  92934. * @param scene defines the hosting scene
  92935. */
  92936. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92937. }
  92938. }
  92939. declare module BABYLON {
  92940. /**
  92941. * Particle emitter emitting particles from the inside of a box.
  92942. * It emits the particles randomly between 2 given directions.
  92943. */
  92944. export class BoxParticleEmitter implements IParticleEmitterType {
  92945. /**
  92946. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92947. */
  92948. direction1: Vector3;
  92949. /**
  92950. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92951. */
  92952. direction2: Vector3;
  92953. /**
  92954. * 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.
  92955. */
  92956. minEmitBox: Vector3;
  92957. /**
  92958. * 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.
  92959. */
  92960. maxEmitBox: Vector3;
  92961. /**
  92962. * Creates a new instance BoxParticleEmitter
  92963. */
  92964. constructor();
  92965. /**
  92966. * Called by the particle System when the direction is computed for the created particle.
  92967. * @param worldMatrix is the world matrix of the particle system
  92968. * @param directionToUpdate is the direction vector to update with the result
  92969. * @param particle is the particle we are computed the direction for
  92970. * @param isLocal defines if the direction should be set in local space
  92971. */
  92972. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92973. /**
  92974. * Called by the particle System when the position is computed for the created particle.
  92975. * @param worldMatrix is the world matrix of the particle system
  92976. * @param positionToUpdate is the position vector to update with the result
  92977. * @param particle is the particle we are computed the position for
  92978. * @param isLocal defines if the position should be set in local space
  92979. */
  92980. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92981. /**
  92982. * Clones the current emitter and returns a copy of it
  92983. * @returns the new emitter
  92984. */
  92985. clone(): BoxParticleEmitter;
  92986. /**
  92987. * Called by the GPUParticleSystem to setup the update shader
  92988. * @param effect defines the update shader
  92989. */
  92990. applyToShader(effect: Effect): void;
  92991. /**
  92992. * Returns a string to use to update the GPU particles update shader
  92993. * @returns a string containng the defines string
  92994. */
  92995. getEffectDefines(): string;
  92996. /**
  92997. * Returns the string "BoxParticleEmitter"
  92998. * @returns a string containing the class name
  92999. */
  93000. getClassName(): string;
  93001. /**
  93002. * Serializes the particle system to a JSON object.
  93003. * @returns the JSON object
  93004. */
  93005. serialize(): any;
  93006. /**
  93007. * Parse properties from a JSON object
  93008. * @param serializationObject defines the JSON object
  93009. */
  93010. parse(serializationObject: any): void;
  93011. }
  93012. }
  93013. declare module BABYLON {
  93014. /**
  93015. * Particle emitter emitting particles from the inside of a cone.
  93016. * It emits the particles alongside the cone volume from the base to the particle.
  93017. * The emission direction might be randomized.
  93018. */
  93019. export class ConeParticleEmitter implements IParticleEmitterType {
  93020. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93021. directionRandomizer: number;
  93022. private _radius;
  93023. private _angle;
  93024. private _height;
  93025. /**
  93026. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  93027. */
  93028. radiusRange: number;
  93029. /**
  93030. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  93031. */
  93032. heightRange: number;
  93033. /**
  93034. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  93035. */
  93036. emitFromSpawnPointOnly: boolean;
  93037. /**
  93038. * Gets or sets the radius of the emission cone
  93039. */
  93040. get radius(): number;
  93041. set radius(value: number);
  93042. /**
  93043. * Gets or sets the angle of the emission cone
  93044. */
  93045. get angle(): number;
  93046. set angle(value: number);
  93047. private _buildHeight;
  93048. /**
  93049. * Creates a new instance ConeParticleEmitter
  93050. * @param radius the radius of the emission cone (1 by default)
  93051. * @param angle the cone base angle (PI by default)
  93052. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  93053. */
  93054. constructor(radius?: number, angle?: number,
  93055. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93056. directionRandomizer?: number);
  93057. /**
  93058. * Called by the particle System when the direction is computed for the created particle.
  93059. * @param worldMatrix is the world matrix of the particle system
  93060. * @param directionToUpdate is the direction vector to update with the result
  93061. * @param particle is the particle we are computed the direction for
  93062. * @param isLocal defines if the direction should be set in local space
  93063. */
  93064. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93065. /**
  93066. * Called by the particle System when the position is computed for the created particle.
  93067. * @param worldMatrix is the world matrix of the particle system
  93068. * @param positionToUpdate is the position vector to update with the result
  93069. * @param particle is the particle we are computed the position for
  93070. * @param isLocal defines if the position should be set in local space
  93071. */
  93072. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93073. /**
  93074. * Clones the current emitter and returns a copy of it
  93075. * @returns the new emitter
  93076. */
  93077. clone(): ConeParticleEmitter;
  93078. /**
  93079. * Called by the GPUParticleSystem to setup the update shader
  93080. * @param effect defines the update shader
  93081. */
  93082. applyToShader(effect: Effect): void;
  93083. /**
  93084. * Returns a string to use to update the GPU particles update shader
  93085. * @returns a string containng the defines string
  93086. */
  93087. getEffectDefines(): string;
  93088. /**
  93089. * Returns the string "ConeParticleEmitter"
  93090. * @returns a string containing the class name
  93091. */
  93092. getClassName(): string;
  93093. /**
  93094. * Serializes the particle system to a JSON object.
  93095. * @returns the JSON object
  93096. */
  93097. serialize(): any;
  93098. /**
  93099. * Parse properties from a JSON object
  93100. * @param serializationObject defines the JSON object
  93101. */
  93102. parse(serializationObject: any): void;
  93103. }
  93104. }
  93105. declare module BABYLON {
  93106. /**
  93107. * Particle emitter emitting particles from the inside of a cylinder.
  93108. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93109. */
  93110. export class CylinderParticleEmitter implements IParticleEmitterType {
  93111. /**
  93112. * The radius of the emission cylinder.
  93113. */
  93114. radius: number;
  93115. /**
  93116. * The height of the emission cylinder.
  93117. */
  93118. height: number;
  93119. /**
  93120. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93121. */
  93122. radiusRange: number;
  93123. /**
  93124. * How much to randomize the particle direction [0-1].
  93125. */
  93126. directionRandomizer: number;
  93127. /**
  93128. * Creates a new instance CylinderParticleEmitter
  93129. * @param radius the radius of the emission cylinder (1 by default)
  93130. * @param height the height of the emission cylinder (1 by default)
  93131. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93132. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93133. */
  93134. constructor(
  93135. /**
  93136. * The radius of the emission cylinder.
  93137. */
  93138. radius?: number,
  93139. /**
  93140. * The height of the emission cylinder.
  93141. */
  93142. height?: number,
  93143. /**
  93144. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93145. */
  93146. radiusRange?: number,
  93147. /**
  93148. * How much to randomize the particle direction [0-1].
  93149. */
  93150. directionRandomizer?: number);
  93151. /**
  93152. * Called by the particle System when the direction is computed for the created particle.
  93153. * @param worldMatrix is the world matrix of the particle system
  93154. * @param directionToUpdate is the direction vector to update with the result
  93155. * @param particle is the particle we are computed the direction for
  93156. * @param isLocal defines if the direction should be set in local space
  93157. */
  93158. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93159. /**
  93160. * Called by the particle System when the position is computed for the created particle.
  93161. * @param worldMatrix is the world matrix of the particle system
  93162. * @param positionToUpdate is the position vector to update with the result
  93163. * @param particle is the particle we are computed the position for
  93164. * @param isLocal defines if the position should be set in local space
  93165. */
  93166. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93167. /**
  93168. * Clones the current emitter and returns a copy of it
  93169. * @returns the new emitter
  93170. */
  93171. clone(): CylinderParticleEmitter;
  93172. /**
  93173. * Called by the GPUParticleSystem to setup the update shader
  93174. * @param effect defines the update shader
  93175. */
  93176. applyToShader(effect: Effect): void;
  93177. /**
  93178. * Returns a string to use to update the GPU particles update shader
  93179. * @returns a string containng the defines string
  93180. */
  93181. getEffectDefines(): string;
  93182. /**
  93183. * Returns the string "CylinderParticleEmitter"
  93184. * @returns a string containing the class name
  93185. */
  93186. getClassName(): string;
  93187. /**
  93188. * Serializes the particle system to a JSON object.
  93189. * @returns the JSON object
  93190. */
  93191. serialize(): any;
  93192. /**
  93193. * Parse properties from a JSON object
  93194. * @param serializationObject defines the JSON object
  93195. */
  93196. parse(serializationObject: any): void;
  93197. }
  93198. /**
  93199. * Particle emitter emitting particles from the inside of a cylinder.
  93200. * It emits the particles randomly between two vectors.
  93201. */
  93202. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93203. /**
  93204. * The min limit of the emission direction.
  93205. */
  93206. direction1: Vector3;
  93207. /**
  93208. * The max limit of the emission direction.
  93209. */
  93210. direction2: Vector3;
  93211. /**
  93212. * Creates a new instance CylinderDirectedParticleEmitter
  93213. * @param radius the radius of the emission cylinder (1 by default)
  93214. * @param height the height of the emission cylinder (1 by default)
  93215. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93216. * @param direction1 the min limit of the emission direction (up vector by default)
  93217. * @param direction2 the max limit of the emission direction (up vector by default)
  93218. */
  93219. constructor(radius?: number, height?: number, radiusRange?: number,
  93220. /**
  93221. * The min limit of the emission direction.
  93222. */
  93223. direction1?: Vector3,
  93224. /**
  93225. * The max limit of the emission direction.
  93226. */
  93227. direction2?: Vector3);
  93228. /**
  93229. * Called by the particle System when the direction is computed for the created particle.
  93230. * @param worldMatrix is the world matrix of the particle system
  93231. * @param directionToUpdate is the direction vector to update with the result
  93232. * @param particle is the particle we are computed the direction for
  93233. */
  93234. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93235. /**
  93236. * Clones the current emitter and returns a copy of it
  93237. * @returns the new emitter
  93238. */
  93239. clone(): CylinderDirectedParticleEmitter;
  93240. /**
  93241. * Called by the GPUParticleSystem to setup the update shader
  93242. * @param effect defines the update shader
  93243. */
  93244. applyToShader(effect: Effect): void;
  93245. /**
  93246. * Returns a string to use to update the GPU particles update shader
  93247. * @returns a string containng the defines string
  93248. */
  93249. getEffectDefines(): string;
  93250. /**
  93251. * Returns the string "CylinderDirectedParticleEmitter"
  93252. * @returns a string containing the class name
  93253. */
  93254. getClassName(): string;
  93255. /**
  93256. * Serializes the particle system to a JSON object.
  93257. * @returns the JSON object
  93258. */
  93259. serialize(): any;
  93260. /**
  93261. * Parse properties from a JSON object
  93262. * @param serializationObject defines the JSON object
  93263. */
  93264. parse(serializationObject: any): void;
  93265. }
  93266. }
  93267. declare module BABYLON {
  93268. /**
  93269. * Particle emitter emitting particles from the inside of a hemisphere.
  93270. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93271. */
  93272. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93273. /**
  93274. * The radius of the emission hemisphere.
  93275. */
  93276. radius: number;
  93277. /**
  93278. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93279. */
  93280. radiusRange: number;
  93281. /**
  93282. * How much to randomize the particle direction [0-1].
  93283. */
  93284. directionRandomizer: number;
  93285. /**
  93286. * Creates a new instance HemisphericParticleEmitter
  93287. * @param radius the radius of the emission hemisphere (1 by default)
  93288. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93289. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93290. */
  93291. constructor(
  93292. /**
  93293. * The radius of the emission hemisphere.
  93294. */
  93295. radius?: number,
  93296. /**
  93297. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93298. */
  93299. radiusRange?: number,
  93300. /**
  93301. * How much to randomize the particle direction [0-1].
  93302. */
  93303. directionRandomizer?: number);
  93304. /**
  93305. * Called by the particle System when the direction is computed for the created particle.
  93306. * @param worldMatrix is the world matrix of the particle system
  93307. * @param directionToUpdate is the direction vector to update with the result
  93308. * @param particle is the particle we are computed the direction for
  93309. * @param isLocal defines if the direction should be set in local space
  93310. */
  93311. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93312. /**
  93313. * Called by the particle System when the position is computed for the created particle.
  93314. * @param worldMatrix is the world matrix of the particle system
  93315. * @param positionToUpdate is the position vector to update with the result
  93316. * @param particle is the particle we are computed the position for
  93317. * @param isLocal defines if the position should be set in local space
  93318. */
  93319. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93320. /**
  93321. * Clones the current emitter and returns a copy of it
  93322. * @returns the new emitter
  93323. */
  93324. clone(): HemisphericParticleEmitter;
  93325. /**
  93326. * Called by the GPUParticleSystem to setup the update shader
  93327. * @param effect defines the update shader
  93328. */
  93329. applyToShader(effect: Effect): void;
  93330. /**
  93331. * Returns a string to use to update the GPU particles update shader
  93332. * @returns a string containng the defines string
  93333. */
  93334. getEffectDefines(): string;
  93335. /**
  93336. * Returns the string "HemisphericParticleEmitter"
  93337. * @returns a string containing the class name
  93338. */
  93339. getClassName(): string;
  93340. /**
  93341. * Serializes the particle system to a JSON object.
  93342. * @returns the JSON object
  93343. */
  93344. serialize(): any;
  93345. /**
  93346. * Parse properties from a JSON object
  93347. * @param serializationObject defines the JSON object
  93348. */
  93349. parse(serializationObject: any): void;
  93350. }
  93351. }
  93352. declare module BABYLON {
  93353. /**
  93354. * Particle emitter emitting particles from a point.
  93355. * It emits the particles randomly between 2 given directions.
  93356. */
  93357. export class PointParticleEmitter implements IParticleEmitterType {
  93358. /**
  93359. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93360. */
  93361. direction1: Vector3;
  93362. /**
  93363. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93364. */
  93365. direction2: Vector3;
  93366. /**
  93367. * Creates a new instance PointParticleEmitter
  93368. */
  93369. constructor();
  93370. /**
  93371. * Called by the particle System when the direction is computed for the created particle.
  93372. * @param worldMatrix is the world matrix of the particle system
  93373. * @param directionToUpdate is the direction vector to update with the result
  93374. * @param particle is the particle we are computed the direction for
  93375. * @param isLocal defines if the direction should be set in local space
  93376. */
  93377. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93378. /**
  93379. * Called by the particle System when the position is computed for the created particle.
  93380. * @param worldMatrix is the world matrix of the particle system
  93381. * @param positionToUpdate is the position vector to update with the result
  93382. * @param particle is the particle we are computed the position for
  93383. * @param isLocal defines if the position should be set in local space
  93384. */
  93385. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93386. /**
  93387. * Clones the current emitter and returns a copy of it
  93388. * @returns the new emitter
  93389. */
  93390. clone(): PointParticleEmitter;
  93391. /**
  93392. * Called by the GPUParticleSystem to setup the update shader
  93393. * @param effect defines the update shader
  93394. */
  93395. applyToShader(effect: Effect): void;
  93396. /**
  93397. * Returns a string to use to update the GPU particles update shader
  93398. * @returns a string containng the defines string
  93399. */
  93400. getEffectDefines(): string;
  93401. /**
  93402. * Returns the string "PointParticleEmitter"
  93403. * @returns a string containing the class name
  93404. */
  93405. getClassName(): string;
  93406. /**
  93407. * Serializes the particle system to a JSON object.
  93408. * @returns the JSON object
  93409. */
  93410. serialize(): any;
  93411. /**
  93412. * Parse properties from a JSON object
  93413. * @param serializationObject defines the JSON object
  93414. */
  93415. parse(serializationObject: any): void;
  93416. }
  93417. }
  93418. declare module BABYLON {
  93419. /**
  93420. * Particle emitter emitting particles from the inside of a sphere.
  93421. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93422. */
  93423. export class SphereParticleEmitter implements IParticleEmitterType {
  93424. /**
  93425. * The radius of the emission sphere.
  93426. */
  93427. radius: number;
  93428. /**
  93429. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93430. */
  93431. radiusRange: number;
  93432. /**
  93433. * How much to randomize the particle direction [0-1].
  93434. */
  93435. directionRandomizer: number;
  93436. /**
  93437. * Creates a new instance SphereParticleEmitter
  93438. * @param radius the radius of the emission sphere (1 by default)
  93439. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93440. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93441. */
  93442. constructor(
  93443. /**
  93444. * The radius of the emission sphere.
  93445. */
  93446. radius?: number,
  93447. /**
  93448. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93449. */
  93450. radiusRange?: number,
  93451. /**
  93452. * How much to randomize the particle direction [0-1].
  93453. */
  93454. directionRandomizer?: number);
  93455. /**
  93456. * Called by the particle System when the direction is computed for the created particle.
  93457. * @param worldMatrix is the world matrix of the particle system
  93458. * @param directionToUpdate is the direction vector to update with the result
  93459. * @param particle is the particle we are computed the direction for
  93460. * @param isLocal defines if the direction should be set in local space
  93461. */
  93462. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93463. /**
  93464. * Called by the particle System when the position is computed for the created particle.
  93465. * @param worldMatrix is the world matrix of the particle system
  93466. * @param positionToUpdate is the position vector to update with the result
  93467. * @param particle is the particle we are computed the position for
  93468. * @param isLocal defines if the position should be set in local space
  93469. */
  93470. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93471. /**
  93472. * Clones the current emitter and returns a copy of it
  93473. * @returns the new emitter
  93474. */
  93475. clone(): SphereParticleEmitter;
  93476. /**
  93477. * Called by the GPUParticleSystem to setup the update shader
  93478. * @param effect defines the update shader
  93479. */
  93480. applyToShader(effect: Effect): void;
  93481. /**
  93482. * Returns a string to use to update the GPU particles update shader
  93483. * @returns a string containng the defines string
  93484. */
  93485. getEffectDefines(): string;
  93486. /**
  93487. * Returns the string "SphereParticleEmitter"
  93488. * @returns a string containing the class name
  93489. */
  93490. getClassName(): string;
  93491. /**
  93492. * Serializes the particle system to a JSON object.
  93493. * @returns the JSON object
  93494. */
  93495. serialize(): any;
  93496. /**
  93497. * Parse properties from a JSON object
  93498. * @param serializationObject defines the JSON object
  93499. */
  93500. parse(serializationObject: any): void;
  93501. }
  93502. /**
  93503. * Particle emitter emitting particles from the inside of a sphere.
  93504. * It emits the particles randomly between two vectors.
  93505. */
  93506. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93507. /**
  93508. * The min limit of the emission direction.
  93509. */
  93510. direction1: Vector3;
  93511. /**
  93512. * The max limit of the emission direction.
  93513. */
  93514. direction2: Vector3;
  93515. /**
  93516. * Creates a new instance SphereDirectedParticleEmitter
  93517. * @param radius the radius of the emission sphere (1 by default)
  93518. * @param direction1 the min limit of the emission direction (up vector by default)
  93519. * @param direction2 the max limit of the emission direction (up vector by default)
  93520. */
  93521. constructor(radius?: number,
  93522. /**
  93523. * The min limit of the emission direction.
  93524. */
  93525. direction1?: Vector3,
  93526. /**
  93527. * The max limit of the emission direction.
  93528. */
  93529. direction2?: Vector3);
  93530. /**
  93531. * Called by the particle System when the direction is computed for the created particle.
  93532. * @param worldMatrix is the world matrix of the particle system
  93533. * @param directionToUpdate is the direction vector to update with the result
  93534. * @param particle is the particle we are computed the direction for
  93535. */
  93536. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93537. /**
  93538. * Clones the current emitter and returns a copy of it
  93539. * @returns the new emitter
  93540. */
  93541. clone(): SphereDirectedParticleEmitter;
  93542. /**
  93543. * Called by the GPUParticleSystem to setup the update shader
  93544. * @param effect defines the update shader
  93545. */
  93546. applyToShader(effect: Effect): void;
  93547. /**
  93548. * Returns a string to use to update the GPU particles update shader
  93549. * @returns a string containng the defines string
  93550. */
  93551. getEffectDefines(): string;
  93552. /**
  93553. * Returns the string "SphereDirectedParticleEmitter"
  93554. * @returns a string containing the class name
  93555. */
  93556. getClassName(): string;
  93557. /**
  93558. * Serializes the particle system to a JSON object.
  93559. * @returns the JSON object
  93560. */
  93561. serialize(): any;
  93562. /**
  93563. * Parse properties from a JSON object
  93564. * @param serializationObject defines the JSON object
  93565. */
  93566. parse(serializationObject: any): void;
  93567. }
  93568. }
  93569. declare module BABYLON {
  93570. /**
  93571. * Particle emitter emitting particles from a custom list of positions.
  93572. */
  93573. export class CustomParticleEmitter implements IParticleEmitterType {
  93574. /**
  93575. * Gets or sets the position generator that will create the inital position of each particle.
  93576. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93577. */
  93578. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93579. /**
  93580. * Gets or sets the destination generator that will create the final destination of each particle.
  93581. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93582. */
  93583. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93584. /**
  93585. * Creates a new instance CustomParticleEmitter
  93586. */
  93587. constructor();
  93588. /**
  93589. * Called by the particle System when the direction is computed for the created particle.
  93590. * @param worldMatrix is the world matrix of the particle system
  93591. * @param directionToUpdate is the direction vector to update with the result
  93592. * @param particle is the particle we are computed the direction for
  93593. * @param isLocal defines if the direction should be set in local space
  93594. */
  93595. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93596. /**
  93597. * Called by the particle System when the position is computed for the created particle.
  93598. * @param worldMatrix is the world matrix of the particle system
  93599. * @param positionToUpdate is the position vector to update with the result
  93600. * @param particle is the particle we are computed the position for
  93601. * @param isLocal defines if the position should be set in local space
  93602. */
  93603. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93604. /**
  93605. * Clones the current emitter and returns a copy of it
  93606. * @returns the new emitter
  93607. */
  93608. clone(): CustomParticleEmitter;
  93609. /**
  93610. * Called by the GPUParticleSystem to setup the update shader
  93611. * @param effect defines the update shader
  93612. */
  93613. applyToShader(effect: Effect): void;
  93614. /**
  93615. * Returns a string to use to update the GPU particles update shader
  93616. * @returns a string containng the defines string
  93617. */
  93618. getEffectDefines(): string;
  93619. /**
  93620. * Returns the string "PointParticleEmitter"
  93621. * @returns a string containing the class name
  93622. */
  93623. getClassName(): string;
  93624. /**
  93625. * Serializes the particle system to a JSON object.
  93626. * @returns the JSON object
  93627. */
  93628. serialize(): any;
  93629. /**
  93630. * Parse properties from a JSON object
  93631. * @param serializationObject defines the JSON object
  93632. */
  93633. parse(serializationObject: any): void;
  93634. }
  93635. }
  93636. declare module BABYLON {
  93637. /**
  93638. * Particle emitter emitting particles from the inside of a box.
  93639. * It emits the particles randomly between 2 given directions.
  93640. */
  93641. export class MeshParticleEmitter implements IParticleEmitterType {
  93642. private _indices;
  93643. private _positions;
  93644. private _normals;
  93645. private _storedNormal;
  93646. private _mesh;
  93647. /**
  93648. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93649. */
  93650. direction1: Vector3;
  93651. /**
  93652. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93653. */
  93654. direction2: Vector3;
  93655. /**
  93656. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93657. */
  93658. useMeshNormalsForDirection: boolean;
  93659. /** Defines the mesh to use as source */
  93660. get mesh(): Nullable<AbstractMesh>;
  93661. set mesh(value: Nullable<AbstractMesh>);
  93662. /**
  93663. * Creates a new instance MeshParticleEmitter
  93664. * @param mesh defines the mesh to use as source
  93665. */
  93666. constructor(mesh?: Nullable<AbstractMesh>);
  93667. /**
  93668. * Called by the particle System when the direction is computed for the created particle.
  93669. * @param worldMatrix is the world matrix of the particle system
  93670. * @param directionToUpdate is the direction vector to update with the result
  93671. * @param particle is the particle we are computed the direction for
  93672. * @param isLocal defines if the direction should be set in local space
  93673. */
  93674. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93675. /**
  93676. * Called by the particle System when the position is computed for the created particle.
  93677. * @param worldMatrix is the world matrix of the particle system
  93678. * @param positionToUpdate is the position vector to update with the result
  93679. * @param particle is the particle we are computed the position for
  93680. * @param isLocal defines if the position should be set in local space
  93681. */
  93682. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93683. /**
  93684. * Clones the current emitter and returns a copy of it
  93685. * @returns the new emitter
  93686. */
  93687. clone(): MeshParticleEmitter;
  93688. /**
  93689. * Called by the GPUParticleSystem to setup the update shader
  93690. * @param effect defines the update shader
  93691. */
  93692. applyToShader(effect: Effect): void;
  93693. /**
  93694. * Returns a string to use to update the GPU particles update shader
  93695. * @returns a string containng the defines string
  93696. */
  93697. getEffectDefines(): string;
  93698. /**
  93699. * Returns the string "BoxParticleEmitter"
  93700. * @returns a string containing the class name
  93701. */
  93702. getClassName(): string;
  93703. /**
  93704. * Serializes the particle system to a JSON object.
  93705. * @returns the JSON object
  93706. */
  93707. serialize(): any;
  93708. /**
  93709. * Parse properties from a JSON object
  93710. * @param serializationObject defines the JSON object
  93711. * @param scene defines the hosting scene
  93712. */
  93713. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93714. }
  93715. }
  93716. declare module BABYLON {
  93717. /**
  93718. * Interface representing a particle system in Babylon.js.
  93719. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93720. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93721. */
  93722. export interface IParticleSystem {
  93723. /**
  93724. * List of animations used by the particle system.
  93725. */
  93726. animations: Animation[];
  93727. /**
  93728. * The id of the Particle system.
  93729. */
  93730. id: string;
  93731. /**
  93732. * The name of the Particle system.
  93733. */
  93734. name: string;
  93735. /**
  93736. * The emitter represents the Mesh or position we are attaching the particle system to.
  93737. */
  93738. emitter: Nullable<AbstractMesh | Vector3>;
  93739. /**
  93740. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93741. */
  93742. isBillboardBased: boolean;
  93743. /**
  93744. * The rendering group used by the Particle system to chose when to render.
  93745. */
  93746. renderingGroupId: number;
  93747. /**
  93748. * The layer mask we are rendering the particles through.
  93749. */
  93750. layerMask: number;
  93751. /**
  93752. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93753. */
  93754. updateSpeed: number;
  93755. /**
  93756. * The amount of time the particle system is running (depends of the overall update speed).
  93757. */
  93758. targetStopDuration: number;
  93759. /**
  93760. * The texture used to render each particle. (this can be a spritesheet)
  93761. */
  93762. particleTexture: Nullable<BaseTexture>;
  93763. /**
  93764. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93765. */
  93766. blendMode: number;
  93767. /**
  93768. * Minimum life time of emitting particles.
  93769. */
  93770. minLifeTime: number;
  93771. /**
  93772. * Maximum life time of emitting particles.
  93773. */
  93774. maxLifeTime: number;
  93775. /**
  93776. * Minimum Size of emitting particles.
  93777. */
  93778. minSize: number;
  93779. /**
  93780. * Maximum Size of emitting particles.
  93781. */
  93782. maxSize: number;
  93783. /**
  93784. * Minimum scale of emitting particles on X axis.
  93785. */
  93786. minScaleX: number;
  93787. /**
  93788. * Maximum scale of emitting particles on X axis.
  93789. */
  93790. maxScaleX: number;
  93791. /**
  93792. * Minimum scale of emitting particles on Y axis.
  93793. */
  93794. minScaleY: number;
  93795. /**
  93796. * Maximum scale of emitting particles on Y axis.
  93797. */
  93798. maxScaleY: number;
  93799. /**
  93800. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93801. */
  93802. color1: Color4;
  93803. /**
  93804. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93805. */
  93806. color2: Color4;
  93807. /**
  93808. * Color the particle will have at the end of its lifetime.
  93809. */
  93810. colorDead: Color4;
  93811. /**
  93812. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93813. */
  93814. emitRate: number;
  93815. /**
  93816. * You can use gravity if you want to give an orientation to your particles.
  93817. */
  93818. gravity: Vector3;
  93819. /**
  93820. * Minimum power of emitting particles.
  93821. */
  93822. minEmitPower: number;
  93823. /**
  93824. * Maximum power of emitting particles.
  93825. */
  93826. maxEmitPower: number;
  93827. /**
  93828. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93829. */
  93830. minAngularSpeed: number;
  93831. /**
  93832. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93833. */
  93834. maxAngularSpeed: number;
  93835. /**
  93836. * Gets or sets the minimal initial rotation in radians.
  93837. */
  93838. minInitialRotation: number;
  93839. /**
  93840. * Gets or sets the maximal initial rotation in radians.
  93841. */
  93842. maxInitialRotation: number;
  93843. /**
  93844. * The particle emitter type defines the emitter used by the particle system.
  93845. * It can be for example box, sphere, or cone...
  93846. */
  93847. particleEmitterType: Nullable<IParticleEmitterType>;
  93848. /**
  93849. * Defines the delay in milliseconds before starting the system (0 by default)
  93850. */
  93851. startDelay: number;
  93852. /**
  93853. * 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
  93854. */
  93855. preWarmCycles: number;
  93856. /**
  93857. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93858. */
  93859. preWarmStepOffset: number;
  93860. /**
  93861. * 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)
  93862. */
  93863. spriteCellChangeSpeed: number;
  93864. /**
  93865. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93866. */
  93867. startSpriteCellID: number;
  93868. /**
  93869. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93870. */
  93871. endSpriteCellID: number;
  93872. /**
  93873. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93874. */
  93875. spriteCellWidth: number;
  93876. /**
  93877. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93878. */
  93879. spriteCellHeight: number;
  93880. /**
  93881. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93882. */
  93883. spriteRandomStartCell: boolean;
  93884. /**
  93885. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93886. */
  93887. isAnimationSheetEnabled: boolean;
  93888. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93889. translationPivot: Vector2;
  93890. /**
  93891. * Gets or sets a texture used to add random noise to particle positions
  93892. */
  93893. noiseTexture: Nullable<BaseTexture>;
  93894. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93895. noiseStrength: Vector3;
  93896. /**
  93897. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93898. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93899. */
  93900. billboardMode: number;
  93901. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93902. limitVelocityDamping: number;
  93903. /**
  93904. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93905. */
  93906. beginAnimationOnStart: boolean;
  93907. /**
  93908. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93909. */
  93910. beginAnimationFrom: number;
  93911. /**
  93912. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93913. */
  93914. beginAnimationTo: number;
  93915. /**
  93916. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93917. */
  93918. beginAnimationLoop: boolean;
  93919. /**
  93920. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93921. */
  93922. disposeOnStop: boolean;
  93923. /**
  93924. * Specifies if the particles are updated in emitter local space or world space
  93925. */
  93926. isLocal: boolean;
  93927. /** Snippet ID if the particle system was created from the snippet server */
  93928. snippetId: string;
  93929. /** Gets or sets a matrix to use to compute projection */
  93930. defaultProjectionMatrix: Matrix;
  93931. /**
  93932. * Gets the maximum number of particles active at the same time.
  93933. * @returns The max number of active particles.
  93934. */
  93935. getCapacity(): number;
  93936. /**
  93937. * Gets the number of particles active at the same time.
  93938. * @returns The number of active particles.
  93939. */
  93940. getActiveCount(): number;
  93941. /**
  93942. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93943. * @returns True if it has been started, otherwise false.
  93944. */
  93945. isStarted(): boolean;
  93946. /**
  93947. * Animates the particle system for this frame.
  93948. */
  93949. animate(): void;
  93950. /**
  93951. * Renders the particle system in its current state.
  93952. * @returns the current number of particles
  93953. */
  93954. render(): number;
  93955. /**
  93956. * Dispose the particle system and frees its associated resources.
  93957. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93958. */
  93959. dispose(disposeTexture?: boolean): void;
  93960. /**
  93961. * An event triggered when the system is disposed
  93962. */
  93963. onDisposeObservable: Observable<IParticleSystem>;
  93964. /**
  93965. * Clones the particle system.
  93966. * @param name The name of the cloned object
  93967. * @param newEmitter The new emitter to use
  93968. * @returns the cloned particle system
  93969. */
  93970. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93971. /**
  93972. * Serializes the particle system to a JSON object
  93973. * @param serializeTexture defines if the texture must be serialized as well
  93974. * @returns the JSON object
  93975. */
  93976. serialize(serializeTexture: boolean): any;
  93977. /**
  93978. * Rebuild the particle system
  93979. */
  93980. rebuild(): void;
  93981. /** Force the system to rebuild all gradients that need to be resync */
  93982. forceRefreshGradients(): void;
  93983. /**
  93984. * Starts the particle system and begins to emit
  93985. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93986. */
  93987. start(delay?: number): void;
  93988. /**
  93989. * Stops the particle system.
  93990. */
  93991. stop(): void;
  93992. /**
  93993. * Remove all active particles
  93994. */
  93995. reset(): void;
  93996. /**
  93997. * Gets a boolean indicating that the system is stopping
  93998. * @returns true if the system is currently stopping
  93999. */
  94000. isStopping(): boolean;
  94001. /**
  94002. * Is this system ready to be used/rendered
  94003. * @return true if the system is ready
  94004. */
  94005. isReady(): boolean;
  94006. /**
  94007. * Returns the string "ParticleSystem"
  94008. * @returns a string containing the class name
  94009. */
  94010. getClassName(): string;
  94011. /**
  94012. * Gets the custom effect used to render the particles
  94013. * @param blendMode Blend mode for which the effect should be retrieved
  94014. * @returns The effect
  94015. */
  94016. getCustomEffect(blendMode: number): Nullable<Effect>;
  94017. /**
  94018. * Sets the custom effect used to render the particles
  94019. * @param effect The effect to set
  94020. * @param blendMode Blend mode for which the effect should be set
  94021. */
  94022. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  94023. /**
  94024. * Fill the defines array according to the current settings of the particle system
  94025. * @param defines Array to be updated
  94026. * @param blendMode blend mode to take into account when updating the array
  94027. */
  94028. fillDefines(defines: Array<string>, blendMode: number): void;
  94029. /**
  94030. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  94031. * @param uniforms Uniforms array to fill
  94032. * @param attributes Attributes array to fill
  94033. * @param samplers Samplers array to fill
  94034. */
  94035. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  94036. /**
  94037. * Observable that will be called just before the particles are drawn
  94038. */
  94039. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  94040. /**
  94041. * Gets the name of the particle vertex shader
  94042. */
  94043. vertexShaderName: string;
  94044. /**
  94045. * Adds a new color gradient
  94046. * @param gradient defines the gradient to use (between 0 and 1)
  94047. * @param color1 defines the color to affect to the specified gradient
  94048. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  94049. * @returns the current particle system
  94050. */
  94051. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  94052. /**
  94053. * Remove a specific color gradient
  94054. * @param gradient defines the gradient to remove
  94055. * @returns the current particle system
  94056. */
  94057. removeColorGradient(gradient: number): IParticleSystem;
  94058. /**
  94059. * Adds a new size gradient
  94060. * @param gradient defines the gradient to use (between 0 and 1)
  94061. * @param factor defines the size factor to affect to the specified gradient
  94062. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94063. * @returns the current particle system
  94064. */
  94065. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94066. /**
  94067. * Remove a specific size gradient
  94068. * @param gradient defines the gradient to remove
  94069. * @returns the current particle system
  94070. */
  94071. removeSizeGradient(gradient: number): IParticleSystem;
  94072. /**
  94073. * Gets the current list of color gradients.
  94074. * You must use addColorGradient and removeColorGradient to udpate this list
  94075. * @returns the list of color gradients
  94076. */
  94077. getColorGradients(): Nullable<Array<ColorGradient>>;
  94078. /**
  94079. * Gets the current list of size gradients.
  94080. * You must use addSizeGradient and removeSizeGradient to udpate this list
  94081. * @returns the list of size gradients
  94082. */
  94083. getSizeGradients(): Nullable<Array<FactorGradient>>;
  94084. /**
  94085. * Gets the current list of angular speed gradients.
  94086. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94087. * @returns the list of angular speed gradients
  94088. */
  94089. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94090. /**
  94091. * Adds a new angular speed gradient
  94092. * @param gradient defines the gradient to use (between 0 and 1)
  94093. * @param factor defines the angular speed to affect to the specified gradient
  94094. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94095. * @returns the current particle system
  94096. */
  94097. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94098. /**
  94099. * Remove a specific angular speed gradient
  94100. * @param gradient defines the gradient to remove
  94101. * @returns the current particle system
  94102. */
  94103. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94104. /**
  94105. * Gets the current list of velocity gradients.
  94106. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94107. * @returns the list of velocity gradients
  94108. */
  94109. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94110. /**
  94111. * Adds a new velocity gradient
  94112. * @param gradient defines the gradient to use (between 0 and 1)
  94113. * @param factor defines the velocity to affect to the specified gradient
  94114. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94115. * @returns the current particle system
  94116. */
  94117. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94118. /**
  94119. * Remove a specific velocity gradient
  94120. * @param gradient defines the gradient to remove
  94121. * @returns the current particle system
  94122. */
  94123. removeVelocityGradient(gradient: number): IParticleSystem;
  94124. /**
  94125. * Gets the current list of limit velocity gradients.
  94126. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94127. * @returns the list of limit velocity gradients
  94128. */
  94129. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94130. /**
  94131. * Adds a new limit velocity gradient
  94132. * @param gradient defines the gradient to use (between 0 and 1)
  94133. * @param factor defines the limit velocity to affect to the specified gradient
  94134. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94135. * @returns the current particle system
  94136. */
  94137. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94138. /**
  94139. * Remove a specific limit velocity gradient
  94140. * @param gradient defines the gradient to remove
  94141. * @returns the current particle system
  94142. */
  94143. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94144. /**
  94145. * Adds a new drag gradient
  94146. * @param gradient defines the gradient to use (between 0 and 1)
  94147. * @param factor defines the drag to affect to the specified gradient
  94148. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94149. * @returns the current particle system
  94150. */
  94151. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94152. /**
  94153. * Remove a specific drag gradient
  94154. * @param gradient defines the gradient to remove
  94155. * @returns the current particle system
  94156. */
  94157. removeDragGradient(gradient: number): IParticleSystem;
  94158. /**
  94159. * Gets the current list of drag gradients.
  94160. * You must use addDragGradient and removeDragGradient to udpate this list
  94161. * @returns the list of drag gradients
  94162. */
  94163. getDragGradients(): Nullable<Array<FactorGradient>>;
  94164. /**
  94165. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94166. * @param gradient defines the gradient to use (between 0 and 1)
  94167. * @param factor defines the emit rate to affect to the specified gradient
  94168. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94169. * @returns the current particle system
  94170. */
  94171. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94172. /**
  94173. * Remove a specific emit rate gradient
  94174. * @param gradient defines the gradient to remove
  94175. * @returns the current particle system
  94176. */
  94177. removeEmitRateGradient(gradient: number): IParticleSystem;
  94178. /**
  94179. * Gets the current list of emit rate gradients.
  94180. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94181. * @returns the list of emit rate gradients
  94182. */
  94183. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94184. /**
  94185. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94186. * @param gradient defines the gradient to use (between 0 and 1)
  94187. * @param factor defines the start size to affect to the specified gradient
  94188. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94189. * @returns the current particle system
  94190. */
  94191. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94192. /**
  94193. * Remove a specific start size gradient
  94194. * @param gradient defines the gradient to remove
  94195. * @returns the current particle system
  94196. */
  94197. removeStartSizeGradient(gradient: number): IParticleSystem;
  94198. /**
  94199. * Gets the current list of start size gradients.
  94200. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94201. * @returns the list of start size gradients
  94202. */
  94203. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94204. /**
  94205. * Adds a new life time gradient
  94206. * @param gradient defines the gradient to use (between 0 and 1)
  94207. * @param factor defines the life time factor to affect to the specified gradient
  94208. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94209. * @returns the current particle system
  94210. */
  94211. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94212. /**
  94213. * Remove a specific life time gradient
  94214. * @param gradient defines the gradient to remove
  94215. * @returns the current particle system
  94216. */
  94217. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94218. /**
  94219. * Gets the current list of life time gradients.
  94220. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94221. * @returns the list of life time gradients
  94222. */
  94223. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94224. /**
  94225. * Gets the current list of color gradients.
  94226. * You must use addColorGradient and removeColorGradient to udpate this list
  94227. * @returns the list of color gradients
  94228. */
  94229. getColorGradients(): Nullable<Array<ColorGradient>>;
  94230. /**
  94231. * Adds a new ramp gradient used to remap particle colors
  94232. * @param gradient defines the gradient to use (between 0 and 1)
  94233. * @param color defines the color to affect to the specified gradient
  94234. * @returns the current particle system
  94235. */
  94236. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94237. /**
  94238. * Gets the current list of ramp gradients.
  94239. * You must use addRampGradient and removeRampGradient to udpate this list
  94240. * @returns the list of ramp gradients
  94241. */
  94242. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94243. /** Gets or sets a boolean indicating that ramp gradients must be used
  94244. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94245. */
  94246. useRampGradients: boolean;
  94247. /**
  94248. * Adds a new color remap gradient
  94249. * @param gradient defines the gradient to use (between 0 and 1)
  94250. * @param min defines the color remap minimal range
  94251. * @param max defines the color remap maximal range
  94252. * @returns the current particle system
  94253. */
  94254. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94255. /**
  94256. * Gets the current list of color remap gradients.
  94257. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94258. * @returns the list of color remap gradients
  94259. */
  94260. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94261. /**
  94262. * Adds a new alpha remap gradient
  94263. * @param gradient defines the gradient to use (between 0 and 1)
  94264. * @param min defines the alpha remap minimal range
  94265. * @param max defines the alpha remap maximal range
  94266. * @returns the current particle system
  94267. */
  94268. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94269. /**
  94270. * Gets the current list of alpha remap gradients.
  94271. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94272. * @returns the list of alpha remap gradients
  94273. */
  94274. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94275. /**
  94276. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94277. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94278. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94279. * @returns the emitter
  94280. */
  94281. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94282. /**
  94283. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94284. * @param radius The radius of the hemisphere to emit from
  94285. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94286. * @returns the emitter
  94287. */
  94288. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94289. /**
  94290. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94291. * @param radius The radius of the sphere to emit from
  94292. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94293. * @returns the emitter
  94294. */
  94295. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94296. /**
  94297. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94298. * @param radius The radius of the sphere to emit from
  94299. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94300. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94301. * @returns the emitter
  94302. */
  94303. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94304. /**
  94305. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94306. * @param radius The radius of the emission cylinder
  94307. * @param height The height of the emission cylinder
  94308. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94309. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94310. * @returns the emitter
  94311. */
  94312. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94313. /**
  94314. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94315. * @param radius The radius of the cylinder to emit from
  94316. * @param height The height of the emission cylinder
  94317. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94318. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94319. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94320. * @returns the emitter
  94321. */
  94322. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94323. /**
  94324. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94325. * @param radius The radius of the cone to emit from
  94326. * @param angle The base angle of the cone
  94327. * @returns the emitter
  94328. */
  94329. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94330. /**
  94331. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94332. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94333. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94334. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94335. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94336. * @returns the emitter
  94337. */
  94338. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94339. /**
  94340. * Get hosting scene
  94341. * @returns the scene
  94342. */
  94343. getScene(): Nullable<Scene>;
  94344. }
  94345. }
  94346. declare module BABYLON {
  94347. /**
  94348. * 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.
  94349. * @see https://doc.babylonjs.com/how_to/transformnode
  94350. */
  94351. export class TransformNode extends Node {
  94352. /**
  94353. * Object will not rotate to face the camera
  94354. */
  94355. static BILLBOARDMODE_NONE: number;
  94356. /**
  94357. * Object will rotate to face the camera but only on the x axis
  94358. */
  94359. static BILLBOARDMODE_X: number;
  94360. /**
  94361. * Object will rotate to face the camera but only on the y axis
  94362. */
  94363. static BILLBOARDMODE_Y: number;
  94364. /**
  94365. * Object will rotate to face the camera but only on the z axis
  94366. */
  94367. static BILLBOARDMODE_Z: number;
  94368. /**
  94369. * Object will rotate to face the camera
  94370. */
  94371. static BILLBOARDMODE_ALL: number;
  94372. /**
  94373. * Object will rotate to face the camera's position instead of orientation
  94374. */
  94375. static BILLBOARDMODE_USE_POSITION: number;
  94376. private static _TmpRotation;
  94377. private static _TmpScaling;
  94378. private static _TmpTranslation;
  94379. private _forward;
  94380. private _forwardInverted;
  94381. private _up;
  94382. private _right;
  94383. private _rightInverted;
  94384. private _position;
  94385. private _rotation;
  94386. private _rotationQuaternion;
  94387. protected _scaling: Vector3;
  94388. protected _isDirty: boolean;
  94389. private _transformToBoneReferal;
  94390. private _isAbsoluteSynced;
  94391. private _billboardMode;
  94392. /**
  94393. * Gets or sets the billboard mode. Default is 0.
  94394. *
  94395. * | Value | Type | Description |
  94396. * | --- | --- | --- |
  94397. * | 0 | BILLBOARDMODE_NONE | |
  94398. * | 1 | BILLBOARDMODE_X | |
  94399. * | 2 | BILLBOARDMODE_Y | |
  94400. * | 4 | BILLBOARDMODE_Z | |
  94401. * | 7 | BILLBOARDMODE_ALL | |
  94402. *
  94403. */
  94404. get billboardMode(): number;
  94405. set billboardMode(value: number);
  94406. private _preserveParentRotationForBillboard;
  94407. /**
  94408. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94409. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94410. */
  94411. get preserveParentRotationForBillboard(): boolean;
  94412. set preserveParentRotationForBillboard(value: boolean);
  94413. /**
  94414. * 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
  94415. */
  94416. scalingDeterminant: number;
  94417. private _infiniteDistance;
  94418. /**
  94419. * Gets or sets the distance of the object to max, often used by skybox
  94420. */
  94421. get infiniteDistance(): boolean;
  94422. set infiniteDistance(value: boolean);
  94423. /**
  94424. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94425. * By default the system will update normals to compensate
  94426. */
  94427. ignoreNonUniformScaling: boolean;
  94428. /**
  94429. * 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
  94430. */
  94431. reIntegrateRotationIntoRotationQuaternion: boolean;
  94432. /** @hidden */
  94433. _poseMatrix: Nullable<Matrix>;
  94434. /** @hidden */
  94435. _localMatrix: Matrix;
  94436. private _usePivotMatrix;
  94437. private _absolutePosition;
  94438. private _absoluteScaling;
  94439. private _absoluteRotationQuaternion;
  94440. private _pivotMatrix;
  94441. private _pivotMatrixInverse;
  94442. /** @hidden */
  94443. _postMultiplyPivotMatrix: boolean;
  94444. protected _isWorldMatrixFrozen: boolean;
  94445. /** @hidden */
  94446. _indexInSceneTransformNodesArray: number;
  94447. /**
  94448. * An event triggered after the world matrix is updated
  94449. */
  94450. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94451. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94452. /**
  94453. * Gets a string identifying the name of the class
  94454. * @returns "TransformNode" string
  94455. */
  94456. getClassName(): string;
  94457. /**
  94458. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94459. */
  94460. get position(): Vector3;
  94461. set position(newPosition: Vector3);
  94462. /**
  94463. * 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)).
  94464. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94465. */
  94466. get rotation(): Vector3;
  94467. set rotation(newRotation: Vector3);
  94468. /**
  94469. * 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)).
  94470. */
  94471. get scaling(): Vector3;
  94472. set scaling(newScaling: Vector3);
  94473. /**
  94474. * 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).
  94475. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94476. */
  94477. get rotationQuaternion(): Nullable<Quaternion>;
  94478. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94479. /**
  94480. * The forward direction of that transform in world space.
  94481. */
  94482. get forward(): Vector3;
  94483. /**
  94484. * The up direction of that transform in world space.
  94485. */
  94486. get up(): Vector3;
  94487. /**
  94488. * The right direction of that transform in world space.
  94489. */
  94490. get right(): Vector3;
  94491. /**
  94492. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94493. * @param matrix the matrix to copy the pose from
  94494. * @returns this TransformNode.
  94495. */
  94496. updatePoseMatrix(matrix: Matrix): TransformNode;
  94497. /**
  94498. * Returns the mesh Pose matrix.
  94499. * @returns the pose matrix
  94500. */
  94501. getPoseMatrix(): Matrix;
  94502. /** @hidden */
  94503. _isSynchronized(): boolean;
  94504. /** @hidden */
  94505. _initCache(): void;
  94506. /**
  94507. * Flag the transform node as dirty (Forcing it to update everything)
  94508. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94509. * @returns this transform node
  94510. */
  94511. markAsDirty(property: string): TransformNode;
  94512. /**
  94513. * Returns the current mesh absolute position.
  94514. * Returns a Vector3.
  94515. */
  94516. get absolutePosition(): Vector3;
  94517. /**
  94518. * Returns the current mesh absolute scaling.
  94519. * Returns a Vector3.
  94520. */
  94521. get absoluteScaling(): Vector3;
  94522. /**
  94523. * Returns the current mesh absolute rotation.
  94524. * Returns a Quaternion.
  94525. */
  94526. get absoluteRotationQuaternion(): Quaternion;
  94527. /**
  94528. * Sets a new matrix to apply before all other transformation
  94529. * @param matrix defines the transform matrix
  94530. * @returns the current TransformNode
  94531. */
  94532. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94533. /**
  94534. * Sets a new pivot matrix to the current node
  94535. * @param matrix defines the new pivot matrix to use
  94536. * @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
  94537. * @returns the current TransformNode
  94538. */
  94539. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94540. /**
  94541. * Returns the mesh pivot matrix.
  94542. * Default : Identity.
  94543. * @returns the matrix
  94544. */
  94545. getPivotMatrix(): Matrix;
  94546. /**
  94547. * Instantiate (when possible) or clone that node with its hierarchy
  94548. * @param newParent defines the new parent to use for the instance (or clone)
  94549. * @param options defines options to configure how copy is done
  94550. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94551. * @returns an instance (or a clone) of the current node with its hiearchy
  94552. */
  94553. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94554. doNotInstantiate: boolean;
  94555. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94556. /**
  94557. * Prevents the World matrix to be computed any longer
  94558. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94559. * @returns the TransformNode.
  94560. */
  94561. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94562. /**
  94563. * Allows back the World matrix computation.
  94564. * @returns the TransformNode.
  94565. */
  94566. unfreezeWorldMatrix(): this;
  94567. /**
  94568. * True if the World matrix has been frozen.
  94569. */
  94570. get isWorldMatrixFrozen(): boolean;
  94571. /**
  94572. * Retuns the mesh absolute position in the World.
  94573. * @returns a Vector3.
  94574. */
  94575. getAbsolutePosition(): Vector3;
  94576. /**
  94577. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94578. * @param absolutePosition the absolute position to set
  94579. * @returns the TransformNode.
  94580. */
  94581. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94582. /**
  94583. * Sets the mesh position in its local space.
  94584. * @param vector3 the position to set in localspace
  94585. * @returns the TransformNode.
  94586. */
  94587. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94588. /**
  94589. * Returns the mesh position in the local space from the current World matrix values.
  94590. * @returns a new Vector3.
  94591. */
  94592. getPositionExpressedInLocalSpace(): Vector3;
  94593. /**
  94594. * Translates the mesh along the passed Vector3 in its local space.
  94595. * @param vector3 the distance to translate in localspace
  94596. * @returns the TransformNode.
  94597. */
  94598. locallyTranslate(vector3: Vector3): TransformNode;
  94599. private static _lookAtVectorCache;
  94600. /**
  94601. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94602. * @param targetPoint the position (must be in same space as current mesh) to look at
  94603. * @param yawCor optional yaw (y-axis) correction in radians
  94604. * @param pitchCor optional pitch (x-axis) correction in radians
  94605. * @param rollCor optional roll (z-axis) correction in radians
  94606. * @param space the choosen space of the target
  94607. * @returns the TransformNode.
  94608. */
  94609. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94610. /**
  94611. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94612. * This Vector3 is expressed in the World space.
  94613. * @param localAxis axis to rotate
  94614. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94615. */
  94616. getDirection(localAxis: Vector3): Vector3;
  94617. /**
  94618. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94619. * localAxis is expressed in the mesh local space.
  94620. * result is computed in the Wordl space from the mesh World matrix.
  94621. * @param localAxis axis to rotate
  94622. * @param result the resulting transformnode
  94623. * @returns this TransformNode.
  94624. */
  94625. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94626. /**
  94627. * Sets this transform node rotation to the given local axis.
  94628. * @param localAxis the axis in local space
  94629. * @param yawCor optional yaw (y-axis) correction in radians
  94630. * @param pitchCor optional pitch (x-axis) correction in radians
  94631. * @param rollCor optional roll (z-axis) correction in radians
  94632. * @returns this TransformNode
  94633. */
  94634. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94635. /**
  94636. * Sets a new pivot point to the current node
  94637. * @param point defines the new pivot point to use
  94638. * @param space defines if the point is in world or local space (local by default)
  94639. * @returns the current TransformNode
  94640. */
  94641. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94642. /**
  94643. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94644. * @returns the pivot point
  94645. */
  94646. getPivotPoint(): Vector3;
  94647. /**
  94648. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94649. * @param result the vector3 to store the result
  94650. * @returns this TransformNode.
  94651. */
  94652. getPivotPointToRef(result: Vector3): TransformNode;
  94653. /**
  94654. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94655. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94656. */
  94657. getAbsolutePivotPoint(): Vector3;
  94658. /**
  94659. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94660. * @param result vector3 to store the result
  94661. * @returns this TransformNode.
  94662. */
  94663. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94664. /**
  94665. * Defines the passed node as the parent of the current node.
  94666. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94667. * @see https://doc.babylonjs.com/how_to/parenting
  94668. * @param node the node ot set as the parent
  94669. * @returns this TransformNode.
  94670. */
  94671. setParent(node: Nullable<Node>): TransformNode;
  94672. private _nonUniformScaling;
  94673. /**
  94674. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94675. */
  94676. get nonUniformScaling(): boolean;
  94677. /** @hidden */
  94678. _updateNonUniformScalingState(value: boolean): boolean;
  94679. /**
  94680. * Attach the current TransformNode to another TransformNode associated with a bone
  94681. * @param bone Bone affecting the TransformNode
  94682. * @param affectedTransformNode TransformNode associated with the bone
  94683. * @returns this object
  94684. */
  94685. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94686. /**
  94687. * Detach the transform node if its associated with a bone
  94688. * @returns this object
  94689. */
  94690. detachFromBone(): TransformNode;
  94691. private static _rotationAxisCache;
  94692. /**
  94693. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94694. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94695. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94696. * The passed axis is also normalized.
  94697. * @param axis the axis to rotate around
  94698. * @param amount the amount to rotate in radians
  94699. * @param space Space to rotate in (Default: local)
  94700. * @returns the TransformNode.
  94701. */
  94702. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94703. /**
  94704. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94705. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94706. * The passed axis is also normalized. .
  94707. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94708. * @param point the point to rotate around
  94709. * @param axis the axis to rotate around
  94710. * @param amount the amount to rotate in radians
  94711. * @returns the TransformNode
  94712. */
  94713. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94714. /**
  94715. * Translates the mesh along the axis vector for the passed distance in the given space.
  94716. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94717. * @param axis the axis to translate in
  94718. * @param distance the distance to translate
  94719. * @param space Space to rotate in (Default: local)
  94720. * @returns the TransformNode.
  94721. */
  94722. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94723. /**
  94724. * Adds a rotation step to the mesh current rotation.
  94725. * x, y, z are Euler angles expressed in radians.
  94726. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94727. * This means this rotation is made in the mesh local space only.
  94728. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94729. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94730. * ```javascript
  94731. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94732. * ```
  94733. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94734. * 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.
  94735. * @param x Rotation to add
  94736. * @param y Rotation to add
  94737. * @param z Rotation to add
  94738. * @returns the TransformNode.
  94739. */
  94740. addRotation(x: number, y: number, z: number): TransformNode;
  94741. /**
  94742. * @hidden
  94743. */
  94744. protected _getEffectiveParent(): Nullable<Node>;
  94745. /**
  94746. * Computes the world matrix of the node
  94747. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94748. * @returns the world matrix
  94749. */
  94750. computeWorldMatrix(force?: boolean): Matrix;
  94751. /**
  94752. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94753. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94754. */
  94755. resetLocalMatrix(independentOfChildren?: boolean): void;
  94756. protected _afterComputeWorldMatrix(): void;
  94757. /**
  94758. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94759. * @param func callback function to add
  94760. *
  94761. * @returns the TransformNode.
  94762. */
  94763. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94764. /**
  94765. * Removes a registered callback function.
  94766. * @param func callback function to remove
  94767. * @returns the TransformNode.
  94768. */
  94769. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94770. /**
  94771. * Gets the position of the current mesh in camera space
  94772. * @param camera defines the camera to use
  94773. * @returns a position
  94774. */
  94775. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94776. /**
  94777. * Returns the distance from the mesh to the active camera
  94778. * @param camera defines the camera to use
  94779. * @returns the distance
  94780. */
  94781. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94782. /**
  94783. * Clone the current transform node
  94784. * @param name Name of the new clone
  94785. * @param newParent New parent for the clone
  94786. * @param doNotCloneChildren Do not clone children hierarchy
  94787. * @returns the new transform node
  94788. */
  94789. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94790. /**
  94791. * Serializes the objects information.
  94792. * @param currentSerializationObject defines the object to serialize in
  94793. * @returns the serialized object
  94794. */
  94795. serialize(currentSerializationObject?: any): any;
  94796. /**
  94797. * Returns a new TransformNode object parsed from the source provided.
  94798. * @param parsedTransformNode is the source.
  94799. * @param scene the scne the object belongs to
  94800. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94801. * @returns a new TransformNode object parsed from the source provided.
  94802. */
  94803. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94804. /**
  94805. * Get all child-transformNodes of this node
  94806. * @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
  94807. * @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
  94808. * @returns an array of TransformNode
  94809. */
  94810. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94811. /**
  94812. * Releases resources associated with this transform node.
  94813. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94814. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94815. */
  94816. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94817. /**
  94818. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94819. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94820. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94821. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94822. * @returns the current mesh
  94823. */
  94824. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94825. private _syncAbsoluteScalingAndRotation;
  94826. }
  94827. }
  94828. declare module BABYLON {
  94829. /**
  94830. * Class used to override all child animations of a given target
  94831. */
  94832. export class AnimationPropertiesOverride {
  94833. /**
  94834. * Gets or sets a value indicating if animation blending must be used
  94835. */
  94836. enableBlending: boolean;
  94837. /**
  94838. * Gets or sets the blending speed to use when enableBlending is true
  94839. */
  94840. blendingSpeed: number;
  94841. /**
  94842. * Gets or sets the default loop mode to use
  94843. */
  94844. loopMode: number;
  94845. }
  94846. }
  94847. declare module BABYLON {
  94848. /**
  94849. * Class used to store bone information
  94850. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94851. */
  94852. export class Bone extends Node {
  94853. /**
  94854. * defines the bone name
  94855. */
  94856. name: string;
  94857. private static _tmpVecs;
  94858. private static _tmpQuat;
  94859. private static _tmpMats;
  94860. /**
  94861. * Gets the list of child bones
  94862. */
  94863. children: Bone[];
  94864. /** Gets the animations associated with this bone */
  94865. animations: Animation[];
  94866. /**
  94867. * Gets or sets bone length
  94868. */
  94869. length: number;
  94870. /**
  94871. * @hidden Internal only
  94872. * Set this value to map this bone to a different index in the transform matrices
  94873. * Set this value to -1 to exclude the bone from the transform matrices
  94874. */
  94875. _index: Nullable<number>;
  94876. private _skeleton;
  94877. private _localMatrix;
  94878. private _restPose;
  94879. private _bindPose;
  94880. private _baseMatrix;
  94881. private _absoluteTransform;
  94882. private _invertedAbsoluteTransform;
  94883. private _parent;
  94884. private _scalingDeterminant;
  94885. private _worldTransform;
  94886. private _localScaling;
  94887. private _localRotation;
  94888. private _localPosition;
  94889. private _needToDecompose;
  94890. private _needToCompose;
  94891. /** @hidden */
  94892. _linkedTransformNode: Nullable<TransformNode>;
  94893. /** @hidden */
  94894. _waitingTransformNodeId: Nullable<string>;
  94895. /** @hidden */
  94896. get _matrix(): Matrix;
  94897. /** @hidden */
  94898. set _matrix(value: Matrix);
  94899. /**
  94900. * Create a new bone
  94901. * @param name defines the bone name
  94902. * @param skeleton defines the parent skeleton
  94903. * @param parentBone defines the parent (can be null if the bone is the root)
  94904. * @param localMatrix defines the local matrix
  94905. * @param restPose defines the rest pose matrix
  94906. * @param baseMatrix defines the base matrix
  94907. * @param index defines index of the bone in the hiearchy
  94908. */
  94909. constructor(
  94910. /**
  94911. * defines the bone name
  94912. */
  94913. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94914. /**
  94915. * Gets the current object class name.
  94916. * @return the class name
  94917. */
  94918. getClassName(): string;
  94919. /**
  94920. * Gets the parent skeleton
  94921. * @returns a skeleton
  94922. */
  94923. getSkeleton(): Skeleton;
  94924. /**
  94925. * Gets parent bone
  94926. * @returns a bone or null if the bone is the root of the bone hierarchy
  94927. */
  94928. getParent(): Nullable<Bone>;
  94929. /**
  94930. * Returns an array containing the root bones
  94931. * @returns an array containing the root bones
  94932. */
  94933. getChildren(): Array<Bone>;
  94934. /**
  94935. * Gets the node index in matrix array generated for rendering
  94936. * @returns the node index
  94937. */
  94938. getIndex(): number;
  94939. /**
  94940. * Sets the parent bone
  94941. * @param parent defines the parent (can be null if the bone is the root)
  94942. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94943. */
  94944. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94945. /**
  94946. * Gets the local matrix
  94947. * @returns a matrix
  94948. */
  94949. getLocalMatrix(): Matrix;
  94950. /**
  94951. * Gets the base matrix (initial matrix which remains unchanged)
  94952. * @returns a matrix
  94953. */
  94954. getBaseMatrix(): Matrix;
  94955. /**
  94956. * Gets the rest pose matrix
  94957. * @returns a matrix
  94958. */
  94959. getRestPose(): Matrix;
  94960. /**
  94961. * Sets the rest pose matrix
  94962. * @param matrix the local-space rest pose to set for this bone
  94963. */
  94964. setRestPose(matrix: Matrix): void;
  94965. /**
  94966. * Gets the bind pose matrix
  94967. * @returns the bind pose matrix
  94968. */
  94969. getBindPose(): Matrix;
  94970. /**
  94971. * Sets the bind pose matrix
  94972. * @param matrix the local-space bind pose to set for this bone
  94973. */
  94974. setBindPose(matrix: Matrix): void;
  94975. /**
  94976. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94977. */
  94978. getWorldMatrix(): Matrix;
  94979. /**
  94980. * Sets the local matrix to rest pose matrix
  94981. */
  94982. returnToRest(): void;
  94983. /**
  94984. * Gets the inverse of the absolute transform matrix.
  94985. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94986. * @returns a matrix
  94987. */
  94988. getInvertedAbsoluteTransform(): Matrix;
  94989. /**
  94990. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94991. * @returns a matrix
  94992. */
  94993. getAbsoluteTransform(): Matrix;
  94994. /**
  94995. * Links with the given transform node.
  94996. * The local matrix of this bone is copied from the transform node every frame.
  94997. * @param transformNode defines the transform node to link to
  94998. */
  94999. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  95000. /**
  95001. * Gets the node used to drive the bone's transformation
  95002. * @returns a transform node or null
  95003. */
  95004. getTransformNode(): Nullable<TransformNode>;
  95005. /** Gets or sets current position (in local space) */
  95006. get position(): Vector3;
  95007. set position(newPosition: Vector3);
  95008. /** Gets or sets current rotation (in local space) */
  95009. get rotation(): Vector3;
  95010. set rotation(newRotation: Vector3);
  95011. /** Gets or sets current rotation quaternion (in local space) */
  95012. get rotationQuaternion(): Quaternion;
  95013. set rotationQuaternion(newRotation: Quaternion);
  95014. /** Gets or sets current scaling (in local space) */
  95015. get scaling(): Vector3;
  95016. set scaling(newScaling: Vector3);
  95017. /**
  95018. * Gets the animation properties override
  95019. */
  95020. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95021. private _decompose;
  95022. private _compose;
  95023. /**
  95024. * Update the base and local matrices
  95025. * @param matrix defines the new base or local matrix
  95026. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95027. * @param updateLocalMatrix defines if the local matrix should be updated
  95028. */
  95029. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  95030. /** @hidden */
  95031. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  95032. /**
  95033. * Flag the bone as dirty (Forcing it to update everything)
  95034. */
  95035. markAsDirty(): void;
  95036. /** @hidden */
  95037. _markAsDirtyAndCompose(): void;
  95038. private _markAsDirtyAndDecompose;
  95039. /**
  95040. * Translate the bone in local or world space
  95041. * @param vec The amount to translate the bone
  95042. * @param space The space that the translation is in
  95043. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95044. */
  95045. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95046. /**
  95047. * Set the postion of the bone in local or world space
  95048. * @param position The position to set the bone
  95049. * @param space The space that the position is in
  95050. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95051. */
  95052. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95053. /**
  95054. * Set the absolute position of the bone (world space)
  95055. * @param position The position to set the bone
  95056. * @param mesh The mesh that this bone is attached to
  95057. */
  95058. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  95059. /**
  95060. * Scale the bone on the x, y and z axes (in local space)
  95061. * @param x The amount to scale the bone on the x axis
  95062. * @param y The amount to scale the bone on the y axis
  95063. * @param z The amount to scale the bone on the z axis
  95064. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  95065. */
  95066. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  95067. /**
  95068. * Set the bone scaling in local space
  95069. * @param scale defines the scaling vector
  95070. */
  95071. setScale(scale: Vector3): void;
  95072. /**
  95073. * Gets the current scaling in local space
  95074. * @returns the current scaling vector
  95075. */
  95076. getScale(): Vector3;
  95077. /**
  95078. * Gets the current scaling in local space and stores it in a target vector
  95079. * @param result defines the target vector
  95080. */
  95081. getScaleToRef(result: Vector3): void;
  95082. /**
  95083. * Set the yaw, pitch, and roll of the bone in local or world space
  95084. * @param yaw The rotation of the bone on the y axis
  95085. * @param pitch The rotation of the bone on the x axis
  95086. * @param roll The rotation of the bone on the z axis
  95087. * @param space The space that the axes of rotation are in
  95088. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95089. */
  95090. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95091. /**
  95092. * Add a rotation to the bone on an axis in local or world space
  95093. * @param axis The axis to rotate the bone on
  95094. * @param amount The amount to rotate the bone
  95095. * @param space The space that the axis is in
  95096. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95097. */
  95098. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95099. /**
  95100. * Set the rotation of the bone to a particular axis angle in local or world space
  95101. * @param axis The axis to rotate the bone on
  95102. * @param angle The angle that the bone should be rotated to
  95103. * @param space The space that the axis is in
  95104. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95105. */
  95106. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95107. /**
  95108. * Set the euler rotation of the bone in local of world space
  95109. * @param rotation The euler rotation that the bone should be set to
  95110. * @param space The space that the rotation is in
  95111. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95112. */
  95113. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95114. /**
  95115. * Set the quaternion rotation of the bone in local of world space
  95116. * @param quat The quaternion rotation that the bone should be set to
  95117. * @param space The space that the rotation is in
  95118. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95119. */
  95120. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95121. /**
  95122. * Set the rotation matrix of the bone in local of world space
  95123. * @param rotMat The rotation matrix that the bone should be set to
  95124. * @param space The space that the rotation is in
  95125. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95126. */
  95127. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95128. private _rotateWithMatrix;
  95129. private _getNegativeRotationToRef;
  95130. /**
  95131. * Get the position of the bone in local or world space
  95132. * @param space The space that the returned position is in
  95133. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95134. * @returns The position of the bone
  95135. */
  95136. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95137. /**
  95138. * Copy the position of the bone to a vector3 in local or world space
  95139. * @param space The space that the returned position is in
  95140. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95141. * @param result The vector3 to copy the position to
  95142. */
  95143. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95144. /**
  95145. * Get the absolute position of the bone (world space)
  95146. * @param mesh The mesh that this bone is attached to
  95147. * @returns The absolute position of the bone
  95148. */
  95149. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95150. /**
  95151. * Copy the absolute position of the bone (world space) to the result param
  95152. * @param mesh The mesh that this bone is attached to
  95153. * @param result The vector3 to copy the absolute position to
  95154. */
  95155. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95156. /**
  95157. * Compute the absolute transforms of this bone and its children
  95158. */
  95159. computeAbsoluteTransforms(): void;
  95160. /**
  95161. * Get the world direction from an axis that is in the local space of the bone
  95162. * @param localAxis The local direction that is used to compute the world direction
  95163. * @param mesh The mesh that this bone is attached to
  95164. * @returns The world direction
  95165. */
  95166. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95167. /**
  95168. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95169. * @param localAxis The local direction that is used to compute the world direction
  95170. * @param mesh The mesh that this bone is attached to
  95171. * @param result The vector3 that the world direction will be copied to
  95172. */
  95173. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95174. /**
  95175. * Get the euler rotation of the bone in local or world space
  95176. * @param space The space that the rotation should be in
  95177. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95178. * @returns The euler rotation
  95179. */
  95180. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95181. /**
  95182. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95183. * @param space The space that the rotation should be in
  95184. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95185. * @param result The vector3 that the rotation should be copied to
  95186. */
  95187. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95188. /**
  95189. * Get the quaternion rotation of the bone in either local or world space
  95190. * @param space The space that the rotation should be in
  95191. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95192. * @returns The quaternion rotation
  95193. */
  95194. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95195. /**
  95196. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95197. * @param space The space that the rotation should be in
  95198. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95199. * @param result The quaternion that the rotation should be copied to
  95200. */
  95201. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95202. /**
  95203. * Get the rotation matrix of the bone in local or world space
  95204. * @param space The space that the rotation should be in
  95205. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95206. * @returns The rotation matrix
  95207. */
  95208. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95209. /**
  95210. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95211. * @param space The space that the rotation should be in
  95212. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95213. * @param result The quaternion that the rotation should be copied to
  95214. */
  95215. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95216. /**
  95217. * Get the world position of a point that is in the local space of the bone
  95218. * @param position The local position
  95219. * @param mesh The mesh that this bone is attached to
  95220. * @returns The world position
  95221. */
  95222. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95223. /**
  95224. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95225. * @param position The local position
  95226. * @param mesh The mesh that this bone is attached to
  95227. * @param result The vector3 that the world position should be copied to
  95228. */
  95229. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95230. /**
  95231. * Get the local position of a point that is in world space
  95232. * @param position The world position
  95233. * @param mesh The mesh that this bone is attached to
  95234. * @returns The local position
  95235. */
  95236. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95237. /**
  95238. * Get the local position of a point that is in world space and copy it to the result param
  95239. * @param position The world position
  95240. * @param mesh The mesh that this bone is attached to
  95241. * @param result The vector3 that the local position should be copied to
  95242. */
  95243. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95244. }
  95245. }
  95246. declare module BABYLON {
  95247. /**
  95248. * Defines a runtime animation
  95249. */
  95250. export class RuntimeAnimation {
  95251. private _events;
  95252. /**
  95253. * The current frame of the runtime animation
  95254. */
  95255. private _currentFrame;
  95256. /**
  95257. * The animation used by the runtime animation
  95258. */
  95259. private _animation;
  95260. /**
  95261. * The target of the runtime animation
  95262. */
  95263. private _target;
  95264. /**
  95265. * The initiating animatable
  95266. */
  95267. private _host;
  95268. /**
  95269. * The original value of the runtime animation
  95270. */
  95271. private _originalValue;
  95272. /**
  95273. * The original blend value of the runtime animation
  95274. */
  95275. private _originalBlendValue;
  95276. /**
  95277. * The offsets cache of the runtime animation
  95278. */
  95279. private _offsetsCache;
  95280. /**
  95281. * The high limits cache of the runtime animation
  95282. */
  95283. private _highLimitsCache;
  95284. /**
  95285. * Specifies if the runtime animation has been stopped
  95286. */
  95287. private _stopped;
  95288. /**
  95289. * The blending factor of the runtime animation
  95290. */
  95291. private _blendingFactor;
  95292. /**
  95293. * The BabylonJS scene
  95294. */
  95295. private _scene;
  95296. /**
  95297. * The current value of the runtime animation
  95298. */
  95299. private _currentValue;
  95300. /** @hidden */
  95301. _animationState: _IAnimationState;
  95302. /**
  95303. * The active target of the runtime animation
  95304. */
  95305. private _activeTargets;
  95306. private _currentActiveTarget;
  95307. private _directTarget;
  95308. /**
  95309. * The target path of the runtime animation
  95310. */
  95311. private _targetPath;
  95312. /**
  95313. * The weight of the runtime animation
  95314. */
  95315. private _weight;
  95316. /**
  95317. * The ratio offset of the runtime animation
  95318. */
  95319. private _ratioOffset;
  95320. /**
  95321. * The previous delay of the runtime animation
  95322. */
  95323. private _previousDelay;
  95324. /**
  95325. * The previous ratio of the runtime animation
  95326. */
  95327. private _previousRatio;
  95328. private _enableBlending;
  95329. private _keys;
  95330. private _minFrame;
  95331. private _maxFrame;
  95332. private _minValue;
  95333. private _maxValue;
  95334. private _targetIsArray;
  95335. /**
  95336. * Gets the current frame of the runtime animation
  95337. */
  95338. get currentFrame(): number;
  95339. /**
  95340. * Gets the weight of the runtime animation
  95341. */
  95342. get weight(): number;
  95343. /**
  95344. * Gets the current value of the runtime animation
  95345. */
  95346. get currentValue(): any;
  95347. /**
  95348. * Gets the target path of the runtime animation
  95349. */
  95350. get targetPath(): string;
  95351. /**
  95352. * Gets the actual target of the runtime animation
  95353. */
  95354. get target(): any;
  95355. /**
  95356. * Gets the additive state of the runtime animation
  95357. */
  95358. get isAdditive(): boolean;
  95359. /** @hidden */
  95360. _onLoop: () => void;
  95361. /**
  95362. * Create a new RuntimeAnimation object
  95363. * @param target defines the target of the animation
  95364. * @param animation defines the source animation object
  95365. * @param scene defines the hosting scene
  95366. * @param host defines the initiating Animatable
  95367. */
  95368. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95369. private _preparePath;
  95370. /**
  95371. * Gets the animation from the runtime animation
  95372. */
  95373. get animation(): Animation;
  95374. /**
  95375. * Resets the runtime animation to the beginning
  95376. * @param restoreOriginal defines whether to restore the target property to the original value
  95377. */
  95378. reset(restoreOriginal?: boolean): void;
  95379. /**
  95380. * Specifies if the runtime animation is stopped
  95381. * @returns Boolean specifying if the runtime animation is stopped
  95382. */
  95383. isStopped(): boolean;
  95384. /**
  95385. * Disposes of the runtime animation
  95386. */
  95387. dispose(): void;
  95388. /**
  95389. * Apply the interpolated value to the target
  95390. * @param currentValue defines the value computed by the animation
  95391. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95392. */
  95393. setValue(currentValue: any, weight: number): void;
  95394. private _getOriginalValues;
  95395. private _setValue;
  95396. /**
  95397. * Gets the loop pmode of the runtime animation
  95398. * @returns Loop Mode
  95399. */
  95400. private _getCorrectLoopMode;
  95401. /**
  95402. * Move the current animation to a given frame
  95403. * @param frame defines the frame to move to
  95404. */
  95405. goToFrame(frame: number): void;
  95406. /**
  95407. * @hidden Internal use only
  95408. */
  95409. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95410. /**
  95411. * Execute the current animation
  95412. * @param delay defines the delay to add to the current frame
  95413. * @param from defines the lower bound of the animation range
  95414. * @param to defines the upper bound of the animation range
  95415. * @param loop defines if the current animation must loop
  95416. * @param speedRatio defines the current speed ratio
  95417. * @param weight defines the weight of the animation (default is -1 so no weight)
  95418. * @param onLoop optional callback called when animation loops
  95419. * @returns a boolean indicating if the animation is running
  95420. */
  95421. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95422. }
  95423. }
  95424. declare module BABYLON {
  95425. /**
  95426. * Class used to store an actual running animation
  95427. */
  95428. export class Animatable {
  95429. /** defines the target object */
  95430. target: any;
  95431. /** defines the starting frame number (default is 0) */
  95432. fromFrame: number;
  95433. /** defines the ending frame number (default is 100) */
  95434. toFrame: number;
  95435. /** defines if the animation must loop (default is false) */
  95436. loopAnimation: boolean;
  95437. /** defines a callback to call when animation ends if it is not looping */
  95438. onAnimationEnd?: (() => void) | null | undefined;
  95439. /** defines a callback to call when animation loops */
  95440. onAnimationLoop?: (() => void) | null | undefined;
  95441. /** defines whether the animation should be evaluated additively */
  95442. isAdditive: boolean;
  95443. private _localDelayOffset;
  95444. private _pausedDelay;
  95445. private _runtimeAnimations;
  95446. private _paused;
  95447. private _scene;
  95448. private _speedRatio;
  95449. private _weight;
  95450. private _syncRoot;
  95451. /**
  95452. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95453. * This will only apply for non looping animation (default is true)
  95454. */
  95455. disposeOnEnd: boolean;
  95456. /**
  95457. * Gets a boolean indicating if the animation has started
  95458. */
  95459. animationStarted: boolean;
  95460. /**
  95461. * Observer raised when the animation ends
  95462. */
  95463. onAnimationEndObservable: Observable<Animatable>;
  95464. /**
  95465. * Observer raised when the animation loops
  95466. */
  95467. onAnimationLoopObservable: Observable<Animatable>;
  95468. /**
  95469. * Gets the root Animatable used to synchronize and normalize animations
  95470. */
  95471. get syncRoot(): Nullable<Animatable>;
  95472. /**
  95473. * Gets the current frame of the first RuntimeAnimation
  95474. * Used to synchronize Animatables
  95475. */
  95476. get masterFrame(): number;
  95477. /**
  95478. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95479. */
  95480. get weight(): number;
  95481. set weight(value: number);
  95482. /**
  95483. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95484. */
  95485. get speedRatio(): number;
  95486. set speedRatio(value: number);
  95487. /**
  95488. * Creates a new Animatable
  95489. * @param scene defines the hosting scene
  95490. * @param target defines the target object
  95491. * @param fromFrame defines the starting frame number (default is 0)
  95492. * @param toFrame defines the ending frame number (default is 100)
  95493. * @param loopAnimation defines if the animation must loop (default is false)
  95494. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95495. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95496. * @param animations defines a group of animation to add to the new Animatable
  95497. * @param onAnimationLoop defines a callback to call when animation loops
  95498. * @param isAdditive defines whether the animation should be evaluated additively
  95499. */
  95500. constructor(scene: Scene,
  95501. /** defines the target object */
  95502. target: any,
  95503. /** defines the starting frame number (default is 0) */
  95504. fromFrame?: number,
  95505. /** defines the ending frame number (default is 100) */
  95506. toFrame?: number,
  95507. /** defines if the animation must loop (default is false) */
  95508. loopAnimation?: boolean, speedRatio?: number,
  95509. /** defines a callback to call when animation ends if it is not looping */
  95510. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95511. /** defines a callback to call when animation loops */
  95512. onAnimationLoop?: (() => void) | null | undefined,
  95513. /** defines whether the animation should be evaluated additively */
  95514. isAdditive?: boolean);
  95515. /**
  95516. * Synchronize and normalize current Animatable with a source Animatable
  95517. * This is useful when using animation weights and when animations are not of the same length
  95518. * @param root defines the root Animatable to synchronize with
  95519. * @returns the current Animatable
  95520. */
  95521. syncWith(root: Animatable): Animatable;
  95522. /**
  95523. * Gets the list of runtime animations
  95524. * @returns an array of RuntimeAnimation
  95525. */
  95526. getAnimations(): RuntimeAnimation[];
  95527. /**
  95528. * Adds more animations to the current animatable
  95529. * @param target defines the target of the animations
  95530. * @param animations defines the new animations to add
  95531. */
  95532. appendAnimations(target: any, animations: Animation[]): void;
  95533. /**
  95534. * Gets the source animation for a specific property
  95535. * @param property defines the propertyu to look for
  95536. * @returns null or the source animation for the given property
  95537. */
  95538. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95539. /**
  95540. * Gets the runtime animation for a specific property
  95541. * @param property defines the propertyu to look for
  95542. * @returns null or the runtime animation for the given property
  95543. */
  95544. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95545. /**
  95546. * Resets the animatable to its original state
  95547. */
  95548. reset(): void;
  95549. /**
  95550. * Allows the animatable to blend with current running animations
  95551. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95552. * @param blendingSpeed defines the blending speed to use
  95553. */
  95554. enableBlending(blendingSpeed: number): void;
  95555. /**
  95556. * Disable animation blending
  95557. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95558. */
  95559. disableBlending(): void;
  95560. /**
  95561. * Jump directly to a given frame
  95562. * @param frame defines the frame to jump to
  95563. */
  95564. goToFrame(frame: number): void;
  95565. /**
  95566. * Pause the animation
  95567. */
  95568. pause(): void;
  95569. /**
  95570. * Restart the animation
  95571. */
  95572. restart(): void;
  95573. private _raiseOnAnimationEnd;
  95574. /**
  95575. * Stop and delete the current animation
  95576. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95577. * @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)
  95578. */
  95579. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95580. /**
  95581. * Wait asynchronously for the animation to end
  95582. * @returns a promise which will be fullfilled when the animation ends
  95583. */
  95584. waitAsync(): Promise<Animatable>;
  95585. /** @hidden */
  95586. _animate(delay: number): boolean;
  95587. }
  95588. interface Scene {
  95589. /** @hidden */
  95590. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95591. /** @hidden */
  95592. _processLateAnimationBindingsForMatrices(holder: {
  95593. totalWeight: number;
  95594. totalAdditiveWeight: number;
  95595. animations: RuntimeAnimation[];
  95596. additiveAnimations: RuntimeAnimation[];
  95597. originalValue: Matrix;
  95598. }): any;
  95599. /** @hidden */
  95600. _processLateAnimationBindingsForQuaternions(holder: {
  95601. totalWeight: number;
  95602. totalAdditiveWeight: number;
  95603. animations: RuntimeAnimation[];
  95604. additiveAnimations: RuntimeAnimation[];
  95605. originalValue: Quaternion;
  95606. }, refQuaternion: Quaternion): Quaternion;
  95607. /** @hidden */
  95608. _processLateAnimationBindings(): void;
  95609. /**
  95610. * Will start the animation sequence of a given target
  95611. * @param target defines the target
  95612. * @param from defines from which frame should animation start
  95613. * @param to defines until which frame should animation run.
  95614. * @param weight defines the weight to apply to the animation (1.0 by default)
  95615. * @param loop defines if the animation loops
  95616. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95617. * @param onAnimationEnd defines the function to be executed when the animation ends
  95618. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95619. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95620. * @param onAnimationLoop defines the callback to call when an animation loops
  95621. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95622. * @returns the animatable object created for this animation
  95623. */
  95624. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95625. /**
  95626. * Will start the animation sequence of a given target
  95627. * @param target defines the target
  95628. * @param from defines from which frame should animation start
  95629. * @param to defines until which frame should animation run.
  95630. * @param loop defines if the animation loops
  95631. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95632. * @param onAnimationEnd defines the function to be executed when the animation ends
  95633. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95634. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95635. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95636. * @param onAnimationLoop defines the callback to call when an animation loops
  95637. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95638. * @returns the animatable object created for this animation
  95639. */
  95640. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95641. /**
  95642. * Will start the animation sequence of a given target and its hierarchy
  95643. * @param target defines the target
  95644. * @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.
  95645. * @param from defines from which frame should animation start
  95646. * @param to defines until which frame should animation run.
  95647. * @param loop defines if the animation loops
  95648. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95649. * @param onAnimationEnd defines the function to be executed when the animation ends
  95650. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95651. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95652. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95653. * @param onAnimationLoop defines the callback to call when an animation loops
  95654. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95655. * @returns the list of created animatables
  95656. */
  95657. 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, isAdditive?: boolean): Animatable[];
  95658. /**
  95659. * Begin a new animation on a given node
  95660. * @param target defines the target where the animation will take place
  95661. * @param animations defines the list of animations to start
  95662. * @param from defines the initial value
  95663. * @param to defines the final value
  95664. * @param loop defines if you want animation to loop (off by default)
  95665. * @param speedRatio defines the speed ratio to apply to all animations
  95666. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95667. * @param onAnimationLoop defines the callback to call when an animation loops
  95668. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95669. * @returns the list of created animatables
  95670. */
  95671. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95672. /**
  95673. * Begin a new animation on a given node and its hierarchy
  95674. * @param target defines the root node where the animation will take place
  95675. * @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.
  95676. * @param animations defines the list of animations to start
  95677. * @param from defines the initial value
  95678. * @param to defines the final value
  95679. * @param loop defines if you want animation to loop (off by default)
  95680. * @param speedRatio defines the speed ratio to apply to all animations
  95681. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95682. * @param onAnimationLoop defines the callback to call when an animation loops
  95683. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95684. * @returns the list of animatables created for all nodes
  95685. */
  95686. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95687. /**
  95688. * Gets the animatable associated with a specific target
  95689. * @param target defines the target of the animatable
  95690. * @returns the required animatable if found
  95691. */
  95692. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95693. /**
  95694. * Gets all animatables associated with a given target
  95695. * @param target defines the target to look animatables for
  95696. * @returns an array of Animatables
  95697. */
  95698. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95699. /**
  95700. * Stops and removes all animations that have been applied to the scene
  95701. */
  95702. stopAllAnimations(): void;
  95703. /**
  95704. * Gets the current delta time used by animation engine
  95705. */
  95706. deltaTime: number;
  95707. }
  95708. interface Bone {
  95709. /**
  95710. * Copy an animation range from another bone
  95711. * @param source defines the source bone
  95712. * @param rangeName defines the range name to copy
  95713. * @param frameOffset defines the frame offset
  95714. * @param rescaleAsRequired defines if rescaling must be applied if required
  95715. * @param skelDimensionsRatio defines the scaling ratio
  95716. * @returns true if operation was successful
  95717. */
  95718. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95719. }
  95720. }
  95721. declare module BABYLON {
  95722. /**
  95723. * Class used to handle skinning animations
  95724. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95725. */
  95726. export class Skeleton implements IAnimatable {
  95727. /** defines the skeleton name */
  95728. name: string;
  95729. /** defines the skeleton Id */
  95730. id: string;
  95731. /**
  95732. * Defines the list of child bones
  95733. */
  95734. bones: Bone[];
  95735. /**
  95736. * Defines an estimate of the dimension of the skeleton at rest
  95737. */
  95738. dimensionsAtRest: Vector3;
  95739. /**
  95740. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95741. */
  95742. needInitialSkinMatrix: boolean;
  95743. /**
  95744. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95745. */
  95746. overrideMesh: Nullable<AbstractMesh>;
  95747. /**
  95748. * Gets the list of animations attached to this skeleton
  95749. */
  95750. animations: Array<Animation>;
  95751. private _scene;
  95752. private _isDirty;
  95753. private _transformMatrices;
  95754. private _transformMatrixTexture;
  95755. private _meshesWithPoseMatrix;
  95756. private _animatables;
  95757. private _identity;
  95758. private _synchronizedWithMesh;
  95759. private _ranges;
  95760. private _lastAbsoluteTransformsUpdateId;
  95761. private _canUseTextureForBones;
  95762. private _uniqueId;
  95763. /** @hidden */
  95764. _numBonesWithLinkedTransformNode: number;
  95765. /** @hidden */
  95766. _hasWaitingData: Nullable<boolean>;
  95767. /** @hidden */
  95768. _waitingOverrideMeshId: Nullable<string>;
  95769. /**
  95770. * Specifies if the skeleton should be serialized
  95771. */
  95772. doNotSerialize: boolean;
  95773. private _useTextureToStoreBoneMatrices;
  95774. /**
  95775. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95776. * Please note that this option is not available if the hardware does not support it
  95777. */
  95778. get useTextureToStoreBoneMatrices(): boolean;
  95779. set useTextureToStoreBoneMatrices(value: boolean);
  95780. private _animationPropertiesOverride;
  95781. /**
  95782. * Gets or sets the animation properties override
  95783. */
  95784. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95785. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95786. /**
  95787. * List of inspectable custom properties (used by the Inspector)
  95788. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95789. */
  95790. inspectableCustomProperties: IInspectable[];
  95791. /**
  95792. * An observable triggered before computing the skeleton's matrices
  95793. */
  95794. onBeforeComputeObservable: Observable<Skeleton>;
  95795. /**
  95796. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95797. */
  95798. get isUsingTextureForMatrices(): boolean;
  95799. /**
  95800. * Gets the unique ID of this skeleton
  95801. */
  95802. get uniqueId(): number;
  95803. /**
  95804. * Creates a new skeleton
  95805. * @param name defines the skeleton name
  95806. * @param id defines the skeleton Id
  95807. * @param scene defines the hosting scene
  95808. */
  95809. constructor(
  95810. /** defines the skeleton name */
  95811. name: string,
  95812. /** defines the skeleton Id */
  95813. id: string, scene: Scene);
  95814. /**
  95815. * Gets the current object class name.
  95816. * @return the class name
  95817. */
  95818. getClassName(): string;
  95819. /**
  95820. * Returns an array containing the root bones
  95821. * @returns an array containing the root bones
  95822. */
  95823. getChildren(): Array<Bone>;
  95824. /**
  95825. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95826. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95827. * @returns a Float32Array containing matrices data
  95828. */
  95829. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95830. /**
  95831. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95832. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95833. * @returns a raw texture containing the data
  95834. */
  95835. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95836. /**
  95837. * Gets the current hosting scene
  95838. * @returns a scene object
  95839. */
  95840. getScene(): Scene;
  95841. /**
  95842. * Gets a string representing the current skeleton data
  95843. * @param fullDetails defines a boolean indicating if we want a verbose version
  95844. * @returns a string representing the current skeleton data
  95845. */
  95846. toString(fullDetails?: boolean): string;
  95847. /**
  95848. * Get bone's index searching by name
  95849. * @param name defines bone's name to search for
  95850. * @return the indice of the bone. Returns -1 if not found
  95851. */
  95852. getBoneIndexByName(name: string): number;
  95853. /**
  95854. * Creater a new animation range
  95855. * @param name defines the name of the range
  95856. * @param from defines the start key
  95857. * @param to defines the end key
  95858. */
  95859. createAnimationRange(name: string, from: number, to: number): void;
  95860. /**
  95861. * Delete a specific animation range
  95862. * @param name defines the name of the range
  95863. * @param deleteFrames defines if frames must be removed as well
  95864. */
  95865. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95866. /**
  95867. * Gets a specific animation range
  95868. * @param name defines the name of the range to look for
  95869. * @returns the requested animation range or null if not found
  95870. */
  95871. getAnimationRange(name: string): Nullable<AnimationRange>;
  95872. /**
  95873. * Gets the list of all animation ranges defined on this skeleton
  95874. * @returns an array
  95875. */
  95876. getAnimationRanges(): Nullable<AnimationRange>[];
  95877. /**
  95878. * Copy animation range from a source skeleton.
  95879. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95880. * @param source defines the source skeleton
  95881. * @param name defines the name of the range to copy
  95882. * @param rescaleAsRequired defines if rescaling must be applied if required
  95883. * @returns true if operation was successful
  95884. */
  95885. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95886. /**
  95887. * Forces the skeleton to go to rest pose
  95888. */
  95889. returnToRest(): void;
  95890. private _getHighestAnimationFrame;
  95891. /**
  95892. * Begin a specific animation range
  95893. * @param name defines the name of the range to start
  95894. * @param loop defines if looping must be turned on (false by default)
  95895. * @param speedRatio defines the speed ratio to apply (1 by default)
  95896. * @param onAnimationEnd defines a callback which will be called when animation will end
  95897. * @returns a new animatable
  95898. */
  95899. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95900. /**
  95901. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95902. * @param skeleton defines the Skeleton containing the animation range to convert
  95903. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95904. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95905. * @returns the original skeleton
  95906. */
  95907. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95908. /** @hidden */
  95909. _markAsDirty(): void;
  95910. /** @hidden */
  95911. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95912. /** @hidden */
  95913. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95914. private _computeTransformMatrices;
  95915. /**
  95916. * Build all resources required to render a skeleton
  95917. */
  95918. prepare(): void;
  95919. /**
  95920. * Gets the list of animatables currently running for this skeleton
  95921. * @returns an array of animatables
  95922. */
  95923. getAnimatables(): IAnimatable[];
  95924. /**
  95925. * Clone the current skeleton
  95926. * @param name defines the name of the new skeleton
  95927. * @param id defines the id of the new skeleton
  95928. * @returns the new skeleton
  95929. */
  95930. clone(name: string, id?: string): Skeleton;
  95931. /**
  95932. * Enable animation blending for this skeleton
  95933. * @param blendingSpeed defines the blending speed to apply
  95934. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95935. */
  95936. enableBlending(blendingSpeed?: number): void;
  95937. /**
  95938. * Releases all resources associated with the current skeleton
  95939. */
  95940. dispose(): void;
  95941. /**
  95942. * Serialize the skeleton in a JSON object
  95943. * @returns a JSON object
  95944. */
  95945. serialize(): any;
  95946. /**
  95947. * Creates a new skeleton from serialized data
  95948. * @param parsedSkeleton defines the serialized data
  95949. * @param scene defines the hosting scene
  95950. * @returns a new skeleton
  95951. */
  95952. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95953. /**
  95954. * Compute all node absolute transforms
  95955. * @param forceUpdate defines if computation must be done even if cache is up to date
  95956. */
  95957. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95958. /**
  95959. * Gets the root pose matrix
  95960. * @returns a matrix
  95961. */
  95962. getPoseMatrix(): Nullable<Matrix>;
  95963. /**
  95964. * Sorts bones per internal index
  95965. */
  95966. sortBones(): void;
  95967. private _sortBones;
  95968. }
  95969. }
  95970. declare module BABYLON {
  95971. /**
  95972. * Creates an instance based on a source mesh.
  95973. */
  95974. export class InstancedMesh extends AbstractMesh {
  95975. private _sourceMesh;
  95976. private _currentLOD;
  95977. /** @hidden */
  95978. _indexInSourceMeshInstanceArray: number;
  95979. constructor(name: string, source: Mesh);
  95980. /**
  95981. * Returns the string "InstancedMesh".
  95982. */
  95983. getClassName(): string;
  95984. /** Gets the list of lights affecting that mesh */
  95985. get lightSources(): Light[];
  95986. _resyncLightSources(): void;
  95987. _resyncLightSource(light: Light): void;
  95988. _removeLightSource(light: Light, dispose: boolean): void;
  95989. /**
  95990. * If the source mesh receives shadows
  95991. */
  95992. get receiveShadows(): boolean;
  95993. /**
  95994. * The material of the source mesh
  95995. */
  95996. get material(): Nullable<Material>;
  95997. /**
  95998. * Visibility of the source mesh
  95999. */
  96000. get visibility(): number;
  96001. /**
  96002. * Skeleton of the source mesh
  96003. */
  96004. get skeleton(): Nullable<Skeleton>;
  96005. /**
  96006. * Rendering ground id of the source mesh
  96007. */
  96008. get renderingGroupId(): number;
  96009. set renderingGroupId(value: number);
  96010. /**
  96011. * Returns the total number of vertices (integer).
  96012. */
  96013. getTotalVertices(): number;
  96014. /**
  96015. * Returns a positive integer : the total number of indices in this mesh geometry.
  96016. * @returns the numner of indices or zero if the mesh has no geometry.
  96017. */
  96018. getTotalIndices(): number;
  96019. /**
  96020. * The source mesh of the instance
  96021. */
  96022. get sourceMesh(): Mesh;
  96023. /**
  96024. * Creates a new InstancedMesh object from the mesh model.
  96025. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96026. * @param name defines the name of the new instance
  96027. * @returns a new InstancedMesh
  96028. */
  96029. createInstance(name: string): InstancedMesh;
  96030. /**
  96031. * Is this node ready to be used/rendered
  96032. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  96033. * @return {boolean} is it ready
  96034. */
  96035. isReady(completeCheck?: boolean): boolean;
  96036. /**
  96037. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  96038. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  96039. * @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.
  96040. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  96041. */
  96042. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  96043. /**
  96044. * Sets the vertex data of the mesh geometry for the requested `kind`.
  96045. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  96046. * The `data` are either a numeric array either a Float32Array.
  96047. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  96048. * 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).
  96049. * Note that a new underlying VertexBuffer object is created each call.
  96050. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  96051. *
  96052. * Possible `kind` values :
  96053. * - VertexBuffer.PositionKind
  96054. * - VertexBuffer.UVKind
  96055. * - VertexBuffer.UV2Kind
  96056. * - VertexBuffer.UV3Kind
  96057. * - VertexBuffer.UV4Kind
  96058. * - VertexBuffer.UV5Kind
  96059. * - VertexBuffer.UV6Kind
  96060. * - VertexBuffer.ColorKind
  96061. * - VertexBuffer.MatricesIndicesKind
  96062. * - VertexBuffer.MatricesIndicesExtraKind
  96063. * - VertexBuffer.MatricesWeightsKind
  96064. * - VertexBuffer.MatricesWeightsExtraKind
  96065. *
  96066. * Returns the Mesh.
  96067. */
  96068. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  96069. /**
  96070. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  96071. * If the mesh has no geometry, it is simply returned as it is.
  96072. * The `data` are either a numeric array either a Float32Array.
  96073. * No new underlying VertexBuffer object is created.
  96074. * 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.
  96075. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  96076. *
  96077. * Possible `kind` values :
  96078. * - VertexBuffer.PositionKind
  96079. * - VertexBuffer.UVKind
  96080. * - VertexBuffer.UV2Kind
  96081. * - VertexBuffer.UV3Kind
  96082. * - VertexBuffer.UV4Kind
  96083. * - VertexBuffer.UV5Kind
  96084. * - VertexBuffer.UV6Kind
  96085. * - VertexBuffer.ColorKind
  96086. * - VertexBuffer.MatricesIndicesKind
  96087. * - VertexBuffer.MatricesIndicesExtraKind
  96088. * - VertexBuffer.MatricesWeightsKind
  96089. * - VertexBuffer.MatricesWeightsExtraKind
  96090. *
  96091. * Returns the Mesh.
  96092. */
  96093. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96094. /**
  96095. * Sets the mesh indices.
  96096. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96097. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96098. * This method creates a new index buffer each call.
  96099. * Returns the Mesh.
  96100. */
  96101. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96102. /**
  96103. * Boolean : True if the mesh owns the requested kind of data.
  96104. */
  96105. isVerticesDataPresent(kind: string): boolean;
  96106. /**
  96107. * Returns an array of indices (IndicesArray).
  96108. */
  96109. getIndices(): Nullable<IndicesArray>;
  96110. get _positions(): Nullable<Vector3[]>;
  96111. /**
  96112. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96113. * This means the mesh underlying bounding box and sphere are recomputed.
  96114. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96115. * @returns the current mesh
  96116. */
  96117. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96118. /** @hidden */
  96119. _preActivate(): InstancedMesh;
  96120. /** @hidden */
  96121. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96122. /** @hidden */
  96123. _postActivate(): void;
  96124. getWorldMatrix(): Matrix;
  96125. get isAnInstance(): boolean;
  96126. /**
  96127. * Returns the current associated LOD AbstractMesh.
  96128. */
  96129. getLOD(camera: Camera): AbstractMesh;
  96130. /** @hidden */
  96131. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96132. /** @hidden */
  96133. _syncSubMeshes(): InstancedMesh;
  96134. /** @hidden */
  96135. _generatePointsArray(): boolean;
  96136. /** @hidden */
  96137. _updateBoundingInfo(): AbstractMesh;
  96138. /**
  96139. * Creates a new InstancedMesh from the current mesh.
  96140. * - name (string) : the cloned mesh name
  96141. * - newParent (optional Node) : the optional Node to parent the clone to.
  96142. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96143. *
  96144. * Returns the clone.
  96145. */
  96146. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96147. /**
  96148. * Disposes the InstancedMesh.
  96149. * Returns nothing.
  96150. */
  96151. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96152. }
  96153. interface Mesh {
  96154. /**
  96155. * Register a custom buffer that will be instanced
  96156. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96157. * @param kind defines the buffer kind
  96158. * @param stride defines the stride in floats
  96159. */
  96160. registerInstancedBuffer(kind: string, stride: number): void;
  96161. /**
  96162. * true to use the edge renderer for all instances of this mesh
  96163. */
  96164. edgesShareWithInstances: boolean;
  96165. /** @hidden */
  96166. _userInstancedBuffersStorage: {
  96167. data: {
  96168. [key: string]: Float32Array;
  96169. };
  96170. sizes: {
  96171. [key: string]: number;
  96172. };
  96173. vertexBuffers: {
  96174. [key: string]: Nullable<VertexBuffer>;
  96175. };
  96176. strides: {
  96177. [key: string]: number;
  96178. };
  96179. };
  96180. }
  96181. interface AbstractMesh {
  96182. /**
  96183. * Object used to store instanced buffers defined by user
  96184. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96185. */
  96186. instancedBuffers: {
  96187. [key: string]: any;
  96188. };
  96189. }
  96190. }
  96191. declare module BABYLON {
  96192. /**
  96193. * Defines the options associated with the creation of a shader material.
  96194. */
  96195. export interface IShaderMaterialOptions {
  96196. /**
  96197. * Does the material work in alpha blend mode
  96198. */
  96199. needAlphaBlending: boolean;
  96200. /**
  96201. * Does the material work in alpha test mode
  96202. */
  96203. needAlphaTesting: boolean;
  96204. /**
  96205. * The list of attribute names used in the shader
  96206. */
  96207. attributes: string[];
  96208. /**
  96209. * The list of unifrom names used in the shader
  96210. */
  96211. uniforms: string[];
  96212. /**
  96213. * The list of UBO names used in the shader
  96214. */
  96215. uniformBuffers: string[];
  96216. /**
  96217. * The list of sampler names used in the shader
  96218. */
  96219. samplers: string[];
  96220. /**
  96221. * The list of defines used in the shader
  96222. */
  96223. defines: string[];
  96224. }
  96225. /**
  96226. * 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.
  96227. *
  96228. * This returned material effects how the mesh will look based on the code in the shaders.
  96229. *
  96230. * @see https://doc.babylonjs.com/how_to/shader_material
  96231. */
  96232. export class ShaderMaterial extends Material {
  96233. private _shaderPath;
  96234. private _options;
  96235. private _textures;
  96236. private _textureArrays;
  96237. private _floats;
  96238. private _ints;
  96239. private _floatsArrays;
  96240. private _colors3;
  96241. private _colors3Arrays;
  96242. private _colors4;
  96243. private _colors4Arrays;
  96244. private _vectors2;
  96245. private _vectors3;
  96246. private _vectors4;
  96247. private _matrices;
  96248. private _matrixArrays;
  96249. private _matrices3x3;
  96250. private _matrices2x2;
  96251. private _vectors2Arrays;
  96252. private _vectors3Arrays;
  96253. private _vectors4Arrays;
  96254. private _cachedWorldViewMatrix;
  96255. private _cachedWorldViewProjectionMatrix;
  96256. private _renderId;
  96257. private _multiview;
  96258. private _cachedDefines;
  96259. /** Define the Url to load snippets */
  96260. static SnippetUrl: string;
  96261. /** Snippet ID if the material was created from the snippet server */
  96262. snippetId: string;
  96263. /**
  96264. * Instantiate a new shader material.
  96265. * 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.
  96266. * This returned material effects how the mesh will look based on the code in the shaders.
  96267. * @see https://doc.babylonjs.com/how_to/shader_material
  96268. * @param name Define the name of the material in the scene
  96269. * @param scene Define the scene the material belongs to
  96270. * @param shaderPath Defines the route to the shader code in one of three ways:
  96271. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96272. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96273. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96274. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96275. * @param options Define the options used to create the shader
  96276. */
  96277. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96278. /**
  96279. * Gets the shader path used to define the shader code
  96280. * It can be modified to trigger a new compilation
  96281. */
  96282. get shaderPath(): any;
  96283. /**
  96284. * Sets the shader path used to define the shader code
  96285. * It can be modified to trigger a new compilation
  96286. */
  96287. set shaderPath(shaderPath: any);
  96288. /**
  96289. * Gets the options used to compile the shader.
  96290. * They can be modified to trigger a new compilation
  96291. */
  96292. get options(): IShaderMaterialOptions;
  96293. /**
  96294. * Gets the current class name of the material e.g. "ShaderMaterial"
  96295. * Mainly use in serialization.
  96296. * @returns the class name
  96297. */
  96298. getClassName(): string;
  96299. /**
  96300. * Specifies if the material will require alpha blending
  96301. * @returns a boolean specifying if alpha blending is needed
  96302. */
  96303. needAlphaBlending(): boolean;
  96304. /**
  96305. * Specifies if this material should be rendered in alpha test mode
  96306. * @returns a boolean specifying if an alpha test is needed.
  96307. */
  96308. needAlphaTesting(): boolean;
  96309. private _checkUniform;
  96310. /**
  96311. * Set a texture in the shader.
  96312. * @param name Define the name of the uniform samplers as defined in the shader
  96313. * @param texture Define the texture to bind to this sampler
  96314. * @return the material itself allowing "fluent" like uniform updates
  96315. */
  96316. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96317. /**
  96318. * Set a texture array in the shader.
  96319. * @param name Define the name of the uniform sampler array as defined in the shader
  96320. * @param textures Define the list of textures to bind to this sampler
  96321. * @return the material itself allowing "fluent" like uniform updates
  96322. */
  96323. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96324. /**
  96325. * Set a float in the shader.
  96326. * @param name Define the name of the uniform as defined in the shader
  96327. * @param value Define the value to give to the uniform
  96328. * @return the material itself allowing "fluent" like uniform updates
  96329. */
  96330. setFloat(name: string, value: number): ShaderMaterial;
  96331. /**
  96332. * Set a int in the shader.
  96333. * @param name Define the name of the uniform as defined in the shader
  96334. * @param value Define the value to give to the uniform
  96335. * @return the material itself allowing "fluent" like uniform updates
  96336. */
  96337. setInt(name: string, value: number): ShaderMaterial;
  96338. /**
  96339. * Set an array of floats in the shader.
  96340. * @param name Define the name of the uniform as defined in the shader
  96341. * @param value Define the value to give to the uniform
  96342. * @return the material itself allowing "fluent" like uniform updates
  96343. */
  96344. setFloats(name: string, value: number[]): ShaderMaterial;
  96345. /**
  96346. * Set a vec3 in the shader from a Color3.
  96347. * @param name Define the name of the uniform as defined in the shader
  96348. * @param value Define the value to give to the uniform
  96349. * @return the material itself allowing "fluent" like uniform updates
  96350. */
  96351. setColor3(name: string, value: Color3): ShaderMaterial;
  96352. /**
  96353. * Set a vec3 array in the shader from a Color3 array.
  96354. * @param name Define the name of the uniform as defined in the shader
  96355. * @param value Define the value to give to the uniform
  96356. * @return the material itself allowing "fluent" like uniform updates
  96357. */
  96358. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96359. /**
  96360. * Set a vec4 in the shader from a Color4.
  96361. * @param name Define the name of the uniform as defined in the shader
  96362. * @param value Define the value to give to the uniform
  96363. * @return the material itself allowing "fluent" like uniform updates
  96364. */
  96365. setColor4(name: string, value: Color4): ShaderMaterial;
  96366. /**
  96367. * Set a vec4 array in the shader from a Color4 array.
  96368. * @param name Define the name of the uniform as defined in the shader
  96369. * @param value Define the value to give to the uniform
  96370. * @return the material itself allowing "fluent" like uniform updates
  96371. */
  96372. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96373. /**
  96374. * Set a vec2 in the shader from a Vector2.
  96375. * @param name Define the name of the uniform as defined in the shader
  96376. * @param value Define the value to give to the uniform
  96377. * @return the material itself allowing "fluent" like uniform updates
  96378. */
  96379. setVector2(name: string, value: Vector2): ShaderMaterial;
  96380. /**
  96381. * Set a vec3 in the shader from a Vector3.
  96382. * @param name Define the name of the uniform as defined in the shader
  96383. * @param value Define the value to give to the uniform
  96384. * @return the material itself allowing "fluent" like uniform updates
  96385. */
  96386. setVector3(name: string, value: Vector3): ShaderMaterial;
  96387. /**
  96388. * Set a vec4 in the shader from a Vector4.
  96389. * @param name Define the name of the uniform as defined in the shader
  96390. * @param value Define the value to give to the uniform
  96391. * @return the material itself allowing "fluent" like uniform updates
  96392. */
  96393. setVector4(name: string, value: Vector4): ShaderMaterial;
  96394. /**
  96395. * Set a mat4 in the shader from a Matrix.
  96396. * @param name Define the name of the uniform as defined in the shader
  96397. * @param value Define the value to give to the uniform
  96398. * @return the material itself allowing "fluent" like uniform updates
  96399. */
  96400. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96401. /**
  96402. * Set a float32Array in the shader from a matrix array.
  96403. * @param name Define the name of the uniform as defined in the shader
  96404. * @param value Define the value to give to the uniform
  96405. * @return the material itself allowing "fluent" like uniform updates
  96406. */
  96407. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96408. /**
  96409. * Set a mat3 in the shader from a Float32Array.
  96410. * @param name Define the name of the uniform as defined in the shader
  96411. * @param value Define the value to give to the uniform
  96412. * @return the material itself allowing "fluent" like uniform updates
  96413. */
  96414. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96415. /**
  96416. * Set a mat2 in the shader from a Float32Array.
  96417. * @param name Define the name of the uniform as defined in the shader
  96418. * @param value Define the value to give to the uniform
  96419. * @return the material itself allowing "fluent" like uniform updates
  96420. */
  96421. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96422. /**
  96423. * Set a vec2 array in the shader from a number array.
  96424. * @param name Define the name of the uniform as defined in the shader
  96425. * @param value Define the value to give to the uniform
  96426. * @return the material itself allowing "fluent" like uniform updates
  96427. */
  96428. setArray2(name: string, value: number[]): ShaderMaterial;
  96429. /**
  96430. * Set a vec3 array in the shader from a number array.
  96431. * @param name Define the name of the uniform as defined in the shader
  96432. * @param value Define the value to give to the uniform
  96433. * @return the material itself allowing "fluent" like uniform updates
  96434. */
  96435. setArray3(name: string, value: number[]): ShaderMaterial;
  96436. /**
  96437. * Set a vec4 array in the shader from a number array.
  96438. * @param name Define the name of the uniform as defined in the shader
  96439. * @param value Define the value to give to the uniform
  96440. * @return the material itself allowing "fluent" like uniform updates
  96441. */
  96442. setArray4(name: string, value: number[]): ShaderMaterial;
  96443. private _checkCache;
  96444. /**
  96445. * Specifies that the submesh is ready to be used
  96446. * @param mesh defines the mesh to check
  96447. * @param subMesh defines which submesh to check
  96448. * @param useInstances specifies that instances should be used
  96449. * @returns a boolean indicating that the submesh is ready or not
  96450. */
  96451. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96452. /**
  96453. * Checks if the material is ready to render the requested mesh
  96454. * @param mesh Define the mesh to render
  96455. * @param useInstances Define whether or not the material is used with instances
  96456. * @returns true if ready, otherwise false
  96457. */
  96458. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96459. /**
  96460. * Binds the world matrix to the material
  96461. * @param world defines the world transformation matrix
  96462. * @param effectOverride - If provided, use this effect instead of internal effect
  96463. */
  96464. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96465. /**
  96466. * Binds the submesh to this material by preparing the effect and shader to draw
  96467. * @param world defines the world transformation matrix
  96468. * @param mesh defines the mesh containing the submesh
  96469. * @param subMesh defines the submesh to bind the material to
  96470. */
  96471. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96472. /**
  96473. * Binds the material to the mesh
  96474. * @param world defines the world transformation matrix
  96475. * @param mesh defines the mesh to bind the material to
  96476. * @param effectOverride - If provided, use this effect instead of internal effect
  96477. */
  96478. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96479. protected _afterBind(mesh?: Mesh): void;
  96480. /**
  96481. * Gets the active textures from the material
  96482. * @returns an array of textures
  96483. */
  96484. getActiveTextures(): BaseTexture[];
  96485. /**
  96486. * Specifies if the material uses a texture
  96487. * @param texture defines the texture to check against the material
  96488. * @returns a boolean specifying if the material uses the texture
  96489. */
  96490. hasTexture(texture: BaseTexture): boolean;
  96491. /**
  96492. * Makes a duplicate of the material, and gives it a new name
  96493. * @param name defines the new name for the duplicated material
  96494. * @returns the cloned material
  96495. */
  96496. clone(name: string): ShaderMaterial;
  96497. /**
  96498. * Disposes the material
  96499. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96500. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96501. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96502. */
  96503. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96504. /**
  96505. * Serializes this material in a JSON representation
  96506. * @returns the serialized material object
  96507. */
  96508. serialize(): any;
  96509. /**
  96510. * Creates a shader material from parsed shader material data
  96511. * @param source defines the JSON represnetation of the material
  96512. * @param scene defines the hosting scene
  96513. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96514. * @returns a new material
  96515. */
  96516. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96517. /**
  96518. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96519. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96520. * @param url defines the url to load from
  96521. * @param scene defines the hosting scene
  96522. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96523. * @returns a promise that will resolve to the new ShaderMaterial
  96524. */
  96525. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96526. /**
  96527. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96528. * @param snippetId defines the snippet to load
  96529. * @param scene defines the hosting scene
  96530. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96531. * @returns a promise that will resolve to the new ShaderMaterial
  96532. */
  96533. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96534. }
  96535. }
  96536. declare module BABYLON {
  96537. /** @hidden */
  96538. export var colorPixelShader: {
  96539. name: string;
  96540. shader: string;
  96541. };
  96542. }
  96543. declare module BABYLON {
  96544. /** @hidden */
  96545. export var colorVertexShader: {
  96546. name: string;
  96547. shader: string;
  96548. };
  96549. }
  96550. declare module BABYLON {
  96551. /**
  96552. * Line mesh
  96553. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96554. */
  96555. export class LinesMesh extends Mesh {
  96556. /**
  96557. * If vertex color should be applied to the mesh
  96558. */
  96559. readonly useVertexColor?: boolean | undefined;
  96560. /**
  96561. * If vertex alpha should be applied to the mesh
  96562. */
  96563. readonly useVertexAlpha?: boolean | undefined;
  96564. /**
  96565. * Color of the line (Default: White)
  96566. */
  96567. color: Color3;
  96568. /**
  96569. * Alpha of the line (Default: 1)
  96570. */
  96571. alpha: number;
  96572. /**
  96573. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96574. * This margin is expressed in world space coordinates, so its value may vary.
  96575. * Default value is 0.1
  96576. */
  96577. intersectionThreshold: number;
  96578. private _colorShader;
  96579. private color4;
  96580. /**
  96581. * Creates a new LinesMesh
  96582. * @param name defines the name
  96583. * @param scene defines the hosting scene
  96584. * @param parent defines the parent mesh if any
  96585. * @param source defines the optional source LinesMesh used to clone data from
  96586. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96587. * When false, achieved by calling a clone(), also passing False.
  96588. * This will make creation of children, recursive.
  96589. * @param useVertexColor defines if this LinesMesh supports vertex color
  96590. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96591. */
  96592. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96593. /**
  96594. * If vertex color should be applied to the mesh
  96595. */
  96596. useVertexColor?: boolean | undefined,
  96597. /**
  96598. * If vertex alpha should be applied to the mesh
  96599. */
  96600. useVertexAlpha?: boolean | undefined);
  96601. private _addClipPlaneDefine;
  96602. private _removeClipPlaneDefine;
  96603. isReady(): boolean;
  96604. /**
  96605. * Returns the string "LineMesh"
  96606. */
  96607. getClassName(): string;
  96608. /**
  96609. * @hidden
  96610. */
  96611. get material(): Material;
  96612. /**
  96613. * @hidden
  96614. */
  96615. set material(value: Material);
  96616. /**
  96617. * @hidden
  96618. */
  96619. get checkCollisions(): boolean;
  96620. /** @hidden */
  96621. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96622. /** @hidden */
  96623. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96624. /**
  96625. * Disposes of the line mesh
  96626. * @param doNotRecurse If children should be disposed
  96627. */
  96628. dispose(doNotRecurse?: boolean): void;
  96629. /**
  96630. * Returns a new LineMesh object cloned from the current one.
  96631. */
  96632. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96633. /**
  96634. * Creates a new InstancedLinesMesh object from the mesh model.
  96635. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96636. * @param name defines the name of the new instance
  96637. * @returns a new InstancedLinesMesh
  96638. */
  96639. createInstance(name: string): InstancedLinesMesh;
  96640. }
  96641. /**
  96642. * Creates an instance based on a source LinesMesh
  96643. */
  96644. export class InstancedLinesMesh extends InstancedMesh {
  96645. /**
  96646. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96647. * This margin is expressed in world space coordinates, so its value may vary.
  96648. * Initilized with the intersectionThreshold value of the source LinesMesh
  96649. */
  96650. intersectionThreshold: number;
  96651. constructor(name: string, source: LinesMesh);
  96652. /**
  96653. * Returns the string "InstancedLinesMesh".
  96654. */
  96655. getClassName(): string;
  96656. }
  96657. }
  96658. declare module BABYLON {
  96659. /** @hidden */
  96660. export var linePixelShader: {
  96661. name: string;
  96662. shader: string;
  96663. };
  96664. }
  96665. declare module BABYLON {
  96666. /** @hidden */
  96667. export var lineVertexShader: {
  96668. name: string;
  96669. shader: string;
  96670. };
  96671. }
  96672. declare module BABYLON {
  96673. interface Scene {
  96674. /** @hidden */
  96675. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96676. }
  96677. interface AbstractMesh {
  96678. /**
  96679. * Gets the edgesRenderer associated with the mesh
  96680. */
  96681. edgesRenderer: Nullable<EdgesRenderer>;
  96682. }
  96683. interface LinesMesh {
  96684. /**
  96685. * Enables the edge rendering mode on the mesh.
  96686. * This mode makes the mesh edges visible
  96687. * @param epsilon defines the maximal distance between two angles to detect a face
  96688. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96689. * @returns the currentAbstractMesh
  96690. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96691. */
  96692. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96693. }
  96694. interface InstancedLinesMesh {
  96695. /**
  96696. * Enables the edge rendering mode on the mesh.
  96697. * This mode makes the mesh edges visible
  96698. * @param epsilon defines the maximal distance between two angles to detect a face
  96699. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96700. * @returns the current InstancedLinesMesh
  96701. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96702. */
  96703. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96704. }
  96705. /**
  96706. * Defines the minimum contract an Edges renderer should follow.
  96707. */
  96708. export interface IEdgesRenderer extends IDisposable {
  96709. /**
  96710. * Gets or sets a boolean indicating if the edgesRenderer is active
  96711. */
  96712. isEnabled: boolean;
  96713. /**
  96714. * Renders the edges of the attached mesh,
  96715. */
  96716. render(): void;
  96717. /**
  96718. * Checks wether or not the edges renderer is ready to render.
  96719. * @return true if ready, otherwise false.
  96720. */
  96721. isReady(): boolean;
  96722. /**
  96723. * List of instances to render in case the source mesh has instances
  96724. */
  96725. customInstances: SmartArray<Matrix>;
  96726. }
  96727. /**
  96728. * Defines the additional options of the edges renderer
  96729. */
  96730. export interface IEdgesRendererOptions {
  96731. /**
  96732. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96733. * If not defined, the default value is true
  96734. */
  96735. useAlternateEdgeFinder?: boolean;
  96736. /**
  96737. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96738. * If not defined, the default value is true.
  96739. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  96740. * This option is used only if useAlternateEdgeFinder = true
  96741. */
  96742. useFastVertexMerger?: boolean;
  96743. /**
  96744. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96745. * The default value is 1e-6
  96746. * This option is used only if useAlternateEdgeFinder = true
  96747. */
  96748. epsilonVertexMerge?: number;
  96749. /**
  96750. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  96751. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  96752. * This option is used only if useAlternateEdgeFinder = true
  96753. */
  96754. applyTessellation?: boolean;
  96755. /**
  96756. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  96757. * The default value is 1e-6
  96758. * This option is used only if useAlternateEdgeFinder = true
  96759. */
  96760. epsilonVertexAligned?: number;
  96761. }
  96762. /**
  96763. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96764. */
  96765. export class EdgesRenderer implements IEdgesRenderer {
  96766. /**
  96767. * Define the size of the edges with an orthographic camera
  96768. */
  96769. edgesWidthScalerForOrthographic: number;
  96770. /**
  96771. * Define the size of the edges with a perspective camera
  96772. */
  96773. edgesWidthScalerForPerspective: number;
  96774. protected _source: AbstractMesh;
  96775. protected _linesPositions: number[];
  96776. protected _linesNormals: number[];
  96777. protected _linesIndices: number[];
  96778. protected _epsilon: number;
  96779. protected _indicesCount: number;
  96780. protected _lineShader: ShaderMaterial;
  96781. protected _ib: DataBuffer;
  96782. protected _buffers: {
  96783. [key: string]: Nullable<VertexBuffer>;
  96784. };
  96785. protected _buffersForInstances: {
  96786. [key: string]: Nullable<VertexBuffer>;
  96787. };
  96788. protected _checkVerticesInsteadOfIndices: boolean;
  96789. protected _options: Nullable<IEdgesRendererOptions>;
  96790. private _meshRebuildObserver;
  96791. private _meshDisposeObserver;
  96792. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96793. isEnabled: boolean;
  96794. /**
  96795. * List of instances to render in case the source mesh has instances
  96796. */
  96797. customInstances: SmartArray<Matrix>;
  96798. private static GetShader;
  96799. /**
  96800. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96801. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96802. * @param source Mesh used to create edges
  96803. * @param epsilon sum of angles in adjacency to check for edge
  96804. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96805. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96806. * @param options The options to apply when generating the edges
  96807. */
  96808. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96809. protected _prepareRessources(): void;
  96810. /** @hidden */
  96811. _rebuild(): void;
  96812. /**
  96813. * Releases the required resources for the edges renderer
  96814. */
  96815. dispose(): void;
  96816. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96817. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96818. /**
  96819. * Checks if the pair of p0 and p1 is en edge
  96820. * @param faceIndex
  96821. * @param edge
  96822. * @param faceNormals
  96823. * @param p0
  96824. * @param p1
  96825. * @private
  96826. */
  96827. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96828. /**
  96829. * push line into the position, normal and index buffer
  96830. * @protected
  96831. */
  96832. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96833. /**
  96834. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96835. */
  96836. private _tessellateTriangle;
  96837. private _generateEdgesLinesAlternate;
  96838. /**
  96839. * Generates lines edges from adjacencjes
  96840. * @private
  96841. */
  96842. _generateEdgesLines(): void;
  96843. /**
  96844. * Checks wether or not the edges renderer is ready to render.
  96845. * @return true if ready, otherwise false.
  96846. */
  96847. isReady(): boolean;
  96848. /**
  96849. * Renders the edges of the attached mesh,
  96850. */
  96851. render(): void;
  96852. }
  96853. /**
  96854. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96855. */
  96856. export class LineEdgesRenderer extends EdgesRenderer {
  96857. /**
  96858. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96859. * @param source LineMesh used to generate edges
  96860. * @param epsilon not important (specified angle for edge detection)
  96861. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96862. */
  96863. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96864. /**
  96865. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96866. */
  96867. _generateEdgesLines(): void;
  96868. }
  96869. }
  96870. declare module BABYLON {
  96871. /**
  96872. * This represents the object necessary to create a rendering group.
  96873. * This is exclusively used and created by the rendering manager.
  96874. * To modify the behavior, you use the available helpers in your scene or meshes.
  96875. * @hidden
  96876. */
  96877. export class RenderingGroup {
  96878. index: number;
  96879. private static _zeroVector;
  96880. private _scene;
  96881. private _opaqueSubMeshes;
  96882. private _transparentSubMeshes;
  96883. private _alphaTestSubMeshes;
  96884. private _depthOnlySubMeshes;
  96885. private _particleSystems;
  96886. private _spriteManagers;
  96887. private _opaqueSortCompareFn;
  96888. private _alphaTestSortCompareFn;
  96889. private _transparentSortCompareFn;
  96890. private _renderOpaque;
  96891. private _renderAlphaTest;
  96892. private _renderTransparent;
  96893. /** @hidden */
  96894. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96895. onBeforeTransparentRendering: () => void;
  96896. /**
  96897. * Set the opaque sort comparison function.
  96898. * If null the sub meshes will be render in the order they were created
  96899. */
  96900. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96901. /**
  96902. * Set the alpha test sort comparison function.
  96903. * If null the sub meshes will be render in the order they were created
  96904. */
  96905. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96906. /**
  96907. * Set the transparent sort comparison function.
  96908. * If null the sub meshes will be render in the order they were created
  96909. */
  96910. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96911. /**
  96912. * Creates a new rendering group.
  96913. * @param index The rendering group index
  96914. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96915. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96916. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96917. */
  96918. 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>);
  96919. /**
  96920. * Render all the sub meshes contained in the group.
  96921. * @param customRenderFunction Used to override the default render behaviour of the group.
  96922. * @returns true if rendered some submeshes.
  96923. */
  96924. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96925. /**
  96926. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96927. * @param subMeshes The submeshes to render
  96928. */
  96929. private renderOpaqueSorted;
  96930. /**
  96931. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96932. * @param subMeshes The submeshes to render
  96933. */
  96934. private renderAlphaTestSorted;
  96935. /**
  96936. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96937. * @param subMeshes The submeshes to render
  96938. */
  96939. private renderTransparentSorted;
  96940. /**
  96941. * Renders the submeshes in a specified order.
  96942. * @param subMeshes The submeshes to sort before render
  96943. * @param sortCompareFn The comparison function use to sort
  96944. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96945. * @param transparent Specifies to activate blending if true
  96946. */
  96947. private static renderSorted;
  96948. /**
  96949. * Renders the submeshes in the order they were dispatched (no sort applied).
  96950. * @param subMeshes The submeshes to render
  96951. */
  96952. private static renderUnsorted;
  96953. /**
  96954. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96955. * are rendered back to front if in the same alpha index.
  96956. *
  96957. * @param a The first submesh
  96958. * @param b The second submesh
  96959. * @returns The result of the comparison
  96960. */
  96961. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96962. /**
  96963. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96964. * are rendered back to front.
  96965. *
  96966. * @param a The first submesh
  96967. * @param b The second submesh
  96968. * @returns The result of the comparison
  96969. */
  96970. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96971. /**
  96972. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96973. * are rendered front to back (prevent overdraw).
  96974. *
  96975. * @param a The first submesh
  96976. * @param b The second submesh
  96977. * @returns The result of the comparison
  96978. */
  96979. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96980. /**
  96981. * Resets the different lists of submeshes to prepare a new frame.
  96982. */
  96983. prepare(): void;
  96984. dispose(): void;
  96985. /**
  96986. * Inserts the submesh in its correct queue depending on its material.
  96987. * @param subMesh The submesh to dispatch
  96988. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96989. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96990. */
  96991. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96992. dispatchSprites(spriteManager: ISpriteManager): void;
  96993. dispatchParticles(particleSystem: IParticleSystem): void;
  96994. private _renderParticles;
  96995. private _renderSprites;
  96996. }
  96997. }
  96998. declare module BABYLON {
  96999. /**
  97000. * Interface describing the different options available in the rendering manager
  97001. * regarding Auto Clear between groups.
  97002. */
  97003. export interface IRenderingManagerAutoClearSetup {
  97004. /**
  97005. * Defines whether or not autoclear is enable.
  97006. */
  97007. autoClear: boolean;
  97008. /**
  97009. * Defines whether or not to autoclear the depth buffer.
  97010. */
  97011. depth: boolean;
  97012. /**
  97013. * Defines whether or not to autoclear the stencil buffer.
  97014. */
  97015. stencil: boolean;
  97016. }
  97017. /**
  97018. * This class is used by the onRenderingGroupObservable
  97019. */
  97020. export class RenderingGroupInfo {
  97021. /**
  97022. * The Scene that being rendered
  97023. */
  97024. scene: Scene;
  97025. /**
  97026. * The camera currently used for the rendering pass
  97027. */
  97028. camera: Nullable<Camera>;
  97029. /**
  97030. * The ID of the renderingGroup being processed
  97031. */
  97032. renderingGroupId: number;
  97033. }
  97034. /**
  97035. * This is the manager responsible of all the rendering for meshes sprites and particles.
  97036. * It is enable to manage the different groups as well as the different necessary sort functions.
  97037. * This should not be used directly aside of the few static configurations
  97038. */
  97039. export class RenderingManager {
  97040. /**
  97041. * The max id used for rendering groups (not included)
  97042. */
  97043. static MAX_RENDERINGGROUPS: number;
  97044. /**
  97045. * The min id used for rendering groups (included)
  97046. */
  97047. static MIN_RENDERINGGROUPS: number;
  97048. /**
  97049. * Used to globally prevent autoclearing scenes.
  97050. */
  97051. static AUTOCLEAR: boolean;
  97052. /**
  97053. * @hidden
  97054. */
  97055. _useSceneAutoClearSetup: boolean;
  97056. private _scene;
  97057. private _renderingGroups;
  97058. private _depthStencilBufferAlreadyCleaned;
  97059. private _autoClearDepthStencil;
  97060. private _customOpaqueSortCompareFn;
  97061. private _customAlphaTestSortCompareFn;
  97062. private _customTransparentSortCompareFn;
  97063. private _renderingGroupInfo;
  97064. /**
  97065. * Instantiates a new rendering group for a particular scene
  97066. * @param scene Defines the scene the groups belongs to
  97067. */
  97068. constructor(scene: Scene);
  97069. private _clearDepthStencilBuffer;
  97070. /**
  97071. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  97072. * @hidden
  97073. */
  97074. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  97075. /**
  97076. * Resets the different information of the group to prepare a new frame
  97077. * @hidden
  97078. */
  97079. reset(): void;
  97080. /**
  97081. * Dispose and release the group and its associated resources.
  97082. * @hidden
  97083. */
  97084. dispose(): void;
  97085. /**
  97086. * Clear the info related to rendering groups preventing retention points during dispose.
  97087. */
  97088. freeRenderingGroups(): void;
  97089. private _prepareRenderingGroup;
  97090. /**
  97091. * Add a sprite manager to the rendering manager in order to render it this frame.
  97092. * @param spriteManager Define the sprite manager to render
  97093. */
  97094. dispatchSprites(spriteManager: ISpriteManager): void;
  97095. /**
  97096. * Add a particle system to the rendering manager in order to render it this frame.
  97097. * @param particleSystem Define the particle system to render
  97098. */
  97099. dispatchParticles(particleSystem: IParticleSystem): void;
  97100. /**
  97101. * Add a submesh to the manager in order to render it this frame
  97102. * @param subMesh The submesh to dispatch
  97103. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97104. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97105. */
  97106. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97107. /**
  97108. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97109. * This allowed control for front to back rendering or reversly depending of the special needs.
  97110. *
  97111. * @param renderingGroupId The rendering group id corresponding to its index
  97112. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97113. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97114. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97115. */
  97116. 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;
  97117. /**
  97118. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97119. *
  97120. * @param renderingGroupId The rendering group id corresponding to its index
  97121. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97122. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97123. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97124. */
  97125. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97126. /**
  97127. * Gets the current auto clear configuration for one rendering group of the rendering
  97128. * manager.
  97129. * @param index the rendering group index to get the information for
  97130. * @returns The auto clear setup for the requested rendering group
  97131. */
  97132. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97133. }
  97134. }
  97135. declare module BABYLON {
  97136. /**
  97137. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97138. */
  97139. export interface ICustomShaderOptions {
  97140. /**
  97141. * Gets or sets the custom shader name to use
  97142. */
  97143. shaderName: string;
  97144. /**
  97145. * The list of attribute names used in the shader
  97146. */
  97147. attributes?: string[];
  97148. /**
  97149. * The list of unifrom names used in the shader
  97150. */
  97151. uniforms?: string[];
  97152. /**
  97153. * The list of sampler names used in the shader
  97154. */
  97155. samplers?: string[];
  97156. /**
  97157. * The list of defines used in the shader
  97158. */
  97159. defines?: string[];
  97160. }
  97161. /**
  97162. * Interface to implement to create a shadow generator compatible with BJS.
  97163. */
  97164. export interface IShadowGenerator {
  97165. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97166. id: string;
  97167. /**
  97168. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97169. * @returns The render target texture if present otherwise, null
  97170. */
  97171. getShadowMap(): Nullable<RenderTargetTexture>;
  97172. /**
  97173. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97174. * @param subMesh The submesh we want to render in the shadow map
  97175. * @param useInstances Defines wether will draw in the map using instances
  97176. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97177. * @returns true if ready otherwise, false
  97178. */
  97179. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97180. /**
  97181. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97182. * @param defines Defines of the material we want to update
  97183. * @param lightIndex Index of the light in the enabled light list of the material
  97184. */
  97185. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97186. /**
  97187. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97188. * defined in the generator but impacting the effect).
  97189. * It implies the unifroms available on the materials are the standard BJS ones.
  97190. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97191. * @param effect The effect we are binfing the information for
  97192. */
  97193. bindShadowLight(lightIndex: string, effect: Effect): void;
  97194. /**
  97195. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97196. * (eq to shadow prjection matrix * light transform matrix)
  97197. * @returns The transform matrix used to create the shadow map
  97198. */
  97199. getTransformMatrix(): Matrix;
  97200. /**
  97201. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97202. * Cube and 2D textures for instance.
  97203. */
  97204. recreateShadowMap(): void;
  97205. /**
  97206. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97207. * @param onCompiled Callback triggered at the and of the effects compilation
  97208. * @param options Sets of optional options forcing the compilation with different modes
  97209. */
  97210. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97211. useInstances: boolean;
  97212. }>): void;
  97213. /**
  97214. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97215. * @param options Sets of optional options forcing the compilation with different modes
  97216. * @returns A promise that resolves when the compilation completes
  97217. */
  97218. forceCompilationAsync(options?: Partial<{
  97219. useInstances: boolean;
  97220. }>): Promise<void>;
  97221. /**
  97222. * Serializes the shadow generator setup to a json object.
  97223. * @returns The serialized JSON object
  97224. */
  97225. serialize(): any;
  97226. /**
  97227. * Disposes the Shadow map and related Textures and effects.
  97228. */
  97229. dispose(): void;
  97230. }
  97231. /**
  97232. * Default implementation IShadowGenerator.
  97233. * This is the main object responsible of generating shadows in the framework.
  97234. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97235. */
  97236. export class ShadowGenerator implements IShadowGenerator {
  97237. /**
  97238. * Name of the shadow generator class
  97239. */
  97240. static CLASSNAME: string;
  97241. /**
  97242. * Shadow generator mode None: no filtering applied.
  97243. */
  97244. static readonly FILTER_NONE: number;
  97245. /**
  97246. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97247. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97248. */
  97249. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97250. /**
  97251. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97252. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97253. */
  97254. static readonly FILTER_POISSONSAMPLING: number;
  97255. /**
  97256. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97257. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97258. */
  97259. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97260. /**
  97261. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97262. * edge artifacts on steep falloff.
  97263. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97264. */
  97265. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97266. /**
  97267. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97268. * edge artifacts on steep falloff.
  97269. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97270. */
  97271. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97272. /**
  97273. * Shadow generator mode PCF: Percentage Closer Filtering
  97274. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97275. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97276. */
  97277. static readonly FILTER_PCF: number;
  97278. /**
  97279. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97280. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97281. * Contact Hardening
  97282. */
  97283. static readonly FILTER_PCSS: number;
  97284. /**
  97285. * Reserved for PCF and PCSS
  97286. * Highest Quality.
  97287. *
  97288. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97289. *
  97290. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97291. */
  97292. static readonly QUALITY_HIGH: number;
  97293. /**
  97294. * Reserved for PCF and PCSS
  97295. * Good tradeoff for quality/perf cross devices
  97296. *
  97297. * Execute PCF on a 3*3 kernel.
  97298. *
  97299. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97300. */
  97301. static readonly QUALITY_MEDIUM: number;
  97302. /**
  97303. * Reserved for PCF and PCSS
  97304. * The lowest quality but the fastest.
  97305. *
  97306. * Execute PCF on a 1*1 kernel.
  97307. *
  97308. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97309. */
  97310. static readonly QUALITY_LOW: number;
  97311. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97312. id: string;
  97313. /** Gets or sets the custom shader name to use */
  97314. customShaderOptions: ICustomShaderOptions;
  97315. /**
  97316. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97317. */
  97318. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97319. /**
  97320. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97321. */
  97322. onAfterShadowMapRenderObservable: Observable<Effect>;
  97323. /**
  97324. * Observable triggered before a mesh is rendered in the shadow map.
  97325. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97326. */
  97327. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97328. /**
  97329. * Observable triggered after a mesh is rendered in the shadow map.
  97330. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97331. */
  97332. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97333. protected _bias: number;
  97334. /**
  97335. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97336. */
  97337. get bias(): number;
  97338. /**
  97339. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97340. */
  97341. set bias(bias: number);
  97342. protected _normalBias: number;
  97343. /**
  97344. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97345. */
  97346. get normalBias(): number;
  97347. /**
  97348. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97349. */
  97350. set normalBias(normalBias: number);
  97351. protected _blurBoxOffset: number;
  97352. /**
  97353. * Gets the blur box offset: offset applied during the blur pass.
  97354. * Only useful if useKernelBlur = false
  97355. */
  97356. get blurBoxOffset(): number;
  97357. /**
  97358. * Sets the blur box offset: offset applied during the blur pass.
  97359. * Only useful if useKernelBlur = false
  97360. */
  97361. set blurBoxOffset(value: number);
  97362. protected _blurScale: number;
  97363. /**
  97364. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97365. * 2 means half of the size.
  97366. */
  97367. get blurScale(): number;
  97368. /**
  97369. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97370. * 2 means half of the size.
  97371. */
  97372. set blurScale(value: number);
  97373. protected _blurKernel: number;
  97374. /**
  97375. * Gets the blur kernel: kernel size of the blur pass.
  97376. * Only useful if useKernelBlur = true
  97377. */
  97378. get blurKernel(): number;
  97379. /**
  97380. * Sets the blur kernel: kernel size of the blur pass.
  97381. * Only useful if useKernelBlur = true
  97382. */
  97383. set blurKernel(value: number);
  97384. protected _useKernelBlur: boolean;
  97385. /**
  97386. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97387. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97388. */
  97389. get useKernelBlur(): boolean;
  97390. /**
  97391. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97392. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97393. */
  97394. set useKernelBlur(value: boolean);
  97395. protected _depthScale: number;
  97396. /**
  97397. * Gets the depth scale used in ESM mode.
  97398. */
  97399. get depthScale(): number;
  97400. /**
  97401. * Sets the depth scale used in ESM mode.
  97402. * This can override the scale stored on the light.
  97403. */
  97404. set depthScale(value: number);
  97405. protected _validateFilter(filter: number): number;
  97406. protected _filter: number;
  97407. /**
  97408. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97409. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97410. */
  97411. get filter(): number;
  97412. /**
  97413. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97414. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97415. */
  97416. set filter(value: number);
  97417. /**
  97418. * Gets if the current filter is set to Poisson Sampling.
  97419. */
  97420. get usePoissonSampling(): boolean;
  97421. /**
  97422. * Sets the current filter to Poisson Sampling.
  97423. */
  97424. set usePoissonSampling(value: boolean);
  97425. /**
  97426. * Gets if the current filter is set to ESM.
  97427. */
  97428. get useExponentialShadowMap(): boolean;
  97429. /**
  97430. * Sets the current filter is to ESM.
  97431. */
  97432. set useExponentialShadowMap(value: boolean);
  97433. /**
  97434. * Gets if the current filter is set to filtered ESM.
  97435. */
  97436. get useBlurExponentialShadowMap(): boolean;
  97437. /**
  97438. * Gets if the current filter is set to filtered ESM.
  97439. */
  97440. set useBlurExponentialShadowMap(value: boolean);
  97441. /**
  97442. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97443. * exponential to prevent steep falloff artifacts).
  97444. */
  97445. get useCloseExponentialShadowMap(): boolean;
  97446. /**
  97447. * Sets the current filter to "close ESM" (using the inverse of the
  97448. * exponential to prevent steep falloff artifacts).
  97449. */
  97450. set useCloseExponentialShadowMap(value: boolean);
  97451. /**
  97452. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97453. * exponential to prevent steep falloff artifacts).
  97454. */
  97455. get useBlurCloseExponentialShadowMap(): boolean;
  97456. /**
  97457. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97458. * exponential to prevent steep falloff artifacts).
  97459. */
  97460. set useBlurCloseExponentialShadowMap(value: boolean);
  97461. /**
  97462. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97463. */
  97464. get usePercentageCloserFiltering(): boolean;
  97465. /**
  97466. * Sets the current filter to "PCF" (percentage closer filtering).
  97467. */
  97468. set usePercentageCloserFiltering(value: boolean);
  97469. protected _filteringQuality: number;
  97470. /**
  97471. * Gets the PCF or PCSS Quality.
  97472. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97473. */
  97474. get filteringQuality(): number;
  97475. /**
  97476. * Sets the PCF or PCSS Quality.
  97477. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97478. */
  97479. set filteringQuality(filteringQuality: number);
  97480. /**
  97481. * Gets if the current filter is set to "PCSS" (contact hardening).
  97482. */
  97483. get useContactHardeningShadow(): boolean;
  97484. /**
  97485. * Sets the current filter to "PCSS" (contact hardening).
  97486. */
  97487. set useContactHardeningShadow(value: boolean);
  97488. protected _contactHardeningLightSizeUVRatio: number;
  97489. /**
  97490. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97491. * Using a ratio helps keeping shape stability independently of the map size.
  97492. *
  97493. * It does not account for the light projection as it was having too much
  97494. * instability during the light setup or during light position changes.
  97495. *
  97496. * Only valid if useContactHardeningShadow is true.
  97497. */
  97498. get contactHardeningLightSizeUVRatio(): number;
  97499. /**
  97500. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97501. * Using a ratio helps keeping shape stability independently of the map size.
  97502. *
  97503. * It does not account for the light projection as it was having too much
  97504. * instability during the light setup or during light position changes.
  97505. *
  97506. * Only valid if useContactHardeningShadow is true.
  97507. */
  97508. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97509. protected _darkness: number;
  97510. /** Gets or sets the actual darkness of a shadow */
  97511. get darkness(): number;
  97512. set darkness(value: number);
  97513. /**
  97514. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97515. * 0 means strongest and 1 would means no shadow.
  97516. * @returns the darkness.
  97517. */
  97518. getDarkness(): number;
  97519. /**
  97520. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97521. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97522. * @returns the shadow generator allowing fluent coding.
  97523. */
  97524. setDarkness(darkness: number): ShadowGenerator;
  97525. protected _transparencyShadow: boolean;
  97526. /** Gets or sets the ability to have transparent shadow */
  97527. get transparencyShadow(): boolean;
  97528. set transparencyShadow(value: boolean);
  97529. /**
  97530. * Sets the ability to have transparent shadow (boolean).
  97531. * @param transparent True if transparent else False
  97532. * @returns the shadow generator allowing fluent coding
  97533. */
  97534. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97535. /**
  97536. * Enables or disables shadows with varying strength based on the transparency
  97537. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97538. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97539. * mesh.visibility * alphaTexture.a
  97540. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97541. */
  97542. enableSoftTransparentShadow: boolean;
  97543. protected _shadowMap: Nullable<RenderTargetTexture>;
  97544. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97545. /**
  97546. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97547. * @returns The render target texture if present otherwise, null
  97548. */
  97549. getShadowMap(): Nullable<RenderTargetTexture>;
  97550. /**
  97551. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97552. * @returns The render target texture if the shadow map is present otherwise, null
  97553. */
  97554. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97555. /**
  97556. * Gets the class name of that object
  97557. * @returns "ShadowGenerator"
  97558. */
  97559. getClassName(): string;
  97560. /**
  97561. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97562. * @param mesh Mesh to add
  97563. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97564. * @returns the Shadow Generator itself
  97565. */
  97566. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97567. /**
  97568. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97569. * @param mesh Mesh to remove
  97570. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97571. * @returns the Shadow Generator itself
  97572. */
  97573. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97574. /**
  97575. * Controls the extent to which the shadows fade out at the edge of the frustum
  97576. */
  97577. frustumEdgeFalloff: number;
  97578. protected _light: IShadowLight;
  97579. /**
  97580. * Returns the associated light object.
  97581. * @returns the light generating the shadow
  97582. */
  97583. getLight(): IShadowLight;
  97584. /**
  97585. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97586. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97587. * It might on the other hand introduce peter panning.
  97588. */
  97589. forceBackFacesOnly: boolean;
  97590. protected _scene: Scene;
  97591. protected _lightDirection: Vector3;
  97592. protected _effect: Effect;
  97593. protected _viewMatrix: Matrix;
  97594. protected _projectionMatrix: Matrix;
  97595. protected _transformMatrix: Matrix;
  97596. protected _cachedPosition: Vector3;
  97597. protected _cachedDirection: Vector3;
  97598. protected _cachedDefines: string;
  97599. protected _currentRenderID: number;
  97600. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97601. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97602. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97603. protected _blurPostProcesses: PostProcess[];
  97604. protected _mapSize: number;
  97605. protected _currentFaceIndex: number;
  97606. protected _currentFaceIndexCache: number;
  97607. protected _textureType: number;
  97608. protected _defaultTextureMatrix: Matrix;
  97609. protected _storedUniqueId: Nullable<number>;
  97610. /** @hidden */
  97611. static _SceneComponentInitialization: (scene: Scene) => void;
  97612. /**
  97613. * Creates a ShadowGenerator object.
  97614. * A ShadowGenerator is the required tool to use the shadows.
  97615. * Each light casting shadows needs to use its own ShadowGenerator.
  97616. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97617. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97618. * @param light The light object generating the shadows.
  97619. * @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.
  97620. */
  97621. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97622. protected _initializeGenerator(): void;
  97623. protected _createTargetRenderTexture(): void;
  97624. protected _initializeShadowMap(): void;
  97625. protected _initializeBlurRTTAndPostProcesses(): void;
  97626. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97627. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97628. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97629. protected _applyFilterValues(): void;
  97630. /**
  97631. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97632. * @param onCompiled Callback triggered at the and of the effects compilation
  97633. * @param options Sets of optional options forcing the compilation with different modes
  97634. */
  97635. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97636. useInstances: boolean;
  97637. }>): void;
  97638. /**
  97639. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97640. * @param options Sets of optional options forcing the compilation with different modes
  97641. * @returns A promise that resolves when the compilation completes
  97642. */
  97643. forceCompilationAsync(options?: Partial<{
  97644. useInstances: boolean;
  97645. }>): Promise<void>;
  97646. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97647. private _prepareShadowDefines;
  97648. /**
  97649. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97650. * @param subMesh The submesh we want to render in the shadow map
  97651. * @param useInstances Defines wether will draw in the map using instances
  97652. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97653. * @returns true if ready otherwise, false
  97654. */
  97655. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97656. /**
  97657. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97658. * @param defines Defines of the material we want to update
  97659. * @param lightIndex Index of the light in the enabled light list of the material
  97660. */
  97661. prepareDefines(defines: any, lightIndex: number): void;
  97662. /**
  97663. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97664. * defined in the generator but impacting the effect).
  97665. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97666. * @param effect The effect we are binfing the information for
  97667. */
  97668. bindShadowLight(lightIndex: string, effect: Effect): void;
  97669. /**
  97670. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97671. * (eq to shadow prjection matrix * light transform matrix)
  97672. * @returns The transform matrix used to create the shadow map
  97673. */
  97674. getTransformMatrix(): Matrix;
  97675. /**
  97676. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97677. * Cube and 2D textures for instance.
  97678. */
  97679. recreateShadowMap(): void;
  97680. protected _disposeBlurPostProcesses(): void;
  97681. protected _disposeRTTandPostProcesses(): void;
  97682. /**
  97683. * Disposes the ShadowGenerator.
  97684. * Returns nothing.
  97685. */
  97686. dispose(): void;
  97687. /**
  97688. * Serializes the shadow generator setup to a json object.
  97689. * @returns The serialized JSON object
  97690. */
  97691. serialize(): any;
  97692. /**
  97693. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97694. * @param parsedShadowGenerator The JSON object to parse
  97695. * @param scene The scene to create the shadow map for
  97696. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97697. * @returns The parsed shadow generator
  97698. */
  97699. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97700. }
  97701. }
  97702. declare module BABYLON {
  97703. /**
  97704. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97705. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97706. * 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.
  97707. */
  97708. export abstract class Light extends Node {
  97709. /**
  97710. * Falloff Default: light is falling off following the material specification:
  97711. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97712. */
  97713. static readonly FALLOFF_DEFAULT: number;
  97714. /**
  97715. * Falloff Physical: light is falling off following the inverse squared distance law.
  97716. */
  97717. static readonly FALLOFF_PHYSICAL: number;
  97718. /**
  97719. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97720. * to enhance interoperability with other engines.
  97721. */
  97722. static readonly FALLOFF_GLTF: number;
  97723. /**
  97724. * Falloff Standard: light is falling off like in the standard material
  97725. * to enhance interoperability with other materials.
  97726. */
  97727. static readonly FALLOFF_STANDARD: number;
  97728. /**
  97729. * If every light affecting the material is in this lightmapMode,
  97730. * material.lightmapTexture adds or multiplies
  97731. * (depends on material.useLightmapAsShadowmap)
  97732. * after every other light calculations.
  97733. */
  97734. static readonly LIGHTMAP_DEFAULT: number;
  97735. /**
  97736. * material.lightmapTexture as only diffuse lighting from this light
  97737. * adds only specular lighting from this light
  97738. * adds dynamic shadows
  97739. */
  97740. static readonly LIGHTMAP_SPECULAR: number;
  97741. /**
  97742. * material.lightmapTexture as only lighting
  97743. * no light calculation from this light
  97744. * only adds dynamic shadows from this light
  97745. */
  97746. static readonly LIGHTMAP_SHADOWSONLY: number;
  97747. /**
  97748. * Each light type uses the default quantity according to its type:
  97749. * point/spot lights use luminous intensity
  97750. * directional lights use illuminance
  97751. */
  97752. static readonly INTENSITYMODE_AUTOMATIC: number;
  97753. /**
  97754. * lumen (lm)
  97755. */
  97756. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97757. /**
  97758. * candela (lm/sr)
  97759. */
  97760. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97761. /**
  97762. * lux (lm/m^2)
  97763. */
  97764. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97765. /**
  97766. * nit (cd/m^2)
  97767. */
  97768. static readonly INTENSITYMODE_LUMINANCE: number;
  97769. /**
  97770. * Light type const id of the point light.
  97771. */
  97772. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97773. /**
  97774. * Light type const id of the directional light.
  97775. */
  97776. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97777. /**
  97778. * Light type const id of the spot light.
  97779. */
  97780. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97781. /**
  97782. * Light type const id of the hemispheric light.
  97783. */
  97784. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97785. /**
  97786. * Diffuse gives the basic color to an object.
  97787. */
  97788. diffuse: Color3;
  97789. /**
  97790. * Specular produces a highlight color on an object.
  97791. * Note: This is note affecting PBR materials.
  97792. */
  97793. specular: Color3;
  97794. /**
  97795. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97796. * falling off base on range or angle.
  97797. * This can be set to any values in Light.FALLOFF_x.
  97798. *
  97799. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97800. * other types of materials.
  97801. */
  97802. falloffType: number;
  97803. /**
  97804. * Strength of the light.
  97805. * Note: By default it is define in the framework own unit.
  97806. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97807. */
  97808. intensity: number;
  97809. private _range;
  97810. protected _inverseSquaredRange: number;
  97811. /**
  97812. * Defines how far from the source the light is impacting in scene units.
  97813. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97814. */
  97815. get range(): number;
  97816. /**
  97817. * Defines how far from the source the light is impacting in scene units.
  97818. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97819. */
  97820. set range(value: number);
  97821. /**
  97822. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97823. * of light.
  97824. */
  97825. private _photometricScale;
  97826. private _intensityMode;
  97827. /**
  97828. * Gets the photometric scale used to interpret the intensity.
  97829. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97830. */
  97831. get intensityMode(): number;
  97832. /**
  97833. * Sets the photometric scale used to interpret the intensity.
  97834. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97835. */
  97836. set intensityMode(value: number);
  97837. private _radius;
  97838. /**
  97839. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97840. */
  97841. get radius(): number;
  97842. /**
  97843. * sets the light radius used by PBR Materials to simulate soft area lights.
  97844. */
  97845. set radius(value: number);
  97846. private _renderPriority;
  97847. /**
  97848. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97849. * exceeding the number allowed of the materials.
  97850. */
  97851. renderPriority: number;
  97852. private _shadowEnabled;
  97853. /**
  97854. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97855. * the current shadow generator.
  97856. */
  97857. get shadowEnabled(): boolean;
  97858. /**
  97859. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97860. * the current shadow generator.
  97861. */
  97862. set shadowEnabled(value: boolean);
  97863. private _includedOnlyMeshes;
  97864. /**
  97865. * Gets the only meshes impacted by this light.
  97866. */
  97867. get includedOnlyMeshes(): AbstractMesh[];
  97868. /**
  97869. * Sets the only meshes impacted by this light.
  97870. */
  97871. set includedOnlyMeshes(value: AbstractMesh[]);
  97872. private _excludedMeshes;
  97873. /**
  97874. * Gets the meshes not impacted by this light.
  97875. */
  97876. get excludedMeshes(): AbstractMesh[];
  97877. /**
  97878. * Sets the meshes not impacted by this light.
  97879. */
  97880. set excludedMeshes(value: AbstractMesh[]);
  97881. private _excludeWithLayerMask;
  97882. /**
  97883. * Gets the layer id use to find what meshes are not impacted by the light.
  97884. * Inactive if 0
  97885. */
  97886. get excludeWithLayerMask(): number;
  97887. /**
  97888. * Sets the layer id use to find what meshes are not impacted by the light.
  97889. * Inactive if 0
  97890. */
  97891. set excludeWithLayerMask(value: number);
  97892. private _includeOnlyWithLayerMask;
  97893. /**
  97894. * Gets the layer id use to find what meshes are impacted by the light.
  97895. * Inactive if 0
  97896. */
  97897. get includeOnlyWithLayerMask(): number;
  97898. /**
  97899. * Sets the layer id use to find what meshes are impacted by the light.
  97900. * Inactive if 0
  97901. */
  97902. set includeOnlyWithLayerMask(value: number);
  97903. private _lightmapMode;
  97904. /**
  97905. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97906. */
  97907. get lightmapMode(): number;
  97908. /**
  97909. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97910. */
  97911. set lightmapMode(value: number);
  97912. /**
  97913. * Shadow generator associted to the light.
  97914. * @hidden Internal use only.
  97915. */
  97916. _shadowGenerator: Nullable<IShadowGenerator>;
  97917. /**
  97918. * @hidden Internal use only.
  97919. */
  97920. _excludedMeshesIds: string[];
  97921. /**
  97922. * @hidden Internal use only.
  97923. */
  97924. _includedOnlyMeshesIds: string[];
  97925. /**
  97926. * The current light unifom buffer.
  97927. * @hidden Internal use only.
  97928. */
  97929. _uniformBuffer: UniformBuffer;
  97930. /** @hidden */
  97931. _renderId: number;
  97932. /**
  97933. * Creates a Light object in the scene.
  97934. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97935. * @param name The firendly name of the light
  97936. * @param scene The scene the light belongs too
  97937. */
  97938. constructor(name: string, scene: Scene);
  97939. protected abstract _buildUniformLayout(): void;
  97940. /**
  97941. * Sets the passed Effect "effect" with the Light information.
  97942. * @param effect The effect to update
  97943. * @param lightIndex The index of the light in the effect to update
  97944. * @returns The light
  97945. */
  97946. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97947. /**
  97948. * Sets the passed Effect "effect" with the Light textures.
  97949. * @param effect The effect to update
  97950. * @param lightIndex The index of the light in the effect to update
  97951. * @returns The light
  97952. */
  97953. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97954. /**
  97955. * Binds the lights information from the scene to the effect for the given mesh.
  97956. * @param lightIndex Light index
  97957. * @param scene The scene where the light belongs to
  97958. * @param effect The effect we are binding the data to
  97959. * @param useSpecular Defines if specular is supported
  97960. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97961. */
  97962. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97963. /**
  97964. * Sets the passed Effect "effect" with the Light information.
  97965. * @param effect The effect to update
  97966. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97967. * @returns The light
  97968. */
  97969. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97970. /**
  97971. * Returns the string "Light".
  97972. * @returns the class name
  97973. */
  97974. getClassName(): string;
  97975. /** @hidden */
  97976. readonly _isLight: boolean;
  97977. /**
  97978. * Converts the light information to a readable string for debug purpose.
  97979. * @param fullDetails Supports for multiple levels of logging within scene loading
  97980. * @returns the human readable light info
  97981. */
  97982. toString(fullDetails?: boolean): string;
  97983. /** @hidden */
  97984. protected _syncParentEnabledState(): void;
  97985. /**
  97986. * Set the enabled state of this node.
  97987. * @param value - the new enabled state
  97988. */
  97989. setEnabled(value: boolean): void;
  97990. /**
  97991. * Returns the Light associated shadow generator if any.
  97992. * @return the associated shadow generator.
  97993. */
  97994. getShadowGenerator(): Nullable<IShadowGenerator>;
  97995. /**
  97996. * Returns a Vector3, the absolute light position in the World.
  97997. * @returns the world space position of the light
  97998. */
  97999. getAbsolutePosition(): Vector3;
  98000. /**
  98001. * Specifies if the light will affect the passed mesh.
  98002. * @param mesh The mesh to test against the light
  98003. * @return true the mesh is affected otherwise, false.
  98004. */
  98005. canAffectMesh(mesh: AbstractMesh): boolean;
  98006. /**
  98007. * Sort function to order lights for rendering.
  98008. * @param a First Light object to compare to second.
  98009. * @param b Second Light object to compare first.
  98010. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  98011. */
  98012. static CompareLightsPriority(a: Light, b: Light): number;
  98013. /**
  98014. * Releases resources associated with this node.
  98015. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  98016. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  98017. */
  98018. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  98019. /**
  98020. * Returns the light type ID (integer).
  98021. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98022. */
  98023. getTypeID(): number;
  98024. /**
  98025. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  98026. * @returns the scaled intensity in intensity mode unit
  98027. */
  98028. getScaledIntensity(): number;
  98029. /**
  98030. * Returns a new Light object, named "name", from the current one.
  98031. * @param name The name of the cloned light
  98032. * @param newParent The parent of this light, if it has one
  98033. * @returns the new created light
  98034. */
  98035. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  98036. /**
  98037. * Serializes the current light into a Serialization object.
  98038. * @returns the serialized object.
  98039. */
  98040. serialize(): any;
  98041. /**
  98042. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  98043. * This new light is named "name" and added to the passed scene.
  98044. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  98045. * @param name The friendly name of the light
  98046. * @param scene The scene the new light will belong to
  98047. * @returns the constructor function
  98048. */
  98049. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  98050. /**
  98051. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  98052. * @param parsedLight The JSON representation of the light
  98053. * @param scene The scene to create the parsed light in
  98054. * @returns the created light after parsing
  98055. */
  98056. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  98057. private _hookArrayForExcluded;
  98058. private _hookArrayForIncludedOnly;
  98059. private _resyncMeshes;
  98060. /**
  98061. * Forces the meshes to update their light related information in their rendering used effects
  98062. * @hidden Internal Use Only
  98063. */
  98064. _markMeshesAsLightDirty(): void;
  98065. /**
  98066. * Recomputes the cached photometric scale if needed.
  98067. */
  98068. private _computePhotometricScale;
  98069. /**
  98070. * Returns the Photometric Scale according to the light type and intensity mode.
  98071. */
  98072. private _getPhotometricScale;
  98073. /**
  98074. * Reorder the light in the scene according to their defined priority.
  98075. * @hidden Internal Use Only
  98076. */
  98077. _reorderLightsInScene(): void;
  98078. /**
  98079. * Prepares the list of defines specific to the light type.
  98080. * @param defines the list of defines
  98081. * @param lightIndex defines the index of the light for the effect
  98082. */
  98083. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98084. }
  98085. }
  98086. declare module BABYLON {
  98087. /**
  98088. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98089. * This is the base of the follow, arc rotate cameras and Free camera
  98090. * @see https://doc.babylonjs.com/features/cameras
  98091. */
  98092. export class TargetCamera extends Camera {
  98093. private static _RigCamTransformMatrix;
  98094. private static _TargetTransformMatrix;
  98095. private static _TargetFocalPoint;
  98096. private _tmpUpVector;
  98097. private _tmpTargetVector;
  98098. /**
  98099. * Define the current direction the camera is moving to
  98100. */
  98101. cameraDirection: Vector3;
  98102. /**
  98103. * Define the current rotation the camera is rotating to
  98104. */
  98105. cameraRotation: Vector2;
  98106. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98107. ignoreParentScaling: boolean;
  98108. /**
  98109. * When set, the up vector of the camera will be updated by the rotation of the camera
  98110. */
  98111. updateUpVectorFromRotation: boolean;
  98112. private _tmpQuaternion;
  98113. /**
  98114. * Define the current rotation of the camera
  98115. */
  98116. rotation: Vector3;
  98117. /**
  98118. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98119. */
  98120. rotationQuaternion: Quaternion;
  98121. /**
  98122. * Define the current speed of the camera
  98123. */
  98124. speed: number;
  98125. /**
  98126. * Add constraint to the camera to prevent it to move freely in all directions and
  98127. * around all axis.
  98128. */
  98129. noRotationConstraint: boolean;
  98130. /**
  98131. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98132. * panning
  98133. */
  98134. invertRotation: boolean;
  98135. /**
  98136. * Speed multiplier for inverse camera panning
  98137. */
  98138. inverseRotationSpeed: number;
  98139. /**
  98140. * Define the current target of the camera as an object or a position.
  98141. */
  98142. lockedTarget: any;
  98143. /** @hidden */
  98144. _currentTarget: Vector3;
  98145. /** @hidden */
  98146. _initialFocalDistance: number;
  98147. /** @hidden */
  98148. _viewMatrix: Matrix;
  98149. /** @hidden */
  98150. _camMatrix: Matrix;
  98151. /** @hidden */
  98152. _cameraTransformMatrix: Matrix;
  98153. /** @hidden */
  98154. _cameraRotationMatrix: Matrix;
  98155. /** @hidden */
  98156. _referencePoint: Vector3;
  98157. /** @hidden */
  98158. _transformedReferencePoint: Vector3;
  98159. /** @hidden */
  98160. _reset: () => void;
  98161. private _defaultUp;
  98162. /**
  98163. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98164. * This is the base of the follow, arc rotate cameras and Free camera
  98165. * @see https://doc.babylonjs.com/features/cameras
  98166. * @param name Defines the name of the camera in the scene
  98167. * @param position Defines the start position of the camera in the scene
  98168. * @param scene Defines the scene the camera belongs to
  98169. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98170. */
  98171. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98172. /**
  98173. * Gets the position in front of the camera at a given distance.
  98174. * @param distance The distance from the camera we want the position to be
  98175. * @returns the position
  98176. */
  98177. getFrontPosition(distance: number): Vector3;
  98178. /** @hidden */
  98179. _getLockedTargetPosition(): Nullable<Vector3>;
  98180. private _storedPosition;
  98181. private _storedRotation;
  98182. private _storedRotationQuaternion;
  98183. /**
  98184. * Store current camera state of the camera (fov, position, rotation, etc..)
  98185. * @returns the camera
  98186. */
  98187. storeState(): Camera;
  98188. /**
  98189. * Restored camera state. You must call storeState() first
  98190. * @returns whether it was successful or not
  98191. * @hidden
  98192. */
  98193. _restoreStateValues(): boolean;
  98194. /** @hidden */
  98195. _initCache(): void;
  98196. /** @hidden */
  98197. _updateCache(ignoreParentClass?: boolean): void;
  98198. /** @hidden */
  98199. _isSynchronizedViewMatrix(): boolean;
  98200. /** @hidden */
  98201. _computeLocalCameraSpeed(): number;
  98202. /**
  98203. * Defines the target the camera should look at.
  98204. * @param target Defines the new target as a Vector or a mesh
  98205. */
  98206. setTarget(target: Vector3): void;
  98207. /**
  98208. * Defines the target point of the camera.
  98209. * The camera looks towards it form the radius distance.
  98210. */
  98211. get target(): Vector3;
  98212. set target(value: Vector3);
  98213. /**
  98214. * Return the current target position of the camera. This value is expressed in local space.
  98215. * @returns the target position
  98216. */
  98217. getTarget(): Vector3;
  98218. /** @hidden */
  98219. _decideIfNeedsToMove(): boolean;
  98220. /** @hidden */
  98221. _updatePosition(): void;
  98222. /** @hidden */
  98223. _checkInputs(): void;
  98224. protected _updateCameraRotationMatrix(): void;
  98225. /**
  98226. * 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)
  98227. * @returns the current camera
  98228. */
  98229. private _rotateUpVectorWithCameraRotationMatrix;
  98230. private _cachedRotationZ;
  98231. private _cachedQuaternionRotationZ;
  98232. /** @hidden */
  98233. _getViewMatrix(): Matrix;
  98234. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98235. /**
  98236. * @hidden
  98237. */
  98238. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98239. /**
  98240. * @hidden
  98241. */
  98242. _updateRigCameras(): void;
  98243. private _getRigCamPositionAndTarget;
  98244. /**
  98245. * Gets the current object class name.
  98246. * @return the class name
  98247. */
  98248. getClassName(): string;
  98249. }
  98250. }
  98251. declare module BABYLON {
  98252. /**
  98253. * Gather the list of keyboard event types as constants.
  98254. */
  98255. export class KeyboardEventTypes {
  98256. /**
  98257. * The keydown event is fired when a key becomes active (pressed).
  98258. */
  98259. static readonly KEYDOWN: number;
  98260. /**
  98261. * The keyup event is fired when a key has been released.
  98262. */
  98263. static readonly KEYUP: number;
  98264. }
  98265. /**
  98266. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98267. */
  98268. export class KeyboardInfo {
  98269. /**
  98270. * Defines the type of event (KeyboardEventTypes)
  98271. */
  98272. type: number;
  98273. /**
  98274. * Defines the related dom event
  98275. */
  98276. event: KeyboardEvent;
  98277. /**
  98278. * Instantiates a new keyboard info.
  98279. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98280. * @param type Defines the type of event (KeyboardEventTypes)
  98281. * @param event Defines the related dom event
  98282. */
  98283. constructor(
  98284. /**
  98285. * Defines the type of event (KeyboardEventTypes)
  98286. */
  98287. type: number,
  98288. /**
  98289. * Defines the related dom event
  98290. */
  98291. event: KeyboardEvent);
  98292. }
  98293. /**
  98294. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98295. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98296. */
  98297. export class KeyboardInfoPre extends KeyboardInfo {
  98298. /**
  98299. * Defines the type of event (KeyboardEventTypes)
  98300. */
  98301. type: number;
  98302. /**
  98303. * Defines the related dom event
  98304. */
  98305. event: KeyboardEvent;
  98306. /**
  98307. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98308. */
  98309. skipOnPointerObservable: boolean;
  98310. /**
  98311. * Instantiates a new keyboard pre info.
  98312. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98313. * @param type Defines the type of event (KeyboardEventTypes)
  98314. * @param event Defines the related dom event
  98315. */
  98316. constructor(
  98317. /**
  98318. * Defines the type of event (KeyboardEventTypes)
  98319. */
  98320. type: number,
  98321. /**
  98322. * Defines the related dom event
  98323. */
  98324. event: KeyboardEvent);
  98325. }
  98326. }
  98327. declare module BABYLON {
  98328. /**
  98329. * Manage the keyboard inputs to control the movement of a free camera.
  98330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98331. */
  98332. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98333. /**
  98334. * Defines the camera the input is attached to.
  98335. */
  98336. camera: FreeCamera;
  98337. /**
  98338. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98339. */
  98340. keysUp: number[];
  98341. /**
  98342. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98343. */
  98344. keysUpward: number[];
  98345. /**
  98346. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98347. */
  98348. keysDown: number[];
  98349. /**
  98350. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98351. */
  98352. keysDownward: number[];
  98353. /**
  98354. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98355. */
  98356. keysLeft: number[];
  98357. /**
  98358. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98359. */
  98360. keysRight: number[];
  98361. private _keys;
  98362. private _onCanvasBlurObserver;
  98363. private _onKeyboardObserver;
  98364. private _engine;
  98365. private _scene;
  98366. /**
  98367. * Attach the input controls to a specific dom element to get the input from.
  98368. * @param element Defines the element the controls should be listened from
  98369. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98370. */
  98371. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98372. /**
  98373. * Detach the current controls from the specified dom element.
  98374. * @param element Defines the element to stop listening the inputs from
  98375. */
  98376. detachControl(element: Nullable<HTMLElement>): void;
  98377. /**
  98378. * Update the current camera state depending on the inputs that have been used this frame.
  98379. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98380. */
  98381. checkInputs(): void;
  98382. /**
  98383. * Gets the class name of the current intput.
  98384. * @returns the class name
  98385. */
  98386. getClassName(): string;
  98387. /** @hidden */
  98388. _onLostFocus(): void;
  98389. /**
  98390. * Get the friendly name associated with the input class.
  98391. * @returns the input friendly name
  98392. */
  98393. getSimpleName(): string;
  98394. }
  98395. }
  98396. declare module BABYLON {
  98397. /**
  98398. * Gather the list of pointer event types as constants.
  98399. */
  98400. export class PointerEventTypes {
  98401. /**
  98402. * 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.
  98403. */
  98404. static readonly POINTERDOWN: number;
  98405. /**
  98406. * The pointerup event is fired when a pointer is no longer active.
  98407. */
  98408. static readonly POINTERUP: number;
  98409. /**
  98410. * The pointermove event is fired when a pointer changes coordinates.
  98411. */
  98412. static readonly POINTERMOVE: number;
  98413. /**
  98414. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98415. */
  98416. static readonly POINTERWHEEL: number;
  98417. /**
  98418. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98419. */
  98420. static readonly POINTERPICK: number;
  98421. /**
  98422. * The pointertap event is fired when a the object has been touched and released without drag.
  98423. */
  98424. static readonly POINTERTAP: number;
  98425. /**
  98426. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98427. */
  98428. static readonly POINTERDOUBLETAP: number;
  98429. }
  98430. /**
  98431. * Base class of pointer info types.
  98432. */
  98433. export class PointerInfoBase {
  98434. /**
  98435. * Defines the type of event (PointerEventTypes)
  98436. */
  98437. type: number;
  98438. /**
  98439. * Defines the related dom event
  98440. */
  98441. event: PointerEvent | MouseWheelEvent;
  98442. /**
  98443. * Instantiates the base class of pointers info.
  98444. * @param type Defines the type of event (PointerEventTypes)
  98445. * @param event Defines the related dom event
  98446. */
  98447. constructor(
  98448. /**
  98449. * Defines the type of event (PointerEventTypes)
  98450. */
  98451. type: number,
  98452. /**
  98453. * Defines the related dom event
  98454. */
  98455. event: PointerEvent | MouseWheelEvent);
  98456. }
  98457. /**
  98458. * This class is used to store pointer related info for the onPrePointerObservable event.
  98459. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98460. */
  98461. export class PointerInfoPre extends PointerInfoBase {
  98462. /**
  98463. * Ray from a pointer if availible (eg. 6dof controller)
  98464. */
  98465. ray: Nullable<Ray>;
  98466. /**
  98467. * Defines the local position of the pointer on the canvas.
  98468. */
  98469. localPosition: Vector2;
  98470. /**
  98471. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98472. */
  98473. skipOnPointerObservable: boolean;
  98474. /**
  98475. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98476. * @param type Defines the type of event (PointerEventTypes)
  98477. * @param event Defines the related dom event
  98478. * @param localX Defines the local x coordinates of the pointer when the event occured
  98479. * @param localY Defines the local y coordinates of the pointer when the event occured
  98480. */
  98481. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98482. }
  98483. /**
  98484. * This type contains all the data related to a pointer event in Babylon.js.
  98485. * 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.
  98486. */
  98487. export class PointerInfo extends PointerInfoBase {
  98488. /**
  98489. * Defines the picking info associated to the info (if any)\
  98490. */
  98491. pickInfo: Nullable<PickingInfo>;
  98492. /**
  98493. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98494. * @param type Defines the type of event (PointerEventTypes)
  98495. * @param event Defines the related dom event
  98496. * @param pickInfo Defines the picking info associated to the info (if any)\
  98497. */
  98498. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98499. /**
  98500. * Defines the picking info associated to the info (if any)\
  98501. */
  98502. pickInfo: Nullable<PickingInfo>);
  98503. }
  98504. /**
  98505. * Data relating to a touch event on the screen.
  98506. */
  98507. export interface PointerTouch {
  98508. /**
  98509. * X coordinate of touch.
  98510. */
  98511. x: number;
  98512. /**
  98513. * Y coordinate of touch.
  98514. */
  98515. y: number;
  98516. /**
  98517. * Id of touch. Unique for each finger.
  98518. */
  98519. pointerId: number;
  98520. /**
  98521. * Event type passed from DOM.
  98522. */
  98523. type: any;
  98524. }
  98525. }
  98526. declare module BABYLON {
  98527. /**
  98528. * Manage the mouse inputs to control the movement of a free camera.
  98529. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98530. */
  98531. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98532. /**
  98533. * Define if touch is enabled in the mouse input
  98534. */
  98535. touchEnabled: boolean;
  98536. /**
  98537. * Defines the camera the input is attached to.
  98538. */
  98539. camera: FreeCamera;
  98540. /**
  98541. * Defines the buttons associated with the input to handle camera move.
  98542. */
  98543. buttons: number[];
  98544. /**
  98545. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98546. */
  98547. angularSensibility: number;
  98548. private _pointerInput;
  98549. private _onMouseMove;
  98550. private _observer;
  98551. private previousPosition;
  98552. /**
  98553. * Observable for when a pointer move event occurs containing the move offset
  98554. */
  98555. onPointerMovedObservable: Observable<{
  98556. offsetX: number;
  98557. offsetY: number;
  98558. }>;
  98559. /**
  98560. * @hidden
  98561. * If the camera should be rotated automatically based on pointer movement
  98562. */
  98563. _allowCameraRotation: boolean;
  98564. /**
  98565. * Manage the mouse inputs to control the movement of a free camera.
  98566. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98567. * @param touchEnabled Defines if touch is enabled or not
  98568. */
  98569. constructor(
  98570. /**
  98571. * Define if touch is enabled in the mouse input
  98572. */
  98573. touchEnabled?: boolean);
  98574. /**
  98575. * Attach the input controls to a specific dom element to get the input from.
  98576. * @param element Defines the element the controls should be listened from
  98577. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98578. */
  98579. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98580. /**
  98581. * Called on JS contextmenu event.
  98582. * Override this method to provide functionality.
  98583. */
  98584. protected onContextMenu(evt: PointerEvent): void;
  98585. /**
  98586. * Detach the current controls from the specified dom element.
  98587. * @param element Defines the element to stop listening the inputs from
  98588. */
  98589. detachControl(element: Nullable<HTMLElement>): void;
  98590. /**
  98591. * Gets the class name of the current intput.
  98592. * @returns the class name
  98593. */
  98594. getClassName(): string;
  98595. /**
  98596. * Get the friendly name associated with the input class.
  98597. * @returns the input friendly name
  98598. */
  98599. getSimpleName(): string;
  98600. }
  98601. }
  98602. declare module BABYLON {
  98603. /**
  98604. * Manage the touch inputs to control the movement of a free camera.
  98605. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98606. */
  98607. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98608. /**
  98609. * Define if mouse events can be treated as touch events
  98610. */
  98611. allowMouse: boolean;
  98612. /**
  98613. * Defines the camera the input is attached to.
  98614. */
  98615. camera: FreeCamera;
  98616. /**
  98617. * Defines the touch sensibility for rotation.
  98618. * The higher the faster.
  98619. */
  98620. touchAngularSensibility: number;
  98621. /**
  98622. * Defines the touch sensibility for move.
  98623. * The higher the faster.
  98624. */
  98625. touchMoveSensibility: number;
  98626. private _offsetX;
  98627. private _offsetY;
  98628. private _pointerPressed;
  98629. private _pointerInput;
  98630. private _observer;
  98631. private _onLostFocus;
  98632. /**
  98633. * Manage the touch inputs to control the movement of a free camera.
  98634. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98635. * @param allowMouse Defines if mouse events can be treated as touch events
  98636. */
  98637. constructor(
  98638. /**
  98639. * Define if mouse events can be treated as touch events
  98640. */
  98641. allowMouse?: boolean);
  98642. /**
  98643. * Attach the input controls to a specific dom element to get the input from.
  98644. * @param element Defines the element the controls should be listened from
  98645. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98646. */
  98647. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98648. /**
  98649. * Detach the current controls from the specified dom element.
  98650. * @param element Defines the element to stop listening the inputs from
  98651. */
  98652. detachControl(element: Nullable<HTMLElement>): void;
  98653. /**
  98654. * Update the current camera state depending on the inputs that have been used this frame.
  98655. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98656. */
  98657. checkInputs(): void;
  98658. /**
  98659. * Gets the class name of the current intput.
  98660. * @returns the class name
  98661. */
  98662. getClassName(): string;
  98663. /**
  98664. * Get the friendly name associated with the input class.
  98665. * @returns the input friendly name
  98666. */
  98667. getSimpleName(): string;
  98668. }
  98669. }
  98670. declare module BABYLON {
  98671. /**
  98672. * Default Inputs manager for the FreeCamera.
  98673. * It groups all the default supported inputs for ease of use.
  98674. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98675. */
  98676. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98677. /**
  98678. * @hidden
  98679. */
  98680. _mouseInput: Nullable<FreeCameraMouseInput>;
  98681. /**
  98682. * Instantiates a new FreeCameraInputsManager.
  98683. * @param camera Defines the camera the inputs belong to
  98684. */
  98685. constructor(camera: FreeCamera);
  98686. /**
  98687. * Add keyboard input support to the input manager.
  98688. * @returns the current input manager
  98689. */
  98690. addKeyboard(): FreeCameraInputsManager;
  98691. /**
  98692. * Add mouse input support to the input manager.
  98693. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98694. * @returns the current input manager
  98695. */
  98696. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98697. /**
  98698. * Removes the mouse input support from the manager
  98699. * @returns the current input manager
  98700. */
  98701. removeMouse(): FreeCameraInputsManager;
  98702. /**
  98703. * Add touch input support to the input manager.
  98704. * @returns the current input manager
  98705. */
  98706. addTouch(): FreeCameraInputsManager;
  98707. /**
  98708. * Remove all attached input methods from a camera
  98709. */
  98710. clear(): void;
  98711. }
  98712. }
  98713. declare module BABYLON {
  98714. /**
  98715. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98716. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98717. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98718. */
  98719. export class FreeCamera extends TargetCamera {
  98720. /**
  98721. * Define the collision ellipsoid of the camera.
  98722. * This is helpful to simulate a camera body like the player body around the camera
  98723. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98724. */
  98725. ellipsoid: Vector3;
  98726. /**
  98727. * Define an offset for the position of the ellipsoid around the camera.
  98728. * This can be helpful to determine the center of the body near the gravity center of the body
  98729. * instead of its head.
  98730. */
  98731. ellipsoidOffset: Vector3;
  98732. /**
  98733. * Enable or disable collisions of the camera with the rest of the scene objects.
  98734. */
  98735. checkCollisions: boolean;
  98736. /**
  98737. * Enable or disable gravity on the camera.
  98738. */
  98739. applyGravity: boolean;
  98740. /**
  98741. * Define the input manager associated to the camera.
  98742. */
  98743. inputs: FreeCameraInputsManager;
  98744. /**
  98745. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98746. * Higher values reduce sensitivity.
  98747. */
  98748. get angularSensibility(): number;
  98749. /**
  98750. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98751. * Higher values reduce sensitivity.
  98752. */
  98753. set angularSensibility(value: number);
  98754. /**
  98755. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98756. */
  98757. get keysUp(): number[];
  98758. set keysUp(value: number[]);
  98759. /**
  98760. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98761. */
  98762. get keysUpward(): number[];
  98763. set keysUpward(value: number[]);
  98764. /**
  98765. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98766. */
  98767. get keysDown(): number[];
  98768. set keysDown(value: number[]);
  98769. /**
  98770. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98771. */
  98772. get keysDownward(): number[];
  98773. set keysDownward(value: number[]);
  98774. /**
  98775. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98776. */
  98777. get keysLeft(): number[];
  98778. set keysLeft(value: number[]);
  98779. /**
  98780. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98781. */
  98782. get keysRight(): number[];
  98783. set keysRight(value: number[]);
  98784. /**
  98785. * Event raised when the camera collide with a mesh in the scene.
  98786. */
  98787. onCollide: (collidedMesh: AbstractMesh) => void;
  98788. private _collider;
  98789. private _needMoveForGravity;
  98790. private _oldPosition;
  98791. private _diffPosition;
  98792. private _newPosition;
  98793. /** @hidden */
  98794. _localDirection: Vector3;
  98795. /** @hidden */
  98796. _transformedDirection: Vector3;
  98797. /**
  98798. * Instantiates a Free Camera.
  98799. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98800. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98801. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98802. * @param name Define the name of the camera in the scene
  98803. * @param position Define the start position of the camera in the scene
  98804. * @param scene Define the scene the camera belongs to
  98805. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98806. */
  98807. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98808. /**
  98809. * Attached controls to the current camera.
  98810. * @param element Defines the element the controls should be listened from
  98811. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98812. */
  98813. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98814. /**
  98815. * Detach the current controls from the camera.
  98816. * The camera will stop reacting to inputs.
  98817. * @param element Defines the element to stop listening the inputs from
  98818. */
  98819. detachControl(element: HTMLElement): void;
  98820. private _collisionMask;
  98821. /**
  98822. * Define a collision mask to limit the list of object the camera can collide with
  98823. */
  98824. get collisionMask(): number;
  98825. set collisionMask(mask: number);
  98826. /** @hidden */
  98827. _collideWithWorld(displacement: Vector3): void;
  98828. private _onCollisionPositionChange;
  98829. /** @hidden */
  98830. _checkInputs(): void;
  98831. /** @hidden */
  98832. _decideIfNeedsToMove(): boolean;
  98833. /** @hidden */
  98834. _updatePosition(): void;
  98835. /**
  98836. * Destroy the camera and release the current resources hold by it.
  98837. */
  98838. dispose(): void;
  98839. /**
  98840. * Gets the current object class name.
  98841. * @return the class name
  98842. */
  98843. getClassName(): string;
  98844. }
  98845. }
  98846. declare module BABYLON {
  98847. /**
  98848. * Represents a gamepad control stick position
  98849. */
  98850. export class StickValues {
  98851. /**
  98852. * The x component of the control stick
  98853. */
  98854. x: number;
  98855. /**
  98856. * The y component of the control stick
  98857. */
  98858. y: number;
  98859. /**
  98860. * Initializes the gamepad x and y control stick values
  98861. * @param x The x component of the gamepad control stick value
  98862. * @param y The y component of the gamepad control stick value
  98863. */
  98864. constructor(
  98865. /**
  98866. * The x component of the control stick
  98867. */
  98868. x: number,
  98869. /**
  98870. * The y component of the control stick
  98871. */
  98872. y: number);
  98873. }
  98874. /**
  98875. * An interface which manages callbacks for gamepad button changes
  98876. */
  98877. export interface GamepadButtonChanges {
  98878. /**
  98879. * Called when a gamepad has been changed
  98880. */
  98881. changed: boolean;
  98882. /**
  98883. * Called when a gamepad press event has been triggered
  98884. */
  98885. pressChanged: boolean;
  98886. /**
  98887. * Called when a touch event has been triggered
  98888. */
  98889. touchChanged: boolean;
  98890. /**
  98891. * Called when a value has changed
  98892. */
  98893. valueChanged: boolean;
  98894. }
  98895. /**
  98896. * Represents a gamepad
  98897. */
  98898. export class Gamepad {
  98899. /**
  98900. * The id of the gamepad
  98901. */
  98902. id: string;
  98903. /**
  98904. * The index of the gamepad
  98905. */
  98906. index: number;
  98907. /**
  98908. * The browser gamepad
  98909. */
  98910. browserGamepad: any;
  98911. /**
  98912. * Specifies what type of gamepad this represents
  98913. */
  98914. type: number;
  98915. private _leftStick;
  98916. private _rightStick;
  98917. /** @hidden */
  98918. _isConnected: boolean;
  98919. private _leftStickAxisX;
  98920. private _leftStickAxisY;
  98921. private _rightStickAxisX;
  98922. private _rightStickAxisY;
  98923. /**
  98924. * Triggered when the left control stick has been changed
  98925. */
  98926. private _onleftstickchanged;
  98927. /**
  98928. * Triggered when the right control stick has been changed
  98929. */
  98930. private _onrightstickchanged;
  98931. /**
  98932. * Represents a gamepad controller
  98933. */
  98934. static GAMEPAD: number;
  98935. /**
  98936. * Represents a generic controller
  98937. */
  98938. static GENERIC: number;
  98939. /**
  98940. * Represents an XBox controller
  98941. */
  98942. static XBOX: number;
  98943. /**
  98944. * Represents a pose-enabled controller
  98945. */
  98946. static POSE_ENABLED: number;
  98947. /**
  98948. * Represents an Dual Shock controller
  98949. */
  98950. static DUALSHOCK: number;
  98951. /**
  98952. * Specifies whether the left control stick should be Y-inverted
  98953. */
  98954. protected _invertLeftStickY: boolean;
  98955. /**
  98956. * Specifies if the gamepad has been connected
  98957. */
  98958. get isConnected(): boolean;
  98959. /**
  98960. * Initializes the gamepad
  98961. * @param id The id of the gamepad
  98962. * @param index The index of the gamepad
  98963. * @param browserGamepad The browser gamepad
  98964. * @param leftStickX The x component of the left joystick
  98965. * @param leftStickY The y component of the left joystick
  98966. * @param rightStickX The x component of the right joystick
  98967. * @param rightStickY The y component of the right joystick
  98968. */
  98969. constructor(
  98970. /**
  98971. * The id of the gamepad
  98972. */
  98973. id: string,
  98974. /**
  98975. * The index of the gamepad
  98976. */
  98977. index: number,
  98978. /**
  98979. * The browser gamepad
  98980. */
  98981. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98982. /**
  98983. * Callback triggered when the left joystick has changed
  98984. * @param callback
  98985. */
  98986. onleftstickchanged(callback: (values: StickValues) => void): void;
  98987. /**
  98988. * Callback triggered when the right joystick has changed
  98989. * @param callback
  98990. */
  98991. onrightstickchanged(callback: (values: StickValues) => void): void;
  98992. /**
  98993. * Gets the left joystick
  98994. */
  98995. get leftStick(): StickValues;
  98996. /**
  98997. * Sets the left joystick values
  98998. */
  98999. set leftStick(newValues: StickValues);
  99000. /**
  99001. * Gets the right joystick
  99002. */
  99003. get rightStick(): StickValues;
  99004. /**
  99005. * Sets the right joystick value
  99006. */
  99007. set rightStick(newValues: StickValues);
  99008. /**
  99009. * Updates the gamepad joystick positions
  99010. */
  99011. update(): void;
  99012. /**
  99013. * Disposes the gamepad
  99014. */
  99015. dispose(): void;
  99016. }
  99017. /**
  99018. * Represents a generic gamepad
  99019. */
  99020. export class GenericPad extends Gamepad {
  99021. private _buttons;
  99022. private _onbuttondown;
  99023. private _onbuttonup;
  99024. /**
  99025. * Observable triggered when a button has been pressed
  99026. */
  99027. onButtonDownObservable: Observable<number>;
  99028. /**
  99029. * Observable triggered when a button has been released
  99030. */
  99031. onButtonUpObservable: Observable<number>;
  99032. /**
  99033. * Callback triggered when a button has been pressed
  99034. * @param callback Called when a button has been pressed
  99035. */
  99036. onbuttondown(callback: (buttonPressed: number) => void): void;
  99037. /**
  99038. * Callback triggered when a button has been released
  99039. * @param callback Called when a button has been released
  99040. */
  99041. onbuttonup(callback: (buttonReleased: number) => void): void;
  99042. /**
  99043. * Initializes the generic gamepad
  99044. * @param id The id of the generic gamepad
  99045. * @param index The index of the generic gamepad
  99046. * @param browserGamepad The browser gamepad
  99047. */
  99048. constructor(id: string, index: number, browserGamepad: any);
  99049. private _setButtonValue;
  99050. /**
  99051. * Updates the generic gamepad
  99052. */
  99053. update(): void;
  99054. /**
  99055. * Disposes the generic gamepad
  99056. */
  99057. dispose(): void;
  99058. }
  99059. }
  99060. declare module BABYLON {
  99061. /**
  99062. * Defines the types of pose enabled controllers that are supported
  99063. */
  99064. export enum PoseEnabledControllerType {
  99065. /**
  99066. * HTC Vive
  99067. */
  99068. VIVE = 0,
  99069. /**
  99070. * Oculus Rift
  99071. */
  99072. OCULUS = 1,
  99073. /**
  99074. * Windows mixed reality
  99075. */
  99076. WINDOWS = 2,
  99077. /**
  99078. * Samsung gear VR
  99079. */
  99080. GEAR_VR = 3,
  99081. /**
  99082. * Google Daydream
  99083. */
  99084. DAYDREAM = 4,
  99085. /**
  99086. * Generic
  99087. */
  99088. GENERIC = 5
  99089. }
  99090. /**
  99091. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99092. */
  99093. export interface MutableGamepadButton {
  99094. /**
  99095. * Value of the button/trigger
  99096. */
  99097. value: number;
  99098. /**
  99099. * If the button/trigger is currently touched
  99100. */
  99101. touched: boolean;
  99102. /**
  99103. * If the button/trigger is currently pressed
  99104. */
  99105. pressed: boolean;
  99106. }
  99107. /**
  99108. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99109. * @hidden
  99110. */
  99111. export interface ExtendedGamepadButton extends GamepadButton {
  99112. /**
  99113. * If the button/trigger is currently pressed
  99114. */
  99115. readonly pressed: boolean;
  99116. /**
  99117. * If the button/trigger is currently touched
  99118. */
  99119. readonly touched: boolean;
  99120. /**
  99121. * Value of the button/trigger
  99122. */
  99123. readonly value: number;
  99124. }
  99125. /** @hidden */
  99126. export interface _GamePadFactory {
  99127. /**
  99128. * Returns whether or not the current gamepad can be created for this type of controller.
  99129. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99130. * @returns true if it can be created, otherwise false
  99131. */
  99132. canCreate(gamepadInfo: any): boolean;
  99133. /**
  99134. * Creates a new instance of the Gamepad.
  99135. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99136. * @returns the new gamepad instance
  99137. */
  99138. create(gamepadInfo: any): Gamepad;
  99139. }
  99140. /**
  99141. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99142. */
  99143. export class PoseEnabledControllerHelper {
  99144. /** @hidden */
  99145. static _ControllerFactories: _GamePadFactory[];
  99146. /** @hidden */
  99147. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99148. /**
  99149. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99150. * @param vrGamepad the gamepad to initialized
  99151. * @returns a vr controller of the type the gamepad identified as
  99152. */
  99153. static InitiateController(vrGamepad: any): Gamepad;
  99154. }
  99155. /**
  99156. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99157. */
  99158. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99159. /**
  99160. * If the controller is used in a webXR session
  99161. */
  99162. isXR: boolean;
  99163. private _deviceRoomPosition;
  99164. private _deviceRoomRotationQuaternion;
  99165. /**
  99166. * The device position in babylon space
  99167. */
  99168. devicePosition: Vector3;
  99169. /**
  99170. * The device rotation in babylon space
  99171. */
  99172. deviceRotationQuaternion: Quaternion;
  99173. /**
  99174. * The scale factor of the device in babylon space
  99175. */
  99176. deviceScaleFactor: number;
  99177. /**
  99178. * (Likely devicePosition should be used instead) The device position in its room space
  99179. */
  99180. position: Vector3;
  99181. /**
  99182. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99183. */
  99184. rotationQuaternion: Quaternion;
  99185. /**
  99186. * The type of controller (Eg. Windows mixed reality)
  99187. */
  99188. controllerType: PoseEnabledControllerType;
  99189. protected _calculatedPosition: Vector3;
  99190. private _calculatedRotation;
  99191. /**
  99192. * The raw pose from the device
  99193. */
  99194. rawPose: DevicePose;
  99195. private _trackPosition;
  99196. private _maxRotationDistFromHeadset;
  99197. private _draggedRoomRotation;
  99198. /**
  99199. * @hidden
  99200. */
  99201. _disableTrackPosition(fixedPosition: Vector3): void;
  99202. /**
  99203. * Internal, the mesh attached to the controller
  99204. * @hidden
  99205. */
  99206. _mesh: Nullable<AbstractMesh>;
  99207. private _poseControlledCamera;
  99208. private _leftHandSystemQuaternion;
  99209. /**
  99210. * Internal, matrix used to convert room space to babylon space
  99211. * @hidden
  99212. */
  99213. _deviceToWorld: Matrix;
  99214. /**
  99215. * Node to be used when casting a ray from the controller
  99216. * @hidden
  99217. */
  99218. _pointingPoseNode: Nullable<TransformNode>;
  99219. /**
  99220. * Name of the child mesh that can be used to cast a ray from the controller
  99221. */
  99222. static readonly POINTING_POSE: string;
  99223. /**
  99224. * Creates a new PoseEnabledController from a gamepad
  99225. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99226. */
  99227. constructor(browserGamepad: any);
  99228. private _workingMatrix;
  99229. /**
  99230. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99231. */
  99232. update(): void;
  99233. /**
  99234. * Updates only the pose device and mesh without doing any button event checking
  99235. */
  99236. protected _updatePoseAndMesh(): void;
  99237. /**
  99238. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99239. * @param poseData raw pose fromthe device
  99240. */
  99241. updateFromDevice(poseData: DevicePose): void;
  99242. /**
  99243. * @hidden
  99244. */
  99245. _meshAttachedObservable: Observable<AbstractMesh>;
  99246. /**
  99247. * Attaches a mesh to the controller
  99248. * @param mesh the mesh to be attached
  99249. */
  99250. attachToMesh(mesh: AbstractMesh): void;
  99251. /**
  99252. * Attaches the controllers mesh to a camera
  99253. * @param camera the camera the mesh should be attached to
  99254. */
  99255. attachToPoseControlledCamera(camera: TargetCamera): void;
  99256. /**
  99257. * Disposes of the controller
  99258. */
  99259. dispose(): void;
  99260. /**
  99261. * The mesh that is attached to the controller
  99262. */
  99263. get mesh(): Nullable<AbstractMesh>;
  99264. /**
  99265. * Gets the ray of the controller in the direction the controller is pointing
  99266. * @param length the length the resulting ray should be
  99267. * @returns a ray in the direction the controller is pointing
  99268. */
  99269. getForwardRay(length?: number): Ray;
  99270. }
  99271. }
  99272. declare module BABYLON {
  99273. /**
  99274. * Defines the WebVRController object that represents controllers tracked in 3D space
  99275. */
  99276. export abstract class WebVRController extends PoseEnabledController {
  99277. /**
  99278. * Internal, the default controller model for the controller
  99279. */
  99280. protected _defaultModel: Nullable<AbstractMesh>;
  99281. /**
  99282. * Fired when the trigger state has changed
  99283. */
  99284. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99285. /**
  99286. * Fired when the main button state has changed
  99287. */
  99288. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99289. /**
  99290. * Fired when the secondary button state has changed
  99291. */
  99292. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99293. /**
  99294. * Fired when the pad state has changed
  99295. */
  99296. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99297. /**
  99298. * Fired when controllers stick values have changed
  99299. */
  99300. onPadValuesChangedObservable: Observable<StickValues>;
  99301. /**
  99302. * Array of button availible on the controller
  99303. */
  99304. protected _buttons: Array<MutableGamepadButton>;
  99305. private _onButtonStateChange;
  99306. /**
  99307. * Fired when a controller button's state has changed
  99308. * @param callback the callback containing the button that was modified
  99309. */
  99310. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99311. /**
  99312. * X and Y axis corresponding to the controllers joystick
  99313. */
  99314. pad: StickValues;
  99315. /**
  99316. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99317. */
  99318. hand: string;
  99319. /**
  99320. * The default controller model for the controller
  99321. */
  99322. get defaultModel(): Nullable<AbstractMesh>;
  99323. /**
  99324. * Creates a new WebVRController from a gamepad
  99325. * @param vrGamepad the gamepad that the WebVRController should be created from
  99326. */
  99327. constructor(vrGamepad: any);
  99328. /**
  99329. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99330. */
  99331. update(): void;
  99332. /**
  99333. * Function to be called when a button is modified
  99334. */
  99335. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99336. /**
  99337. * Loads a mesh and attaches it to the controller
  99338. * @param scene the scene the mesh should be added to
  99339. * @param meshLoaded callback for when the mesh has been loaded
  99340. */
  99341. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99342. private _setButtonValue;
  99343. private _changes;
  99344. private _checkChanges;
  99345. /**
  99346. * Disposes of th webVRCOntroller
  99347. */
  99348. dispose(): void;
  99349. }
  99350. }
  99351. declare module BABYLON {
  99352. /**
  99353. * The HemisphericLight simulates the ambient environment light,
  99354. * so the passed direction is the light reflection direction, not the incoming direction.
  99355. */
  99356. export class HemisphericLight extends Light {
  99357. /**
  99358. * The groundColor is the light in the opposite direction to the one specified during creation.
  99359. * 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.
  99360. */
  99361. groundColor: Color3;
  99362. /**
  99363. * The light reflection direction, not the incoming direction.
  99364. */
  99365. direction: Vector3;
  99366. /**
  99367. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99368. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99369. * The HemisphericLight can't cast shadows.
  99370. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99371. * @param name The friendly name of the light
  99372. * @param direction The direction of the light reflection
  99373. * @param scene The scene the light belongs to
  99374. */
  99375. constructor(name: string, direction: Vector3, scene: Scene);
  99376. protected _buildUniformLayout(): void;
  99377. /**
  99378. * Returns the string "HemisphericLight".
  99379. * @return The class name
  99380. */
  99381. getClassName(): string;
  99382. /**
  99383. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99384. * Returns the updated direction.
  99385. * @param target The target the direction should point to
  99386. * @return The computed direction
  99387. */
  99388. setDirectionToTarget(target: Vector3): Vector3;
  99389. /**
  99390. * Returns the shadow generator associated to the light.
  99391. * @returns Always null for hemispheric lights because it does not support shadows.
  99392. */
  99393. getShadowGenerator(): Nullable<IShadowGenerator>;
  99394. /**
  99395. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99396. * @param effect The effect to update
  99397. * @param lightIndex The index of the light in the effect to update
  99398. * @returns The hemispheric light
  99399. */
  99400. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99401. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99402. /**
  99403. * Computes the world matrix of the node
  99404. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99405. * @param useWasUpdatedFlag defines a reserved property
  99406. * @returns the world matrix
  99407. */
  99408. computeWorldMatrix(): Matrix;
  99409. /**
  99410. * Returns the integer 3.
  99411. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99412. */
  99413. getTypeID(): number;
  99414. /**
  99415. * Prepares the list of defines specific to the light type.
  99416. * @param defines the list of defines
  99417. * @param lightIndex defines the index of the light for the effect
  99418. */
  99419. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99420. }
  99421. }
  99422. declare module BABYLON {
  99423. /** @hidden */
  99424. export var vrMultiviewToSingleviewPixelShader: {
  99425. name: string;
  99426. shader: string;
  99427. };
  99428. }
  99429. declare module BABYLON {
  99430. /**
  99431. * Renders to multiple views with a single draw call
  99432. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99433. */
  99434. export class MultiviewRenderTarget extends RenderTargetTexture {
  99435. /**
  99436. * Creates a multiview render target
  99437. * @param scene scene used with the render target
  99438. * @param size the size of the render target (used for each view)
  99439. */
  99440. constructor(scene: Scene, size?: number | {
  99441. width: number;
  99442. height: number;
  99443. } | {
  99444. ratio: number;
  99445. });
  99446. /**
  99447. * @hidden
  99448. * @param faceIndex the face index, if its a cube texture
  99449. */
  99450. _bindFrameBuffer(faceIndex?: number): void;
  99451. /**
  99452. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99453. * @returns the view count
  99454. */
  99455. getViewCount(): number;
  99456. }
  99457. }
  99458. declare module BABYLON {
  99459. interface Engine {
  99460. /**
  99461. * Creates a new multiview render target
  99462. * @param width defines the width of the texture
  99463. * @param height defines the height of the texture
  99464. * @returns the created multiview texture
  99465. */
  99466. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99467. /**
  99468. * Binds a multiview framebuffer to be drawn to
  99469. * @param multiviewTexture texture to bind
  99470. */
  99471. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99472. }
  99473. interface Camera {
  99474. /**
  99475. * @hidden
  99476. * 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)
  99477. */
  99478. _useMultiviewToSingleView: boolean;
  99479. /**
  99480. * @hidden
  99481. * 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)
  99482. */
  99483. _multiviewTexture: Nullable<RenderTargetTexture>;
  99484. /**
  99485. * @hidden
  99486. * ensures the multiview texture of the camera exists and has the specified width/height
  99487. * @param width height to set on the multiview texture
  99488. * @param height width to set on the multiview texture
  99489. */
  99490. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99491. }
  99492. interface Scene {
  99493. /** @hidden */
  99494. _transformMatrixR: Matrix;
  99495. /** @hidden */
  99496. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99497. /** @hidden */
  99498. _createMultiviewUbo(): void;
  99499. /** @hidden */
  99500. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99501. /** @hidden */
  99502. _renderMultiviewToSingleView(camera: Camera): void;
  99503. }
  99504. }
  99505. declare module BABYLON {
  99506. /**
  99507. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99508. * This will not be used for webXR as it supports displaying texture arrays directly
  99509. */
  99510. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99511. /**
  99512. * Gets a string identifying the name of the class
  99513. * @returns "VRMultiviewToSingleviewPostProcess" string
  99514. */
  99515. getClassName(): string;
  99516. /**
  99517. * Initializes a VRMultiviewToSingleview
  99518. * @param name name of the post process
  99519. * @param camera camera to be applied to
  99520. * @param scaleFactor scaling factor to the size of the output texture
  99521. */
  99522. constructor(name: string, camera: Camera, scaleFactor: number);
  99523. }
  99524. }
  99525. declare module BABYLON {
  99526. /**
  99527. * Interface used to define additional presentation attributes
  99528. */
  99529. export interface IVRPresentationAttributes {
  99530. /**
  99531. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99532. */
  99533. highRefreshRate: boolean;
  99534. /**
  99535. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99536. */
  99537. foveationLevel: number;
  99538. }
  99539. interface Engine {
  99540. /** @hidden */
  99541. _vrDisplay: any;
  99542. /** @hidden */
  99543. _vrSupported: boolean;
  99544. /** @hidden */
  99545. _oldSize: Size;
  99546. /** @hidden */
  99547. _oldHardwareScaleFactor: number;
  99548. /** @hidden */
  99549. _vrExclusivePointerMode: boolean;
  99550. /** @hidden */
  99551. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99552. /** @hidden */
  99553. _onVRDisplayPointerRestricted: () => void;
  99554. /** @hidden */
  99555. _onVRDisplayPointerUnrestricted: () => void;
  99556. /** @hidden */
  99557. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99558. /** @hidden */
  99559. _onVrDisplayDisconnect: Nullable<() => void>;
  99560. /** @hidden */
  99561. _onVrDisplayPresentChange: Nullable<() => void>;
  99562. /**
  99563. * Observable signaled when VR display mode changes
  99564. */
  99565. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99566. /**
  99567. * Observable signaled when VR request present is complete
  99568. */
  99569. onVRRequestPresentComplete: Observable<boolean>;
  99570. /**
  99571. * Observable signaled when VR request present starts
  99572. */
  99573. onVRRequestPresentStart: Observable<Engine>;
  99574. /**
  99575. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99576. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99577. */
  99578. isInVRExclusivePointerMode: boolean;
  99579. /**
  99580. * Gets a boolean indicating if a webVR device was detected
  99581. * @returns true if a webVR device was detected
  99582. */
  99583. isVRDevicePresent(): boolean;
  99584. /**
  99585. * Gets the current webVR device
  99586. * @returns the current webVR device (or null)
  99587. */
  99588. getVRDevice(): any;
  99589. /**
  99590. * Initializes a webVR display and starts listening to display change events
  99591. * The onVRDisplayChangedObservable will be notified upon these changes
  99592. * @returns A promise containing a VRDisplay and if vr is supported
  99593. */
  99594. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99595. /** @hidden */
  99596. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99597. /**
  99598. * Gets or sets the presentation attributes used to configure VR rendering
  99599. */
  99600. vrPresentationAttributes?: IVRPresentationAttributes;
  99601. /**
  99602. * Call this function to switch to webVR mode
  99603. * Will do nothing if webVR is not supported or if there is no webVR device
  99604. * @param options the webvr options provided to the camera. mainly used for multiview
  99605. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99606. */
  99607. enableVR(options: WebVROptions): void;
  99608. /** @hidden */
  99609. _onVRFullScreenTriggered(): void;
  99610. }
  99611. }
  99612. declare module BABYLON {
  99613. /**
  99614. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99615. * IMPORTANT!! The data is right-hand data.
  99616. * @export
  99617. * @interface DevicePose
  99618. */
  99619. export interface DevicePose {
  99620. /**
  99621. * The position of the device, values in array are [x,y,z].
  99622. */
  99623. readonly position: Nullable<Float32Array>;
  99624. /**
  99625. * The linearVelocity of the device, values in array are [x,y,z].
  99626. */
  99627. readonly linearVelocity: Nullable<Float32Array>;
  99628. /**
  99629. * The linearAcceleration of the device, values in array are [x,y,z].
  99630. */
  99631. readonly linearAcceleration: Nullable<Float32Array>;
  99632. /**
  99633. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99634. */
  99635. readonly orientation: Nullable<Float32Array>;
  99636. /**
  99637. * The angularVelocity of the device, values in array are [x,y,z].
  99638. */
  99639. readonly angularVelocity: Nullable<Float32Array>;
  99640. /**
  99641. * The angularAcceleration of the device, values in array are [x,y,z].
  99642. */
  99643. readonly angularAcceleration: Nullable<Float32Array>;
  99644. }
  99645. /**
  99646. * Interface representing a pose controlled object in Babylon.
  99647. * A pose controlled object has both regular pose values as well as pose values
  99648. * from an external device such as a VR head mounted display
  99649. */
  99650. export interface PoseControlled {
  99651. /**
  99652. * The position of the object in babylon space.
  99653. */
  99654. position: Vector3;
  99655. /**
  99656. * The rotation quaternion of the object in babylon space.
  99657. */
  99658. rotationQuaternion: Quaternion;
  99659. /**
  99660. * The position of the device in babylon space.
  99661. */
  99662. devicePosition?: Vector3;
  99663. /**
  99664. * The rotation quaternion of the device in babylon space.
  99665. */
  99666. deviceRotationQuaternion: Quaternion;
  99667. /**
  99668. * The raw pose coming from the device.
  99669. */
  99670. rawPose: Nullable<DevicePose>;
  99671. /**
  99672. * The scale of the device to be used when translating from device space to babylon space.
  99673. */
  99674. deviceScaleFactor: number;
  99675. /**
  99676. * Updates the poseControlled values based on the input device pose.
  99677. * @param poseData the pose data to update the object with
  99678. */
  99679. updateFromDevice(poseData: DevicePose): void;
  99680. }
  99681. /**
  99682. * Set of options to customize the webVRCamera
  99683. */
  99684. export interface WebVROptions {
  99685. /**
  99686. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99687. */
  99688. trackPosition?: boolean;
  99689. /**
  99690. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99691. */
  99692. positionScale?: number;
  99693. /**
  99694. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99695. */
  99696. displayName?: string;
  99697. /**
  99698. * Should the native controller meshes be initialized. (default: true)
  99699. */
  99700. controllerMeshes?: boolean;
  99701. /**
  99702. * Creating a default HemiLight only on controllers. (default: true)
  99703. */
  99704. defaultLightingOnControllers?: boolean;
  99705. /**
  99706. * If you don't want to use the default VR button of the helper. (default: false)
  99707. */
  99708. useCustomVRButton?: boolean;
  99709. /**
  99710. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99711. */
  99712. customVRButton?: HTMLButtonElement;
  99713. /**
  99714. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99715. */
  99716. rayLength?: number;
  99717. /**
  99718. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99719. */
  99720. defaultHeight?: number;
  99721. /**
  99722. * If multiview should be used if availible (default: false)
  99723. */
  99724. useMultiview?: boolean;
  99725. }
  99726. /**
  99727. * This represents a WebVR camera.
  99728. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99729. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99730. */
  99731. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99732. private webVROptions;
  99733. /**
  99734. * @hidden
  99735. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99736. */
  99737. _vrDevice: any;
  99738. /**
  99739. * The rawPose of the vrDevice.
  99740. */
  99741. rawPose: Nullable<DevicePose>;
  99742. private _onVREnabled;
  99743. private _specsVersion;
  99744. private _attached;
  99745. private _frameData;
  99746. protected _descendants: Array<Node>;
  99747. private _deviceRoomPosition;
  99748. /** @hidden */
  99749. _deviceRoomRotationQuaternion: Quaternion;
  99750. private _standingMatrix;
  99751. /**
  99752. * Represents device position in babylon space.
  99753. */
  99754. devicePosition: Vector3;
  99755. /**
  99756. * Represents device rotation in babylon space.
  99757. */
  99758. deviceRotationQuaternion: Quaternion;
  99759. /**
  99760. * The scale of the device to be used when translating from device space to babylon space.
  99761. */
  99762. deviceScaleFactor: number;
  99763. private _deviceToWorld;
  99764. private _worldToDevice;
  99765. /**
  99766. * References to the webVR controllers for the vrDevice.
  99767. */
  99768. controllers: Array<WebVRController>;
  99769. /**
  99770. * Emits an event when a controller is attached.
  99771. */
  99772. onControllersAttachedObservable: Observable<WebVRController[]>;
  99773. /**
  99774. * Emits an event when a controller's mesh has been loaded;
  99775. */
  99776. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99777. /**
  99778. * Emits an event when the HMD's pose has been updated.
  99779. */
  99780. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99781. private _poseSet;
  99782. /**
  99783. * If the rig cameras be used as parent instead of this camera.
  99784. */
  99785. rigParenting: boolean;
  99786. private _lightOnControllers;
  99787. private _defaultHeight?;
  99788. /**
  99789. * Instantiates a WebVRFreeCamera.
  99790. * @param name The name of the WebVRFreeCamera
  99791. * @param position The starting anchor position for the camera
  99792. * @param scene The scene the camera belongs to
  99793. * @param webVROptions a set of customizable options for the webVRCamera
  99794. */
  99795. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99796. /**
  99797. * Gets the device distance from the ground in meters.
  99798. * @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.
  99799. */
  99800. deviceDistanceToRoomGround(): number;
  99801. /**
  99802. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99803. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99804. */
  99805. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99806. /**
  99807. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99808. * @returns A promise with a boolean set to if the standing matrix is supported.
  99809. */
  99810. useStandingMatrixAsync(): Promise<boolean>;
  99811. /**
  99812. * Disposes the camera
  99813. */
  99814. dispose(): void;
  99815. /**
  99816. * Gets a vrController by name.
  99817. * @param name The name of the controller to retreive
  99818. * @returns the controller matching the name specified or null if not found
  99819. */
  99820. getControllerByName(name: string): Nullable<WebVRController>;
  99821. private _leftController;
  99822. /**
  99823. * The controller corresponding to the users left hand.
  99824. */
  99825. get leftController(): Nullable<WebVRController>;
  99826. private _rightController;
  99827. /**
  99828. * The controller corresponding to the users right hand.
  99829. */
  99830. get rightController(): Nullable<WebVRController>;
  99831. /**
  99832. * Casts a ray forward from the vrCamera's gaze.
  99833. * @param length Length of the ray (default: 100)
  99834. * @returns the ray corresponding to the gaze
  99835. */
  99836. getForwardRay(length?: number): Ray;
  99837. /**
  99838. * @hidden
  99839. * Updates the camera based on device's frame data
  99840. */
  99841. _checkInputs(): void;
  99842. /**
  99843. * Updates the poseControlled values based on the input device pose.
  99844. * @param poseData Pose coming from the device
  99845. */
  99846. updateFromDevice(poseData: DevicePose): void;
  99847. private _htmlElementAttached;
  99848. private _detachIfAttached;
  99849. /**
  99850. * WebVR's attach control will start broadcasting frames to the device.
  99851. * Note that in certain browsers (chrome for example) this function must be called
  99852. * within a user-interaction callback. Example:
  99853. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99854. *
  99855. * @param element html element to attach the vrDevice to
  99856. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99857. */
  99858. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99859. /**
  99860. * Detaches the camera from the html element and disables VR
  99861. *
  99862. * @param element html element to detach from
  99863. */
  99864. detachControl(element: HTMLElement): void;
  99865. /**
  99866. * @returns the name of this class
  99867. */
  99868. getClassName(): string;
  99869. /**
  99870. * Calls resetPose on the vrDisplay
  99871. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99872. */
  99873. resetToCurrentRotation(): void;
  99874. /**
  99875. * @hidden
  99876. * Updates the rig cameras (left and right eye)
  99877. */
  99878. _updateRigCameras(): void;
  99879. private _workingVector;
  99880. private _oneVector;
  99881. private _workingMatrix;
  99882. private updateCacheCalled;
  99883. private _correctPositionIfNotTrackPosition;
  99884. /**
  99885. * @hidden
  99886. * Updates the cached values of the camera
  99887. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99888. */
  99889. _updateCache(ignoreParentClass?: boolean): void;
  99890. /**
  99891. * @hidden
  99892. * Get current device position in babylon world
  99893. */
  99894. _computeDevicePosition(): void;
  99895. /**
  99896. * Updates the current device position and rotation in the babylon world
  99897. */
  99898. update(): void;
  99899. /**
  99900. * @hidden
  99901. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99902. * @returns an identity matrix
  99903. */
  99904. _getViewMatrix(): Matrix;
  99905. private _tmpMatrix;
  99906. /**
  99907. * This function is called by the two RIG cameras.
  99908. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99909. * @hidden
  99910. */
  99911. _getWebVRViewMatrix(): Matrix;
  99912. /** @hidden */
  99913. _getWebVRProjectionMatrix(): Matrix;
  99914. private _onGamepadConnectedObserver;
  99915. private _onGamepadDisconnectedObserver;
  99916. private _updateCacheWhenTrackingDisabledObserver;
  99917. /**
  99918. * Initializes the controllers and their meshes
  99919. */
  99920. initControllers(): void;
  99921. }
  99922. }
  99923. declare module BABYLON {
  99924. /**
  99925. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99926. *
  99927. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99928. *
  99929. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99930. */
  99931. export class MaterialHelper {
  99932. /**
  99933. * Bind the current view position to an effect.
  99934. * @param effect The effect to be bound
  99935. * @param scene The scene the eyes position is used from
  99936. * @param variableName name of the shader variable that will hold the eye position
  99937. */
  99938. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99939. /**
  99940. * Helps preparing the defines values about the UVs in used in the effect.
  99941. * UVs are shared as much as we can accross channels in the shaders.
  99942. * @param texture The texture we are preparing the UVs for
  99943. * @param defines The defines to update
  99944. * @param key The channel key "diffuse", "specular"... used in the shader
  99945. */
  99946. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99947. /**
  99948. * Binds a texture matrix value to its corrsponding uniform
  99949. * @param texture The texture to bind the matrix for
  99950. * @param uniformBuffer The uniform buffer receivin the data
  99951. * @param key The channel key "diffuse", "specular"... used in the shader
  99952. */
  99953. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99954. /**
  99955. * Gets the current status of the fog (should it be enabled?)
  99956. * @param mesh defines the mesh to evaluate for fog support
  99957. * @param scene defines the hosting scene
  99958. * @returns true if fog must be enabled
  99959. */
  99960. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99961. /**
  99962. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99963. * @param mesh defines the current mesh
  99964. * @param scene defines the current scene
  99965. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99966. * @param pointsCloud defines if point cloud rendering has to be turned on
  99967. * @param fogEnabled defines if fog has to be turned on
  99968. * @param alphaTest defines if alpha testing has to be turned on
  99969. * @param defines defines the current list of defines
  99970. */
  99971. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99972. /**
  99973. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99974. * @param scene defines the current scene
  99975. * @param engine defines the current engine
  99976. * @param defines specifies the list of active defines
  99977. * @param useInstances defines if instances have to be turned on
  99978. * @param useClipPlane defines if clip plane have to be turned on
  99979. * @param useInstances defines if instances have to be turned on
  99980. * @param useThinInstances defines if thin instances have to be turned on
  99981. */
  99982. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99983. /**
  99984. * Prepares the defines for bones
  99985. * @param mesh The mesh containing the geometry data we will draw
  99986. * @param defines The defines to update
  99987. */
  99988. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99989. /**
  99990. * Prepares the defines for morph targets
  99991. * @param mesh The mesh containing the geometry data we will draw
  99992. * @param defines The defines to update
  99993. */
  99994. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99995. /**
  99996. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99997. * @param mesh The mesh containing the geometry data we will draw
  99998. * @param defines The defines to update
  99999. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  100000. * @param useBones Precise whether bones should be used or not (override mesh info)
  100001. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  100002. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  100003. * @returns false if defines are considered not dirty and have not been checked
  100004. */
  100005. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  100006. /**
  100007. * Prepares the defines related to multiview
  100008. * @param scene The scene we are intending to draw
  100009. * @param defines The defines to update
  100010. */
  100011. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  100012. /**
  100013. * Prepares the defines related to the prepass
  100014. * @param scene The scene we are intending to draw
  100015. * @param defines The defines to update
  100016. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  100017. */
  100018. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  100019. /**
  100020. * Prepares the defines related to the light information passed in parameter
  100021. * @param scene The scene we are intending to draw
  100022. * @param mesh The mesh the effect is compiling for
  100023. * @param light The light the effect is compiling for
  100024. * @param lightIndex The index of the light
  100025. * @param defines The defines to update
  100026. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100027. * @param state Defines the current state regarding what is needed (normals, etc...)
  100028. */
  100029. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  100030. needNormals: boolean;
  100031. needRebuild: boolean;
  100032. shadowEnabled: boolean;
  100033. specularEnabled: boolean;
  100034. lightmapMode: boolean;
  100035. }): void;
  100036. /**
  100037. * Prepares the defines related to the light information passed in parameter
  100038. * @param scene The scene we are intending to draw
  100039. * @param mesh The mesh the effect is compiling for
  100040. * @param defines The defines to update
  100041. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100042. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  100043. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  100044. * @returns true if normals will be required for the rest of the effect
  100045. */
  100046. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  100047. /**
  100048. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  100049. * @param lightIndex defines the light index
  100050. * @param uniformsList The uniform list
  100051. * @param samplersList The sampler list
  100052. * @param projectedLightTexture defines if projected texture must be used
  100053. * @param uniformBuffersList defines an optional list of uniform buffers
  100054. */
  100055. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  100056. /**
  100057. * Prepares the uniforms and samplers list to be used in the effect
  100058. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  100059. * @param samplersList The sampler list
  100060. * @param defines The defines helping in the list generation
  100061. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  100062. */
  100063. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  100064. /**
  100065. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  100066. * @param defines The defines to update while falling back
  100067. * @param fallbacks The authorized effect fallbacks
  100068. * @param maxSimultaneousLights The maximum number of lights allowed
  100069. * @param rank the current rank of the Effect
  100070. * @returns The newly affected rank
  100071. */
  100072. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  100073. private static _TmpMorphInfluencers;
  100074. /**
  100075. * Prepares the list of attributes required for morph targets according to the effect defines.
  100076. * @param attribs The current list of supported attribs
  100077. * @param mesh The mesh to prepare the morph targets attributes for
  100078. * @param influencers The number of influencers
  100079. */
  100080. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  100081. /**
  100082. * Prepares the list of attributes required for morph targets according to the effect defines.
  100083. * @param attribs The current list of supported attribs
  100084. * @param mesh The mesh to prepare the morph targets attributes for
  100085. * @param defines The current Defines of the effect
  100086. */
  100087. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100088. /**
  100089. * Prepares the list of attributes required for bones according to the effect defines.
  100090. * @param attribs The current list of supported attribs
  100091. * @param mesh The mesh to prepare the bones attributes for
  100092. * @param defines The current Defines of the effect
  100093. * @param fallbacks The current efffect fallback strategy
  100094. */
  100095. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100096. /**
  100097. * Check and prepare the list of attributes required for instances according to the effect defines.
  100098. * @param attribs The current list of supported attribs
  100099. * @param defines The current MaterialDefines of the effect
  100100. */
  100101. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100102. /**
  100103. * Add the list of attributes required for instances to the attribs array.
  100104. * @param attribs The current list of supported attribs
  100105. */
  100106. static PushAttributesForInstances(attribs: string[]): void;
  100107. /**
  100108. * Binds the light information to the effect.
  100109. * @param light The light containing the generator
  100110. * @param effect The effect we are binding the data to
  100111. * @param lightIndex The light index in the effect used to render
  100112. */
  100113. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100114. /**
  100115. * Binds the lights information from the scene to the effect for the given mesh.
  100116. * @param light Light to bind
  100117. * @param lightIndex Light index
  100118. * @param scene The scene where the light belongs to
  100119. * @param effect The effect we are binding the data to
  100120. * @param useSpecular Defines if specular is supported
  100121. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100122. */
  100123. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100124. /**
  100125. * Binds the lights information from the scene to the effect for the given mesh.
  100126. * @param scene The scene the lights belongs to
  100127. * @param mesh The mesh we are binding the information to render
  100128. * @param effect The effect we are binding the data to
  100129. * @param defines The generated defines for the effect
  100130. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100131. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100132. */
  100133. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100134. private static _tempFogColor;
  100135. /**
  100136. * Binds the fog information from the scene to the effect for the given mesh.
  100137. * @param scene The scene the lights belongs to
  100138. * @param mesh The mesh we are binding the information to render
  100139. * @param effect The effect we are binding the data to
  100140. * @param linearSpace Defines if the fog effect is applied in linear space
  100141. */
  100142. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100143. /**
  100144. * Binds the bones information from the mesh to the effect.
  100145. * @param mesh The mesh we are binding the information to render
  100146. * @param effect The effect we are binding the data to
  100147. */
  100148. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100149. /**
  100150. * Binds the morph targets information from the mesh to the effect.
  100151. * @param abstractMesh The mesh we are binding the information to render
  100152. * @param effect The effect we are binding the data to
  100153. */
  100154. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100155. /**
  100156. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100157. * @param defines The generated defines used in the effect
  100158. * @param effect The effect we are binding the data to
  100159. * @param scene The scene we are willing to render with logarithmic scale for
  100160. */
  100161. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100162. /**
  100163. * Binds the clip plane information from the scene to the effect.
  100164. * @param scene The scene the clip plane information are extracted from
  100165. * @param effect The effect we are binding the data to
  100166. */
  100167. static BindClipPlane(effect: Effect, scene: Scene): void;
  100168. }
  100169. }
  100170. declare module BABYLON {
  100171. /**
  100172. * Block used to expose an input value
  100173. */
  100174. export class InputBlock extends NodeMaterialBlock {
  100175. private _mode;
  100176. private _associatedVariableName;
  100177. private _storedValue;
  100178. private _valueCallback;
  100179. private _type;
  100180. private _animationType;
  100181. /** Gets or set a value used to limit the range of float values */
  100182. min: number;
  100183. /** Gets or set a value used to limit the range of float values */
  100184. max: number;
  100185. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100186. isBoolean: boolean;
  100187. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100188. matrixMode: number;
  100189. /** @hidden */
  100190. _systemValue: Nullable<NodeMaterialSystemValues>;
  100191. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100192. visibleInInspector: boolean;
  100193. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100194. isConstant: boolean;
  100195. /** Gets or sets the group to use to display this block in the Inspector */
  100196. groupInInspector: string;
  100197. /** Gets an observable raised when the value is changed */
  100198. onValueChangedObservable: Observable<InputBlock>;
  100199. /**
  100200. * Gets or sets the connection point type (default is float)
  100201. */
  100202. get type(): NodeMaterialBlockConnectionPointTypes;
  100203. /**
  100204. * Creates a new InputBlock
  100205. * @param name defines the block name
  100206. * @param target defines the target of that block (Vertex by default)
  100207. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100208. */
  100209. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100210. /**
  100211. * Validates if a name is a reserve word.
  100212. * @param newName the new name to be given to the node.
  100213. * @returns false if the name is a reserve word, else true.
  100214. */
  100215. validateBlockName(newName: string): boolean;
  100216. /**
  100217. * Gets the output component
  100218. */
  100219. get output(): NodeMaterialConnectionPoint;
  100220. /**
  100221. * Set the source of this connection point to a vertex attribute
  100222. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100223. * @returns the current connection point
  100224. */
  100225. setAsAttribute(attributeName?: string): InputBlock;
  100226. /**
  100227. * Set the source of this connection point to a system value
  100228. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100229. * @returns the current connection point
  100230. */
  100231. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100232. /**
  100233. * Gets or sets the value of that point.
  100234. * Please note that this value will be ignored if valueCallback is defined
  100235. */
  100236. get value(): any;
  100237. set value(value: any);
  100238. /**
  100239. * Gets or sets a callback used to get the value of that point.
  100240. * Please note that setting this value will force the connection point to ignore the value property
  100241. */
  100242. get valueCallback(): () => any;
  100243. set valueCallback(value: () => any);
  100244. /**
  100245. * Gets or sets the associated variable name in the shader
  100246. */
  100247. get associatedVariableName(): string;
  100248. set associatedVariableName(value: string);
  100249. /** Gets or sets the type of animation applied to the input */
  100250. get animationType(): AnimatedInputBlockTypes;
  100251. set animationType(value: AnimatedInputBlockTypes);
  100252. /**
  100253. * Gets a boolean indicating that this connection point not defined yet
  100254. */
  100255. get isUndefined(): boolean;
  100256. /**
  100257. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100258. * In this case the connection point name must be the name of the uniform to use.
  100259. * Can only be set on inputs
  100260. */
  100261. get isUniform(): boolean;
  100262. set isUniform(value: boolean);
  100263. /**
  100264. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100265. * In this case the connection point name must be the name of the attribute to use
  100266. * Can only be set on inputs
  100267. */
  100268. get isAttribute(): boolean;
  100269. set isAttribute(value: boolean);
  100270. /**
  100271. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100272. * Can only be set on exit points
  100273. */
  100274. get isVarying(): boolean;
  100275. set isVarying(value: boolean);
  100276. /**
  100277. * Gets a boolean indicating that the current connection point is a system value
  100278. */
  100279. get isSystemValue(): boolean;
  100280. /**
  100281. * Gets or sets the current well known value or null if not defined as a system value
  100282. */
  100283. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100284. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100285. /**
  100286. * Gets the current class name
  100287. * @returns the class name
  100288. */
  100289. getClassName(): string;
  100290. /**
  100291. * Animate the input if animationType !== None
  100292. * @param scene defines the rendering scene
  100293. */
  100294. animate(scene: Scene): void;
  100295. private _emitDefine;
  100296. initialize(state: NodeMaterialBuildState): void;
  100297. /**
  100298. * Set the input block to its default value (based on its type)
  100299. */
  100300. setDefaultValue(): void;
  100301. private _emitConstant;
  100302. /** @hidden */
  100303. get _noContextSwitch(): boolean;
  100304. private _emit;
  100305. /** @hidden */
  100306. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100307. /** @hidden */
  100308. _transmit(effect: Effect, scene: Scene): void;
  100309. protected _buildBlock(state: NodeMaterialBuildState): void;
  100310. protected _dumpPropertiesCode(): string;
  100311. dispose(): void;
  100312. serialize(): any;
  100313. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100314. }
  100315. }
  100316. declare module BABYLON {
  100317. /**
  100318. * Enum used to define the compatibility state between two connection points
  100319. */
  100320. export enum NodeMaterialConnectionPointCompatibilityStates {
  100321. /** Points are compatibles */
  100322. Compatible = 0,
  100323. /** Points are incompatible because of their types */
  100324. TypeIncompatible = 1,
  100325. /** Points are incompatible because of their targets (vertex vs fragment) */
  100326. TargetIncompatible = 2
  100327. }
  100328. /**
  100329. * Defines the direction of a connection point
  100330. */
  100331. export enum NodeMaterialConnectionPointDirection {
  100332. /** Input */
  100333. Input = 0,
  100334. /** Output */
  100335. Output = 1
  100336. }
  100337. /**
  100338. * Defines a connection point for a block
  100339. */
  100340. export class NodeMaterialConnectionPoint {
  100341. /** @hidden */
  100342. _ownerBlock: NodeMaterialBlock;
  100343. /** @hidden */
  100344. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100345. private _endpoints;
  100346. private _associatedVariableName;
  100347. private _direction;
  100348. /** @hidden */
  100349. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100350. /** @hidden */
  100351. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100352. private _type;
  100353. /** @hidden */
  100354. _enforceAssociatedVariableName: boolean;
  100355. /** Gets the direction of the point */
  100356. get direction(): NodeMaterialConnectionPointDirection;
  100357. /** Indicates that this connection point needs dual validation before being connected to another point */
  100358. needDualDirectionValidation: boolean;
  100359. /**
  100360. * Gets or sets the additional types supported by this connection point
  100361. */
  100362. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100363. /**
  100364. * Gets or sets the additional types excluded by this connection point
  100365. */
  100366. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100367. /**
  100368. * Observable triggered when this point is connected
  100369. */
  100370. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100371. /**
  100372. * Gets or sets the associated variable name in the shader
  100373. */
  100374. get associatedVariableName(): string;
  100375. set associatedVariableName(value: string);
  100376. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100377. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100378. /**
  100379. * Gets or sets the connection point type (default is float)
  100380. */
  100381. get type(): NodeMaterialBlockConnectionPointTypes;
  100382. set type(value: NodeMaterialBlockConnectionPointTypes);
  100383. /**
  100384. * Gets or sets the connection point name
  100385. */
  100386. name: string;
  100387. /**
  100388. * Gets or sets the connection point name
  100389. */
  100390. displayName: string;
  100391. /**
  100392. * Gets or sets a boolean indicating that this connection point can be omitted
  100393. */
  100394. isOptional: boolean;
  100395. /**
  100396. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100397. */
  100398. isExposedOnFrame: boolean;
  100399. /**
  100400. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100401. */
  100402. define: string;
  100403. /** @hidden */
  100404. _prioritizeVertex: boolean;
  100405. private _target;
  100406. /** Gets or sets the target of that connection point */
  100407. get target(): NodeMaterialBlockTargets;
  100408. set target(value: NodeMaterialBlockTargets);
  100409. /**
  100410. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100411. */
  100412. get isConnected(): boolean;
  100413. /**
  100414. * Gets a boolean indicating that the current point is connected to an input block
  100415. */
  100416. get isConnectedToInputBlock(): boolean;
  100417. /**
  100418. * Gets a the connected input block (if any)
  100419. */
  100420. get connectInputBlock(): Nullable<InputBlock>;
  100421. /** Get the other side of the connection (if any) */
  100422. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100423. /** Get the block that owns this connection point */
  100424. get ownerBlock(): NodeMaterialBlock;
  100425. /** Get the block connected on the other side of this connection (if any) */
  100426. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100427. /** Get the block connected on the endpoints of this connection (if any) */
  100428. get connectedBlocks(): Array<NodeMaterialBlock>;
  100429. /** Gets the list of connected endpoints */
  100430. get endpoints(): NodeMaterialConnectionPoint[];
  100431. /** Gets a boolean indicating if that output point is connected to at least one input */
  100432. get hasEndpoints(): boolean;
  100433. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100434. get isConnectedInVertexShader(): boolean;
  100435. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100436. get isConnectedInFragmentShader(): boolean;
  100437. /**
  100438. * Creates a block suitable to be used as an input for this input point.
  100439. * If null is returned, a block based on the point type will be created.
  100440. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  100441. */
  100442. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100443. /**
  100444. * Creates a new connection point
  100445. * @param name defines the connection point name
  100446. * @param ownerBlock defines the block hosting this connection point
  100447. * @param direction defines the direction of the connection point
  100448. */
  100449. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100450. /**
  100451. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100452. * @returns the class name
  100453. */
  100454. getClassName(): string;
  100455. /**
  100456. * Gets a boolean indicating if the current point can be connected to another point
  100457. * @param connectionPoint defines the other connection point
  100458. * @returns a boolean
  100459. */
  100460. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100461. /**
  100462. * Gets a number indicating if the current point can be connected to another point
  100463. * @param connectionPoint defines the other connection point
  100464. * @returns a number defining the compatibility state
  100465. */
  100466. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100467. /**
  100468. * Connect this point to another connection point
  100469. * @param connectionPoint defines the other connection point
  100470. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100471. * @returns the current connection point
  100472. */
  100473. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100474. /**
  100475. * Disconnect this point from one of his endpoint
  100476. * @param endpoint defines the other connection point
  100477. * @returns the current connection point
  100478. */
  100479. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100480. /**
  100481. * Serializes this point in a JSON representation
  100482. * @param isInput defines if the connection point is an input (default is true)
  100483. * @returns the serialized point object
  100484. */
  100485. serialize(isInput?: boolean): any;
  100486. /**
  100487. * Release resources
  100488. */
  100489. dispose(): void;
  100490. }
  100491. }
  100492. declare module BABYLON {
  100493. /**
  100494. * Enum used to define the material modes
  100495. */
  100496. export enum NodeMaterialModes {
  100497. /** Regular material */
  100498. Material = 0,
  100499. /** For post process */
  100500. PostProcess = 1,
  100501. /** For particle system */
  100502. Particle = 2
  100503. }
  100504. }
  100505. declare module BABYLON {
  100506. /**
  100507. * Block used to read a texture from a sampler
  100508. */
  100509. export class TextureBlock extends NodeMaterialBlock {
  100510. private _defineName;
  100511. private _linearDefineName;
  100512. private _gammaDefineName;
  100513. private _tempTextureRead;
  100514. private _samplerName;
  100515. private _transformedUVName;
  100516. private _textureTransformName;
  100517. private _textureInfoName;
  100518. private _mainUVName;
  100519. private _mainUVDefineName;
  100520. private _fragmentOnly;
  100521. /**
  100522. * Gets or sets the texture associated with the node
  100523. */
  100524. texture: Nullable<Texture>;
  100525. /**
  100526. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100527. */
  100528. convertToGammaSpace: boolean;
  100529. /**
  100530. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100531. */
  100532. convertToLinearSpace: boolean;
  100533. /**
  100534. * Create a new TextureBlock
  100535. * @param name defines the block name
  100536. */
  100537. constructor(name: string, fragmentOnly?: boolean);
  100538. /**
  100539. * Gets the current class name
  100540. * @returns the class name
  100541. */
  100542. getClassName(): string;
  100543. /**
  100544. * Gets the uv input component
  100545. */
  100546. get uv(): NodeMaterialConnectionPoint;
  100547. /**
  100548. * Gets the rgba output component
  100549. */
  100550. get rgba(): NodeMaterialConnectionPoint;
  100551. /**
  100552. * Gets the rgb output component
  100553. */
  100554. get rgb(): NodeMaterialConnectionPoint;
  100555. /**
  100556. * Gets the r output component
  100557. */
  100558. get r(): NodeMaterialConnectionPoint;
  100559. /**
  100560. * Gets the g output component
  100561. */
  100562. get g(): NodeMaterialConnectionPoint;
  100563. /**
  100564. * Gets the b output component
  100565. */
  100566. get b(): NodeMaterialConnectionPoint;
  100567. /**
  100568. * Gets the a output component
  100569. */
  100570. get a(): NodeMaterialConnectionPoint;
  100571. get target(): NodeMaterialBlockTargets;
  100572. autoConfigure(material: NodeMaterial): void;
  100573. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100574. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100575. isReady(): boolean;
  100576. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100577. private get _isMixed();
  100578. private _injectVertexCode;
  100579. private _writeTextureRead;
  100580. private _writeOutput;
  100581. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100582. protected _dumpPropertiesCode(): string;
  100583. serialize(): any;
  100584. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100585. }
  100586. }
  100587. declare module BABYLON {
  100588. /** @hidden */
  100589. export var reflectionFunction: {
  100590. name: string;
  100591. shader: string;
  100592. };
  100593. }
  100594. declare module BABYLON {
  100595. /**
  100596. * Base block used to read a reflection texture from a sampler
  100597. */
  100598. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100599. /** @hidden */
  100600. _define3DName: string;
  100601. /** @hidden */
  100602. _defineCubicName: string;
  100603. /** @hidden */
  100604. _defineExplicitName: string;
  100605. /** @hidden */
  100606. _defineProjectionName: string;
  100607. /** @hidden */
  100608. _defineLocalCubicName: string;
  100609. /** @hidden */
  100610. _defineSphericalName: string;
  100611. /** @hidden */
  100612. _definePlanarName: string;
  100613. /** @hidden */
  100614. _defineEquirectangularName: string;
  100615. /** @hidden */
  100616. _defineMirroredEquirectangularFixedName: string;
  100617. /** @hidden */
  100618. _defineEquirectangularFixedName: string;
  100619. /** @hidden */
  100620. _defineSkyboxName: string;
  100621. /** @hidden */
  100622. _defineOppositeZ: string;
  100623. /** @hidden */
  100624. _cubeSamplerName: string;
  100625. /** @hidden */
  100626. _2DSamplerName: string;
  100627. protected _positionUVWName: string;
  100628. protected _directionWName: string;
  100629. protected _reflectionVectorName: string;
  100630. /** @hidden */
  100631. _reflectionCoordsName: string;
  100632. /** @hidden */
  100633. _reflectionMatrixName: string;
  100634. protected _reflectionColorName: string;
  100635. /**
  100636. * Gets or sets the texture associated with the node
  100637. */
  100638. texture: Nullable<BaseTexture>;
  100639. /**
  100640. * Create a new ReflectionTextureBaseBlock
  100641. * @param name defines the block name
  100642. */
  100643. constructor(name: string);
  100644. /**
  100645. * Gets the current class name
  100646. * @returns the class name
  100647. */
  100648. getClassName(): string;
  100649. /**
  100650. * Gets the world position input component
  100651. */
  100652. abstract get position(): NodeMaterialConnectionPoint;
  100653. /**
  100654. * Gets the world position input component
  100655. */
  100656. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100657. /**
  100658. * Gets the world normal input component
  100659. */
  100660. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100661. /**
  100662. * Gets the world input component
  100663. */
  100664. abstract get world(): NodeMaterialConnectionPoint;
  100665. /**
  100666. * Gets the camera (or eye) position component
  100667. */
  100668. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100669. /**
  100670. * Gets the view input component
  100671. */
  100672. abstract get view(): NodeMaterialConnectionPoint;
  100673. protected _getTexture(): Nullable<BaseTexture>;
  100674. autoConfigure(material: NodeMaterial): void;
  100675. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100676. isReady(): boolean;
  100677. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100678. /**
  100679. * Gets the code to inject in the vertex shader
  100680. * @param state current state of the node material building
  100681. * @returns the shader code
  100682. */
  100683. handleVertexSide(state: NodeMaterialBuildState): string;
  100684. /**
  100685. * Handles the inits for the fragment code path
  100686. * @param state node material build state
  100687. */
  100688. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100689. /**
  100690. * Generates the reflection coords code for the fragment code path
  100691. * @param worldNormalVarName name of the world normal variable
  100692. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100693. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100694. * @returns the shader code
  100695. */
  100696. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100697. /**
  100698. * Generates the reflection color code for the fragment code path
  100699. * @param lodVarName name of the lod variable
  100700. * @param swizzleLookupTexture swizzle to use for the final color variable
  100701. * @returns the shader code
  100702. */
  100703. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100704. /**
  100705. * Generates the code corresponding to the connected output points
  100706. * @param state node material build state
  100707. * @param varName name of the variable to output
  100708. * @returns the shader code
  100709. */
  100710. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100711. protected _buildBlock(state: NodeMaterialBuildState): this;
  100712. protected _dumpPropertiesCode(): string;
  100713. serialize(): any;
  100714. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100715. }
  100716. }
  100717. declare module BABYLON {
  100718. /**
  100719. * Defines a connection point to be used for points with a custom object type
  100720. */
  100721. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100722. private _blockType;
  100723. private _blockName;
  100724. private _nameForCheking?;
  100725. /**
  100726. * Creates a new connection point
  100727. * @param name defines the connection point name
  100728. * @param ownerBlock defines the block hosting this connection point
  100729. * @param direction defines the direction of the connection point
  100730. */
  100731. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100732. /**
  100733. * Gets a number indicating if the current point can be connected to another point
  100734. * @param connectionPoint defines the other connection point
  100735. * @returns a number defining the compatibility state
  100736. */
  100737. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100738. /**
  100739. * Creates a block suitable to be used as an input for this input point.
  100740. * If null is returned, a block based on the point type will be created.
  100741. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  100742. */
  100743. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100744. }
  100745. }
  100746. declare module BABYLON {
  100747. /**
  100748. * Enum defining the type of properties that can be edited in the property pages in the NME
  100749. */
  100750. export enum PropertyTypeForEdition {
  100751. /** property is a boolean */
  100752. Boolean = 0,
  100753. /** property is a float */
  100754. Float = 1,
  100755. /** property is a Vector2 */
  100756. Vector2 = 2,
  100757. /** property is a list of values */
  100758. List = 3
  100759. }
  100760. /**
  100761. * Interface that defines an option in a variable of type list
  100762. */
  100763. export interface IEditablePropertyListOption {
  100764. /** label of the option */
  100765. "label": string;
  100766. /** value of the option */
  100767. "value": number;
  100768. }
  100769. /**
  100770. * Interface that defines the options available for an editable property
  100771. */
  100772. export interface IEditablePropertyOption {
  100773. /** min value */
  100774. "min"?: number;
  100775. /** max value */
  100776. "max"?: number;
  100777. /** notifiers: indicates which actions to take when the property is changed */
  100778. "notifiers"?: {
  100779. /** the material should be rebuilt */
  100780. "rebuild"?: boolean;
  100781. /** the preview should be updated */
  100782. "update"?: boolean;
  100783. };
  100784. /** list of the options for a variable of type list */
  100785. "options"?: IEditablePropertyListOption[];
  100786. }
  100787. /**
  100788. * Interface that describes an editable property
  100789. */
  100790. export interface IPropertyDescriptionForEdition {
  100791. /** name of the property */
  100792. "propertyName": string;
  100793. /** display name of the property */
  100794. "displayName": string;
  100795. /** type of the property */
  100796. "type": PropertyTypeForEdition;
  100797. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100798. "groupName": string;
  100799. /** options for the property */
  100800. "options": IEditablePropertyOption;
  100801. }
  100802. /**
  100803. * Decorator that flags a property in a node material block as being editable
  100804. */
  100805. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100806. }
  100807. declare module BABYLON {
  100808. /**
  100809. * Block used to implement the refraction part of the sub surface module of the PBR material
  100810. */
  100811. export class RefractionBlock extends NodeMaterialBlock {
  100812. /** @hidden */
  100813. _define3DName: string;
  100814. /** @hidden */
  100815. _refractionMatrixName: string;
  100816. /** @hidden */
  100817. _defineLODRefractionAlpha: string;
  100818. /** @hidden */
  100819. _defineLinearSpecularRefraction: string;
  100820. /** @hidden */
  100821. _defineOppositeZ: string;
  100822. /** @hidden */
  100823. _cubeSamplerName: string;
  100824. /** @hidden */
  100825. _2DSamplerName: string;
  100826. /** @hidden */
  100827. _vRefractionMicrosurfaceInfosName: string;
  100828. /** @hidden */
  100829. _vRefractionInfosName: string;
  100830. private _scene;
  100831. /**
  100832. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100833. * Materials half opaque for instance using refraction could benefit from this control.
  100834. */
  100835. linkRefractionWithTransparency: boolean;
  100836. /**
  100837. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100838. */
  100839. invertRefractionY: boolean;
  100840. /**
  100841. * Gets or sets the texture associated with the node
  100842. */
  100843. texture: Nullable<BaseTexture>;
  100844. /**
  100845. * Create a new RefractionBlock
  100846. * @param name defines the block name
  100847. */
  100848. constructor(name: string);
  100849. /**
  100850. * Gets the current class name
  100851. * @returns the class name
  100852. */
  100853. getClassName(): string;
  100854. /**
  100855. * Gets the intensity input component
  100856. */
  100857. get intensity(): NodeMaterialConnectionPoint;
  100858. /**
  100859. * Gets the index of refraction input component
  100860. */
  100861. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100862. /**
  100863. * Gets the tint at distance input component
  100864. */
  100865. get tintAtDistance(): NodeMaterialConnectionPoint;
  100866. /**
  100867. * Gets the view input component
  100868. */
  100869. get view(): NodeMaterialConnectionPoint;
  100870. /**
  100871. * Gets the refraction object output component
  100872. */
  100873. get refraction(): NodeMaterialConnectionPoint;
  100874. /**
  100875. * Returns true if the block has a texture
  100876. */
  100877. get hasTexture(): boolean;
  100878. protected _getTexture(): Nullable<BaseTexture>;
  100879. autoConfigure(material: NodeMaterial): void;
  100880. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100881. isReady(): boolean;
  100882. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100883. /**
  100884. * Gets the main code of the block (fragment side)
  100885. * @param state current state of the node material building
  100886. * @returns the shader code
  100887. */
  100888. getCode(state: NodeMaterialBuildState): string;
  100889. protected _buildBlock(state: NodeMaterialBuildState): this;
  100890. protected _dumpPropertiesCode(): string;
  100891. serialize(): any;
  100892. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100893. }
  100894. }
  100895. declare module BABYLON {
  100896. /**
  100897. * Base block used as input for post process
  100898. */
  100899. export class CurrentScreenBlock extends NodeMaterialBlock {
  100900. private _samplerName;
  100901. private _linearDefineName;
  100902. private _gammaDefineName;
  100903. private _mainUVName;
  100904. private _tempTextureRead;
  100905. /**
  100906. * Gets or sets the texture associated with the node
  100907. */
  100908. texture: Nullable<BaseTexture>;
  100909. /**
  100910. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100911. */
  100912. convertToGammaSpace: boolean;
  100913. /**
  100914. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100915. */
  100916. convertToLinearSpace: boolean;
  100917. /**
  100918. * Create a new CurrentScreenBlock
  100919. * @param name defines the block name
  100920. */
  100921. constructor(name: string);
  100922. /**
  100923. * Gets the current class name
  100924. * @returns the class name
  100925. */
  100926. getClassName(): string;
  100927. /**
  100928. * Gets the uv input component
  100929. */
  100930. get uv(): NodeMaterialConnectionPoint;
  100931. /**
  100932. * Gets the rgba output component
  100933. */
  100934. get rgba(): NodeMaterialConnectionPoint;
  100935. /**
  100936. * Gets the rgb output component
  100937. */
  100938. get rgb(): NodeMaterialConnectionPoint;
  100939. /**
  100940. * Gets the r output component
  100941. */
  100942. get r(): NodeMaterialConnectionPoint;
  100943. /**
  100944. * Gets the g output component
  100945. */
  100946. get g(): NodeMaterialConnectionPoint;
  100947. /**
  100948. * Gets the b output component
  100949. */
  100950. get b(): NodeMaterialConnectionPoint;
  100951. /**
  100952. * Gets the a output component
  100953. */
  100954. get a(): NodeMaterialConnectionPoint;
  100955. /**
  100956. * Initialize the block and prepare the context for build
  100957. * @param state defines the state that will be used for the build
  100958. */
  100959. initialize(state: NodeMaterialBuildState): void;
  100960. get target(): NodeMaterialBlockTargets;
  100961. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100962. isReady(): boolean;
  100963. private _injectVertexCode;
  100964. private _writeTextureRead;
  100965. private _writeOutput;
  100966. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100967. serialize(): any;
  100968. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100969. }
  100970. }
  100971. declare module BABYLON {
  100972. /**
  100973. * Base block used for the particle texture
  100974. */
  100975. export class ParticleTextureBlock extends NodeMaterialBlock {
  100976. private _samplerName;
  100977. private _linearDefineName;
  100978. private _gammaDefineName;
  100979. private _tempTextureRead;
  100980. /**
  100981. * Gets or sets the texture associated with the node
  100982. */
  100983. texture: Nullable<BaseTexture>;
  100984. /**
  100985. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100986. */
  100987. convertToGammaSpace: boolean;
  100988. /**
  100989. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100990. */
  100991. convertToLinearSpace: boolean;
  100992. /**
  100993. * Create a new ParticleTextureBlock
  100994. * @param name defines the block name
  100995. */
  100996. constructor(name: string);
  100997. /**
  100998. * Gets the current class name
  100999. * @returns the class name
  101000. */
  101001. getClassName(): string;
  101002. /**
  101003. * Gets the uv input component
  101004. */
  101005. get uv(): NodeMaterialConnectionPoint;
  101006. /**
  101007. * Gets the rgba output component
  101008. */
  101009. get rgba(): NodeMaterialConnectionPoint;
  101010. /**
  101011. * Gets the rgb output component
  101012. */
  101013. get rgb(): NodeMaterialConnectionPoint;
  101014. /**
  101015. * Gets the r output component
  101016. */
  101017. get r(): NodeMaterialConnectionPoint;
  101018. /**
  101019. * Gets the g output component
  101020. */
  101021. get g(): NodeMaterialConnectionPoint;
  101022. /**
  101023. * Gets the b output component
  101024. */
  101025. get b(): NodeMaterialConnectionPoint;
  101026. /**
  101027. * Gets the a output component
  101028. */
  101029. get a(): NodeMaterialConnectionPoint;
  101030. /**
  101031. * Initialize the block and prepare the context for build
  101032. * @param state defines the state that will be used for the build
  101033. */
  101034. initialize(state: NodeMaterialBuildState): void;
  101035. autoConfigure(material: NodeMaterial): void;
  101036. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101037. isReady(): boolean;
  101038. private _writeOutput;
  101039. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101040. serialize(): any;
  101041. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101042. }
  101043. }
  101044. declare module BABYLON {
  101045. /**
  101046. * Class used to store shared data between 2 NodeMaterialBuildState
  101047. */
  101048. export class NodeMaterialBuildStateSharedData {
  101049. /**
  101050. * Gets the list of emitted varyings
  101051. */
  101052. temps: string[];
  101053. /**
  101054. * Gets the list of emitted varyings
  101055. */
  101056. varyings: string[];
  101057. /**
  101058. * Gets the varying declaration string
  101059. */
  101060. varyingDeclaration: string;
  101061. /**
  101062. * Input blocks
  101063. */
  101064. inputBlocks: InputBlock[];
  101065. /**
  101066. * Input blocks
  101067. */
  101068. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101069. /**
  101070. * Bindable blocks (Blocks that need to set data to the effect)
  101071. */
  101072. bindableBlocks: NodeMaterialBlock[];
  101073. /**
  101074. * List of blocks that can provide a compilation fallback
  101075. */
  101076. blocksWithFallbacks: NodeMaterialBlock[];
  101077. /**
  101078. * List of blocks that can provide a define update
  101079. */
  101080. blocksWithDefines: NodeMaterialBlock[];
  101081. /**
  101082. * List of blocks that can provide a repeatable content
  101083. */
  101084. repeatableContentBlocks: NodeMaterialBlock[];
  101085. /**
  101086. * List of blocks that can provide a dynamic list of uniforms
  101087. */
  101088. dynamicUniformBlocks: NodeMaterialBlock[];
  101089. /**
  101090. * List of blocks that can block the isReady function for the material
  101091. */
  101092. blockingBlocks: NodeMaterialBlock[];
  101093. /**
  101094. * Gets the list of animated inputs
  101095. */
  101096. animatedInputs: InputBlock[];
  101097. /**
  101098. * Build Id used to avoid multiple recompilations
  101099. */
  101100. buildId: number;
  101101. /** List of emitted variables */
  101102. variableNames: {
  101103. [key: string]: number;
  101104. };
  101105. /** List of emitted defines */
  101106. defineNames: {
  101107. [key: string]: number;
  101108. };
  101109. /** Should emit comments? */
  101110. emitComments: boolean;
  101111. /** Emit build activity */
  101112. verbose: boolean;
  101113. /** Gets or sets the hosting scene */
  101114. scene: Scene;
  101115. /**
  101116. * Gets the compilation hints emitted at compilation time
  101117. */
  101118. hints: {
  101119. needWorldViewMatrix: boolean;
  101120. needWorldViewProjectionMatrix: boolean;
  101121. needAlphaBlending: boolean;
  101122. needAlphaTesting: boolean;
  101123. };
  101124. /**
  101125. * List of compilation checks
  101126. */
  101127. checks: {
  101128. emitVertex: boolean;
  101129. emitFragment: boolean;
  101130. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101131. };
  101132. /**
  101133. * Is vertex program allowed to be empty?
  101134. */
  101135. allowEmptyVertexProgram: boolean;
  101136. /** Creates a new shared data */
  101137. constructor();
  101138. /**
  101139. * Emits console errors and exceptions if there is a failing check
  101140. */
  101141. emitErrors(): void;
  101142. }
  101143. }
  101144. declare module BABYLON {
  101145. /**
  101146. * Class used to store node based material build state
  101147. */
  101148. export class NodeMaterialBuildState {
  101149. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101150. supportUniformBuffers: boolean;
  101151. /**
  101152. * Gets the list of emitted attributes
  101153. */
  101154. attributes: string[];
  101155. /**
  101156. * Gets the list of emitted uniforms
  101157. */
  101158. uniforms: string[];
  101159. /**
  101160. * Gets the list of emitted constants
  101161. */
  101162. constants: string[];
  101163. /**
  101164. * Gets the list of emitted samplers
  101165. */
  101166. samplers: string[];
  101167. /**
  101168. * Gets the list of emitted functions
  101169. */
  101170. functions: {
  101171. [key: string]: string;
  101172. };
  101173. /**
  101174. * Gets the list of emitted extensions
  101175. */
  101176. extensions: {
  101177. [key: string]: string;
  101178. };
  101179. /**
  101180. * Gets the target of the compilation state
  101181. */
  101182. target: NodeMaterialBlockTargets;
  101183. /**
  101184. * Gets the list of emitted counters
  101185. */
  101186. counters: {
  101187. [key: string]: number;
  101188. };
  101189. /**
  101190. * Shared data between multiple NodeMaterialBuildState instances
  101191. */
  101192. sharedData: NodeMaterialBuildStateSharedData;
  101193. /** @hidden */
  101194. _vertexState: NodeMaterialBuildState;
  101195. /** @hidden */
  101196. _attributeDeclaration: string;
  101197. /** @hidden */
  101198. _uniformDeclaration: string;
  101199. /** @hidden */
  101200. _constantDeclaration: string;
  101201. /** @hidden */
  101202. _samplerDeclaration: string;
  101203. /** @hidden */
  101204. _varyingTransfer: string;
  101205. /** @hidden */
  101206. _injectAtEnd: string;
  101207. private _repeatableContentAnchorIndex;
  101208. /** @hidden */
  101209. _builtCompilationString: string;
  101210. /**
  101211. * Gets the emitted compilation strings
  101212. */
  101213. compilationString: string;
  101214. /**
  101215. * Finalize the compilation strings
  101216. * @param state defines the current compilation state
  101217. */
  101218. finalize(state: NodeMaterialBuildState): void;
  101219. /** @hidden */
  101220. get _repeatableContentAnchor(): string;
  101221. /** @hidden */
  101222. _getFreeVariableName(prefix: string): string;
  101223. /** @hidden */
  101224. _getFreeDefineName(prefix: string): string;
  101225. /** @hidden */
  101226. _excludeVariableName(name: string): void;
  101227. /** @hidden */
  101228. _emit2DSampler(name: string): void;
  101229. /** @hidden */
  101230. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101231. /** @hidden */
  101232. _emitExtension(name: string, extension: string, define?: string): void;
  101233. /** @hidden */
  101234. _emitFunction(name: string, code: string, comments: string): void;
  101235. /** @hidden */
  101236. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101237. replaceStrings?: {
  101238. search: RegExp;
  101239. replace: string;
  101240. }[];
  101241. repeatKey?: string;
  101242. }): string;
  101243. /** @hidden */
  101244. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101245. repeatKey?: string;
  101246. removeAttributes?: boolean;
  101247. removeUniforms?: boolean;
  101248. removeVaryings?: boolean;
  101249. removeIfDef?: boolean;
  101250. replaceStrings?: {
  101251. search: RegExp;
  101252. replace: string;
  101253. }[];
  101254. }, storeKey?: string): void;
  101255. /** @hidden */
  101256. _registerTempVariable(name: string): boolean;
  101257. /** @hidden */
  101258. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101259. /** @hidden */
  101260. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101261. /** @hidden */
  101262. _emitFloat(value: number): string;
  101263. }
  101264. }
  101265. declare module BABYLON {
  101266. /**
  101267. * Helper class used to generate session unique ID
  101268. */
  101269. export class UniqueIdGenerator {
  101270. private static _UniqueIdCounter;
  101271. /**
  101272. * Gets an unique (relatively to the current scene) Id
  101273. */
  101274. static get UniqueId(): number;
  101275. }
  101276. }
  101277. declare module BABYLON {
  101278. /**
  101279. * Defines a block that can be used inside a node based material
  101280. */
  101281. export class NodeMaterialBlock {
  101282. private _buildId;
  101283. private _buildTarget;
  101284. private _target;
  101285. private _isFinalMerger;
  101286. private _isInput;
  101287. private _name;
  101288. protected _isUnique: boolean;
  101289. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101290. inputsAreExclusive: boolean;
  101291. /** @hidden */
  101292. _codeVariableName: string;
  101293. /** @hidden */
  101294. _inputs: NodeMaterialConnectionPoint[];
  101295. /** @hidden */
  101296. _outputs: NodeMaterialConnectionPoint[];
  101297. /** @hidden */
  101298. _preparationId: number;
  101299. /**
  101300. * Gets the name of the block
  101301. */
  101302. get name(): string;
  101303. /**
  101304. * Sets the name of the block. Will check if the name is valid.
  101305. */
  101306. set name(newName: string);
  101307. /**
  101308. * Gets or sets the unique id of the node
  101309. */
  101310. uniqueId: number;
  101311. /**
  101312. * Gets or sets the comments associated with this block
  101313. */
  101314. comments: string;
  101315. /**
  101316. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101317. */
  101318. get isUnique(): boolean;
  101319. /**
  101320. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101321. */
  101322. get isFinalMerger(): boolean;
  101323. /**
  101324. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101325. */
  101326. get isInput(): boolean;
  101327. /**
  101328. * Gets or sets the build Id
  101329. */
  101330. get buildId(): number;
  101331. set buildId(value: number);
  101332. /**
  101333. * Gets or sets the target of the block
  101334. */
  101335. get target(): NodeMaterialBlockTargets;
  101336. set target(value: NodeMaterialBlockTargets);
  101337. /**
  101338. * Gets the list of input points
  101339. */
  101340. get inputs(): NodeMaterialConnectionPoint[];
  101341. /** Gets the list of output points */
  101342. get outputs(): NodeMaterialConnectionPoint[];
  101343. /**
  101344. * Find an input by its name
  101345. * @param name defines the name of the input to look for
  101346. * @returns the input or null if not found
  101347. */
  101348. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101349. /**
  101350. * Find an output by its name
  101351. * @param name defines the name of the outputto look for
  101352. * @returns the output or null if not found
  101353. */
  101354. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101355. /**
  101356. * Creates a new NodeMaterialBlock
  101357. * @param name defines the block name
  101358. * @param target defines the target of that block (Vertex by default)
  101359. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101360. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101361. */
  101362. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101363. /**
  101364. * Initialize the block and prepare the context for build
  101365. * @param state defines the state that will be used for the build
  101366. */
  101367. initialize(state: NodeMaterialBuildState): void;
  101368. /**
  101369. * Bind data to effect. Will only be called for blocks with isBindable === true
  101370. * @param effect defines the effect to bind data to
  101371. * @param nodeMaterial defines the hosting NodeMaterial
  101372. * @param mesh defines the mesh that will be rendered
  101373. * @param subMesh defines the submesh that will be rendered
  101374. */
  101375. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101376. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101377. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101378. protected _writeFloat(value: number): string;
  101379. /**
  101380. * Gets the current class name e.g. "NodeMaterialBlock"
  101381. * @returns the class name
  101382. */
  101383. getClassName(): string;
  101384. /**
  101385. * Register a new input. Must be called inside a block constructor
  101386. * @param name defines the connection point name
  101387. * @param type defines the connection point type
  101388. * @param isOptional defines a boolean indicating that this input can be omitted
  101389. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101390. * @param point an already created connection point. If not provided, create a new one
  101391. * @returns the current block
  101392. */
  101393. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101394. /**
  101395. * Register a new output. Must be called inside a block constructor
  101396. * @param name defines the connection point name
  101397. * @param type defines the connection point type
  101398. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101399. * @param point an already created connection point. If not provided, create a new one
  101400. * @returns the current block
  101401. */
  101402. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101403. /**
  101404. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101405. * @param forOutput defines an optional connection point to check compatibility with
  101406. * @returns the first available input or null
  101407. */
  101408. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101409. /**
  101410. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101411. * @param forBlock defines an optional block to check compatibility with
  101412. * @returns the first available input or null
  101413. */
  101414. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101415. /**
  101416. * Gets the sibling of the given output
  101417. * @param current defines the current output
  101418. * @returns the next output in the list or null
  101419. */
  101420. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101421. /**
  101422. * Connect current block with another block
  101423. * @param other defines the block to connect with
  101424. * @param options define the various options to help pick the right connections
  101425. * @returns the current block
  101426. */
  101427. connectTo(other: NodeMaterialBlock, options?: {
  101428. input?: string;
  101429. output?: string;
  101430. outputSwizzle?: string;
  101431. }): this | undefined;
  101432. protected _buildBlock(state: NodeMaterialBuildState): void;
  101433. /**
  101434. * Add uniforms, samplers and uniform buffers at compilation time
  101435. * @param state defines the state to update
  101436. * @param nodeMaterial defines the node material requesting the update
  101437. * @param defines defines the material defines to update
  101438. * @param uniformBuffers defines the list of uniform buffer names
  101439. */
  101440. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101441. /**
  101442. * Add potential fallbacks if shader compilation fails
  101443. * @param mesh defines the mesh to be rendered
  101444. * @param fallbacks defines the current prioritized list of fallbacks
  101445. */
  101446. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101447. /**
  101448. * Initialize defines for shader compilation
  101449. * @param mesh defines the mesh to be rendered
  101450. * @param nodeMaterial defines the node material requesting the update
  101451. * @param defines defines the material defines to update
  101452. * @param useInstances specifies that instances should be used
  101453. */
  101454. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101455. /**
  101456. * Update defines for shader compilation
  101457. * @param mesh defines the mesh to be rendered
  101458. * @param nodeMaterial defines the node material requesting the update
  101459. * @param defines defines the material defines to update
  101460. * @param useInstances specifies that instances should be used
  101461. * @param subMesh defines which submesh to render
  101462. */
  101463. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101464. /**
  101465. * Lets the block try to connect some inputs automatically
  101466. * @param material defines the hosting NodeMaterial
  101467. */
  101468. autoConfigure(material: NodeMaterial): void;
  101469. /**
  101470. * Function called when a block is declared as repeatable content generator
  101471. * @param vertexShaderState defines the current compilation state for the vertex shader
  101472. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101473. * @param mesh defines the mesh to be rendered
  101474. * @param defines defines the material defines to update
  101475. */
  101476. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101477. /**
  101478. * Checks if the block is ready
  101479. * @param mesh defines the mesh to be rendered
  101480. * @param nodeMaterial defines the node material requesting the update
  101481. * @param defines defines the material defines to update
  101482. * @param useInstances specifies that instances should be used
  101483. * @returns true if the block is ready
  101484. */
  101485. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101486. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101487. private _processBuild;
  101488. /**
  101489. * Validates the new name for the block node.
  101490. * @param newName the new name to be given to the node.
  101491. * @returns false if the name is a reserve word, else true.
  101492. */
  101493. validateBlockName(newName: string): boolean;
  101494. /**
  101495. * Compile the current node and generate the shader code
  101496. * @param state defines the current compilation state (uniforms, samplers, current string)
  101497. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101498. * @returns true if already built
  101499. */
  101500. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101501. protected _inputRename(name: string): string;
  101502. protected _outputRename(name: string): string;
  101503. protected _dumpPropertiesCode(): string;
  101504. /** @hidden */
  101505. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101506. /** @hidden */
  101507. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101508. /**
  101509. * Clone the current block to a new identical block
  101510. * @param scene defines the hosting scene
  101511. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101512. * @returns a copy of the current block
  101513. */
  101514. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101515. /**
  101516. * Serializes this block in a JSON representation
  101517. * @returns the serialized block object
  101518. */
  101519. serialize(): any;
  101520. /** @hidden */
  101521. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101522. private _deserializePortDisplayNamesAndExposedOnFrame;
  101523. /**
  101524. * Release resources
  101525. */
  101526. dispose(): void;
  101527. }
  101528. }
  101529. declare module BABYLON {
  101530. /**
  101531. * Base class of materials working in push mode in babylon JS
  101532. * @hidden
  101533. */
  101534. export class PushMaterial extends Material {
  101535. protected _activeEffect: Effect;
  101536. protected _normalMatrix: Matrix;
  101537. constructor(name: string, scene: Scene);
  101538. getEffect(): Effect;
  101539. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101540. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101541. /**
  101542. * Binds the given world matrix to the active effect
  101543. *
  101544. * @param world the matrix to bind
  101545. */
  101546. bindOnlyWorldMatrix(world: Matrix): void;
  101547. /**
  101548. * Binds the given normal matrix to the active effect
  101549. *
  101550. * @param normalMatrix the matrix to bind
  101551. */
  101552. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101553. bind(world: Matrix, mesh?: Mesh): void;
  101554. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101555. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101556. }
  101557. }
  101558. declare module BABYLON {
  101559. /**
  101560. * Root class for all node material optimizers
  101561. */
  101562. export class NodeMaterialOptimizer {
  101563. /**
  101564. * Function used to optimize a NodeMaterial graph
  101565. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101566. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101567. */
  101568. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101569. }
  101570. }
  101571. declare module BABYLON {
  101572. /**
  101573. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101574. */
  101575. export class TransformBlock extends NodeMaterialBlock {
  101576. /**
  101577. * Defines the value to use to complement W value to transform it to a Vector4
  101578. */
  101579. complementW: number;
  101580. /**
  101581. * Defines the value to use to complement z value to transform it to a Vector4
  101582. */
  101583. complementZ: number;
  101584. /**
  101585. * Creates a new TransformBlock
  101586. * @param name defines the block name
  101587. */
  101588. constructor(name: string);
  101589. /**
  101590. * Gets the current class name
  101591. * @returns the class name
  101592. */
  101593. getClassName(): string;
  101594. /**
  101595. * Gets the vector input
  101596. */
  101597. get vector(): NodeMaterialConnectionPoint;
  101598. /**
  101599. * Gets the output component
  101600. */
  101601. get output(): NodeMaterialConnectionPoint;
  101602. /**
  101603. * Gets the xyz output component
  101604. */
  101605. get xyz(): NodeMaterialConnectionPoint;
  101606. /**
  101607. * Gets the matrix transform input
  101608. */
  101609. get transform(): NodeMaterialConnectionPoint;
  101610. protected _buildBlock(state: NodeMaterialBuildState): this;
  101611. /**
  101612. * Update defines for shader compilation
  101613. * @param mesh defines the mesh to be rendered
  101614. * @param nodeMaterial defines the node material requesting the update
  101615. * @param defines defines the material defines to update
  101616. * @param useInstances specifies that instances should be used
  101617. * @param subMesh defines which submesh to render
  101618. */
  101619. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101620. serialize(): any;
  101621. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101622. protected _dumpPropertiesCode(): string;
  101623. }
  101624. }
  101625. declare module BABYLON {
  101626. /**
  101627. * Block used to output the vertex position
  101628. */
  101629. export class VertexOutputBlock extends NodeMaterialBlock {
  101630. /**
  101631. * Creates a new VertexOutputBlock
  101632. * @param name defines the block name
  101633. */
  101634. constructor(name: string);
  101635. /**
  101636. * Gets the current class name
  101637. * @returns the class name
  101638. */
  101639. getClassName(): string;
  101640. /**
  101641. * Gets the vector input component
  101642. */
  101643. get vector(): NodeMaterialConnectionPoint;
  101644. protected _buildBlock(state: NodeMaterialBuildState): this;
  101645. }
  101646. }
  101647. declare module BABYLON {
  101648. /**
  101649. * Block used to output the final color
  101650. */
  101651. export class FragmentOutputBlock extends NodeMaterialBlock {
  101652. /**
  101653. * Create a new FragmentOutputBlock
  101654. * @param name defines the block name
  101655. */
  101656. constructor(name: string);
  101657. /**
  101658. * Gets the current class name
  101659. * @returns the class name
  101660. */
  101661. getClassName(): string;
  101662. /**
  101663. * Gets the rgba input component
  101664. */
  101665. get rgba(): NodeMaterialConnectionPoint;
  101666. /**
  101667. * Gets the rgb input component
  101668. */
  101669. get rgb(): NodeMaterialConnectionPoint;
  101670. /**
  101671. * Gets the a input component
  101672. */
  101673. get a(): NodeMaterialConnectionPoint;
  101674. protected _buildBlock(state: NodeMaterialBuildState): this;
  101675. }
  101676. }
  101677. declare module BABYLON {
  101678. /**
  101679. * Block used for the particle ramp gradient section
  101680. */
  101681. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101682. /**
  101683. * Create a new ParticleRampGradientBlock
  101684. * @param name defines the block name
  101685. */
  101686. constructor(name: string);
  101687. /**
  101688. * Gets the current class name
  101689. * @returns the class name
  101690. */
  101691. getClassName(): string;
  101692. /**
  101693. * Gets the color input component
  101694. */
  101695. get color(): NodeMaterialConnectionPoint;
  101696. /**
  101697. * Gets the rampColor output component
  101698. */
  101699. get rampColor(): NodeMaterialConnectionPoint;
  101700. /**
  101701. * Initialize the block and prepare the context for build
  101702. * @param state defines the state that will be used for the build
  101703. */
  101704. initialize(state: NodeMaterialBuildState): void;
  101705. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101706. }
  101707. }
  101708. declare module BABYLON {
  101709. /**
  101710. * Block used for the particle blend multiply section
  101711. */
  101712. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101713. /**
  101714. * Create a new ParticleBlendMultiplyBlock
  101715. * @param name defines the block name
  101716. */
  101717. constructor(name: string);
  101718. /**
  101719. * Gets the current class name
  101720. * @returns the class name
  101721. */
  101722. getClassName(): string;
  101723. /**
  101724. * Gets the color input component
  101725. */
  101726. get color(): NodeMaterialConnectionPoint;
  101727. /**
  101728. * Gets the alphaTexture input component
  101729. */
  101730. get alphaTexture(): NodeMaterialConnectionPoint;
  101731. /**
  101732. * Gets the alphaColor input component
  101733. */
  101734. get alphaColor(): NodeMaterialConnectionPoint;
  101735. /**
  101736. * Gets the blendColor output component
  101737. */
  101738. get blendColor(): NodeMaterialConnectionPoint;
  101739. /**
  101740. * Initialize the block and prepare the context for build
  101741. * @param state defines the state that will be used for the build
  101742. */
  101743. initialize(state: NodeMaterialBuildState): void;
  101744. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101745. }
  101746. }
  101747. declare module BABYLON {
  101748. /**
  101749. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101750. */
  101751. export class VectorMergerBlock extends NodeMaterialBlock {
  101752. /**
  101753. * Create a new VectorMergerBlock
  101754. * @param name defines the block name
  101755. */
  101756. constructor(name: string);
  101757. /**
  101758. * Gets the current class name
  101759. * @returns the class name
  101760. */
  101761. getClassName(): string;
  101762. /**
  101763. * Gets the xyz component (input)
  101764. */
  101765. get xyzIn(): NodeMaterialConnectionPoint;
  101766. /**
  101767. * Gets the xy component (input)
  101768. */
  101769. get xyIn(): NodeMaterialConnectionPoint;
  101770. /**
  101771. * Gets the x component (input)
  101772. */
  101773. get x(): NodeMaterialConnectionPoint;
  101774. /**
  101775. * Gets the y component (input)
  101776. */
  101777. get y(): NodeMaterialConnectionPoint;
  101778. /**
  101779. * Gets the z component (input)
  101780. */
  101781. get z(): NodeMaterialConnectionPoint;
  101782. /**
  101783. * Gets the w component (input)
  101784. */
  101785. get w(): NodeMaterialConnectionPoint;
  101786. /**
  101787. * Gets the xyzw component (output)
  101788. */
  101789. get xyzw(): NodeMaterialConnectionPoint;
  101790. /**
  101791. * Gets the xyz component (output)
  101792. */
  101793. get xyzOut(): NodeMaterialConnectionPoint;
  101794. /**
  101795. * Gets the xy component (output)
  101796. */
  101797. get xyOut(): NodeMaterialConnectionPoint;
  101798. /**
  101799. * Gets the xy component (output)
  101800. * @deprecated Please use xyOut instead.
  101801. */
  101802. get xy(): NodeMaterialConnectionPoint;
  101803. /**
  101804. * Gets the xyz component (output)
  101805. * @deprecated Please use xyzOut instead.
  101806. */
  101807. get xyz(): NodeMaterialConnectionPoint;
  101808. protected _buildBlock(state: NodeMaterialBuildState): this;
  101809. }
  101810. }
  101811. declare module BABYLON {
  101812. /**
  101813. * Block used to remap a float from a range to a new one
  101814. */
  101815. export class RemapBlock extends NodeMaterialBlock {
  101816. /**
  101817. * Gets or sets the source range
  101818. */
  101819. sourceRange: Vector2;
  101820. /**
  101821. * Gets or sets the target range
  101822. */
  101823. targetRange: Vector2;
  101824. /**
  101825. * Creates a new RemapBlock
  101826. * @param name defines the block name
  101827. */
  101828. constructor(name: string);
  101829. /**
  101830. * Gets the current class name
  101831. * @returns the class name
  101832. */
  101833. getClassName(): string;
  101834. /**
  101835. * Gets the input component
  101836. */
  101837. get input(): NodeMaterialConnectionPoint;
  101838. /**
  101839. * Gets the source min input component
  101840. */
  101841. get sourceMin(): NodeMaterialConnectionPoint;
  101842. /**
  101843. * Gets the source max input component
  101844. */
  101845. get sourceMax(): NodeMaterialConnectionPoint;
  101846. /**
  101847. * Gets the target min input component
  101848. */
  101849. get targetMin(): NodeMaterialConnectionPoint;
  101850. /**
  101851. * Gets the target max input component
  101852. */
  101853. get targetMax(): NodeMaterialConnectionPoint;
  101854. /**
  101855. * Gets the output component
  101856. */
  101857. get output(): NodeMaterialConnectionPoint;
  101858. protected _buildBlock(state: NodeMaterialBuildState): this;
  101859. protected _dumpPropertiesCode(): string;
  101860. serialize(): any;
  101861. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101862. }
  101863. }
  101864. declare module BABYLON {
  101865. /**
  101866. * Block used to multiply 2 values
  101867. */
  101868. export class MultiplyBlock extends NodeMaterialBlock {
  101869. /**
  101870. * Creates a new MultiplyBlock
  101871. * @param name defines the block name
  101872. */
  101873. constructor(name: string);
  101874. /**
  101875. * Gets the current class name
  101876. * @returns the class name
  101877. */
  101878. getClassName(): string;
  101879. /**
  101880. * Gets the left operand input component
  101881. */
  101882. get left(): NodeMaterialConnectionPoint;
  101883. /**
  101884. * Gets the right operand input component
  101885. */
  101886. get right(): NodeMaterialConnectionPoint;
  101887. /**
  101888. * Gets the output component
  101889. */
  101890. get output(): NodeMaterialConnectionPoint;
  101891. protected _buildBlock(state: NodeMaterialBuildState): this;
  101892. }
  101893. }
  101894. declare module BABYLON {
  101895. /**
  101896. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101897. */
  101898. export class ColorSplitterBlock extends NodeMaterialBlock {
  101899. /**
  101900. * Create a new ColorSplitterBlock
  101901. * @param name defines the block name
  101902. */
  101903. constructor(name: string);
  101904. /**
  101905. * Gets the current class name
  101906. * @returns the class name
  101907. */
  101908. getClassName(): string;
  101909. /**
  101910. * Gets the rgba component (input)
  101911. */
  101912. get rgba(): NodeMaterialConnectionPoint;
  101913. /**
  101914. * Gets the rgb component (input)
  101915. */
  101916. get rgbIn(): NodeMaterialConnectionPoint;
  101917. /**
  101918. * Gets the rgb component (output)
  101919. */
  101920. get rgbOut(): NodeMaterialConnectionPoint;
  101921. /**
  101922. * Gets the r component (output)
  101923. */
  101924. get r(): NodeMaterialConnectionPoint;
  101925. /**
  101926. * Gets the g component (output)
  101927. */
  101928. get g(): NodeMaterialConnectionPoint;
  101929. /**
  101930. * Gets the b component (output)
  101931. */
  101932. get b(): NodeMaterialConnectionPoint;
  101933. /**
  101934. * Gets the a component (output)
  101935. */
  101936. get a(): NodeMaterialConnectionPoint;
  101937. protected _inputRename(name: string): string;
  101938. protected _outputRename(name: string): string;
  101939. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101940. }
  101941. }
  101942. declare module BABYLON {
  101943. /**
  101944. * Interface used to configure the node material editor
  101945. */
  101946. export interface INodeMaterialEditorOptions {
  101947. /** Define the URl to load node editor script */
  101948. editorURL?: string;
  101949. }
  101950. /** @hidden */
  101951. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101952. NORMAL: boolean;
  101953. TANGENT: boolean;
  101954. UV1: boolean;
  101955. /** BONES */
  101956. NUM_BONE_INFLUENCERS: number;
  101957. BonesPerMesh: number;
  101958. BONETEXTURE: boolean;
  101959. /** MORPH TARGETS */
  101960. MORPHTARGETS: boolean;
  101961. MORPHTARGETS_NORMAL: boolean;
  101962. MORPHTARGETS_TANGENT: boolean;
  101963. MORPHTARGETS_UV: boolean;
  101964. NUM_MORPH_INFLUENCERS: number;
  101965. /** IMAGE PROCESSING */
  101966. IMAGEPROCESSING: boolean;
  101967. VIGNETTE: boolean;
  101968. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101969. VIGNETTEBLENDMODEOPAQUE: boolean;
  101970. TONEMAPPING: boolean;
  101971. TONEMAPPING_ACES: boolean;
  101972. CONTRAST: boolean;
  101973. EXPOSURE: boolean;
  101974. COLORCURVES: boolean;
  101975. COLORGRADING: boolean;
  101976. COLORGRADING3D: boolean;
  101977. SAMPLER3DGREENDEPTH: boolean;
  101978. SAMPLER3DBGRMAP: boolean;
  101979. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101980. /** MISC. */
  101981. BUMPDIRECTUV: number;
  101982. constructor();
  101983. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101984. }
  101985. /**
  101986. * Class used to configure NodeMaterial
  101987. */
  101988. export interface INodeMaterialOptions {
  101989. /**
  101990. * Defines if blocks should emit comments
  101991. */
  101992. emitComments: boolean;
  101993. }
  101994. /**
  101995. * Class used to create a node based material built by assembling shader blocks
  101996. */
  101997. export class NodeMaterial extends PushMaterial {
  101998. private static _BuildIdGenerator;
  101999. private _options;
  102000. private _vertexCompilationState;
  102001. private _fragmentCompilationState;
  102002. private _sharedData;
  102003. private _buildId;
  102004. private _buildWasSuccessful;
  102005. private _cachedWorldViewMatrix;
  102006. private _cachedWorldViewProjectionMatrix;
  102007. private _optimizers;
  102008. private _animationFrame;
  102009. /** Define the Url to load node editor script */
  102010. static EditorURL: string;
  102011. /** Define the Url to load snippets */
  102012. static SnippetUrl: string;
  102013. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  102014. static IgnoreTexturesAtLoadTime: boolean;
  102015. private BJSNODEMATERIALEDITOR;
  102016. /** Get the inspector from bundle or global */
  102017. private _getGlobalNodeMaterialEditor;
  102018. /**
  102019. * Snippet ID if the material was created from the snippet server
  102020. */
  102021. snippetId: string;
  102022. /**
  102023. * Gets or sets data used by visual editor
  102024. * @see https://nme.babylonjs.com
  102025. */
  102026. editorData: any;
  102027. /**
  102028. * 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)
  102029. */
  102030. ignoreAlpha: boolean;
  102031. /**
  102032. * Defines the maximum number of lights that can be used in the material
  102033. */
  102034. maxSimultaneousLights: number;
  102035. /**
  102036. * Observable raised when the material is built
  102037. */
  102038. onBuildObservable: Observable<NodeMaterial>;
  102039. /**
  102040. * Gets or sets the root nodes of the material vertex shader
  102041. */
  102042. _vertexOutputNodes: NodeMaterialBlock[];
  102043. /**
  102044. * Gets or sets the root nodes of the material fragment (pixel) shader
  102045. */
  102046. _fragmentOutputNodes: NodeMaterialBlock[];
  102047. /** Gets or sets options to control the node material overall behavior */
  102048. get options(): INodeMaterialOptions;
  102049. set options(options: INodeMaterialOptions);
  102050. /**
  102051. * Default configuration related to image processing available in the standard Material.
  102052. */
  102053. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102054. /**
  102055. * Gets the image processing configuration used either in this material.
  102056. */
  102057. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102058. /**
  102059. * Sets the Default image processing configuration used either in the this material.
  102060. *
  102061. * If sets to null, the scene one is in use.
  102062. */
  102063. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102064. /**
  102065. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  102066. */
  102067. attachedBlocks: NodeMaterialBlock[];
  102068. /**
  102069. * Specifies the mode of the node material
  102070. * @hidden
  102071. */
  102072. _mode: NodeMaterialModes;
  102073. /**
  102074. * Gets the mode property
  102075. */
  102076. get mode(): NodeMaterialModes;
  102077. /**
  102078. * Create a new node based material
  102079. * @param name defines the material name
  102080. * @param scene defines the hosting scene
  102081. * @param options defines creation option
  102082. */
  102083. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  102084. /**
  102085. * Gets the current class name of the material e.g. "NodeMaterial"
  102086. * @returns the class name
  102087. */
  102088. getClassName(): string;
  102089. /**
  102090. * Keep track of the image processing observer to allow dispose and replace.
  102091. */
  102092. private _imageProcessingObserver;
  102093. /**
  102094. * Attaches a new image processing configuration to the Standard Material.
  102095. * @param configuration
  102096. */
  102097. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102098. /**
  102099. * Get a block by its name
  102100. * @param name defines the name of the block to retrieve
  102101. * @returns the required block or null if not found
  102102. */
  102103. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102104. /**
  102105. * Get a block by its name
  102106. * @param predicate defines the predicate used to find the good candidate
  102107. * @returns the required block or null if not found
  102108. */
  102109. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102110. /**
  102111. * Get an input block by its name
  102112. * @param predicate defines the predicate used to find the good candidate
  102113. * @returns the required input block or null if not found
  102114. */
  102115. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102116. /**
  102117. * Gets the list of input blocks attached to this material
  102118. * @returns an array of InputBlocks
  102119. */
  102120. getInputBlocks(): InputBlock[];
  102121. /**
  102122. * Adds a new optimizer to the list of optimizers
  102123. * @param optimizer defines the optimizers to add
  102124. * @returns the current material
  102125. */
  102126. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102127. /**
  102128. * Remove an optimizer from the list of optimizers
  102129. * @param optimizer defines the optimizers to remove
  102130. * @returns the current material
  102131. */
  102132. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102133. /**
  102134. * Add a new block to the list of output nodes
  102135. * @param node defines the node to add
  102136. * @returns the current material
  102137. */
  102138. addOutputNode(node: NodeMaterialBlock): this;
  102139. /**
  102140. * Remove a block from the list of root nodes
  102141. * @param node defines the node to remove
  102142. * @returns the current material
  102143. */
  102144. removeOutputNode(node: NodeMaterialBlock): this;
  102145. private _addVertexOutputNode;
  102146. private _removeVertexOutputNode;
  102147. private _addFragmentOutputNode;
  102148. private _removeFragmentOutputNode;
  102149. /**
  102150. * Specifies if the material will require alpha blending
  102151. * @returns a boolean specifying if alpha blending is needed
  102152. */
  102153. needAlphaBlending(): boolean;
  102154. /**
  102155. * Specifies if this material should be rendered in alpha test mode
  102156. * @returns a boolean specifying if an alpha test is needed.
  102157. */
  102158. needAlphaTesting(): boolean;
  102159. private _initializeBlock;
  102160. private _resetDualBlocks;
  102161. /**
  102162. * Remove a block from the current node material
  102163. * @param block defines the block to remove
  102164. */
  102165. removeBlock(block: NodeMaterialBlock): void;
  102166. /**
  102167. * Build the material and generates the inner effect
  102168. * @param verbose defines if the build should log activity
  102169. */
  102170. build(verbose?: boolean): void;
  102171. /**
  102172. * Runs an otpimization phase to try to improve the shader code
  102173. */
  102174. optimize(): void;
  102175. private _prepareDefinesForAttributes;
  102176. /**
  102177. * Create a post process from the material
  102178. * @param camera The camera to apply the render pass to.
  102179. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102180. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102181. * @param engine The engine which the post process will be applied. (default: current engine)
  102182. * @param reusable If the post process can be reused on the same frame. (default: false)
  102183. * @param textureType Type of textures used when performing the post process. (default: 0)
  102184. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102185. * @returns the post process created
  102186. */
  102187. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102188. /**
  102189. * Create the post process effect from the material
  102190. * @param postProcess The post process to create the effect for
  102191. */
  102192. createEffectForPostProcess(postProcess: PostProcess): void;
  102193. private _createEffectOrPostProcess;
  102194. private _createEffectForParticles;
  102195. /**
  102196. * Create the effect to be used as the custom effect for a particle system
  102197. * @param particleSystem Particle system to create the effect for
  102198. * @param onCompiled defines a function to call when the effect creation is successful
  102199. * @param onError defines a function to call when the effect creation has failed
  102200. */
  102201. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102202. private _processDefines;
  102203. /**
  102204. * Get if the submesh is ready to be used and all its information available.
  102205. * Child classes can use it to update shaders
  102206. * @param mesh defines the mesh to check
  102207. * @param subMesh defines which submesh to check
  102208. * @param useInstances specifies that instances should be used
  102209. * @returns a boolean indicating that the submesh is ready or not
  102210. */
  102211. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102212. /**
  102213. * Get a string representing the shaders built by the current node graph
  102214. */
  102215. get compiledShaders(): string;
  102216. /**
  102217. * Binds the world matrix to the material
  102218. * @param world defines the world transformation matrix
  102219. */
  102220. bindOnlyWorldMatrix(world: Matrix): void;
  102221. /**
  102222. * Binds the submesh to this material by preparing the effect and shader to draw
  102223. * @param world defines the world transformation matrix
  102224. * @param mesh defines the mesh containing the submesh
  102225. * @param subMesh defines the submesh to bind the material to
  102226. */
  102227. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102228. /**
  102229. * Gets the active textures from the material
  102230. * @returns an array of textures
  102231. */
  102232. getActiveTextures(): BaseTexture[];
  102233. /**
  102234. * Gets the list of texture blocks
  102235. * @returns an array of texture blocks
  102236. */
  102237. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102238. /**
  102239. * Specifies if the material uses a texture
  102240. * @param texture defines the texture to check against the material
  102241. * @returns a boolean specifying if the material uses the texture
  102242. */
  102243. hasTexture(texture: BaseTexture): boolean;
  102244. /**
  102245. * Disposes the material
  102246. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102247. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102248. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102249. */
  102250. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102251. /** Creates the node editor window. */
  102252. private _createNodeEditor;
  102253. /**
  102254. * Launch the node material editor
  102255. * @param config Define the configuration of the editor
  102256. * @return a promise fulfilled when the node editor is visible
  102257. */
  102258. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102259. /**
  102260. * Clear the current material
  102261. */
  102262. clear(): void;
  102263. /**
  102264. * Clear the current material and set it to a default state
  102265. */
  102266. setToDefault(): void;
  102267. /**
  102268. * Clear the current material and set it to a default state for post process
  102269. */
  102270. setToDefaultPostProcess(): void;
  102271. /**
  102272. * Clear the current material and set it to a default state for particle
  102273. */
  102274. setToDefaultParticle(): void;
  102275. /**
  102276. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102277. * @param url defines the url to load from
  102278. * @returns a promise that will fullfil when the material is fully loaded
  102279. */
  102280. loadAsync(url: string): Promise<void>;
  102281. private _gatherBlocks;
  102282. /**
  102283. * Generate a string containing the code declaration required to create an equivalent of this material
  102284. * @returns a string
  102285. */
  102286. generateCode(): string;
  102287. /**
  102288. * Serializes this material in a JSON representation
  102289. * @returns the serialized material object
  102290. */
  102291. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102292. private _restoreConnections;
  102293. /**
  102294. * Clear the current graph and load a new one from a serialization object
  102295. * @param source defines the JSON representation of the material
  102296. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102297. * @param merge defines whether or not the source must be merged or replace the current content
  102298. */
  102299. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102300. /**
  102301. * Makes a duplicate of the current material.
  102302. * @param name - name to use for the new material.
  102303. */
  102304. clone(name: string): NodeMaterial;
  102305. /**
  102306. * Creates a node material from parsed material data
  102307. * @param source defines the JSON representation of the material
  102308. * @param scene defines the hosting scene
  102309. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102310. * @returns a new node material
  102311. */
  102312. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102313. /**
  102314. * Creates a node material from a snippet saved in a remote file
  102315. * @param name defines the name of the material to create
  102316. * @param url defines the url to load from
  102317. * @param scene defines the hosting scene
  102318. * @returns a promise that will resolve to the new node material
  102319. */
  102320. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102321. /**
  102322. * Creates a node material from a snippet saved by the node material editor
  102323. * @param snippetId defines the snippet to load
  102324. * @param scene defines the hosting scene
  102325. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102326. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102327. * @returns a promise that will resolve to the new node material
  102328. */
  102329. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102330. /**
  102331. * Creates a new node material set to default basic configuration
  102332. * @param name defines the name of the material
  102333. * @param scene defines the hosting scene
  102334. * @returns a new NodeMaterial
  102335. */
  102336. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102337. }
  102338. }
  102339. declare module BABYLON {
  102340. /**
  102341. * Size options for a post process
  102342. */
  102343. export type PostProcessOptions = {
  102344. width: number;
  102345. height: number;
  102346. };
  102347. /**
  102348. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102349. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102350. */
  102351. export class PostProcess {
  102352. /**
  102353. * Gets or sets the unique id of the post process
  102354. */
  102355. uniqueId: number;
  102356. /** Name of the PostProcess. */
  102357. name: string;
  102358. /**
  102359. * Width of the texture to apply the post process on
  102360. */
  102361. width: number;
  102362. /**
  102363. * Height of the texture to apply the post process on
  102364. */
  102365. height: number;
  102366. /**
  102367. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102368. */
  102369. nodeMaterialSource: Nullable<NodeMaterial>;
  102370. /**
  102371. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102372. * @hidden
  102373. */
  102374. _outputTexture: Nullable<InternalTexture>;
  102375. /**
  102376. * Sampling mode used by the shader
  102377. * See https://doc.babylonjs.com/classes/3.1/texture
  102378. */
  102379. renderTargetSamplingMode: number;
  102380. /**
  102381. * Clear color to use when screen clearing
  102382. */
  102383. clearColor: Color4;
  102384. /**
  102385. * If the buffer needs to be cleared before applying the post process. (default: true)
  102386. * Should be set to false if shader will overwrite all previous pixels.
  102387. */
  102388. autoClear: boolean;
  102389. /**
  102390. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102391. */
  102392. alphaMode: number;
  102393. /**
  102394. * Sets the setAlphaBlendConstants of the babylon engine
  102395. */
  102396. alphaConstants: Color4;
  102397. /**
  102398. * Animations to be used for the post processing
  102399. */
  102400. animations: Animation[];
  102401. /**
  102402. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102403. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102404. */
  102405. enablePixelPerfectMode: boolean;
  102406. /**
  102407. * Force the postprocess to be applied without taking in account viewport
  102408. */
  102409. forceFullscreenViewport: boolean;
  102410. /**
  102411. * List of inspectable custom properties (used by the Inspector)
  102412. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102413. */
  102414. inspectableCustomProperties: IInspectable[];
  102415. /**
  102416. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102417. *
  102418. * | Value | Type | Description |
  102419. * | ----- | ----------------------------------- | ----------- |
  102420. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102421. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102422. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102423. *
  102424. */
  102425. scaleMode: number;
  102426. /**
  102427. * Force textures to be a power of two (default: false)
  102428. */
  102429. alwaysForcePOT: boolean;
  102430. private _samples;
  102431. /**
  102432. * Number of sample textures (default: 1)
  102433. */
  102434. get samples(): number;
  102435. set samples(n: number);
  102436. /**
  102437. * Modify the scale of the post process to be the same as the viewport (default: false)
  102438. */
  102439. adaptScaleToCurrentViewport: boolean;
  102440. private _camera;
  102441. protected _scene: Scene;
  102442. private _engine;
  102443. private _options;
  102444. private _reusable;
  102445. private _textureType;
  102446. private _textureFormat;
  102447. /**
  102448. * Smart array of input and output textures for the post process.
  102449. * @hidden
  102450. */
  102451. _textures: SmartArray<InternalTexture>;
  102452. /**
  102453. * The index in _textures that corresponds to the output texture.
  102454. * @hidden
  102455. */
  102456. _currentRenderTextureInd: number;
  102457. private _effect;
  102458. private _samplers;
  102459. private _fragmentUrl;
  102460. private _vertexUrl;
  102461. private _parameters;
  102462. private _scaleRatio;
  102463. protected _indexParameters: any;
  102464. private _shareOutputWithPostProcess;
  102465. private _texelSize;
  102466. private _forcedOutputTexture;
  102467. /**
  102468. * Returns the fragment url or shader name used in the post process.
  102469. * @returns the fragment url or name in the shader store.
  102470. */
  102471. getEffectName(): string;
  102472. /**
  102473. * An event triggered when the postprocess is activated.
  102474. */
  102475. onActivateObservable: Observable<Camera>;
  102476. private _onActivateObserver;
  102477. /**
  102478. * A function that is added to the onActivateObservable
  102479. */
  102480. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102481. /**
  102482. * An event triggered when the postprocess changes its size.
  102483. */
  102484. onSizeChangedObservable: Observable<PostProcess>;
  102485. private _onSizeChangedObserver;
  102486. /**
  102487. * A function that is added to the onSizeChangedObservable
  102488. */
  102489. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102490. /**
  102491. * An event triggered when the postprocess applies its effect.
  102492. */
  102493. onApplyObservable: Observable<Effect>;
  102494. private _onApplyObserver;
  102495. /**
  102496. * A function that is added to the onApplyObservable
  102497. */
  102498. set onApply(callback: (effect: Effect) => void);
  102499. /**
  102500. * An event triggered before rendering the postprocess
  102501. */
  102502. onBeforeRenderObservable: Observable<Effect>;
  102503. private _onBeforeRenderObserver;
  102504. /**
  102505. * A function that is added to the onBeforeRenderObservable
  102506. */
  102507. set onBeforeRender(callback: (effect: Effect) => void);
  102508. /**
  102509. * An event triggered after rendering the postprocess
  102510. */
  102511. onAfterRenderObservable: Observable<Effect>;
  102512. private _onAfterRenderObserver;
  102513. /**
  102514. * A function that is added to the onAfterRenderObservable
  102515. */
  102516. set onAfterRender(callback: (efect: Effect) => void);
  102517. /**
  102518. * 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
  102519. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102520. */
  102521. get inputTexture(): InternalTexture;
  102522. set inputTexture(value: InternalTexture);
  102523. /**
  102524. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102525. * the only way to unset it is to use this function to restore its internal state
  102526. */
  102527. restoreDefaultInputTexture(): void;
  102528. /**
  102529. * Gets the camera which post process is applied to.
  102530. * @returns The camera the post process is applied to.
  102531. */
  102532. getCamera(): Camera;
  102533. /**
  102534. * Gets the texel size of the postprocess.
  102535. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102536. */
  102537. get texelSize(): Vector2;
  102538. /**
  102539. * Creates a new instance PostProcess
  102540. * @param name The name of the PostProcess.
  102541. * @param fragmentUrl The url of the fragment shader to be used.
  102542. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102543. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102544. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102545. * @param camera The camera to apply the render pass to.
  102546. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102547. * @param engine The engine which the post process will be applied. (default: current engine)
  102548. * @param reusable If the post process can be reused on the same frame. (default: false)
  102549. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102550. * @param textureType Type of textures used when performing the post process. (default: 0)
  102551. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102552. * @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
  102553. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102554. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102555. */
  102556. constructor(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, textureFormat?: number);
  102557. /**
  102558. * Gets a string identifying the name of the class
  102559. * @returns "PostProcess" string
  102560. */
  102561. getClassName(): string;
  102562. /**
  102563. * Gets the engine which this post process belongs to.
  102564. * @returns The engine the post process was enabled with.
  102565. */
  102566. getEngine(): Engine;
  102567. /**
  102568. * The effect that is created when initializing the post process.
  102569. * @returns The created effect corresponding the the postprocess.
  102570. */
  102571. getEffect(): Effect;
  102572. /**
  102573. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102574. * @param postProcess The post process to share the output with.
  102575. * @returns This post process.
  102576. */
  102577. shareOutputWith(postProcess: PostProcess): PostProcess;
  102578. /**
  102579. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102580. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102581. */
  102582. useOwnOutput(): void;
  102583. /**
  102584. * Updates the effect with the current post process compile time values and recompiles the shader.
  102585. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102586. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102587. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102588. * @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
  102589. * @param onCompiled Called when the shader has been compiled.
  102590. * @param onError Called if there is an error when compiling a shader.
  102591. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102592. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102593. */
  102594. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  102595. /**
  102596. * The post process is reusable if it can be used multiple times within one frame.
  102597. * @returns If the post process is reusable
  102598. */
  102599. isReusable(): boolean;
  102600. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102601. markTextureDirty(): void;
  102602. /**
  102603. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102604. * 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.
  102605. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102606. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102607. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102608. * @returns The target texture that was bound to be written to.
  102609. */
  102610. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102611. /**
  102612. * If the post process is supported.
  102613. */
  102614. get isSupported(): boolean;
  102615. /**
  102616. * The aspect ratio of the output texture.
  102617. */
  102618. get aspectRatio(): number;
  102619. /**
  102620. * Get a value indicating if the post-process is ready to be used
  102621. * @returns true if the post-process is ready (shader is compiled)
  102622. */
  102623. isReady(): boolean;
  102624. /**
  102625. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102626. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102627. */
  102628. apply(): Nullable<Effect>;
  102629. private _disposeTextures;
  102630. /**
  102631. * Disposes the post process.
  102632. * @param camera The camera to dispose the post process on.
  102633. */
  102634. dispose(camera?: Camera): void;
  102635. /**
  102636. * Serializes the particle system to a JSON object
  102637. * @returns the JSON object
  102638. */
  102639. serialize(): any;
  102640. /**
  102641. * Creates a material from parsed material data
  102642. * @param parsedPostProcess defines parsed post process data
  102643. * @param scene defines the hosting scene
  102644. * @param rootUrl defines the root URL to use to load textures
  102645. * @returns a new post process
  102646. */
  102647. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102648. }
  102649. }
  102650. declare module BABYLON {
  102651. /** @hidden */
  102652. export var kernelBlurVaryingDeclaration: {
  102653. name: string;
  102654. shader: string;
  102655. };
  102656. }
  102657. declare module BABYLON {
  102658. /** @hidden */
  102659. export var kernelBlurFragment: {
  102660. name: string;
  102661. shader: string;
  102662. };
  102663. }
  102664. declare module BABYLON {
  102665. /** @hidden */
  102666. export var kernelBlurFragment2: {
  102667. name: string;
  102668. shader: string;
  102669. };
  102670. }
  102671. declare module BABYLON {
  102672. /** @hidden */
  102673. export var kernelBlurPixelShader: {
  102674. name: string;
  102675. shader: string;
  102676. };
  102677. }
  102678. declare module BABYLON {
  102679. /** @hidden */
  102680. export var kernelBlurVertex: {
  102681. name: string;
  102682. shader: string;
  102683. };
  102684. }
  102685. declare module BABYLON {
  102686. /** @hidden */
  102687. export var kernelBlurVertexShader: {
  102688. name: string;
  102689. shader: string;
  102690. };
  102691. }
  102692. declare module BABYLON {
  102693. /**
  102694. * The Blur Post Process which blurs an image based on a kernel and direction.
  102695. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102696. */
  102697. export class BlurPostProcess extends PostProcess {
  102698. private blockCompilation;
  102699. protected _kernel: number;
  102700. protected _idealKernel: number;
  102701. protected _packedFloat: boolean;
  102702. private _staticDefines;
  102703. /** The direction in which to blur the image. */
  102704. direction: Vector2;
  102705. /**
  102706. * Sets the length in pixels of the blur sample region
  102707. */
  102708. set kernel(v: number);
  102709. /**
  102710. * Gets the length in pixels of the blur sample region
  102711. */
  102712. get kernel(): number;
  102713. /**
  102714. * Sets wether or not the blur needs to unpack/repack floats
  102715. */
  102716. set packedFloat(v: boolean);
  102717. /**
  102718. * Gets wether or not the blur is unpacking/repacking floats
  102719. */
  102720. get packedFloat(): boolean;
  102721. /**
  102722. * Gets a string identifying the name of the class
  102723. * @returns "BlurPostProcess" string
  102724. */
  102725. getClassName(): string;
  102726. /**
  102727. * Creates a new instance BlurPostProcess
  102728. * @param name The name of the effect.
  102729. * @param direction The direction in which to blur the image.
  102730. * @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.
  102731. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102732. * @param camera The camera to apply the render pass to.
  102733. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102734. * @param engine The engine which the post process will be applied. (default: current engine)
  102735. * @param reusable If the post process can be reused on the same frame. (default: false)
  102736. * @param textureType Type of textures used when performing the post process. (default: 0)
  102737. * @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)
  102738. */
  102739. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  102740. /**
  102741. * Updates the effect with the current post process compile time values and recompiles the shader.
  102742. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102743. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102744. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102745. * @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
  102746. * @param onCompiled Called when the shader has been compiled.
  102747. * @param onError Called if there is an error when compiling a shader.
  102748. */
  102749. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102750. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102751. /**
  102752. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102753. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102754. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102755. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102756. * The gaps between physical kernels are compensated for in the weighting of the samples
  102757. * @param idealKernel Ideal blur kernel.
  102758. * @return Nearest best kernel.
  102759. */
  102760. protected _nearestBestKernel(idealKernel: number): number;
  102761. /**
  102762. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102763. * @param x The point on the Gaussian distribution to sample.
  102764. * @return the value of the Gaussian function at x.
  102765. */
  102766. protected _gaussianWeight(x: number): number;
  102767. /**
  102768. * Generates a string that can be used as a floating point number in GLSL.
  102769. * @param x Value to print.
  102770. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102771. * @return GLSL float string.
  102772. */
  102773. protected _glslFloat(x: number, decimalFigures?: number): string;
  102774. /** @hidden */
  102775. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102776. }
  102777. }
  102778. declare module BABYLON {
  102779. /**
  102780. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102781. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102782. * You can then easily use it as a reflectionTexture on a flat surface.
  102783. * In case the surface is not a plane, please consider relying on reflection probes.
  102784. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102785. */
  102786. export class MirrorTexture extends RenderTargetTexture {
  102787. private scene;
  102788. /**
  102789. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102790. * 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.
  102791. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102792. */
  102793. mirrorPlane: Plane;
  102794. /**
  102795. * Define the blur ratio used to blur the reflection if needed.
  102796. */
  102797. set blurRatio(value: number);
  102798. get blurRatio(): number;
  102799. /**
  102800. * Define the adaptive blur kernel used to blur the reflection if needed.
  102801. * This will autocompute the closest best match for the `blurKernel`
  102802. */
  102803. set adaptiveBlurKernel(value: number);
  102804. /**
  102805. * Define the blur kernel used to blur the reflection if needed.
  102806. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102807. */
  102808. set blurKernel(value: number);
  102809. /**
  102810. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102811. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102812. */
  102813. set blurKernelX(value: number);
  102814. get blurKernelX(): number;
  102815. /**
  102816. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102817. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102818. */
  102819. set blurKernelY(value: number);
  102820. get blurKernelY(): number;
  102821. private _autoComputeBlurKernel;
  102822. protected _onRatioRescale(): void;
  102823. private _updateGammaSpace;
  102824. private _imageProcessingConfigChangeObserver;
  102825. private _transformMatrix;
  102826. private _mirrorMatrix;
  102827. private _savedViewMatrix;
  102828. private _blurX;
  102829. private _blurY;
  102830. private _adaptiveBlurKernel;
  102831. private _blurKernelX;
  102832. private _blurKernelY;
  102833. private _blurRatio;
  102834. /**
  102835. * Instantiates a Mirror Texture.
  102836. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102837. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102838. * You can then easily use it as a reflectionTexture on a flat surface.
  102839. * In case the surface is not a plane, please consider relying on reflection probes.
  102840. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102841. * @param name
  102842. * @param size
  102843. * @param scene
  102844. * @param generateMipMaps
  102845. * @param type
  102846. * @param samplingMode
  102847. * @param generateDepthBuffer
  102848. */
  102849. constructor(name: string, size: number | {
  102850. width: number;
  102851. height: number;
  102852. } | {
  102853. ratio: number;
  102854. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102855. private _preparePostProcesses;
  102856. /**
  102857. * Clone the mirror texture.
  102858. * @returns the cloned texture
  102859. */
  102860. clone(): MirrorTexture;
  102861. /**
  102862. * Serialize the texture to a JSON representation you could use in Parse later on
  102863. * @returns the serialized JSON representation
  102864. */
  102865. serialize(): any;
  102866. /**
  102867. * Dispose the texture and release its associated resources.
  102868. */
  102869. dispose(): void;
  102870. }
  102871. }
  102872. declare module BABYLON {
  102873. /**
  102874. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102875. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102876. */
  102877. export class Texture extends BaseTexture {
  102878. /**
  102879. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102880. */
  102881. static SerializeBuffers: boolean;
  102882. /** @hidden */
  102883. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102884. /** @hidden */
  102885. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102886. /** @hidden */
  102887. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102888. /** nearest is mag = nearest and min = nearest and mip = linear */
  102889. static readonly NEAREST_SAMPLINGMODE: number;
  102890. /** nearest is mag = nearest and min = nearest and mip = linear */
  102891. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102892. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102893. static readonly BILINEAR_SAMPLINGMODE: number;
  102894. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102895. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102896. /** Trilinear is mag = linear and min = linear and mip = linear */
  102897. static readonly TRILINEAR_SAMPLINGMODE: number;
  102898. /** Trilinear is mag = linear and min = linear and mip = linear */
  102899. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102900. /** mag = nearest and min = nearest and mip = nearest */
  102901. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102902. /** mag = nearest and min = linear and mip = nearest */
  102903. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102904. /** mag = nearest and min = linear and mip = linear */
  102905. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102906. /** mag = nearest and min = linear and mip = none */
  102907. static readonly NEAREST_LINEAR: number;
  102908. /** mag = nearest and min = nearest and mip = none */
  102909. static readonly NEAREST_NEAREST: number;
  102910. /** mag = linear and min = nearest and mip = nearest */
  102911. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102912. /** mag = linear and min = nearest and mip = linear */
  102913. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102914. /** mag = linear and min = linear and mip = none */
  102915. static readonly LINEAR_LINEAR: number;
  102916. /** mag = linear and min = nearest and mip = none */
  102917. static readonly LINEAR_NEAREST: number;
  102918. /** Explicit coordinates mode */
  102919. static readonly EXPLICIT_MODE: number;
  102920. /** Spherical coordinates mode */
  102921. static readonly SPHERICAL_MODE: number;
  102922. /** Planar coordinates mode */
  102923. static readonly PLANAR_MODE: number;
  102924. /** Cubic coordinates mode */
  102925. static readonly CUBIC_MODE: number;
  102926. /** Projection coordinates mode */
  102927. static readonly PROJECTION_MODE: number;
  102928. /** Inverse Cubic coordinates mode */
  102929. static readonly SKYBOX_MODE: number;
  102930. /** Inverse Cubic coordinates mode */
  102931. static readonly INVCUBIC_MODE: number;
  102932. /** Equirectangular coordinates mode */
  102933. static readonly EQUIRECTANGULAR_MODE: number;
  102934. /** Equirectangular Fixed coordinates mode */
  102935. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102936. /** Equirectangular Fixed Mirrored coordinates mode */
  102937. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102938. /** Texture is not repeating outside of 0..1 UVs */
  102939. static readonly CLAMP_ADDRESSMODE: number;
  102940. /** Texture is repeating outside of 0..1 UVs */
  102941. static readonly WRAP_ADDRESSMODE: number;
  102942. /** Texture is repeating and mirrored */
  102943. static readonly MIRROR_ADDRESSMODE: number;
  102944. /**
  102945. * 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
  102946. */
  102947. static UseSerializedUrlIfAny: boolean;
  102948. /**
  102949. * Define the url of the texture.
  102950. */
  102951. url: Nullable<string>;
  102952. /**
  102953. * Define an offset on the texture to offset the u coordinates of the UVs
  102954. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102955. */
  102956. uOffset: number;
  102957. /**
  102958. * Define an offset on the texture to offset the v coordinates of the UVs
  102959. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102960. */
  102961. vOffset: number;
  102962. /**
  102963. * Define an offset on the texture to scale the u coordinates of the UVs
  102964. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102965. */
  102966. uScale: number;
  102967. /**
  102968. * Define an offset on the texture to scale the v coordinates of the UVs
  102969. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102970. */
  102971. vScale: number;
  102972. /**
  102973. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102974. * @see https://doc.babylonjs.com/how_to/more_materials
  102975. */
  102976. uAng: number;
  102977. /**
  102978. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102979. * @see https://doc.babylonjs.com/how_to/more_materials
  102980. */
  102981. vAng: number;
  102982. /**
  102983. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102984. * @see https://doc.babylonjs.com/how_to/more_materials
  102985. */
  102986. wAng: number;
  102987. /**
  102988. * Defines the center of rotation (U)
  102989. */
  102990. uRotationCenter: number;
  102991. /**
  102992. * Defines the center of rotation (V)
  102993. */
  102994. vRotationCenter: number;
  102995. /**
  102996. * Defines the center of rotation (W)
  102997. */
  102998. wRotationCenter: number;
  102999. /**
  103000. * Are mip maps generated for this texture or not.
  103001. */
  103002. get noMipmap(): boolean;
  103003. /**
  103004. * List of inspectable custom properties (used by the Inspector)
  103005. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103006. */
  103007. inspectableCustomProperties: Nullable<IInspectable[]>;
  103008. private _noMipmap;
  103009. /** @hidden */
  103010. _invertY: boolean;
  103011. private _rowGenerationMatrix;
  103012. private _cachedTextureMatrix;
  103013. private _projectionModeMatrix;
  103014. private _t0;
  103015. private _t1;
  103016. private _t2;
  103017. private _cachedUOffset;
  103018. private _cachedVOffset;
  103019. private _cachedUScale;
  103020. private _cachedVScale;
  103021. private _cachedUAng;
  103022. private _cachedVAng;
  103023. private _cachedWAng;
  103024. private _cachedProjectionMatrixId;
  103025. private _cachedCoordinatesMode;
  103026. /** @hidden */
  103027. protected _initialSamplingMode: number;
  103028. /** @hidden */
  103029. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  103030. private _deleteBuffer;
  103031. protected _format: Nullable<number>;
  103032. private _delayedOnLoad;
  103033. private _delayedOnError;
  103034. private _mimeType?;
  103035. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  103036. get mimeType(): string | undefined;
  103037. /**
  103038. * Observable triggered once the texture has been loaded.
  103039. */
  103040. onLoadObservable: Observable<Texture>;
  103041. protected _isBlocking: boolean;
  103042. /**
  103043. * Is the texture preventing material to render while loading.
  103044. * If false, a default texture will be used instead of the loading one during the preparation step.
  103045. */
  103046. set isBlocking(value: boolean);
  103047. get isBlocking(): boolean;
  103048. /**
  103049. * Get the current sampling mode associated with the texture.
  103050. */
  103051. get samplingMode(): number;
  103052. /**
  103053. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  103054. */
  103055. get invertY(): boolean;
  103056. /**
  103057. * Instantiates a new texture.
  103058. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103059. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103060. * @param url defines the url of the picture to load as a texture
  103061. * @param sceneOrEngine defines the scene or engine the texture will belong to
  103062. * @param noMipmap defines if the texture will require mip maps or not
  103063. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  103064. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103065. * @param onLoad defines a callback triggered when the texture has been loaded
  103066. * @param onError defines a callback triggered when an error occurred during the loading session
  103067. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  103068. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  103069. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103070. * @param mimeType defines an optional mime type information
  103071. */
  103072. 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);
  103073. /**
  103074. * Update the url (and optional buffer) of this texture if url was null during construction.
  103075. * @param url the url of the texture
  103076. * @param buffer the buffer of the texture (defaults to null)
  103077. * @param onLoad callback called when the texture is loaded (defaults to null)
  103078. */
  103079. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  103080. /**
  103081. * Finish the loading sequence of a texture flagged as delayed load.
  103082. * @hidden
  103083. */
  103084. delayLoad(): void;
  103085. private _prepareRowForTextureGeneration;
  103086. /**
  103087. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103088. * @returns the transform matrix of the texture.
  103089. */
  103090. getTextureMatrix(uBase?: number): Matrix;
  103091. /**
  103092. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103093. * @returns The reflection texture transform
  103094. */
  103095. getReflectionTextureMatrix(): Matrix;
  103096. /**
  103097. * Clones the texture.
  103098. * @returns the cloned texture
  103099. */
  103100. clone(): Texture;
  103101. /**
  103102. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103103. * @returns The JSON representation of the texture
  103104. */
  103105. serialize(): any;
  103106. /**
  103107. * Get the current class name of the texture useful for serialization or dynamic coding.
  103108. * @returns "Texture"
  103109. */
  103110. getClassName(): string;
  103111. /**
  103112. * Dispose the texture and release its associated resources.
  103113. */
  103114. dispose(): void;
  103115. /**
  103116. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103117. * @param parsedTexture Define the JSON representation of the texture
  103118. * @param scene Define the scene the parsed texture should be instantiated in
  103119. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103120. * @returns The parsed texture if successful
  103121. */
  103122. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103123. /**
  103124. * Creates a texture from its base 64 representation.
  103125. * @param data Define the base64 payload without the data: prefix
  103126. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103127. * @param scene Define the scene the texture should belong to
  103128. * @param noMipmap Forces the texture to not create mip map information if true
  103129. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103130. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103131. * @param onLoad define a callback triggered when the texture has been loaded
  103132. * @param onError define a callback triggered when an error occurred during the loading session
  103133. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103134. * @returns the created texture
  103135. */
  103136. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103137. /**
  103138. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103139. * @param data Define the base64 payload without the data: prefix
  103140. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103141. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103142. * @param scene Define the scene the texture should belong to
  103143. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103144. * @param noMipmap Forces the texture to not create mip map information if true
  103145. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103146. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103147. * @param onLoad define a callback triggered when the texture has been loaded
  103148. * @param onError define a callback triggered when an error occurred during the loading session
  103149. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103150. * @returns the created texture
  103151. */
  103152. 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;
  103153. }
  103154. }
  103155. declare module BABYLON {
  103156. /**
  103157. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103158. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103159. */
  103160. export class PostProcessManager {
  103161. private _scene;
  103162. private _indexBuffer;
  103163. private _vertexBuffers;
  103164. /**
  103165. * Creates a new instance PostProcess
  103166. * @param scene The scene that the post process is associated with.
  103167. */
  103168. constructor(scene: Scene);
  103169. private _prepareBuffers;
  103170. private _buildIndexBuffer;
  103171. /**
  103172. * Rebuilds the vertex buffers of the manager.
  103173. * @hidden
  103174. */
  103175. _rebuild(): void;
  103176. /**
  103177. * Prepares a frame to be run through a post process.
  103178. * @param sourceTexture The input texture to the post procesess. (default: null)
  103179. * @param postProcesses An array of post processes to be run. (default: null)
  103180. * @returns True if the post processes were able to be run.
  103181. * @hidden
  103182. */
  103183. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103184. /**
  103185. * Manually render a set of post processes to a texture.
  103186. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103187. * @param postProcesses An array of post processes to be run.
  103188. * @param targetTexture The target texture to render to.
  103189. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103190. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103191. * @param lodLevel defines which lod of the texture to render to
  103192. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103193. */
  103194. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103195. /**
  103196. * Finalize the result of the output of the postprocesses.
  103197. * @param doNotPresent If true the result will not be displayed to the screen.
  103198. * @param targetTexture The target texture to render to.
  103199. * @param faceIndex The index of the face to bind the target texture to.
  103200. * @param postProcesses The array of post processes to render.
  103201. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103202. * @hidden
  103203. */
  103204. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103205. /**
  103206. * Disposes of the post process manager.
  103207. */
  103208. dispose(): void;
  103209. }
  103210. }
  103211. declare module BABYLON {
  103212. /**
  103213. * This Helps creating a texture that will be created from a camera in your scene.
  103214. * It is basically a dynamic texture that could be used to create special effects for instance.
  103215. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103216. */
  103217. export class RenderTargetTexture extends Texture {
  103218. /**
  103219. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103220. */
  103221. static readonly REFRESHRATE_RENDER_ONCE: number;
  103222. /**
  103223. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103224. */
  103225. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103226. /**
  103227. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103228. * the central point of your effect and can save a lot of performances.
  103229. */
  103230. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103231. /**
  103232. * Use this predicate to dynamically define the list of mesh you want to render.
  103233. * If set, the renderList property will be overwritten.
  103234. */
  103235. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103236. private _renderList;
  103237. /**
  103238. * Use this list to define the list of mesh you want to render.
  103239. */
  103240. get renderList(): Nullable<Array<AbstractMesh>>;
  103241. set renderList(value: Nullable<Array<AbstractMesh>>);
  103242. /**
  103243. * Use this function to overload the renderList array at rendering time.
  103244. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103245. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103246. * the cube (if the RTT is a cube, else layerOrFace=0).
  103247. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103248. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103249. * hold dummy elements!
  103250. */
  103251. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103252. private _hookArray;
  103253. /**
  103254. * Define if particles should be rendered in your texture.
  103255. */
  103256. renderParticles: boolean;
  103257. /**
  103258. * Define if sprites should be rendered in your texture.
  103259. */
  103260. renderSprites: boolean;
  103261. /**
  103262. * Define the camera used to render the texture.
  103263. */
  103264. activeCamera: Nullable<Camera>;
  103265. /**
  103266. * Override the mesh isReady function with your own one.
  103267. */
  103268. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103269. /**
  103270. * Override the render function of the texture with your own one.
  103271. */
  103272. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103273. /**
  103274. * Define if camera post processes should be use while rendering the texture.
  103275. */
  103276. useCameraPostProcesses: boolean;
  103277. /**
  103278. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103279. */
  103280. ignoreCameraViewport: boolean;
  103281. private _postProcessManager;
  103282. private _postProcesses;
  103283. private _resizeObserver;
  103284. /**
  103285. * An event triggered when the texture is unbind.
  103286. */
  103287. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103288. /**
  103289. * An event triggered when the texture is unbind.
  103290. */
  103291. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103292. private _onAfterUnbindObserver;
  103293. /**
  103294. * Set a after unbind callback in the texture.
  103295. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103296. */
  103297. set onAfterUnbind(callback: () => void);
  103298. /**
  103299. * An event triggered before rendering the texture
  103300. */
  103301. onBeforeRenderObservable: Observable<number>;
  103302. private _onBeforeRenderObserver;
  103303. /**
  103304. * Set a before render callback in the texture.
  103305. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103306. */
  103307. set onBeforeRender(callback: (faceIndex: number) => void);
  103308. /**
  103309. * An event triggered after rendering the texture
  103310. */
  103311. onAfterRenderObservable: Observable<number>;
  103312. private _onAfterRenderObserver;
  103313. /**
  103314. * Set a after render callback in the texture.
  103315. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103316. */
  103317. set onAfterRender(callback: (faceIndex: number) => void);
  103318. /**
  103319. * An event triggered after the texture clear
  103320. */
  103321. onClearObservable: Observable<Engine>;
  103322. private _onClearObserver;
  103323. /**
  103324. * Set a clear callback in the texture.
  103325. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103326. */
  103327. set onClear(callback: (Engine: Engine) => void);
  103328. /**
  103329. * An event triggered when the texture is resized.
  103330. */
  103331. onResizeObservable: Observable<RenderTargetTexture>;
  103332. /**
  103333. * Define the clear color of the Render Target if it should be different from the scene.
  103334. */
  103335. clearColor: Color4;
  103336. protected _size: number | {
  103337. width: number;
  103338. height: number;
  103339. layers?: number;
  103340. };
  103341. protected _initialSizeParameter: number | {
  103342. width: number;
  103343. height: number;
  103344. } | {
  103345. ratio: number;
  103346. };
  103347. protected _sizeRatio: Nullable<number>;
  103348. /** @hidden */
  103349. _generateMipMaps: boolean;
  103350. protected _renderingManager: RenderingManager;
  103351. /** @hidden */
  103352. _waitingRenderList?: string[];
  103353. protected _doNotChangeAspectRatio: boolean;
  103354. protected _currentRefreshId: number;
  103355. protected _refreshRate: number;
  103356. protected _textureMatrix: Matrix;
  103357. protected _samples: number;
  103358. protected _renderTargetOptions: RenderTargetCreationOptions;
  103359. /**
  103360. * Gets render target creation options that were used.
  103361. */
  103362. get renderTargetOptions(): RenderTargetCreationOptions;
  103363. protected _onRatioRescale(): void;
  103364. /**
  103365. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103366. * It must define where the camera used to render the texture is set
  103367. */
  103368. boundingBoxPosition: Vector3;
  103369. private _boundingBoxSize;
  103370. /**
  103371. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103372. * When defined, the cubemap will switch to local mode
  103373. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103374. * @example https://www.babylonjs-playground.com/#RNASML
  103375. */
  103376. set boundingBoxSize(value: Vector3);
  103377. get boundingBoxSize(): Vector3;
  103378. /**
  103379. * In case the RTT has been created with a depth texture, get the associated
  103380. * depth texture.
  103381. * Otherwise, return null.
  103382. */
  103383. get depthStencilTexture(): Nullable<InternalTexture>;
  103384. /**
  103385. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103386. * or used a shadow, depth texture...
  103387. * @param name The friendly name of the texture
  103388. * @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)
  103389. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103390. * @param generateMipMaps True if mip maps need to be generated after render.
  103391. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103392. * @param type The type of the buffer in the RTT (int, half float, float...)
  103393. * @param isCube True if a cube texture needs to be created
  103394. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103395. * @param generateDepthBuffer True to generate a depth buffer
  103396. * @param generateStencilBuffer True to generate a stencil buffer
  103397. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103398. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103399. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103400. */
  103401. constructor(name: string, size: number | {
  103402. width: number;
  103403. height: number;
  103404. layers?: number;
  103405. } | {
  103406. ratio: number;
  103407. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103408. /**
  103409. * Creates a depth stencil texture.
  103410. * This is only available in WebGL 2 or with the depth texture extension available.
  103411. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103412. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103413. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103414. */
  103415. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103416. private _processSizeParameter;
  103417. /**
  103418. * Define the number of samples to use in case of MSAA.
  103419. * It defaults to one meaning no MSAA has been enabled.
  103420. */
  103421. get samples(): number;
  103422. set samples(value: number);
  103423. /**
  103424. * Resets the refresh counter of the texture and start bak from scratch.
  103425. * Could be useful to regenerate the texture if it is setup to render only once.
  103426. */
  103427. resetRefreshCounter(): void;
  103428. /**
  103429. * Define the refresh rate of the texture or the rendering frequency.
  103430. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103431. */
  103432. get refreshRate(): number;
  103433. set refreshRate(value: number);
  103434. /**
  103435. * Adds a post process to the render target rendering passes.
  103436. * @param postProcess define the post process to add
  103437. */
  103438. addPostProcess(postProcess: PostProcess): void;
  103439. /**
  103440. * Clear all the post processes attached to the render target
  103441. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103442. */
  103443. clearPostProcesses(dispose?: boolean): void;
  103444. /**
  103445. * Remove one of the post process from the list of attached post processes to the texture
  103446. * @param postProcess define the post process to remove from the list
  103447. */
  103448. removePostProcess(postProcess: PostProcess): void;
  103449. /** @hidden */
  103450. _shouldRender(): boolean;
  103451. /**
  103452. * Gets the actual render size of the texture.
  103453. * @returns the width of the render size
  103454. */
  103455. getRenderSize(): number;
  103456. /**
  103457. * Gets the actual render width of the texture.
  103458. * @returns the width of the render size
  103459. */
  103460. getRenderWidth(): number;
  103461. /**
  103462. * Gets the actual render height of the texture.
  103463. * @returns the height of the render size
  103464. */
  103465. getRenderHeight(): number;
  103466. /**
  103467. * Gets the actual number of layers of the texture.
  103468. * @returns the number of layers
  103469. */
  103470. getRenderLayers(): number;
  103471. /**
  103472. * Get if the texture can be rescaled or not.
  103473. */
  103474. get canRescale(): boolean;
  103475. /**
  103476. * Resize the texture using a ratio.
  103477. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103478. */
  103479. scale(ratio: number): void;
  103480. /**
  103481. * Get the texture reflection matrix used to rotate/transform the reflection.
  103482. * @returns the reflection matrix
  103483. */
  103484. getReflectionTextureMatrix(): Matrix;
  103485. /**
  103486. * Resize the texture to a new desired size.
  103487. * Be carrefull as it will recreate all the data in the new texture.
  103488. * @param size Define the new size. It can be:
  103489. * - a number for squared texture,
  103490. * - an object containing { width: number, height: number }
  103491. * - or an object containing a ratio { ratio: number }
  103492. */
  103493. resize(size: number | {
  103494. width: number;
  103495. height: number;
  103496. } | {
  103497. ratio: number;
  103498. }): void;
  103499. private _defaultRenderListPrepared;
  103500. /**
  103501. * Renders all the objects from the render list into the texture.
  103502. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103503. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103504. */
  103505. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103506. private _bestReflectionRenderTargetDimension;
  103507. private _prepareRenderingManager;
  103508. /**
  103509. * @hidden
  103510. * @param faceIndex face index to bind to if this is a cubetexture
  103511. * @param layer defines the index of the texture to bind in the array
  103512. */
  103513. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103514. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103515. private renderToTarget;
  103516. /**
  103517. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103518. * This allowed control for front to back rendering or reversly depending of the special needs.
  103519. *
  103520. * @param renderingGroupId The rendering group id corresponding to its index
  103521. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103522. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103523. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103524. */
  103525. 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;
  103526. /**
  103527. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103528. *
  103529. * @param renderingGroupId The rendering group id corresponding to its index
  103530. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103531. */
  103532. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103533. /**
  103534. * Clones the texture.
  103535. * @returns the cloned texture
  103536. */
  103537. clone(): RenderTargetTexture;
  103538. /**
  103539. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103540. * @returns The JSON representation of the texture
  103541. */
  103542. serialize(): any;
  103543. /**
  103544. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103545. */
  103546. disposeFramebufferObjects(): void;
  103547. /**
  103548. * Dispose the texture and release its associated resources.
  103549. */
  103550. dispose(): void;
  103551. /** @hidden */
  103552. _rebuild(): void;
  103553. /**
  103554. * Clear the info related to rendering groups preventing retention point in material dispose.
  103555. */
  103556. freeRenderingGroups(): void;
  103557. /**
  103558. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103559. * @returns the view count
  103560. */
  103561. getViewCount(): number;
  103562. }
  103563. }
  103564. declare module BABYLON {
  103565. /**
  103566. * Class used to manipulate GUIDs
  103567. */
  103568. export class GUID {
  103569. /**
  103570. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103571. * Be aware Math.random() could cause collisions, but:
  103572. * "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"
  103573. * @returns a pseudo random id
  103574. */
  103575. static RandomId(): string;
  103576. }
  103577. }
  103578. declare module BABYLON {
  103579. /**
  103580. * Options to be used when creating a shadow depth material
  103581. */
  103582. export interface IIOptionShadowDepthMaterial {
  103583. /** Variables in the vertex shader code that need to have their names remapped.
  103584. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103585. * "var_name" should be either: worldPos or vNormalW
  103586. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103587. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103588. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103589. */
  103590. remappedVariables?: string[];
  103591. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103592. standalone?: boolean;
  103593. }
  103594. /**
  103595. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103596. */
  103597. export class ShadowDepthWrapper {
  103598. private _scene;
  103599. private _options?;
  103600. private _baseMaterial;
  103601. private _onEffectCreatedObserver;
  103602. private _subMeshToEffect;
  103603. private _subMeshToDepthEffect;
  103604. private _meshes;
  103605. /** @hidden */
  103606. _matriceNames: any;
  103607. /** Gets the standalone status of the wrapper */
  103608. get standalone(): boolean;
  103609. /** Gets the base material the wrapper is built upon */
  103610. get baseMaterial(): Material;
  103611. /**
  103612. * Instantiate a new shadow depth wrapper.
  103613. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103614. * generate the shadow depth map. For more information, please refer to the documentation:
  103615. * https://doc.babylonjs.com/babylon101/shadows
  103616. * @param baseMaterial Material to wrap
  103617. * @param scene Define the scene the material belongs to
  103618. * @param options Options used to create the wrapper
  103619. */
  103620. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103621. /**
  103622. * Gets the effect to use to generate the depth map
  103623. * @param subMesh subMesh to get the effect for
  103624. * @param shadowGenerator shadow generator to get the effect for
  103625. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103626. */
  103627. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103628. /**
  103629. * Specifies that the submesh is ready to be used for depth rendering
  103630. * @param subMesh submesh to check
  103631. * @param defines the list of defines to take into account when checking the effect
  103632. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103633. * @param useInstances specifies that instances should be used
  103634. * @returns a boolean indicating that the submesh is ready or not
  103635. */
  103636. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103637. /**
  103638. * Disposes the resources
  103639. */
  103640. dispose(): void;
  103641. private _makeEffect;
  103642. }
  103643. }
  103644. declare module BABYLON {
  103645. interface ThinEngine {
  103646. /**
  103647. * Unbind a list of render target textures from the webGL context
  103648. * This is used only when drawBuffer extension or webGL2 are active
  103649. * @param textures defines the render target textures to unbind
  103650. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103651. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103652. */
  103653. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103654. /**
  103655. * Create a multi render target texture
  103656. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103657. * @param size defines the size of the texture
  103658. * @param options defines the creation options
  103659. * @returns the cube texture as an InternalTexture
  103660. */
  103661. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103662. /**
  103663. * Update the sample count for a given multiple render target texture
  103664. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103665. * @param textures defines the textures to update
  103666. * @param samples defines the sample count to set
  103667. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103668. */
  103669. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103670. /**
  103671. * Select a subsets of attachments to draw to.
  103672. * @param attachments gl attachments
  103673. */
  103674. bindAttachments(attachments: number[]): void;
  103675. }
  103676. }
  103677. declare module BABYLON {
  103678. /**
  103679. * Creation options of the multi render target texture.
  103680. */
  103681. export interface IMultiRenderTargetOptions {
  103682. /**
  103683. * Define if the texture needs to create mip maps after render.
  103684. */
  103685. generateMipMaps?: boolean;
  103686. /**
  103687. * Define the types of all the draw buffers we want to create
  103688. */
  103689. types?: number[];
  103690. /**
  103691. * Define the sampling modes of all the draw buffers we want to create
  103692. */
  103693. samplingModes?: number[];
  103694. /**
  103695. * Define if a depth buffer is required
  103696. */
  103697. generateDepthBuffer?: boolean;
  103698. /**
  103699. * Define if a stencil buffer is required
  103700. */
  103701. generateStencilBuffer?: boolean;
  103702. /**
  103703. * Define if a depth texture is required instead of a depth buffer
  103704. */
  103705. generateDepthTexture?: boolean;
  103706. /**
  103707. * Define the number of desired draw buffers
  103708. */
  103709. textureCount?: number;
  103710. /**
  103711. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103712. */
  103713. doNotChangeAspectRatio?: boolean;
  103714. /**
  103715. * Define the default type of the buffers we are creating
  103716. */
  103717. defaultType?: number;
  103718. }
  103719. /**
  103720. * A multi render target, like a render target provides the ability to render to a texture.
  103721. * Unlike the render target, it can render to several draw buffers in one draw.
  103722. * This is specially interesting in deferred rendering or for any effects requiring more than
  103723. * just one color from a single pass.
  103724. */
  103725. export class MultiRenderTarget extends RenderTargetTexture {
  103726. private _internalTextures;
  103727. private _textures;
  103728. private _multiRenderTargetOptions;
  103729. private _count;
  103730. /**
  103731. * Get if draw buffers are currently supported by the used hardware and browser.
  103732. */
  103733. get isSupported(): boolean;
  103734. /**
  103735. * Get the list of textures generated by the multi render target.
  103736. */
  103737. get textures(): Texture[];
  103738. /**
  103739. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103740. */
  103741. get count(): number;
  103742. /**
  103743. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103744. */
  103745. get depthTexture(): Texture;
  103746. /**
  103747. * Set the wrapping mode on U of all the textures we are rendering to.
  103748. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103749. */
  103750. set wrapU(wrap: number);
  103751. /**
  103752. * Set the wrapping mode on V of all the textures we are rendering to.
  103753. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103754. */
  103755. set wrapV(wrap: number);
  103756. /**
  103757. * Instantiate a new multi render target texture.
  103758. * A multi render target, like a render target provides the ability to render to a texture.
  103759. * Unlike the render target, it can render to several draw buffers in one draw.
  103760. * This is specially interesting in deferred rendering or for any effects requiring more than
  103761. * just one color from a single pass.
  103762. * @param name Define the name of the texture
  103763. * @param size Define the size of the buffers to render to
  103764. * @param count Define the number of target we are rendering into
  103765. * @param scene Define the scene the texture belongs to
  103766. * @param options Define the options used to create the multi render target
  103767. */
  103768. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103769. /** @hidden */
  103770. _rebuild(): void;
  103771. private _createInternalTextures;
  103772. private _createTextures;
  103773. /**
  103774. * Define the number of samples used if MSAA is enabled.
  103775. */
  103776. get samples(): number;
  103777. set samples(value: number);
  103778. /**
  103779. * Resize all the textures in the multi render target.
  103780. * Be carrefull as it will recreate all the data in the new texture.
  103781. * @param size Define the new size
  103782. */
  103783. resize(size: any): void;
  103784. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103785. /**
  103786. * Dispose the render targets and their associated resources
  103787. */
  103788. dispose(): void;
  103789. /**
  103790. * Release all the underlying texture used as draw buffers.
  103791. */
  103792. releaseInternalTextures(): void;
  103793. }
  103794. }
  103795. declare module BABYLON {
  103796. /** @hidden */
  103797. export var imageProcessingPixelShader: {
  103798. name: string;
  103799. shader: string;
  103800. };
  103801. }
  103802. declare module BABYLON {
  103803. /**
  103804. * ImageProcessingPostProcess
  103805. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103806. */
  103807. export class ImageProcessingPostProcess extends PostProcess {
  103808. /**
  103809. * Default configuration related to image processing available in the PBR Material.
  103810. */
  103811. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103812. /**
  103813. * Gets the image processing configuration used either in this material.
  103814. */
  103815. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103816. /**
  103817. * Sets the Default image processing configuration used either in the this material.
  103818. *
  103819. * If sets to null, the scene one is in use.
  103820. */
  103821. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103822. /**
  103823. * Keep track of the image processing observer to allow dispose and replace.
  103824. */
  103825. private _imageProcessingObserver;
  103826. /**
  103827. * Attaches a new image processing configuration to the PBR Material.
  103828. * @param configuration
  103829. */
  103830. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103831. /**
  103832. * If the post process is supported.
  103833. */
  103834. get isSupported(): boolean;
  103835. /**
  103836. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103837. */
  103838. get colorCurves(): Nullable<ColorCurves>;
  103839. /**
  103840. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103841. */
  103842. set colorCurves(value: Nullable<ColorCurves>);
  103843. /**
  103844. * Gets wether the color curves effect is enabled.
  103845. */
  103846. get colorCurvesEnabled(): boolean;
  103847. /**
  103848. * Sets wether the color curves effect is enabled.
  103849. */
  103850. set colorCurvesEnabled(value: boolean);
  103851. /**
  103852. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103853. */
  103854. get colorGradingTexture(): Nullable<BaseTexture>;
  103855. /**
  103856. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103857. */
  103858. set colorGradingTexture(value: Nullable<BaseTexture>);
  103859. /**
  103860. * Gets wether the color grading effect is enabled.
  103861. */
  103862. get colorGradingEnabled(): boolean;
  103863. /**
  103864. * Gets wether the color grading effect is enabled.
  103865. */
  103866. set colorGradingEnabled(value: boolean);
  103867. /**
  103868. * Gets exposure used in the effect.
  103869. */
  103870. get exposure(): number;
  103871. /**
  103872. * Sets exposure used in the effect.
  103873. */
  103874. set exposure(value: number);
  103875. /**
  103876. * Gets wether tonemapping is enabled or not.
  103877. */
  103878. get toneMappingEnabled(): boolean;
  103879. /**
  103880. * Sets wether tonemapping is enabled or not
  103881. */
  103882. set toneMappingEnabled(value: boolean);
  103883. /**
  103884. * Gets the type of tone mapping effect.
  103885. */
  103886. get toneMappingType(): number;
  103887. /**
  103888. * Sets the type of tone mapping effect.
  103889. */
  103890. set toneMappingType(value: number);
  103891. /**
  103892. * Gets contrast used in the effect.
  103893. */
  103894. get contrast(): number;
  103895. /**
  103896. * Sets contrast used in the effect.
  103897. */
  103898. set contrast(value: number);
  103899. /**
  103900. * Gets Vignette stretch size.
  103901. */
  103902. get vignetteStretch(): number;
  103903. /**
  103904. * Sets Vignette stretch size.
  103905. */
  103906. set vignetteStretch(value: number);
  103907. /**
  103908. * Gets Vignette centre X Offset.
  103909. */
  103910. get vignetteCentreX(): number;
  103911. /**
  103912. * Sets Vignette centre X Offset.
  103913. */
  103914. set vignetteCentreX(value: number);
  103915. /**
  103916. * Gets Vignette centre Y Offset.
  103917. */
  103918. get vignetteCentreY(): number;
  103919. /**
  103920. * Sets Vignette centre Y Offset.
  103921. */
  103922. set vignetteCentreY(value: number);
  103923. /**
  103924. * Gets Vignette weight or intensity of the vignette effect.
  103925. */
  103926. get vignetteWeight(): number;
  103927. /**
  103928. * Sets Vignette weight or intensity of the vignette effect.
  103929. */
  103930. set vignetteWeight(value: number);
  103931. /**
  103932. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103933. * if vignetteEnabled is set to true.
  103934. */
  103935. get vignetteColor(): Color4;
  103936. /**
  103937. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103938. * if vignetteEnabled is set to true.
  103939. */
  103940. set vignetteColor(value: Color4);
  103941. /**
  103942. * Gets Camera field of view used by the Vignette effect.
  103943. */
  103944. get vignetteCameraFov(): number;
  103945. /**
  103946. * Sets Camera field of view used by the Vignette effect.
  103947. */
  103948. set vignetteCameraFov(value: number);
  103949. /**
  103950. * Gets the vignette blend mode allowing different kind of effect.
  103951. */
  103952. get vignetteBlendMode(): number;
  103953. /**
  103954. * Sets the vignette blend mode allowing different kind of effect.
  103955. */
  103956. set vignetteBlendMode(value: number);
  103957. /**
  103958. * Gets wether the vignette effect is enabled.
  103959. */
  103960. get vignetteEnabled(): boolean;
  103961. /**
  103962. * Sets wether the vignette effect is enabled.
  103963. */
  103964. set vignetteEnabled(value: boolean);
  103965. private _fromLinearSpace;
  103966. /**
  103967. * Gets wether the input of the processing is in Gamma or Linear Space.
  103968. */
  103969. get fromLinearSpace(): boolean;
  103970. /**
  103971. * Sets wether the input of the processing is in Gamma or Linear Space.
  103972. */
  103973. set fromLinearSpace(value: boolean);
  103974. /**
  103975. * Defines cache preventing GC.
  103976. */
  103977. private _defines;
  103978. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103979. /**
  103980. * "ImageProcessingPostProcess"
  103981. * @returns "ImageProcessingPostProcess"
  103982. */
  103983. getClassName(): string;
  103984. /**
  103985. * @hidden
  103986. */
  103987. _updateParameters(): void;
  103988. dispose(camera?: Camera): void;
  103989. }
  103990. }
  103991. declare module BABYLON {
  103992. /** @hidden */
  103993. export var fibonacci: {
  103994. name: string;
  103995. shader: string;
  103996. };
  103997. }
  103998. declare module BABYLON {
  103999. /** @hidden */
  104000. export var subSurfaceScatteringFunctions: {
  104001. name: string;
  104002. shader: string;
  104003. };
  104004. }
  104005. declare module BABYLON {
  104006. /** @hidden */
  104007. export var diffusionProfile: {
  104008. name: string;
  104009. shader: string;
  104010. };
  104011. }
  104012. declare module BABYLON {
  104013. /** @hidden */
  104014. export var subSurfaceScatteringPixelShader: {
  104015. name: string;
  104016. shader: string;
  104017. };
  104018. }
  104019. declare module BABYLON {
  104020. /**
  104021. * Sub surface scattering post process
  104022. */
  104023. export class SubSurfaceScatteringPostProcess extends PostProcess {
  104024. /**
  104025. * Gets a string identifying the name of the class
  104026. * @returns "SubSurfaceScatteringPostProcess" string
  104027. */
  104028. getClassName(): string;
  104029. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  104030. }
  104031. }
  104032. declare module BABYLON {
  104033. /**
  104034. * Interface for defining prepass effects in the prepass post-process pipeline
  104035. */
  104036. export interface PrePassEffectConfiguration {
  104037. /**
  104038. * Post process to attach for this effect
  104039. */
  104040. postProcess: PostProcess;
  104041. /**
  104042. * Is the effect enabled
  104043. */
  104044. enabled: boolean;
  104045. /**
  104046. * Disposes the effect configuration
  104047. */
  104048. dispose(): void;
  104049. /**
  104050. * Disposes the effect configuration
  104051. */
  104052. createPostProcess: () => PostProcess;
  104053. }
  104054. }
  104055. declare module BABYLON {
  104056. /**
  104057. * Contains all parameters needed for the prepass to perform
  104058. * screen space subsurface scattering
  104059. */
  104060. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  104061. private _ssDiffusionS;
  104062. private _ssFilterRadii;
  104063. private _ssDiffusionD;
  104064. /**
  104065. * Post process to attach for screen space subsurface scattering
  104066. */
  104067. postProcess: SubSurfaceScatteringPostProcess;
  104068. /**
  104069. * Diffusion profile color for subsurface scattering
  104070. */
  104071. get ssDiffusionS(): number[];
  104072. /**
  104073. * Diffusion profile max color channel value for subsurface scattering
  104074. */
  104075. get ssDiffusionD(): number[];
  104076. /**
  104077. * Diffusion profile filter radius for subsurface scattering
  104078. */
  104079. get ssFilterRadii(): number[];
  104080. /**
  104081. * Is subsurface enabled
  104082. */
  104083. enabled: boolean;
  104084. /**
  104085. * Diffusion profile colors for subsurface scattering
  104086. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  104087. * See ...
  104088. * Note that you can only store up to 5 of them
  104089. */
  104090. ssDiffusionProfileColors: Color3[];
  104091. /**
  104092. * Defines the ratio real world => scene units.
  104093. * Used for subsurface scattering
  104094. */
  104095. metersPerUnit: number;
  104096. private _scene;
  104097. /**
  104098. * Builds a subsurface configuration object
  104099. * @param scene The scene
  104100. */
  104101. constructor(scene: Scene);
  104102. /**
  104103. * Adds a new diffusion profile.
  104104. * Useful for more realistic subsurface scattering on diverse materials.
  104105. * @param color The color of the diffusion profile. Should be the average color of the material.
  104106. * @return The index of the diffusion profile for the material subsurface configuration
  104107. */
  104108. addDiffusionProfile(color: Color3): number;
  104109. /**
  104110. * Creates the sss post process
  104111. * @return The created post process
  104112. */
  104113. createPostProcess(): SubSurfaceScatteringPostProcess;
  104114. /**
  104115. * Deletes all diffusion profiles.
  104116. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104117. */
  104118. clearAllDiffusionProfiles(): void;
  104119. /**
  104120. * Disposes this object
  104121. */
  104122. dispose(): void;
  104123. /**
  104124. * @hidden
  104125. * https://zero-radiance.github.io/post/sampling-diffusion/
  104126. *
  104127. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104128. * ------------------------------------------------------------------------------------
  104129. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104130. * PDF[r, phi, s] = r * R[r, phi, s]
  104131. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104132. * ------------------------------------------------------------------------------------
  104133. * We importance sample the color channel with the widest scattering distance.
  104134. */
  104135. getDiffusionProfileParameters(color: Color3): number;
  104136. /**
  104137. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104138. * 'u' is the random number (the value of the CDF): [0, 1).
  104139. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104140. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104141. */
  104142. private _sampleBurleyDiffusionProfile;
  104143. }
  104144. }
  104145. declare module BABYLON {
  104146. /**
  104147. * Renders a pre pass of the scene
  104148. * This means every mesh in the scene will be rendered to a render target texture
  104149. * And then this texture will be composited to the rendering canvas with post processes
  104150. * It is necessary for effects like subsurface scattering or deferred shading
  104151. */
  104152. export class PrePassRenderer {
  104153. /** @hidden */
  104154. static _SceneComponentInitialization: (scene: Scene) => void;
  104155. private _scene;
  104156. private _engine;
  104157. private _isDirty;
  104158. /**
  104159. * Number of textures in the multi render target texture where the scene is directly rendered
  104160. */
  104161. readonly mrtCount: number;
  104162. /**
  104163. * The render target where the scene is directly rendered
  104164. */
  104165. prePassRT: MultiRenderTarget;
  104166. private _mrtTypes;
  104167. private _multiRenderAttachments;
  104168. private _defaultAttachments;
  104169. private _clearAttachments;
  104170. private _postProcesses;
  104171. private readonly _clearColor;
  104172. /**
  104173. * Image processing post process for composition
  104174. */
  104175. imageProcessingPostProcess: ImageProcessingPostProcess;
  104176. /**
  104177. * Configuration for sub surface scattering post process
  104178. */
  104179. subSurfaceConfiguration: SubSurfaceConfiguration;
  104180. /**
  104181. * Should materials render their geometry on the MRT
  104182. */
  104183. materialsShouldRenderGeometry: boolean;
  104184. /**
  104185. * Should materials render the irradiance information on the MRT
  104186. */
  104187. materialsShouldRenderIrradiance: boolean;
  104188. private _enabled;
  104189. /**
  104190. * Indicates if the prepass is enabled
  104191. */
  104192. get enabled(): boolean;
  104193. /**
  104194. * How many samples are used for MSAA of the scene render target
  104195. */
  104196. get samples(): number;
  104197. set samples(n: number);
  104198. /**
  104199. * Instanciates a prepass renderer
  104200. * @param scene The scene
  104201. */
  104202. constructor(scene: Scene);
  104203. private _initializeAttachments;
  104204. private _createCompositionEffect;
  104205. /**
  104206. * Indicates if rendering a prepass is supported
  104207. */
  104208. get isSupported(): boolean;
  104209. /**
  104210. * Sets the proper output textures to draw in the engine.
  104211. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104212. */
  104213. bindAttachmentsForEffect(effect: Effect): void;
  104214. /**
  104215. * @hidden
  104216. */
  104217. _beforeCameraDraw(): void;
  104218. /**
  104219. * @hidden
  104220. */
  104221. _afterCameraDraw(): void;
  104222. private _checkRTSize;
  104223. private _bindFrameBuffer;
  104224. /**
  104225. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104226. */
  104227. clear(): void;
  104228. private _setState;
  104229. private _enable;
  104230. private _disable;
  104231. private _resetPostProcessChain;
  104232. private _bindPostProcessChain;
  104233. /**
  104234. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104235. */
  104236. markAsDirty(): void;
  104237. private _update;
  104238. /**
  104239. * Disposes the prepass renderer.
  104240. */
  104241. dispose(): void;
  104242. }
  104243. }
  104244. declare module BABYLON {
  104245. /**
  104246. * Options for compiling materials.
  104247. */
  104248. export interface IMaterialCompilationOptions {
  104249. /**
  104250. * Defines whether clip planes are enabled.
  104251. */
  104252. clipPlane: boolean;
  104253. /**
  104254. * Defines whether instances are enabled.
  104255. */
  104256. useInstances: boolean;
  104257. }
  104258. /**
  104259. * Options passed when calling customShaderNameResolve
  104260. */
  104261. export interface ICustomShaderNameResolveOptions {
  104262. /**
  104263. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  104264. */
  104265. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104266. }
  104267. /**
  104268. * Base class for the main features of a material in Babylon.js
  104269. */
  104270. export class Material implements IAnimatable {
  104271. /**
  104272. * Returns the triangle fill mode
  104273. */
  104274. static readonly TriangleFillMode: number;
  104275. /**
  104276. * Returns the wireframe mode
  104277. */
  104278. static readonly WireFrameFillMode: number;
  104279. /**
  104280. * Returns the point fill mode
  104281. */
  104282. static readonly PointFillMode: number;
  104283. /**
  104284. * Returns the point list draw mode
  104285. */
  104286. static readonly PointListDrawMode: number;
  104287. /**
  104288. * Returns the line list draw mode
  104289. */
  104290. static readonly LineListDrawMode: number;
  104291. /**
  104292. * Returns the line loop draw mode
  104293. */
  104294. static readonly LineLoopDrawMode: number;
  104295. /**
  104296. * Returns the line strip draw mode
  104297. */
  104298. static readonly LineStripDrawMode: number;
  104299. /**
  104300. * Returns the triangle strip draw mode
  104301. */
  104302. static readonly TriangleStripDrawMode: number;
  104303. /**
  104304. * Returns the triangle fan draw mode
  104305. */
  104306. static readonly TriangleFanDrawMode: number;
  104307. /**
  104308. * Stores the clock-wise side orientation
  104309. */
  104310. static readonly ClockWiseSideOrientation: number;
  104311. /**
  104312. * Stores the counter clock-wise side orientation
  104313. */
  104314. static readonly CounterClockWiseSideOrientation: number;
  104315. /**
  104316. * The dirty texture flag value
  104317. */
  104318. static readonly TextureDirtyFlag: number;
  104319. /**
  104320. * The dirty light flag value
  104321. */
  104322. static readonly LightDirtyFlag: number;
  104323. /**
  104324. * The dirty fresnel flag value
  104325. */
  104326. static readonly FresnelDirtyFlag: number;
  104327. /**
  104328. * The dirty attribute flag value
  104329. */
  104330. static readonly AttributesDirtyFlag: number;
  104331. /**
  104332. * The dirty misc flag value
  104333. */
  104334. static readonly MiscDirtyFlag: number;
  104335. /**
  104336. * The all dirty flag value
  104337. */
  104338. static readonly AllDirtyFlag: number;
  104339. /**
  104340. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104341. */
  104342. static readonly MATERIAL_OPAQUE: number;
  104343. /**
  104344. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104345. */
  104346. static readonly MATERIAL_ALPHATEST: number;
  104347. /**
  104348. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104349. */
  104350. static readonly MATERIAL_ALPHABLEND: number;
  104351. /**
  104352. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104353. * They are also discarded below the alpha cutoff threshold to improve performances.
  104354. */
  104355. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104356. /**
  104357. * The Whiteout method is used to blend normals.
  104358. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104359. */
  104360. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104361. /**
  104362. * The Reoriented Normal Mapping method is used to blend normals.
  104363. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104364. */
  104365. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104366. /**
  104367. * Custom callback helping to override the default shader used in the material.
  104368. */
  104369. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104370. /**
  104371. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104372. */
  104373. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104374. /**
  104375. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104376. * This means that the material can keep using a previous shader while a new one is being compiled.
  104377. * This is mostly used when shader parallel compilation is supported (true by default)
  104378. */
  104379. allowShaderHotSwapping: boolean;
  104380. /**
  104381. * The ID of the material
  104382. */
  104383. id: string;
  104384. /**
  104385. * Gets or sets the unique id of the material
  104386. */
  104387. uniqueId: number;
  104388. /**
  104389. * The name of the material
  104390. */
  104391. name: string;
  104392. /**
  104393. * Gets or sets user defined metadata
  104394. */
  104395. metadata: any;
  104396. /**
  104397. * For internal use only. Please do not use.
  104398. */
  104399. reservedDataStore: any;
  104400. /**
  104401. * Specifies if the ready state should be checked on each call
  104402. */
  104403. checkReadyOnEveryCall: boolean;
  104404. /**
  104405. * Specifies if the ready state should be checked once
  104406. */
  104407. checkReadyOnlyOnce: boolean;
  104408. /**
  104409. * The state of the material
  104410. */
  104411. state: string;
  104412. /**
  104413. * If the material can be rendered to several textures with MRT extension
  104414. */
  104415. get canRenderToMRT(): boolean;
  104416. /**
  104417. * The alpha value of the material
  104418. */
  104419. protected _alpha: number;
  104420. /**
  104421. * List of inspectable custom properties (used by the Inspector)
  104422. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104423. */
  104424. inspectableCustomProperties: IInspectable[];
  104425. /**
  104426. * Sets the alpha value of the material
  104427. */
  104428. set alpha(value: number);
  104429. /**
  104430. * Gets the alpha value of the material
  104431. */
  104432. get alpha(): number;
  104433. /**
  104434. * Specifies if back face culling is enabled
  104435. */
  104436. protected _backFaceCulling: boolean;
  104437. /**
  104438. * Sets the back-face culling state
  104439. */
  104440. set backFaceCulling(value: boolean);
  104441. /**
  104442. * Gets the back-face culling state
  104443. */
  104444. get backFaceCulling(): boolean;
  104445. /**
  104446. * Stores the value for side orientation
  104447. */
  104448. sideOrientation: number;
  104449. /**
  104450. * Callback triggered when the material is compiled
  104451. */
  104452. onCompiled: Nullable<(effect: Effect) => void>;
  104453. /**
  104454. * Callback triggered when an error occurs
  104455. */
  104456. onError: Nullable<(effect: Effect, errors: string) => void>;
  104457. /**
  104458. * Callback triggered to get the render target textures
  104459. */
  104460. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104461. /**
  104462. * Gets a boolean indicating that current material needs to register RTT
  104463. */
  104464. get hasRenderTargetTextures(): boolean;
  104465. /**
  104466. * Specifies if the material should be serialized
  104467. */
  104468. doNotSerialize: boolean;
  104469. /**
  104470. * @hidden
  104471. */
  104472. _storeEffectOnSubMeshes: boolean;
  104473. /**
  104474. * Stores the animations for the material
  104475. */
  104476. animations: Nullable<Array<Animation>>;
  104477. /**
  104478. * An event triggered when the material is disposed
  104479. */
  104480. onDisposeObservable: Observable<Material>;
  104481. /**
  104482. * An observer which watches for dispose events
  104483. */
  104484. private _onDisposeObserver;
  104485. private _onUnBindObservable;
  104486. /**
  104487. * Called during a dispose event
  104488. */
  104489. set onDispose(callback: () => void);
  104490. private _onBindObservable;
  104491. /**
  104492. * An event triggered when the material is bound
  104493. */
  104494. get onBindObservable(): Observable<AbstractMesh>;
  104495. /**
  104496. * An observer which watches for bind events
  104497. */
  104498. private _onBindObserver;
  104499. /**
  104500. * Called during a bind event
  104501. */
  104502. set onBind(callback: (Mesh: AbstractMesh) => void);
  104503. /**
  104504. * An event triggered when the material is unbound
  104505. */
  104506. get onUnBindObservable(): Observable<Material>;
  104507. protected _onEffectCreatedObservable: Nullable<Observable<{
  104508. effect: Effect;
  104509. subMesh: Nullable<SubMesh>;
  104510. }>>;
  104511. /**
  104512. * An event triggered when the effect is (re)created
  104513. */
  104514. get onEffectCreatedObservable(): Observable<{
  104515. effect: Effect;
  104516. subMesh: Nullable<SubMesh>;
  104517. }>;
  104518. /**
  104519. * Stores the value of the alpha mode
  104520. */
  104521. private _alphaMode;
  104522. /**
  104523. * Sets the value of the alpha mode.
  104524. *
  104525. * | Value | Type | Description |
  104526. * | --- | --- | --- |
  104527. * | 0 | ALPHA_DISABLE | |
  104528. * | 1 | ALPHA_ADD | |
  104529. * | 2 | ALPHA_COMBINE | |
  104530. * | 3 | ALPHA_SUBTRACT | |
  104531. * | 4 | ALPHA_MULTIPLY | |
  104532. * | 5 | ALPHA_MAXIMIZED | |
  104533. * | 6 | ALPHA_ONEONE | |
  104534. * | 7 | ALPHA_PREMULTIPLIED | |
  104535. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104536. * | 9 | ALPHA_INTERPOLATE | |
  104537. * | 10 | ALPHA_SCREENMODE | |
  104538. *
  104539. */
  104540. set alphaMode(value: number);
  104541. /**
  104542. * Gets the value of the alpha mode
  104543. */
  104544. get alphaMode(): number;
  104545. /**
  104546. * Stores the state of the need depth pre-pass value
  104547. */
  104548. private _needDepthPrePass;
  104549. /**
  104550. * Sets the need depth pre-pass value
  104551. */
  104552. set needDepthPrePass(value: boolean);
  104553. /**
  104554. * Gets the depth pre-pass value
  104555. */
  104556. get needDepthPrePass(): boolean;
  104557. /**
  104558. * Specifies if depth writing should be disabled
  104559. */
  104560. disableDepthWrite: boolean;
  104561. /**
  104562. * Specifies if color writing should be disabled
  104563. */
  104564. disableColorWrite: boolean;
  104565. /**
  104566. * Specifies if depth writing should be forced
  104567. */
  104568. forceDepthWrite: boolean;
  104569. /**
  104570. * Specifies the depth function that should be used. 0 means the default engine function
  104571. */
  104572. depthFunction: number;
  104573. /**
  104574. * Specifies if there should be a separate pass for culling
  104575. */
  104576. separateCullingPass: boolean;
  104577. /**
  104578. * Stores the state specifing if fog should be enabled
  104579. */
  104580. private _fogEnabled;
  104581. /**
  104582. * Sets the state for enabling fog
  104583. */
  104584. set fogEnabled(value: boolean);
  104585. /**
  104586. * Gets the value of the fog enabled state
  104587. */
  104588. get fogEnabled(): boolean;
  104589. /**
  104590. * Stores the size of points
  104591. */
  104592. pointSize: number;
  104593. /**
  104594. * Stores the z offset value
  104595. */
  104596. zOffset: number;
  104597. get wireframe(): boolean;
  104598. /**
  104599. * Sets the state of wireframe mode
  104600. */
  104601. set wireframe(value: boolean);
  104602. /**
  104603. * Gets the value specifying if point clouds are enabled
  104604. */
  104605. get pointsCloud(): boolean;
  104606. /**
  104607. * Sets the state of point cloud mode
  104608. */
  104609. set pointsCloud(value: boolean);
  104610. /**
  104611. * Gets the material fill mode
  104612. */
  104613. get fillMode(): number;
  104614. /**
  104615. * Sets the material fill mode
  104616. */
  104617. set fillMode(value: number);
  104618. /**
  104619. * @hidden
  104620. * Stores the effects for the material
  104621. */
  104622. _effect: Nullable<Effect>;
  104623. /**
  104624. * Specifies if uniform buffers should be used
  104625. */
  104626. private _useUBO;
  104627. /**
  104628. * Stores a reference to the scene
  104629. */
  104630. private _scene;
  104631. /**
  104632. * Stores the fill mode state
  104633. */
  104634. private _fillMode;
  104635. /**
  104636. * Specifies if the depth write state should be cached
  104637. */
  104638. private _cachedDepthWriteState;
  104639. /**
  104640. * Specifies if the color write state should be cached
  104641. */
  104642. private _cachedColorWriteState;
  104643. /**
  104644. * Specifies if the depth function state should be cached
  104645. */
  104646. private _cachedDepthFunctionState;
  104647. /**
  104648. * Stores the uniform buffer
  104649. */
  104650. protected _uniformBuffer: UniformBuffer;
  104651. /** @hidden */
  104652. _indexInSceneMaterialArray: number;
  104653. /** @hidden */
  104654. meshMap: Nullable<{
  104655. [id: string]: AbstractMesh | undefined;
  104656. }>;
  104657. /**
  104658. * Creates a material instance
  104659. * @param name defines the name of the material
  104660. * @param scene defines the scene to reference
  104661. * @param doNotAdd specifies if the material should be added to the scene
  104662. */
  104663. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104664. /**
  104665. * Returns a string representation of the current material
  104666. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104667. * @returns a string with material information
  104668. */
  104669. toString(fullDetails?: boolean): string;
  104670. /**
  104671. * Gets the class name of the material
  104672. * @returns a string with the class name of the material
  104673. */
  104674. getClassName(): string;
  104675. /**
  104676. * Specifies if updates for the material been locked
  104677. */
  104678. get isFrozen(): boolean;
  104679. /**
  104680. * Locks updates for the material
  104681. */
  104682. freeze(): void;
  104683. /**
  104684. * Unlocks updates for the material
  104685. */
  104686. unfreeze(): void;
  104687. /**
  104688. * Specifies if the material is ready to be used
  104689. * @param mesh defines the mesh to check
  104690. * @param useInstances specifies if instances should be used
  104691. * @returns a boolean indicating if the material is ready to be used
  104692. */
  104693. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104694. /**
  104695. * Specifies that the submesh is ready to be used
  104696. * @param mesh defines the mesh to check
  104697. * @param subMesh defines which submesh to check
  104698. * @param useInstances specifies that instances should be used
  104699. * @returns a boolean indicating that the submesh is ready or not
  104700. */
  104701. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104702. /**
  104703. * Returns the material effect
  104704. * @returns the effect associated with the material
  104705. */
  104706. getEffect(): Nullable<Effect>;
  104707. /**
  104708. * Returns the current scene
  104709. * @returns a Scene
  104710. */
  104711. getScene(): Scene;
  104712. /**
  104713. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104714. */
  104715. protected _forceAlphaTest: boolean;
  104716. /**
  104717. * The transparency mode of the material.
  104718. */
  104719. protected _transparencyMode: Nullable<number>;
  104720. /**
  104721. * Gets the current transparency mode.
  104722. */
  104723. get transparencyMode(): Nullable<number>;
  104724. /**
  104725. * Sets the transparency mode of the material.
  104726. *
  104727. * | Value | Type | Description |
  104728. * | ----- | ----------------------------------- | ----------- |
  104729. * | 0 | OPAQUE | |
  104730. * | 1 | ALPHATEST | |
  104731. * | 2 | ALPHABLEND | |
  104732. * | 3 | ALPHATESTANDBLEND | |
  104733. *
  104734. */
  104735. set transparencyMode(value: Nullable<number>);
  104736. /**
  104737. * Returns true if alpha blending should be disabled.
  104738. */
  104739. protected get _disableAlphaBlending(): boolean;
  104740. /**
  104741. * Specifies whether or not this material should be rendered in alpha blend mode.
  104742. * @returns a boolean specifying if alpha blending is needed
  104743. */
  104744. needAlphaBlending(): boolean;
  104745. /**
  104746. * Specifies if the mesh will require alpha blending
  104747. * @param mesh defines the mesh to check
  104748. * @returns a boolean specifying if alpha blending is needed for the mesh
  104749. */
  104750. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104751. /**
  104752. * Specifies whether or not this material should be rendered in alpha test mode.
  104753. * @returns a boolean specifying if an alpha test is needed.
  104754. */
  104755. needAlphaTesting(): boolean;
  104756. /**
  104757. * Specifies if material alpha testing should be turned on for the mesh
  104758. * @param mesh defines the mesh to check
  104759. */
  104760. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104761. /**
  104762. * Gets the texture used for the alpha test
  104763. * @returns the texture to use for alpha testing
  104764. */
  104765. getAlphaTestTexture(): Nullable<BaseTexture>;
  104766. /**
  104767. * Marks the material to indicate that it needs to be re-calculated
  104768. */
  104769. markDirty(): void;
  104770. /** @hidden */
  104771. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104772. /**
  104773. * Binds the material to the mesh
  104774. * @param world defines the world transformation matrix
  104775. * @param mesh defines the mesh to bind the material to
  104776. */
  104777. bind(world: Matrix, mesh?: Mesh): void;
  104778. /**
  104779. * Binds the submesh to the material
  104780. * @param world defines the world transformation matrix
  104781. * @param mesh defines the mesh containing the submesh
  104782. * @param subMesh defines the submesh to bind the material to
  104783. */
  104784. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104785. /**
  104786. * Binds the world matrix to the material
  104787. * @param world defines the world transformation matrix
  104788. */
  104789. bindOnlyWorldMatrix(world: Matrix): void;
  104790. /**
  104791. * Binds the scene's uniform buffer to the effect.
  104792. * @param effect defines the effect to bind to the scene uniform buffer
  104793. * @param sceneUbo defines the uniform buffer storing scene data
  104794. */
  104795. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104796. /**
  104797. * Binds the view matrix to the effect
  104798. * @param effect defines the effect to bind the view matrix to
  104799. */
  104800. bindView(effect: Effect): void;
  104801. /**
  104802. * Binds the view projection matrix to the effect
  104803. * @param effect defines the effect to bind the view projection matrix to
  104804. */
  104805. bindViewProjection(effect: Effect): void;
  104806. /**
  104807. * Processes to execute after binding the material to a mesh
  104808. * @param mesh defines the rendered mesh
  104809. */
  104810. protected _afterBind(mesh?: Mesh): void;
  104811. /**
  104812. * Unbinds the material from the mesh
  104813. */
  104814. unbind(): void;
  104815. /**
  104816. * Gets the active textures from the material
  104817. * @returns an array of textures
  104818. */
  104819. getActiveTextures(): BaseTexture[];
  104820. /**
  104821. * Specifies if the material uses a texture
  104822. * @param texture defines the texture to check against the material
  104823. * @returns a boolean specifying if the material uses the texture
  104824. */
  104825. hasTexture(texture: BaseTexture): boolean;
  104826. /**
  104827. * Makes a duplicate of the material, and gives it a new name
  104828. * @param name defines the new name for the duplicated material
  104829. * @returns the cloned material
  104830. */
  104831. clone(name: string): Nullable<Material>;
  104832. /**
  104833. * Gets the meshes bound to the material
  104834. * @returns an array of meshes bound to the material
  104835. */
  104836. getBindedMeshes(): AbstractMesh[];
  104837. /**
  104838. * Force shader compilation
  104839. * @param mesh defines the mesh associated with this material
  104840. * @param onCompiled defines a function to execute once the material is compiled
  104841. * @param options defines the options to configure the compilation
  104842. * @param onError defines a function to execute if the material fails compiling
  104843. */
  104844. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104845. /**
  104846. * Force shader compilation
  104847. * @param mesh defines the mesh that will use this material
  104848. * @param options defines additional options for compiling the shaders
  104849. * @returns a promise that resolves when the compilation completes
  104850. */
  104851. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104852. private static readonly _AllDirtyCallBack;
  104853. private static readonly _ImageProcessingDirtyCallBack;
  104854. private static readonly _TextureDirtyCallBack;
  104855. private static readonly _FresnelDirtyCallBack;
  104856. private static readonly _MiscDirtyCallBack;
  104857. private static readonly _LightsDirtyCallBack;
  104858. private static readonly _AttributeDirtyCallBack;
  104859. private static _FresnelAndMiscDirtyCallBack;
  104860. private static _TextureAndMiscDirtyCallBack;
  104861. private static readonly _DirtyCallbackArray;
  104862. private static readonly _RunDirtyCallBacks;
  104863. /**
  104864. * Marks a define in the material to indicate that it needs to be re-computed
  104865. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104866. */
  104867. markAsDirty(flag: number): void;
  104868. /**
  104869. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104870. * @param func defines a function which checks material defines against the submeshes
  104871. */
  104872. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104873. /**
  104874. * Indicates that the scene should check if the rendering now needs a prepass
  104875. */
  104876. protected _markScenePrePassDirty(): void;
  104877. /**
  104878. * Indicates that we need to re-calculated for all submeshes
  104879. */
  104880. protected _markAllSubMeshesAsAllDirty(): void;
  104881. /**
  104882. * Indicates that image processing needs to be re-calculated for all submeshes
  104883. */
  104884. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104885. /**
  104886. * Indicates that textures need to be re-calculated for all submeshes
  104887. */
  104888. protected _markAllSubMeshesAsTexturesDirty(): void;
  104889. /**
  104890. * Indicates that fresnel needs to be re-calculated for all submeshes
  104891. */
  104892. protected _markAllSubMeshesAsFresnelDirty(): void;
  104893. /**
  104894. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104895. */
  104896. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104897. /**
  104898. * Indicates that lights need to be re-calculated for all submeshes
  104899. */
  104900. protected _markAllSubMeshesAsLightsDirty(): void;
  104901. /**
  104902. * Indicates that attributes need to be re-calculated for all submeshes
  104903. */
  104904. protected _markAllSubMeshesAsAttributesDirty(): void;
  104905. /**
  104906. * Indicates that misc needs to be re-calculated for all submeshes
  104907. */
  104908. protected _markAllSubMeshesAsMiscDirty(): void;
  104909. /**
  104910. * Indicates that textures and misc need to be re-calculated for all submeshes
  104911. */
  104912. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104913. /**
  104914. * Sets the required values to the prepass renderer.
  104915. * @param prePassRenderer defines the prepass renderer to setup.
  104916. * @returns true if the pre pass is needed.
  104917. */
  104918. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104919. /**
  104920. * Disposes the material
  104921. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104922. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104923. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104924. */
  104925. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104926. /** @hidden */
  104927. private releaseVertexArrayObject;
  104928. /**
  104929. * Serializes this material
  104930. * @returns the serialized material object
  104931. */
  104932. serialize(): any;
  104933. /**
  104934. * Creates a material from parsed material data
  104935. * @param parsedMaterial defines parsed material data
  104936. * @param scene defines the hosting scene
  104937. * @param rootUrl defines the root URL to use to load textures
  104938. * @returns a new material
  104939. */
  104940. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104941. }
  104942. }
  104943. declare module BABYLON {
  104944. /**
  104945. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104946. * separate meshes. This can be use to improve performances.
  104947. * @see https://doc.babylonjs.com/how_to/multi_materials
  104948. */
  104949. export class MultiMaterial extends Material {
  104950. private _subMaterials;
  104951. /**
  104952. * Gets or Sets the list of Materials used within the multi material.
  104953. * They need to be ordered according to the submeshes order in the associated mesh
  104954. */
  104955. get subMaterials(): Nullable<Material>[];
  104956. set subMaterials(value: Nullable<Material>[]);
  104957. /**
  104958. * Function used to align with Node.getChildren()
  104959. * @returns the list of Materials used within the multi material
  104960. */
  104961. getChildren(): Nullable<Material>[];
  104962. /**
  104963. * Instantiates a new Multi Material
  104964. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104965. * separate meshes. This can be use to improve performances.
  104966. * @see https://doc.babylonjs.com/how_to/multi_materials
  104967. * @param name Define the name in the scene
  104968. * @param scene Define the scene the material belongs to
  104969. */
  104970. constructor(name: string, scene: Scene);
  104971. private _hookArray;
  104972. /**
  104973. * Get one of the submaterial by its index in the submaterials array
  104974. * @param index The index to look the sub material at
  104975. * @returns The Material if the index has been defined
  104976. */
  104977. getSubMaterial(index: number): Nullable<Material>;
  104978. /**
  104979. * Get the list of active textures for the whole sub materials list.
  104980. * @returns All the textures that will be used during the rendering
  104981. */
  104982. getActiveTextures(): BaseTexture[];
  104983. /**
  104984. * Gets the current class name of the material e.g. "MultiMaterial"
  104985. * Mainly use in serialization.
  104986. * @returns the class name
  104987. */
  104988. getClassName(): string;
  104989. /**
  104990. * Checks if the material is ready to render the requested sub mesh
  104991. * @param mesh Define the mesh the submesh belongs to
  104992. * @param subMesh Define the sub mesh to look readyness for
  104993. * @param useInstances Define whether or not the material is used with instances
  104994. * @returns true if ready, otherwise false
  104995. */
  104996. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104997. /**
  104998. * Clones the current material and its related sub materials
  104999. * @param name Define the name of the newly cloned material
  105000. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  105001. * @returns the cloned material
  105002. */
  105003. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  105004. /**
  105005. * Serializes the materials into a JSON representation.
  105006. * @returns the JSON representation
  105007. */
  105008. serialize(): any;
  105009. /**
  105010. * Dispose the material and release its associated resources
  105011. * @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)
  105012. * @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)
  105013. * @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)
  105014. */
  105015. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  105016. /**
  105017. * Creates a MultiMaterial from parsed MultiMaterial data.
  105018. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  105019. * @param scene defines the hosting scene
  105020. * @returns a new MultiMaterial
  105021. */
  105022. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  105023. }
  105024. }
  105025. declare module BABYLON {
  105026. /**
  105027. * Defines a subdivision inside a mesh
  105028. */
  105029. export class SubMesh implements ICullable {
  105030. /** the material index to use */
  105031. materialIndex: number;
  105032. /** vertex index start */
  105033. verticesStart: number;
  105034. /** vertices count */
  105035. verticesCount: number;
  105036. /** index start */
  105037. indexStart: number;
  105038. /** indices count */
  105039. indexCount: number;
  105040. /** @hidden */
  105041. _materialDefines: Nullable<MaterialDefines>;
  105042. /** @hidden */
  105043. _materialEffect: Nullable<Effect>;
  105044. /** @hidden */
  105045. _effectOverride: Nullable<Effect>;
  105046. /**
  105047. * Gets material defines used by the effect associated to the sub mesh
  105048. */
  105049. get materialDefines(): Nullable<MaterialDefines>;
  105050. /**
  105051. * Sets material defines used by the effect associated to the sub mesh
  105052. */
  105053. set materialDefines(defines: Nullable<MaterialDefines>);
  105054. /**
  105055. * Gets associated effect
  105056. */
  105057. get effect(): Nullable<Effect>;
  105058. /**
  105059. * Sets associated effect (effect used to render this submesh)
  105060. * @param effect defines the effect to associate with
  105061. * @param defines defines the set of defines used to compile this effect
  105062. */
  105063. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  105064. /** @hidden */
  105065. _linesIndexCount: number;
  105066. private _mesh;
  105067. private _renderingMesh;
  105068. private _boundingInfo;
  105069. private _linesIndexBuffer;
  105070. /** @hidden */
  105071. _lastColliderWorldVertices: Nullable<Vector3[]>;
  105072. /** @hidden */
  105073. _trianglePlanes: Plane[];
  105074. /** @hidden */
  105075. _lastColliderTransformMatrix: Nullable<Matrix>;
  105076. /** @hidden */
  105077. _renderId: number;
  105078. /** @hidden */
  105079. _alphaIndex: number;
  105080. /** @hidden */
  105081. _distanceToCamera: number;
  105082. /** @hidden */
  105083. _id: number;
  105084. private _currentMaterial;
  105085. /**
  105086. * Add a new submesh to a mesh
  105087. * @param materialIndex defines the material index to use
  105088. * @param verticesStart defines vertex index start
  105089. * @param verticesCount defines vertices count
  105090. * @param indexStart defines index start
  105091. * @param indexCount defines indices count
  105092. * @param mesh defines the parent mesh
  105093. * @param renderingMesh defines an optional rendering mesh
  105094. * @param createBoundingBox defines if bounding box should be created for this submesh
  105095. * @returns the new submesh
  105096. */
  105097. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105098. /**
  105099. * Creates a new submesh
  105100. * @param materialIndex defines the material index to use
  105101. * @param verticesStart defines vertex index start
  105102. * @param verticesCount defines vertices count
  105103. * @param indexStart defines index start
  105104. * @param indexCount defines indices count
  105105. * @param mesh defines the parent mesh
  105106. * @param renderingMesh defines an optional rendering mesh
  105107. * @param createBoundingBox defines if bounding box should be created for this submesh
  105108. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105109. */
  105110. constructor(
  105111. /** the material index to use */
  105112. materialIndex: number,
  105113. /** vertex index start */
  105114. verticesStart: number,
  105115. /** vertices count */
  105116. verticesCount: number,
  105117. /** index start */
  105118. indexStart: number,
  105119. /** indices count */
  105120. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105121. /**
  105122. * Returns true if this submesh covers the entire parent mesh
  105123. * @ignorenaming
  105124. */
  105125. get IsGlobal(): boolean;
  105126. /**
  105127. * Returns the submesh BoudingInfo object
  105128. * @returns current bounding info (or mesh's one if the submesh is global)
  105129. */
  105130. getBoundingInfo(): BoundingInfo;
  105131. /**
  105132. * Sets the submesh BoundingInfo
  105133. * @param boundingInfo defines the new bounding info to use
  105134. * @returns the SubMesh
  105135. */
  105136. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105137. /**
  105138. * Returns the mesh of the current submesh
  105139. * @return the parent mesh
  105140. */
  105141. getMesh(): AbstractMesh;
  105142. /**
  105143. * Returns the rendering mesh of the submesh
  105144. * @returns the rendering mesh (could be different from parent mesh)
  105145. */
  105146. getRenderingMesh(): Mesh;
  105147. /**
  105148. * Returns the replacement mesh of the submesh
  105149. * @returns the replacement mesh (could be different from parent mesh)
  105150. */
  105151. getReplacementMesh(): Nullable<AbstractMesh>;
  105152. /**
  105153. * Returns the effective mesh of the submesh
  105154. * @returns the effective mesh (could be different from parent mesh)
  105155. */
  105156. getEffectiveMesh(): AbstractMesh;
  105157. /**
  105158. * Returns the submesh material
  105159. * @returns null or the current material
  105160. */
  105161. getMaterial(): Nullable<Material>;
  105162. private _IsMultiMaterial;
  105163. /**
  105164. * Sets a new updated BoundingInfo object to the submesh
  105165. * @param data defines an optional position array to use to determine the bounding info
  105166. * @returns the SubMesh
  105167. */
  105168. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105169. /** @hidden */
  105170. _checkCollision(collider: Collider): boolean;
  105171. /**
  105172. * Updates the submesh BoundingInfo
  105173. * @param world defines the world matrix to use to update the bounding info
  105174. * @returns the submesh
  105175. */
  105176. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105177. /**
  105178. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105179. * @param frustumPlanes defines the frustum planes
  105180. * @returns true if the submesh is intersecting with the frustum
  105181. */
  105182. isInFrustum(frustumPlanes: Plane[]): boolean;
  105183. /**
  105184. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105185. * @param frustumPlanes defines the frustum planes
  105186. * @returns true if the submesh is inside the frustum
  105187. */
  105188. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105189. /**
  105190. * Renders the submesh
  105191. * @param enableAlphaMode defines if alpha needs to be used
  105192. * @returns the submesh
  105193. */
  105194. render(enableAlphaMode: boolean): SubMesh;
  105195. /**
  105196. * @hidden
  105197. */
  105198. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105199. /**
  105200. * Checks if the submesh intersects with a ray
  105201. * @param ray defines the ray to test
  105202. * @returns true is the passed ray intersects the submesh bounding box
  105203. */
  105204. canIntersects(ray: Ray): boolean;
  105205. /**
  105206. * Intersects current submesh with a ray
  105207. * @param ray defines the ray to test
  105208. * @param positions defines mesh's positions array
  105209. * @param indices defines mesh's indices array
  105210. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105211. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105212. * @returns intersection info or null if no intersection
  105213. */
  105214. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105215. /** @hidden */
  105216. private _intersectLines;
  105217. /** @hidden */
  105218. private _intersectUnIndexedLines;
  105219. /** @hidden */
  105220. private _intersectTriangles;
  105221. /** @hidden */
  105222. private _intersectUnIndexedTriangles;
  105223. /** @hidden */
  105224. _rebuild(): void;
  105225. /**
  105226. * Creates a new submesh from the passed mesh
  105227. * @param newMesh defines the new hosting mesh
  105228. * @param newRenderingMesh defines an optional rendering mesh
  105229. * @returns the new submesh
  105230. */
  105231. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105232. /**
  105233. * Release associated resources
  105234. */
  105235. dispose(): void;
  105236. /**
  105237. * Gets the class name
  105238. * @returns the string "SubMesh".
  105239. */
  105240. getClassName(): string;
  105241. /**
  105242. * Creates a new submesh from indices data
  105243. * @param materialIndex the index of the main mesh material
  105244. * @param startIndex the index where to start the copy in the mesh indices array
  105245. * @param indexCount the number of indices to copy then from the startIndex
  105246. * @param mesh the main mesh to create the submesh from
  105247. * @param renderingMesh the optional rendering mesh
  105248. * @returns a new submesh
  105249. */
  105250. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105251. }
  105252. }
  105253. declare module BABYLON {
  105254. /**
  105255. * Class used to represent data loading progression
  105256. */
  105257. export class SceneLoaderFlags {
  105258. private static _ForceFullSceneLoadingForIncremental;
  105259. private static _ShowLoadingScreen;
  105260. private static _CleanBoneMatrixWeights;
  105261. private static _loggingLevel;
  105262. /**
  105263. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105264. */
  105265. static get ForceFullSceneLoadingForIncremental(): boolean;
  105266. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105267. /**
  105268. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105269. */
  105270. static get ShowLoadingScreen(): boolean;
  105271. static set ShowLoadingScreen(value: boolean);
  105272. /**
  105273. * Defines the current logging level (while loading the scene)
  105274. * @ignorenaming
  105275. */
  105276. static get loggingLevel(): number;
  105277. static set loggingLevel(value: number);
  105278. /**
  105279. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105280. */
  105281. static get CleanBoneMatrixWeights(): boolean;
  105282. static set CleanBoneMatrixWeights(value: boolean);
  105283. }
  105284. }
  105285. declare module BABYLON {
  105286. /**
  105287. * Class used to store geometry data (vertex buffers + index buffer)
  105288. */
  105289. export class Geometry implements IGetSetVerticesData {
  105290. /**
  105291. * Gets or sets the ID of the geometry
  105292. */
  105293. id: string;
  105294. /**
  105295. * Gets or sets the unique ID of the geometry
  105296. */
  105297. uniqueId: number;
  105298. /**
  105299. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105300. */
  105301. delayLoadState: number;
  105302. /**
  105303. * Gets the file containing the data to load when running in delay load state
  105304. */
  105305. delayLoadingFile: Nullable<string>;
  105306. /**
  105307. * Callback called when the geometry is updated
  105308. */
  105309. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105310. private _scene;
  105311. private _engine;
  105312. private _meshes;
  105313. private _totalVertices;
  105314. /** @hidden */
  105315. _indices: IndicesArray;
  105316. /** @hidden */
  105317. _vertexBuffers: {
  105318. [key: string]: VertexBuffer;
  105319. };
  105320. private _isDisposed;
  105321. private _extend;
  105322. private _boundingBias;
  105323. /** @hidden */
  105324. _delayInfo: Array<string>;
  105325. private _indexBuffer;
  105326. private _indexBufferIsUpdatable;
  105327. /** @hidden */
  105328. _boundingInfo: Nullable<BoundingInfo>;
  105329. /** @hidden */
  105330. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105331. /** @hidden */
  105332. _softwareSkinningFrameId: number;
  105333. private _vertexArrayObjects;
  105334. private _updatable;
  105335. /** @hidden */
  105336. _positions: Nullable<Vector3[]>;
  105337. /**
  105338. * 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
  105339. */
  105340. get boundingBias(): Vector2;
  105341. /**
  105342. * 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
  105343. */
  105344. set boundingBias(value: Vector2);
  105345. /**
  105346. * Static function used to attach a new empty geometry to a mesh
  105347. * @param mesh defines the mesh to attach the geometry to
  105348. * @returns the new Geometry
  105349. */
  105350. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105351. /** Get the list of meshes using this geometry */
  105352. get meshes(): Mesh[];
  105353. /**
  105354. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  105355. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105356. */
  105357. useBoundingInfoFromGeometry: boolean;
  105358. /**
  105359. * Creates a new geometry
  105360. * @param id defines the unique ID
  105361. * @param scene defines the hosting scene
  105362. * @param vertexData defines the VertexData used to get geometry data
  105363. * @param updatable defines if geometry must be updatable (false by default)
  105364. * @param mesh defines the mesh that will be associated with the geometry
  105365. */
  105366. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105367. /**
  105368. * Gets the current extend of the geometry
  105369. */
  105370. get extend(): {
  105371. minimum: Vector3;
  105372. maximum: Vector3;
  105373. };
  105374. /**
  105375. * Gets the hosting scene
  105376. * @returns the hosting Scene
  105377. */
  105378. getScene(): Scene;
  105379. /**
  105380. * Gets the hosting engine
  105381. * @returns the hosting Engine
  105382. */
  105383. getEngine(): Engine;
  105384. /**
  105385. * Defines if the geometry is ready to use
  105386. * @returns true if the geometry is ready to be used
  105387. */
  105388. isReady(): boolean;
  105389. /**
  105390. * Gets a value indicating that the geometry should not be serialized
  105391. */
  105392. get doNotSerialize(): boolean;
  105393. /** @hidden */
  105394. _rebuild(): void;
  105395. /**
  105396. * Affects all geometry data in one call
  105397. * @param vertexData defines the geometry data
  105398. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105399. */
  105400. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105401. /**
  105402. * Set specific vertex data
  105403. * @param kind defines the data kind (Position, normal, etc...)
  105404. * @param data defines the vertex data to use
  105405. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105406. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105407. */
  105408. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105409. /**
  105410. * Removes a specific vertex data
  105411. * @param kind defines the data kind (Position, normal, etc...)
  105412. */
  105413. removeVerticesData(kind: string): void;
  105414. /**
  105415. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105416. * @param buffer defines the vertex buffer to use
  105417. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105418. */
  105419. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105420. /**
  105421. * Update a specific vertex buffer
  105422. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105423. * It will do nothing if the buffer is not updatable
  105424. * @param kind defines the data kind (Position, normal, etc...)
  105425. * @param data defines the data to use
  105426. * @param offset defines the offset in the target buffer where to store the data
  105427. * @param useBytes set to true if the offset is in bytes
  105428. */
  105429. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105430. /**
  105431. * Update a specific vertex buffer
  105432. * This function will create a new buffer if the current one is not updatable
  105433. * @param kind defines the data kind (Position, normal, etc...)
  105434. * @param data defines the data to use
  105435. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105436. */
  105437. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105438. private _updateBoundingInfo;
  105439. /** @hidden */
  105440. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105441. /**
  105442. * Gets total number of vertices
  105443. * @returns the total number of vertices
  105444. */
  105445. getTotalVertices(): number;
  105446. /**
  105447. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105448. * @param kind defines the data kind (Position, normal, etc...)
  105449. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105450. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105451. * @returns a float array containing vertex data
  105452. */
  105453. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105454. /**
  105455. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105456. * @param kind defines the data kind (Position, normal, etc...)
  105457. * @returns true if the vertex buffer with the specified kind is updatable
  105458. */
  105459. isVertexBufferUpdatable(kind: string): boolean;
  105460. /**
  105461. * Gets a specific vertex buffer
  105462. * @param kind defines the data kind (Position, normal, etc...)
  105463. * @returns a VertexBuffer
  105464. */
  105465. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105466. /**
  105467. * Returns all vertex buffers
  105468. * @return an object holding all vertex buffers indexed by kind
  105469. */
  105470. getVertexBuffers(): Nullable<{
  105471. [key: string]: VertexBuffer;
  105472. }>;
  105473. /**
  105474. * Gets a boolean indicating if specific vertex buffer is present
  105475. * @param kind defines the data kind (Position, normal, etc...)
  105476. * @returns true if data is present
  105477. */
  105478. isVerticesDataPresent(kind: string): boolean;
  105479. /**
  105480. * Gets a list of all attached data kinds (Position, normal, etc...)
  105481. * @returns a list of string containing all kinds
  105482. */
  105483. getVerticesDataKinds(): string[];
  105484. /**
  105485. * Update index buffer
  105486. * @param indices defines the indices to store in the index buffer
  105487. * @param offset defines the offset in the target buffer where to store the data
  105488. * @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)
  105489. */
  105490. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105491. /**
  105492. * Creates a new index buffer
  105493. * @param indices defines the indices to store in the index buffer
  105494. * @param totalVertices defines the total number of vertices (could be null)
  105495. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105496. */
  105497. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105498. /**
  105499. * Return the total number of indices
  105500. * @returns the total number of indices
  105501. */
  105502. getTotalIndices(): number;
  105503. /**
  105504. * Gets the index buffer array
  105505. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105506. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105507. * @returns the index buffer array
  105508. */
  105509. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105510. /**
  105511. * Gets the index buffer
  105512. * @return the index buffer
  105513. */
  105514. getIndexBuffer(): Nullable<DataBuffer>;
  105515. /** @hidden */
  105516. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105517. /**
  105518. * Release the associated resources for a specific mesh
  105519. * @param mesh defines the source mesh
  105520. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105521. */
  105522. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105523. /**
  105524. * Apply current geometry to a given mesh
  105525. * @param mesh defines the mesh to apply geometry to
  105526. */
  105527. applyToMesh(mesh: Mesh): void;
  105528. private _updateExtend;
  105529. private _applyToMesh;
  105530. private notifyUpdate;
  105531. /**
  105532. * Load the geometry if it was flagged as delay loaded
  105533. * @param scene defines the hosting scene
  105534. * @param onLoaded defines a callback called when the geometry is loaded
  105535. */
  105536. load(scene: Scene, onLoaded?: () => void): void;
  105537. private _queueLoad;
  105538. /**
  105539. * Invert the geometry to move from a right handed system to a left handed one.
  105540. */
  105541. toLeftHanded(): void;
  105542. /** @hidden */
  105543. _resetPointsArrayCache(): void;
  105544. /** @hidden */
  105545. _generatePointsArray(): boolean;
  105546. /**
  105547. * Gets a value indicating if the geometry is disposed
  105548. * @returns true if the geometry was disposed
  105549. */
  105550. isDisposed(): boolean;
  105551. private _disposeVertexArrayObjects;
  105552. /**
  105553. * Free all associated resources
  105554. */
  105555. dispose(): void;
  105556. /**
  105557. * Clone the current geometry into a new geometry
  105558. * @param id defines the unique ID of the new geometry
  105559. * @returns a new geometry object
  105560. */
  105561. copy(id: string): Geometry;
  105562. /**
  105563. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105564. * @return a JSON representation of the current geometry data (without the vertices data)
  105565. */
  105566. serialize(): any;
  105567. private toNumberArray;
  105568. /**
  105569. * Serialize all vertices data into a JSON oject
  105570. * @returns a JSON representation of the current geometry data
  105571. */
  105572. serializeVerticeData(): any;
  105573. /**
  105574. * Extracts a clone of a mesh geometry
  105575. * @param mesh defines the source mesh
  105576. * @param id defines the unique ID of the new geometry object
  105577. * @returns the new geometry object
  105578. */
  105579. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105580. /**
  105581. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105582. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105583. * Be aware Math.random() could cause collisions, but:
  105584. * "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"
  105585. * @returns a string containing a new GUID
  105586. */
  105587. static RandomId(): string;
  105588. /** @hidden */
  105589. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105590. private static _CleanMatricesWeights;
  105591. /**
  105592. * Create a new geometry from persisted data (Using .babylon file format)
  105593. * @param parsedVertexData defines the persisted data
  105594. * @param scene defines the hosting scene
  105595. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105596. * @returns the new geometry object
  105597. */
  105598. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105599. }
  105600. }
  105601. declare module BABYLON {
  105602. /**
  105603. * Define an interface for all classes that will get and set the data on vertices
  105604. */
  105605. export interface IGetSetVerticesData {
  105606. /**
  105607. * Gets a boolean indicating if specific vertex data is present
  105608. * @param kind defines the vertex data kind to use
  105609. * @returns true is data kind is present
  105610. */
  105611. isVerticesDataPresent(kind: string): boolean;
  105612. /**
  105613. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105614. * @param kind defines the data kind (Position, normal, etc...)
  105615. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105616. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105617. * @returns a float array containing vertex data
  105618. */
  105619. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105620. /**
  105621. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105622. * @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.
  105623. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105624. * @returns the indices array or an empty array if the mesh has no geometry
  105625. */
  105626. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105627. /**
  105628. * Set specific vertex data
  105629. * @param kind defines the data kind (Position, normal, etc...)
  105630. * @param data defines the vertex data to use
  105631. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105632. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105633. */
  105634. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105635. /**
  105636. * Update a specific associated vertex buffer
  105637. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105638. * - VertexBuffer.PositionKind
  105639. * - VertexBuffer.UVKind
  105640. * - VertexBuffer.UV2Kind
  105641. * - VertexBuffer.UV3Kind
  105642. * - VertexBuffer.UV4Kind
  105643. * - VertexBuffer.UV5Kind
  105644. * - VertexBuffer.UV6Kind
  105645. * - VertexBuffer.ColorKind
  105646. * - VertexBuffer.MatricesIndicesKind
  105647. * - VertexBuffer.MatricesIndicesExtraKind
  105648. * - VertexBuffer.MatricesWeightsKind
  105649. * - VertexBuffer.MatricesWeightsExtraKind
  105650. * @param data defines the data source
  105651. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105652. * @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)
  105653. */
  105654. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105655. /**
  105656. * Creates a new index buffer
  105657. * @param indices defines the indices to store in the index buffer
  105658. * @param totalVertices defines the total number of vertices (could be null)
  105659. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105660. */
  105661. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105662. }
  105663. /**
  105664. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105665. */
  105666. export class VertexData {
  105667. /**
  105668. * Mesh side orientation : usually the external or front surface
  105669. */
  105670. static readonly FRONTSIDE: number;
  105671. /**
  105672. * Mesh side orientation : usually the internal or back surface
  105673. */
  105674. static readonly BACKSIDE: number;
  105675. /**
  105676. * Mesh side orientation : both internal and external or front and back surfaces
  105677. */
  105678. static readonly DOUBLESIDE: number;
  105679. /**
  105680. * Mesh side orientation : by default, `FRONTSIDE`
  105681. */
  105682. static readonly DEFAULTSIDE: number;
  105683. /**
  105684. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105685. */
  105686. positions: Nullable<FloatArray>;
  105687. /**
  105688. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105689. */
  105690. normals: Nullable<FloatArray>;
  105691. /**
  105692. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105693. */
  105694. tangents: Nullable<FloatArray>;
  105695. /**
  105696. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105697. */
  105698. uvs: Nullable<FloatArray>;
  105699. /**
  105700. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105701. */
  105702. uvs2: Nullable<FloatArray>;
  105703. /**
  105704. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105705. */
  105706. uvs3: Nullable<FloatArray>;
  105707. /**
  105708. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105709. */
  105710. uvs4: Nullable<FloatArray>;
  105711. /**
  105712. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105713. */
  105714. uvs5: Nullable<FloatArray>;
  105715. /**
  105716. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105717. */
  105718. uvs6: Nullable<FloatArray>;
  105719. /**
  105720. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105721. */
  105722. colors: Nullable<FloatArray>;
  105723. /**
  105724. * 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).
  105725. */
  105726. matricesIndices: Nullable<FloatArray>;
  105727. /**
  105728. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105729. */
  105730. matricesWeights: Nullable<FloatArray>;
  105731. /**
  105732. * An array extending the number of possible indices
  105733. */
  105734. matricesIndicesExtra: Nullable<FloatArray>;
  105735. /**
  105736. * An array extending the number of possible weights when the number of indices is extended
  105737. */
  105738. matricesWeightsExtra: Nullable<FloatArray>;
  105739. /**
  105740. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105741. */
  105742. indices: Nullable<IndicesArray>;
  105743. /**
  105744. * Uses the passed data array to set the set the values for the specified kind of data
  105745. * @param data a linear array of floating numbers
  105746. * @param kind the type of data that is being set, eg positions, colors etc
  105747. */
  105748. set(data: FloatArray, kind: string): void;
  105749. /**
  105750. * Associates the vertexData to the passed Mesh.
  105751. * Sets it as updatable or not (default `false`)
  105752. * @param mesh the mesh the vertexData is applied to
  105753. * @param updatable when used and having the value true allows new data to update the vertexData
  105754. * @returns the VertexData
  105755. */
  105756. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105757. /**
  105758. * Associates the vertexData to the passed Geometry.
  105759. * Sets it as updatable or not (default `false`)
  105760. * @param geometry the geometry the vertexData is applied to
  105761. * @param updatable when used and having the value true allows new data to update the vertexData
  105762. * @returns VertexData
  105763. */
  105764. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105765. /**
  105766. * Updates the associated mesh
  105767. * @param mesh the mesh to be updated
  105768. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105769. * @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
  105770. * @returns VertexData
  105771. */
  105772. updateMesh(mesh: Mesh): VertexData;
  105773. /**
  105774. * Updates the associated geometry
  105775. * @param geometry the geometry to be updated
  105776. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105777. * @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
  105778. * @returns VertexData.
  105779. */
  105780. updateGeometry(geometry: Geometry): VertexData;
  105781. private _applyTo;
  105782. private _update;
  105783. /**
  105784. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105785. * @param matrix the transforming matrix
  105786. * @returns the VertexData
  105787. */
  105788. transform(matrix: Matrix): VertexData;
  105789. /**
  105790. * Merges the passed VertexData into the current one
  105791. * @param other the VertexData to be merged into the current one
  105792. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105793. * @returns the modified VertexData
  105794. */
  105795. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105796. private _mergeElement;
  105797. private _validate;
  105798. /**
  105799. * Serializes the VertexData
  105800. * @returns a serialized object
  105801. */
  105802. serialize(): any;
  105803. /**
  105804. * Extracts the vertexData from a mesh
  105805. * @param mesh the mesh from which to extract the VertexData
  105806. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105807. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105808. * @returns the object VertexData associated to the passed mesh
  105809. */
  105810. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105811. /**
  105812. * Extracts the vertexData from the geometry
  105813. * @param geometry the geometry from which to extract the VertexData
  105814. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105815. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105816. * @returns the object VertexData associated to the passed mesh
  105817. */
  105818. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105819. private static _ExtractFrom;
  105820. /**
  105821. * Creates the VertexData for a Ribbon
  105822. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105823. * * pathArray array of paths, each of which an array of successive Vector3
  105824. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105825. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105826. * * 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
  105827. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105828. * * 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)
  105829. * * 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)
  105830. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105831. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105832. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105833. * @returns the VertexData of the ribbon
  105834. */
  105835. static CreateRibbon(options: {
  105836. pathArray: Vector3[][];
  105837. closeArray?: boolean;
  105838. closePath?: boolean;
  105839. offset?: number;
  105840. sideOrientation?: number;
  105841. frontUVs?: Vector4;
  105842. backUVs?: Vector4;
  105843. invertUV?: boolean;
  105844. uvs?: Vector2[];
  105845. colors?: Color4[];
  105846. }): VertexData;
  105847. /**
  105848. * Creates the VertexData for a box
  105849. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105850. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105851. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105852. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105853. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105854. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105855. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105856. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105857. * * 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)
  105858. * * 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)
  105859. * @returns the VertexData of the box
  105860. */
  105861. static CreateBox(options: {
  105862. size?: number;
  105863. width?: number;
  105864. height?: number;
  105865. depth?: number;
  105866. faceUV?: Vector4[];
  105867. faceColors?: Color4[];
  105868. sideOrientation?: number;
  105869. frontUVs?: Vector4;
  105870. backUVs?: Vector4;
  105871. }): VertexData;
  105872. /**
  105873. * Creates the VertexData for a tiled box
  105874. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105875. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105876. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105877. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105878. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105879. * @returns the VertexData of the box
  105880. */
  105881. static CreateTiledBox(options: {
  105882. pattern?: number;
  105883. width?: number;
  105884. height?: number;
  105885. depth?: number;
  105886. tileSize?: number;
  105887. tileWidth?: number;
  105888. tileHeight?: number;
  105889. alignHorizontal?: number;
  105890. alignVertical?: number;
  105891. faceUV?: Vector4[];
  105892. faceColors?: Color4[];
  105893. sideOrientation?: number;
  105894. }): VertexData;
  105895. /**
  105896. * Creates the VertexData for a tiled plane
  105897. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105898. * * pattern a limited pattern arrangement depending on the number
  105899. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105900. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105901. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105902. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105903. * * 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)
  105904. * * 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)
  105905. * @returns the VertexData of the tiled plane
  105906. */
  105907. static CreateTiledPlane(options: {
  105908. pattern?: number;
  105909. tileSize?: number;
  105910. tileWidth?: number;
  105911. tileHeight?: number;
  105912. size?: number;
  105913. width?: number;
  105914. height?: number;
  105915. alignHorizontal?: number;
  105916. alignVertical?: number;
  105917. sideOrientation?: number;
  105918. frontUVs?: Vector4;
  105919. backUVs?: Vector4;
  105920. }): VertexData;
  105921. /**
  105922. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105923. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105924. * * segments sets the number of horizontal strips optional, default 32
  105925. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105926. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105927. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105928. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105929. * * 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
  105930. * * 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
  105931. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105932. * * 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)
  105933. * * 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)
  105934. * @returns the VertexData of the ellipsoid
  105935. */
  105936. static CreateSphere(options: {
  105937. segments?: number;
  105938. diameter?: number;
  105939. diameterX?: number;
  105940. diameterY?: number;
  105941. diameterZ?: number;
  105942. arc?: number;
  105943. slice?: number;
  105944. sideOrientation?: number;
  105945. frontUVs?: Vector4;
  105946. backUVs?: Vector4;
  105947. }): VertexData;
  105948. /**
  105949. * Creates the VertexData for a cylinder, cone or prism
  105950. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105951. * * height sets the height (y direction) of the cylinder, optional, default 2
  105952. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105953. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105954. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105955. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105956. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105957. * * 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
  105958. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105959. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105960. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105961. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105962. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105963. * * 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)
  105964. * * 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)
  105965. * @returns the VertexData of the cylinder, cone or prism
  105966. */
  105967. static CreateCylinder(options: {
  105968. height?: number;
  105969. diameterTop?: number;
  105970. diameterBottom?: number;
  105971. diameter?: number;
  105972. tessellation?: number;
  105973. subdivisions?: number;
  105974. arc?: number;
  105975. faceColors?: Color4[];
  105976. faceUV?: Vector4[];
  105977. hasRings?: boolean;
  105978. enclose?: boolean;
  105979. sideOrientation?: number;
  105980. frontUVs?: Vector4;
  105981. backUVs?: Vector4;
  105982. }): VertexData;
  105983. /**
  105984. * Creates the VertexData for a torus
  105985. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105986. * * diameter the diameter of the torus, optional default 1
  105987. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105988. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105989. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105990. * * 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)
  105991. * * 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)
  105992. * @returns the VertexData of the torus
  105993. */
  105994. static CreateTorus(options: {
  105995. diameter?: number;
  105996. thickness?: number;
  105997. tessellation?: number;
  105998. sideOrientation?: number;
  105999. frontUVs?: Vector4;
  106000. backUVs?: Vector4;
  106001. }): VertexData;
  106002. /**
  106003. * Creates the VertexData of the LineSystem
  106004. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  106005. * - lines an array of lines, each line being an array of successive Vector3
  106006. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  106007. * @returns the VertexData of the LineSystem
  106008. */
  106009. static CreateLineSystem(options: {
  106010. lines: Vector3[][];
  106011. colors?: Nullable<Color4[][]>;
  106012. }): VertexData;
  106013. /**
  106014. * Create the VertexData for a DashedLines
  106015. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  106016. * - points an array successive Vector3
  106017. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  106018. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  106019. * - dashNb the intended total number of dashes, optional, default 200
  106020. * @returns the VertexData for the DashedLines
  106021. */
  106022. static CreateDashedLines(options: {
  106023. points: Vector3[];
  106024. dashSize?: number;
  106025. gapSize?: number;
  106026. dashNb?: number;
  106027. }): VertexData;
  106028. /**
  106029. * Creates the VertexData for a Ground
  106030. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106031. * - width the width (x direction) of the ground, optional, default 1
  106032. * - height the height (z direction) of the ground, optional, default 1
  106033. * - subdivisions the number of subdivisions per side, optional, default 1
  106034. * @returns the VertexData of the Ground
  106035. */
  106036. static CreateGround(options: {
  106037. width?: number;
  106038. height?: number;
  106039. subdivisions?: number;
  106040. subdivisionsX?: number;
  106041. subdivisionsY?: number;
  106042. }): VertexData;
  106043. /**
  106044. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  106045. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106046. * * xmin the ground minimum X coordinate, optional, default -1
  106047. * * zmin the ground minimum Z coordinate, optional, default -1
  106048. * * xmax the ground maximum X coordinate, optional, default 1
  106049. * * zmax the ground maximum Z coordinate, optional, default 1
  106050. * * 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}
  106051. * * 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}
  106052. * @returns the VertexData of the TiledGround
  106053. */
  106054. static CreateTiledGround(options: {
  106055. xmin: number;
  106056. zmin: number;
  106057. xmax: number;
  106058. zmax: number;
  106059. subdivisions?: {
  106060. w: number;
  106061. h: number;
  106062. };
  106063. precision?: {
  106064. w: number;
  106065. h: number;
  106066. };
  106067. }): VertexData;
  106068. /**
  106069. * Creates the VertexData of the Ground designed from a heightmap
  106070. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  106071. * * width the width (x direction) of the ground
  106072. * * height the height (z direction) of the ground
  106073. * * subdivisions the number of subdivisions per side
  106074. * * minHeight the minimum altitude on the ground, optional, default 0
  106075. * * maxHeight the maximum altitude on the ground, optional default 1
  106076. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  106077. * * buffer the array holding the image color data
  106078. * * bufferWidth the width of image
  106079. * * bufferHeight the height of image
  106080. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  106081. * @returns the VertexData of the Ground designed from a heightmap
  106082. */
  106083. static CreateGroundFromHeightMap(options: {
  106084. width: number;
  106085. height: number;
  106086. subdivisions: number;
  106087. minHeight: number;
  106088. maxHeight: number;
  106089. colorFilter: Color3;
  106090. buffer: Uint8Array;
  106091. bufferWidth: number;
  106092. bufferHeight: number;
  106093. alphaFilter: number;
  106094. }): VertexData;
  106095. /**
  106096. * Creates the VertexData for a Plane
  106097. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106098. * * size sets the width and height of the plane to the value of size, optional default 1
  106099. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106100. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106101. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106102. * * 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)
  106103. * * 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)
  106104. * @returns the VertexData of the box
  106105. */
  106106. static CreatePlane(options: {
  106107. size?: number;
  106108. width?: number;
  106109. height?: number;
  106110. sideOrientation?: number;
  106111. frontUVs?: Vector4;
  106112. backUVs?: Vector4;
  106113. }): VertexData;
  106114. /**
  106115. * Creates the VertexData of the Disc or regular Polygon
  106116. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106117. * * radius the radius of the disc, optional default 0.5
  106118. * * tessellation the number of polygon sides, optional, default 64
  106119. * * 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
  106120. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106121. * * 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)
  106122. * * 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)
  106123. * @returns the VertexData of the box
  106124. */
  106125. static CreateDisc(options: {
  106126. radius?: number;
  106127. tessellation?: number;
  106128. arc?: number;
  106129. sideOrientation?: number;
  106130. frontUVs?: Vector4;
  106131. backUVs?: Vector4;
  106132. }): VertexData;
  106133. /**
  106134. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106135. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106136. * @param polygon a mesh built from polygonTriangulation.build()
  106137. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106138. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106139. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106140. * @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)
  106141. * @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)
  106142. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106143. * @returns the VertexData of the Polygon
  106144. */
  106145. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106146. /**
  106147. * Creates the VertexData of the IcoSphere
  106148. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106149. * * radius the radius of the IcoSphere, optional default 1
  106150. * * radiusX allows stretching in the x direction, optional, default radius
  106151. * * radiusY allows stretching in the y direction, optional, default radius
  106152. * * radiusZ allows stretching in the z direction, optional, default radius
  106153. * * flat when true creates a flat shaded mesh, optional, default true
  106154. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106155. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106156. * * 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)
  106157. * * 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)
  106158. * @returns the VertexData of the IcoSphere
  106159. */
  106160. static CreateIcoSphere(options: {
  106161. radius?: number;
  106162. radiusX?: number;
  106163. radiusY?: number;
  106164. radiusZ?: number;
  106165. flat?: boolean;
  106166. subdivisions?: number;
  106167. sideOrientation?: number;
  106168. frontUVs?: Vector4;
  106169. backUVs?: Vector4;
  106170. }): VertexData;
  106171. /**
  106172. * Creates the VertexData for a Polyhedron
  106173. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106174. * * type provided types are:
  106175. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106176. * * 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)
  106177. * * size the size of the IcoSphere, optional default 1
  106178. * * sizeX allows stretching in the x direction, optional, default size
  106179. * * sizeY allows stretching in the y direction, optional, default size
  106180. * * sizeZ allows stretching in the z direction, optional, default size
  106181. * * 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
  106182. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106183. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106184. * * flat when true creates a flat shaded mesh, optional, default true
  106185. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106186. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106187. * * 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)
  106188. * * 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)
  106189. * @returns the VertexData of the Polyhedron
  106190. */
  106191. static CreatePolyhedron(options: {
  106192. type?: number;
  106193. size?: number;
  106194. sizeX?: number;
  106195. sizeY?: number;
  106196. sizeZ?: number;
  106197. custom?: any;
  106198. faceUV?: Vector4[];
  106199. faceColors?: Color4[];
  106200. flat?: boolean;
  106201. sideOrientation?: number;
  106202. frontUVs?: Vector4;
  106203. backUVs?: Vector4;
  106204. }): VertexData;
  106205. /**
  106206. * Creates the VertexData for a TorusKnot
  106207. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106208. * * radius the radius of the torus knot, optional, default 2
  106209. * * tube the thickness of the tube, optional, default 0.5
  106210. * * radialSegments the number of sides on each tube segments, optional, default 32
  106211. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106212. * * p the number of windings around the z axis, optional, default 2
  106213. * * q the number of windings around the x axis, optional, default 3
  106214. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106215. * * 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)
  106216. * * 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)
  106217. * @returns the VertexData of the Torus Knot
  106218. */
  106219. static CreateTorusKnot(options: {
  106220. radius?: number;
  106221. tube?: number;
  106222. radialSegments?: number;
  106223. tubularSegments?: number;
  106224. p?: number;
  106225. q?: number;
  106226. sideOrientation?: number;
  106227. frontUVs?: Vector4;
  106228. backUVs?: Vector4;
  106229. }): VertexData;
  106230. /**
  106231. * Compute normals for given positions and indices
  106232. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106233. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106234. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106235. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106236. * * facetNormals : optional array of facet normals (vector3)
  106237. * * facetPositions : optional array of facet positions (vector3)
  106238. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106239. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106240. * * bInfo : optional bounding info, required for facetPartitioning computation
  106241. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106242. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106243. * * useRightHandedSystem: optional boolean to for right handed system computation
  106244. * * depthSort : optional boolean to enable the facet depth sort computation
  106245. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106246. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106247. */
  106248. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106249. facetNormals?: any;
  106250. facetPositions?: any;
  106251. facetPartitioning?: any;
  106252. ratio?: number;
  106253. bInfo?: any;
  106254. bbSize?: Vector3;
  106255. subDiv?: any;
  106256. useRightHandedSystem?: boolean;
  106257. depthSort?: boolean;
  106258. distanceTo?: Vector3;
  106259. depthSortedFacets?: any;
  106260. }): void;
  106261. /** @hidden */
  106262. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106263. /**
  106264. * Applies VertexData created from the imported parameters to the geometry
  106265. * @param parsedVertexData the parsed data from an imported file
  106266. * @param geometry the geometry to apply the VertexData to
  106267. */
  106268. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106269. }
  106270. }
  106271. declare module BABYLON {
  106272. /**
  106273. * Defines a target to use with MorphTargetManager
  106274. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106275. */
  106276. export class MorphTarget implements IAnimatable {
  106277. /** defines the name of the target */
  106278. name: string;
  106279. /**
  106280. * Gets or sets the list of animations
  106281. */
  106282. animations: Animation[];
  106283. private _scene;
  106284. private _positions;
  106285. private _normals;
  106286. private _tangents;
  106287. private _uvs;
  106288. private _influence;
  106289. private _uniqueId;
  106290. /**
  106291. * Observable raised when the influence changes
  106292. */
  106293. onInfluenceChanged: Observable<boolean>;
  106294. /** @hidden */
  106295. _onDataLayoutChanged: Observable<void>;
  106296. /**
  106297. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106298. */
  106299. get influence(): number;
  106300. set influence(influence: number);
  106301. /**
  106302. * Gets or sets the id of the morph Target
  106303. */
  106304. id: string;
  106305. private _animationPropertiesOverride;
  106306. /**
  106307. * Gets or sets the animation properties override
  106308. */
  106309. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106310. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106311. /**
  106312. * Creates a new MorphTarget
  106313. * @param name defines the name of the target
  106314. * @param influence defines the influence to use
  106315. * @param scene defines the scene the morphtarget belongs to
  106316. */
  106317. constructor(
  106318. /** defines the name of the target */
  106319. name: string, influence?: number, scene?: Nullable<Scene>);
  106320. /**
  106321. * Gets the unique ID of this manager
  106322. */
  106323. get uniqueId(): number;
  106324. /**
  106325. * Gets a boolean defining if the target contains position data
  106326. */
  106327. get hasPositions(): boolean;
  106328. /**
  106329. * Gets a boolean defining if the target contains normal data
  106330. */
  106331. get hasNormals(): boolean;
  106332. /**
  106333. * Gets a boolean defining if the target contains tangent data
  106334. */
  106335. get hasTangents(): boolean;
  106336. /**
  106337. * Gets a boolean defining if the target contains texture coordinates data
  106338. */
  106339. get hasUVs(): boolean;
  106340. /**
  106341. * Affects position data to this target
  106342. * @param data defines the position data to use
  106343. */
  106344. setPositions(data: Nullable<FloatArray>): void;
  106345. /**
  106346. * Gets the position data stored in this target
  106347. * @returns a FloatArray containing the position data (or null if not present)
  106348. */
  106349. getPositions(): Nullable<FloatArray>;
  106350. /**
  106351. * Affects normal data to this target
  106352. * @param data defines the normal data to use
  106353. */
  106354. setNormals(data: Nullable<FloatArray>): void;
  106355. /**
  106356. * Gets the normal data stored in this target
  106357. * @returns a FloatArray containing the normal data (or null if not present)
  106358. */
  106359. getNormals(): Nullable<FloatArray>;
  106360. /**
  106361. * Affects tangent data to this target
  106362. * @param data defines the tangent data to use
  106363. */
  106364. setTangents(data: Nullable<FloatArray>): void;
  106365. /**
  106366. * Gets the tangent data stored in this target
  106367. * @returns a FloatArray containing the tangent data (or null if not present)
  106368. */
  106369. getTangents(): Nullable<FloatArray>;
  106370. /**
  106371. * Affects texture coordinates data to this target
  106372. * @param data defines the texture coordinates data to use
  106373. */
  106374. setUVs(data: Nullable<FloatArray>): void;
  106375. /**
  106376. * Gets the texture coordinates data stored in this target
  106377. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106378. */
  106379. getUVs(): Nullable<FloatArray>;
  106380. /**
  106381. * Clone the current target
  106382. * @returns a new MorphTarget
  106383. */
  106384. clone(): MorphTarget;
  106385. /**
  106386. * Serializes the current target into a Serialization object
  106387. * @returns the serialized object
  106388. */
  106389. serialize(): any;
  106390. /**
  106391. * Returns the string "MorphTarget"
  106392. * @returns "MorphTarget"
  106393. */
  106394. getClassName(): string;
  106395. /**
  106396. * Creates a new target from serialized data
  106397. * @param serializationObject defines the serialized data to use
  106398. * @returns a new MorphTarget
  106399. */
  106400. static Parse(serializationObject: any): MorphTarget;
  106401. /**
  106402. * Creates a MorphTarget from mesh data
  106403. * @param mesh defines the source mesh
  106404. * @param name defines the name to use for the new target
  106405. * @param influence defines the influence to attach to the target
  106406. * @returns a new MorphTarget
  106407. */
  106408. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106409. }
  106410. }
  106411. declare module BABYLON {
  106412. /**
  106413. * This class is used to deform meshes using morphing between different targets
  106414. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106415. */
  106416. export class MorphTargetManager {
  106417. private _targets;
  106418. private _targetInfluenceChangedObservers;
  106419. private _targetDataLayoutChangedObservers;
  106420. private _activeTargets;
  106421. private _scene;
  106422. private _influences;
  106423. private _supportsNormals;
  106424. private _supportsTangents;
  106425. private _supportsUVs;
  106426. private _vertexCount;
  106427. private _uniqueId;
  106428. private _tempInfluences;
  106429. /**
  106430. * Gets or sets a boolean indicating if normals must be morphed
  106431. */
  106432. enableNormalMorphing: boolean;
  106433. /**
  106434. * Gets or sets a boolean indicating if tangents must be morphed
  106435. */
  106436. enableTangentMorphing: boolean;
  106437. /**
  106438. * Gets or sets a boolean indicating if UV must be morphed
  106439. */
  106440. enableUVMorphing: boolean;
  106441. /**
  106442. * Creates a new MorphTargetManager
  106443. * @param scene defines the current scene
  106444. */
  106445. constructor(scene?: Nullable<Scene>);
  106446. /**
  106447. * Gets the unique ID of this manager
  106448. */
  106449. get uniqueId(): number;
  106450. /**
  106451. * Gets the number of vertices handled by this manager
  106452. */
  106453. get vertexCount(): number;
  106454. /**
  106455. * Gets a boolean indicating if this manager supports morphing of normals
  106456. */
  106457. get supportsNormals(): boolean;
  106458. /**
  106459. * Gets a boolean indicating if this manager supports morphing of tangents
  106460. */
  106461. get supportsTangents(): boolean;
  106462. /**
  106463. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106464. */
  106465. get supportsUVs(): boolean;
  106466. /**
  106467. * Gets the number of targets stored in this manager
  106468. */
  106469. get numTargets(): number;
  106470. /**
  106471. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106472. */
  106473. get numInfluencers(): number;
  106474. /**
  106475. * Gets the list of influences (one per target)
  106476. */
  106477. get influences(): Float32Array;
  106478. /**
  106479. * Gets the active target at specified index. An active target is a target with an influence > 0
  106480. * @param index defines the index to check
  106481. * @returns the requested target
  106482. */
  106483. getActiveTarget(index: number): MorphTarget;
  106484. /**
  106485. * Gets the target at specified index
  106486. * @param index defines the index to check
  106487. * @returns the requested target
  106488. */
  106489. getTarget(index: number): MorphTarget;
  106490. /**
  106491. * Add a new target to this manager
  106492. * @param target defines the target to add
  106493. */
  106494. addTarget(target: MorphTarget): void;
  106495. /**
  106496. * Removes a target from the manager
  106497. * @param target defines the target to remove
  106498. */
  106499. removeTarget(target: MorphTarget): void;
  106500. /**
  106501. * Clone the current manager
  106502. * @returns a new MorphTargetManager
  106503. */
  106504. clone(): MorphTargetManager;
  106505. /**
  106506. * Serializes the current manager into a Serialization object
  106507. * @returns the serialized object
  106508. */
  106509. serialize(): any;
  106510. private _syncActiveTargets;
  106511. /**
  106512. * Syncrhonize the targets with all the meshes using this morph target manager
  106513. */
  106514. synchronize(): void;
  106515. /**
  106516. * Creates a new MorphTargetManager from serialized data
  106517. * @param serializationObject defines the serialized data
  106518. * @param scene defines the hosting scene
  106519. * @returns the new MorphTargetManager
  106520. */
  106521. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106522. }
  106523. }
  106524. declare module BABYLON {
  106525. /**
  106526. * Class used to represent a specific level of detail of a mesh
  106527. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106528. */
  106529. export class MeshLODLevel {
  106530. /** Defines the distance where this level should start being displayed */
  106531. distance: number;
  106532. /** Defines the mesh to use to render this level */
  106533. mesh: Nullable<Mesh>;
  106534. /**
  106535. * Creates a new LOD level
  106536. * @param distance defines the distance where this level should star being displayed
  106537. * @param mesh defines the mesh to use to render this level
  106538. */
  106539. constructor(
  106540. /** Defines the distance where this level should start being displayed */
  106541. distance: number,
  106542. /** Defines the mesh to use to render this level */
  106543. mesh: Nullable<Mesh>);
  106544. }
  106545. }
  106546. declare module BABYLON {
  106547. /**
  106548. * Helper class used to generate a canvas to manipulate images
  106549. */
  106550. export class CanvasGenerator {
  106551. /**
  106552. * Create a new canvas (or offscreen canvas depending on the context)
  106553. * @param width defines the expected width
  106554. * @param height defines the expected height
  106555. * @return a new canvas or offscreen canvas
  106556. */
  106557. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106558. }
  106559. }
  106560. declare module BABYLON {
  106561. /**
  106562. * Mesh representing the gorund
  106563. */
  106564. export class GroundMesh extends Mesh {
  106565. /** If octree should be generated */
  106566. generateOctree: boolean;
  106567. private _heightQuads;
  106568. /** @hidden */
  106569. _subdivisionsX: number;
  106570. /** @hidden */
  106571. _subdivisionsY: number;
  106572. /** @hidden */
  106573. _width: number;
  106574. /** @hidden */
  106575. _height: number;
  106576. /** @hidden */
  106577. _minX: number;
  106578. /** @hidden */
  106579. _maxX: number;
  106580. /** @hidden */
  106581. _minZ: number;
  106582. /** @hidden */
  106583. _maxZ: number;
  106584. constructor(name: string, scene: Scene);
  106585. /**
  106586. * "GroundMesh"
  106587. * @returns "GroundMesh"
  106588. */
  106589. getClassName(): string;
  106590. /**
  106591. * The minimum of x and y subdivisions
  106592. */
  106593. get subdivisions(): number;
  106594. /**
  106595. * X subdivisions
  106596. */
  106597. get subdivisionsX(): number;
  106598. /**
  106599. * Y subdivisions
  106600. */
  106601. get subdivisionsY(): number;
  106602. /**
  106603. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106604. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106605. * @param chunksCount the number of subdivisions for x and y
  106606. * @param octreeBlocksSize (Default: 32)
  106607. */
  106608. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106609. /**
  106610. * Returns a height (y) value in the Worl system :
  106611. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106612. * @param x x coordinate
  106613. * @param z z coordinate
  106614. * @returns the ground y position if (x, z) are outside the ground surface.
  106615. */
  106616. getHeightAtCoordinates(x: number, z: number): number;
  106617. /**
  106618. * Returns a normalized vector (Vector3) orthogonal to the ground
  106619. * at the ground coordinates (x, z) expressed in the World system.
  106620. * @param x x coordinate
  106621. * @param z z coordinate
  106622. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106623. */
  106624. getNormalAtCoordinates(x: number, z: number): Vector3;
  106625. /**
  106626. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106627. * at the ground coordinates (x, z) expressed in the World system.
  106628. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106629. * @param x x coordinate
  106630. * @param z z coordinate
  106631. * @param ref vector to store the result
  106632. * @returns the GroundMesh.
  106633. */
  106634. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106635. /**
  106636. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106637. * if the ground has been updated.
  106638. * This can be used in the render loop.
  106639. * @returns the GroundMesh.
  106640. */
  106641. updateCoordinateHeights(): GroundMesh;
  106642. private _getFacetAt;
  106643. private _initHeightQuads;
  106644. private _computeHeightQuads;
  106645. /**
  106646. * Serializes this ground mesh
  106647. * @param serializationObject object to write serialization to
  106648. */
  106649. serialize(serializationObject: any): void;
  106650. /**
  106651. * Parses a serialized ground mesh
  106652. * @param parsedMesh the serialized mesh
  106653. * @param scene the scene to create the ground mesh in
  106654. * @returns the created ground mesh
  106655. */
  106656. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106657. }
  106658. }
  106659. declare module BABYLON {
  106660. /**
  106661. * Interface for Physics-Joint data
  106662. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106663. */
  106664. export interface PhysicsJointData {
  106665. /**
  106666. * The main pivot of the joint
  106667. */
  106668. mainPivot?: Vector3;
  106669. /**
  106670. * The connected pivot of the joint
  106671. */
  106672. connectedPivot?: Vector3;
  106673. /**
  106674. * The main axis of the joint
  106675. */
  106676. mainAxis?: Vector3;
  106677. /**
  106678. * The connected axis of the joint
  106679. */
  106680. connectedAxis?: Vector3;
  106681. /**
  106682. * The collision of the joint
  106683. */
  106684. collision?: boolean;
  106685. /**
  106686. * Native Oimo/Cannon/Energy data
  106687. */
  106688. nativeParams?: any;
  106689. }
  106690. /**
  106691. * This is a holder class for the physics joint created by the physics plugin
  106692. * It holds a set of functions to control the underlying joint
  106693. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106694. */
  106695. export class PhysicsJoint {
  106696. /**
  106697. * The type of the physics joint
  106698. */
  106699. type: number;
  106700. /**
  106701. * The data for the physics joint
  106702. */
  106703. jointData: PhysicsJointData;
  106704. private _physicsJoint;
  106705. protected _physicsPlugin: IPhysicsEnginePlugin;
  106706. /**
  106707. * Initializes the physics joint
  106708. * @param type The type of the physics joint
  106709. * @param jointData The data for the physics joint
  106710. */
  106711. constructor(
  106712. /**
  106713. * The type of the physics joint
  106714. */
  106715. type: number,
  106716. /**
  106717. * The data for the physics joint
  106718. */
  106719. jointData: PhysicsJointData);
  106720. /**
  106721. * Gets the physics joint
  106722. */
  106723. get physicsJoint(): any;
  106724. /**
  106725. * Sets the physics joint
  106726. */
  106727. set physicsJoint(newJoint: any);
  106728. /**
  106729. * Sets the physics plugin
  106730. */
  106731. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106732. /**
  106733. * Execute a function that is physics-plugin specific.
  106734. * @param {Function} func the function that will be executed.
  106735. * It accepts two parameters: the physics world and the physics joint
  106736. */
  106737. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106738. /**
  106739. * Distance-Joint type
  106740. */
  106741. static DistanceJoint: number;
  106742. /**
  106743. * Hinge-Joint type
  106744. */
  106745. static HingeJoint: number;
  106746. /**
  106747. * Ball-and-Socket joint type
  106748. */
  106749. static BallAndSocketJoint: number;
  106750. /**
  106751. * Wheel-Joint type
  106752. */
  106753. static WheelJoint: number;
  106754. /**
  106755. * Slider-Joint type
  106756. */
  106757. static SliderJoint: number;
  106758. /**
  106759. * Prismatic-Joint type
  106760. */
  106761. static PrismaticJoint: number;
  106762. /**
  106763. * Universal-Joint type
  106764. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106765. */
  106766. static UniversalJoint: number;
  106767. /**
  106768. * Hinge-Joint 2 type
  106769. */
  106770. static Hinge2Joint: number;
  106771. /**
  106772. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106773. */
  106774. static PointToPointJoint: number;
  106775. /**
  106776. * Spring-Joint type
  106777. */
  106778. static SpringJoint: number;
  106779. /**
  106780. * Lock-Joint type
  106781. */
  106782. static LockJoint: number;
  106783. }
  106784. /**
  106785. * A class representing a physics distance joint
  106786. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106787. */
  106788. export class DistanceJoint extends PhysicsJoint {
  106789. /**
  106790. *
  106791. * @param jointData The data for the Distance-Joint
  106792. */
  106793. constructor(jointData: DistanceJointData);
  106794. /**
  106795. * Update the predefined distance.
  106796. * @param maxDistance The maximum preferred distance
  106797. * @param minDistance The minimum preferred distance
  106798. */
  106799. updateDistance(maxDistance: number, minDistance?: number): void;
  106800. }
  106801. /**
  106802. * Represents a Motor-Enabled Joint
  106803. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106804. */
  106805. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106806. /**
  106807. * Initializes the Motor-Enabled Joint
  106808. * @param type The type of the joint
  106809. * @param jointData The physica joint data for the joint
  106810. */
  106811. constructor(type: number, jointData: PhysicsJointData);
  106812. /**
  106813. * Set the motor values.
  106814. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106815. * @param force the force to apply
  106816. * @param maxForce max force for this motor.
  106817. */
  106818. setMotor(force?: number, maxForce?: number): void;
  106819. /**
  106820. * Set the motor's limits.
  106821. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106822. * @param upperLimit The upper limit of the motor
  106823. * @param lowerLimit The lower limit of the motor
  106824. */
  106825. setLimit(upperLimit: number, lowerLimit?: number): void;
  106826. }
  106827. /**
  106828. * This class represents a single physics Hinge-Joint
  106829. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106830. */
  106831. export class HingeJoint extends MotorEnabledJoint {
  106832. /**
  106833. * Initializes the Hinge-Joint
  106834. * @param jointData The joint data for the Hinge-Joint
  106835. */
  106836. constructor(jointData: PhysicsJointData);
  106837. /**
  106838. * Set the motor values.
  106839. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106840. * @param {number} force the force to apply
  106841. * @param {number} maxForce max force for this motor.
  106842. */
  106843. setMotor(force?: number, maxForce?: number): void;
  106844. /**
  106845. * Set the motor's limits.
  106846. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106847. * @param upperLimit The upper limit of the motor
  106848. * @param lowerLimit The lower limit of the motor
  106849. */
  106850. setLimit(upperLimit: number, lowerLimit?: number): void;
  106851. }
  106852. /**
  106853. * This class represents a dual hinge physics joint (same as wheel joint)
  106854. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106855. */
  106856. export class Hinge2Joint extends MotorEnabledJoint {
  106857. /**
  106858. * Initializes the Hinge2-Joint
  106859. * @param jointData The joint data for the Hinge2-Joint
  106860. */
  106861. constructor(jointData: PhysicsJointData);
  106862. /**
  106863. * Set the motor values.
  106864. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106865. * @param {number} targetSpeed the speed the motor is to reach
  106866. * @param {number} maxForce max force for this motor.
  106867. * @param {motorIndex} the motor's index, 0 or 1.
  106868. */
  106869. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106870. /**
  106871. * Set the motor limits.
  106872. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106873. * @param {number} upperLimit the upper limit
  106874. * @param {number} lowerLimit lower limit
  106875. * @param {motorIndex} the motor's index, 0 or 1.
  106876. */
  106877. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106878. }
  106879. /**
  106880. * Interface for a motor enabled joint
  106881. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106882. */
  106883. export interface IMotorEnabledJoint {
  106884. /**
  106885. * Physics joint
  106886. */
  106887. physicsJoint: any;
  106888. /**
  106889. * Sets the motor of the motor-enabled joint
  106890. * @param force The force of the motor
  106891. * @param maxForce The maximum force of the motor
  106892. * @param motorIndex The index of the motor
  106893. */
  106894. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106895. /**
  106896. * Sets the limit of the motor
  106897. * @param upperLimit The upper limit of the motor
  106898. * @param lowerLimit The lower limit of the motor
  106899. * @param motorIndex The index of the motor
  106900. */
  106901. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106902. }
  106903. /**
  106904. * Joint data for a Distance-Joint
  106905. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106906. */
  106907. export interface DistanceJointData extends PhysicsJointData {
  106908. /**
  106909. * Max distance the 2 joint objects can be apart
  106910. */
  106911. maxDistance: number;
  106912. }
  106913. /**
  106914. * Joint data from a spring joint
  106915. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106916. */
  106917. export interface SpringJointData extends PhysicsJointData {
  106918. /**
  106919. * Length of the spring
  106920. */
  106921. length: number;
  106922. /**
  106923. * Stiffness of the spring
  106924. */
  106925. stiffness: number;
  106926. /**
  106927. * Damping of the spring
  106928. */
  106929. damping: number;
  106930. /** this callback will be called when applying the force to the impostors. */
  106931. forceApplicationCallback: () => void;
  106932. }
  106933. }
  106934. declare module BABYLON {
  106935. /**
  106936. * Holds the data for the raycast result
  106937. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106938. */
  106939. export class PhysicsRaycastResult {
  106940. private _hasHit;
  106941. private _hitDistance;
  106942. private _hitNormalWorld;
  106943. private _hitPointWorld;
  106944. private _rayFromWorld;
  106945. private _rayToWorld;
  106946. /**
  106947. * Gets if there was a hit
  106948. */
  106949. get hasHit(): boolean;
  106950. /**
  106951. * Gets the distance from the hit
  106952. */
  106953. get hitDistance(): number;
  106954. /**
  106955. * Gets the hit normal/direction in the world
  106956. */
  106957. get hitNormalWorld(): Vector3;
  106958. /**
  106959. * Gets the hit point in the world
  106960. */
  106961. get hitPointWorld(): Vector3;
  106962. /**
  106963. * Gets the ray "start point" of the ray in the world
  106964. */
  106965. get rayFromWorld(): Vector3;
  106966. /**
  106967. * Gets the ray "end point" of the ray in the world
  106968. */
  106969. get rayToWorld(): Vector3;
  106970. /**
  106971. * Sets the hit data (normal & point in world space)
  106972. * @param hitNormalWorld defines the normal in world space
  106973. * @param hitPointWorld defines the point in world space
  106974. */
  106975. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106976. /**
  106977. * Sets the distance from the start point to the hit point
  106978. * @param distance
  106979. */
  106980. setHitDistance(distance: number): void;
  106981. /**
  106982. * Calculates the distance manually
  106983. */
  106984. calculateHitDistance(): void;
  106985. /**
  106986. * Resets all the values to default
  106987. * @param from The from point on world space
  106988. * @param to The to point on world space
  106989. */
  106990. reset(from?: Vector3, to?: Vector3): void;
  106991. }
  106992. /**
  106993. * Interface for the size containing width and height
  106994. */
  106995. interface IXYZ {
  106996. /**
  106997. * X
  106998. */
  106999. x: number;
  107000. /**
  107001. * Y
  107002. */
  107003. y: number;
  107004. /**
  107005. * Z
  107006. */
  107007. z: number;
  107008. }
  107009. }
  107010. declare module BABYLON {
  107011. /**
  107012. * Interface used to describe a physics joint
  107013. */
  107014. export interface PhysicsImpostorJoint {
  107015. /** Defines the main impostor to which the joint is linked */
  107016. mainImpostor: PhysicsImpostor;
  107017. /** Defines the impostor that is connected to the main impostor using this joint */
  107018. connectedImpostor: PhysicsImpostor;
  107019. /** Defines the joint itself */
  107020. joint: PhysicsJoint;
  107021. }
  107022. /** @hidden */
  107023. export interface IPhysicsEnginePlugin {
  107024. world: any;
  107025. name: string;
  107026. setGravity(gravity: Vector3): void;
  107027. setTimeStep(timeStep: number): void;
  107028. getTimeStep(): number;
  107029. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  107030. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107031. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107032. generatePhysicsBody(impostor: PhysicsImpostor): void;
  107033. removePhysicsBody(impostor: PhysicsImpostor): void;
  107034. generateJoint(joint: PhysicsImpostorJoint): void;
  107035. removeJoint(joint: PhysicsImpostorJoint): void;
  107036. isSupported(): boolean;
  107037. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  107038. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  107039. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107040. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107041. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107042. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107043. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  107044. getBodyMass(impostor: PhysicsImpostor): number;
  107045. getBodyFriction(impostor: PhysicsImpostor): number;
  107046. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  107047. getBodyRestitution(impostor: PhysicsImpostor): number;
  107048. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  107049. getBodyPressure?(impostor: PhysicsImpostor): number;
  107050. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  107051. getBodyStiffness?(impostor: PhysicsImpostor): number;
  107052. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  107053. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  107054. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  107055. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  107056. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  107057. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107058. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107059. sleepBody(impostor: PhysicsImpostor): void;
  107060. wakeUpBody(impostor: PhysicsImpostor): void;
  107061. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107062. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  107063. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  107064. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107065. getRadius(impostor: PhysicsImpostor): number;
  107066. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  107067. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  107068. dispose(): void;
  107069. }
  107070. /**
  107071. * Interface used to define a physics engine
  107072. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107073. */
  107074. export interface IPhysicsEngine {
  107075. /**
  107076. * Gets the gravity vector used by the simulation
  107077. */
  107078. gravity: Vector3;
  107079. /**
  107080. * Sets the gravity vector used by the simulation
  107081. * @param gravity defines the gravity vector to use
  107082. */
  107083. setGravity(gravity: Vector3): void;
  107084. /**
  107085. * Set the time step of the physics engine.
  107086. * Default is 1/60.
  107087. * To slow it down, enter 1/600 for example.
  107088. * To speed it up, 1/30
  107089. * @param newTimeStep the new timestep to apply to this world.
  107090. */
  107091. setTimeStep(newTimeStep: number): void;
  107092. /**
  107093. * Get the time step of the physics engine.
  107094. * @returns the current time step
  107095. */
  107096. getTimeStep(): number;
  107097. /**
  107098. * Set the sub time step of the physics engine.
  107099. * Default is 0 meaning there is no sub steps
  107100. * To increase physics resolution precision, set a small value (like 1 ms)
  107101. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107102. */
  107103. setSubTimeStep(subTimeStep: number): void;
  107104. /**
  107105. * Get the sub time step of the physics engine.
  107106. * @returns the current sub time step
  107107. */
  107108. getSubTimeStep(): number;
  107109. /**
  107110. * Release all resources
  107111. */
  107112. dispose(): void;
  107113. /**
  107114. * Gets the name of the current physics plugin
  107115. * @returns the name of the plugin
  107116. */
  107117. getPhysicsPluginName(): string;
  107118. /**
  107119. * Adding a new impostor for the impostor tracking.
  107120. * This will be done by the impostor itself.
  107121. * @param impostor the impostor to add
  107122. */
  107123. addImpostor(impostor: PhysicsImpostor): void;
  107124. /**
  107125. * Remove an impostor from the engine.
  107126. * This impostor and its mesh will not longer be updated by the physics engine.
  107127. * @param impostor the impostor to remove
  107128. */
  107129. removeImpostor(impostor: PhysicsImpostor): void;
  107130. /**
  107131. * Add a joint to the physics engine
  107132. * @param mainImpostor defines the main impostor to which the joint is added.
  107133. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107134. * @param joint defines the joint that will connect both impostors.
  107135. */
  107136. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107137. /**
  107138. * Removes a joint from the simulation
  107139. * @param mainImpostor defines the impostor used with the joint
  107140. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107141. * @param joint defines the joint to remove
  107142. */
  107143. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107144. /**
  107145. * Gets the current plugin used to run the simulation
  107146. * @returns current plugin
  107147. */
  107148. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107149. /**
  107150. * Gets the list of physic impostors
  107151. * @returns an array of PhysicsImpostor
  107152. */
  107153. getImpostors(): Array<PhysicsImpostor>;
  107154. /**
  107155. * Gets the impostor for a physics enabled object
  107156. * @param object defines the object impersonated by the impostor
  107157. * @returns the PhysicsImpostor or null if not found
  107158. */
  107159. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107160. /**
  107161. * Gets the impostor for a physics body object
  107162. * @param body defines physics body used by the impostor
  107163. * @returns the PhysicsImpostor or null if not found
  107164. */
  107165. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107166. /**
  107167. * Does a raycast in the physics world
  107168. * @param from when should the ray start?
  107169. * @param to when should the ray end?
  107170. * @returns PhysicsRaycastResult
  107171. */
  107172. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107173. /**
  107174. * Called by the scene. No need to call it.
  107175. * @param delta defines the timespam between frames
  107176. */
  107177. _step(delta: number): void;
  107178. }
  107179. }
  107180. declare module BABYLON {
  107181. /**
  107182. * The interface for the physics imposter parameters
  107183. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107184. */
  107185. export interface PhysicsImpostorParameters {
  107186. /**
  107187. * The mass of the physics imposter
  107188. */
  107189. mass: number;
  107190. /**
  107191. * The friction of the physics imposter
  107192. */
  107193. friction?: number;
  107194. /**
  107195. * The coefficient of restitution of the physics imposter
  107196. */
  107197. restitution?: number;
  107198. /**
  107199. * The native options of the physics imposter
  107200. */
  107201. nativeOptions?: any;
  107202. /**
  107203. * Specifies if the parent should be ignored
  107204. */
  107205. ignoreParent?: boolean;
  107206. /**
  107207. * Specifies if bi-directional transformations should be disabled
  107208. */
  107209. disableBidirectionalTransformation?: boolean;
  107210. /**
  107211. * The pressure inside the physics imposter, soft object only
  107212. */
  107213. pressure?: number;
  107214. /**
  107215. * The stiffness the physics imposter, soft object only
  107216. */
  107217. stiffness?: number;
  107218. /**
  107219. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107220. */
  107221. velocityIterations?: number;
  107222. /**
  107223. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107224. */
  107225. positionIterations?: number;
  107226. /**
  107227. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107228. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107229. * Add to fix multiple points
  107230. */
  107231. fixedPoints?: number;
  107232. /**
  107233. * The collision margin around a soft object
  107234. */
  107235. margin?: number;
  107236. /**
  107237. * The collision margin around a soft object
  107238. */
  107239. damping?: number;
  107240. /**
  107241. * The path for a rope based on an extrusion
  107242. */
  107243. path?: any;
  107244. /**
  107245. * The shape of an extrusion used for a rope based on an extrusion
  107246. */
  107247. shape?: any;
  107248. }
  107249. /**
  107250. * Interface for a physics-enabled object
  107251. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107252. */
  107253. export interface IPhysicsEnabledObject {
  107254. /**
  107255. * The position of the physics-enabled object
  107256. */
  107257. position: Vector3;
  107258. /**
  107259. * The rotation of the physics-enabled object
  107260. */
  107261. rotationQuaternion: Nullable<Quaternion>;
  107262. /**
  107263. * The scale of the physics-enabled object
  107264. */
  107265. scaling: Vector3;
  107266. /**
  107267. * The rotation of the physics-enabled object
  107268. */
  107269. rotation?: Vector3;
  107270. /**
  107271. * The parent of the physics-enabled object
  107272. */
  107273. parent?: any;
  107274. /**
  107275. * The bounding info of the physics-enabled object
  107276. * @returns The bounding info of the physics-enabled object
  107277. */
  107278. getBoundingInfo(): BoundingInfo;
  107279. /**
  107280. * Computes the world matrix
  107281. * @param force Specifies if the world matrix should be computed by force
  107282. * @returns A world matrix
  107283. */
  107284. computeWorldMatrix(force: boolean): Matrix;
  107285. /**
  107286. * Gets the world matrix
  107287. * @returns A world matrix
  107288. */
  107289. getWorldMatrix?(): Matrix;
  107290. /**
  107291. * Gets the child meshes
  107292. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107293. * @returns An array of abstract meshes
  107294. */
  107295. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107296. /**
  107297. * Gets the vertex data
  107298. * @param kind The type of vertex data
  107299. * @returns A nullable array of numbers, or a float32 array
  107300. */
  107301. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107302. /**
  107303. * Gets the indices from the mesh
  107304. * @returns A nullable array of index arrays
  107305. */
  107306. getIndices?(): Nullable<IndicesArray>;
  107307. /**
  107308. * Gets the scene from the mesh
  107309. * @returns the indices array or null
  107310. */
  107311. getScene?(): Scene;
  107312. /**
  107313. * Gets the absolute position from the mesh
  107314. * @returns the absolute position
  107315. */
  107316. getAbsolutePosition(): Vector3;
  107317. /**
  107318. * Gets the absolute pivot point from the mesh
  107319. * @returns the absolute pivot point
  107320. */
  107321. getAbsolutePivotPoint(): Vector3;
  107322. /**
  107323. * Rotates the mesh
  107324. * @param axis The axis of rotation
  107325. * @param amount The amount of rotation
  107326. * @param space The space of the rotation
  107327. * @returns The rotation transform node
  107328. */
  107329. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107330. /**
  107331. * Translates the mesh
  107332. * @param axis The axis of translation
  107333. * @param distance The distance of translation
  107334. * @param space The space of the translation
  107335. * @returns The transform node
  107336. */
  107337. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107338. /**
  107339. * Sets the absolute position of the mesh
  107340. * @param absolutePosition The absolute position of the mesh
  107341. * @returns The transform node
  107342. */
  107343. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107344. /**
  107345. * Gets the class name of the mesh
  107346. * @returns The class name
  107347. */
  107348. getClassName(): string;
  107349. }
  107350. /**
  107351. * Represents a physics imposter
  107352. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107353. */
  107354. export class PhysicsImpostor {
  107355. /**
  107356. * The physics-enabled object used as the physics imposter
  107357. */
  107358. object: IPhysicsEnabledObject;
  107359. /**
  107360. * The type of the physics imposter
  107361. */
  107362. type: number;
  107363. private _options;
  107364. private _scene?;
  107365. /**
  107366. * The default object size of the imposter
  107367. */
  107368. static DEFAULT_OBJECT_SIZE: Vector3;
  107369. /**
  107370. * The identity quaternion of the imposter
  107371. */
  107372. static IDENTITY_QUATERNION: Quaternion;
  107373. /** @hidden */
  107374. _pluginData: any;
  107375. private _physicsEngine;
  107376. private _physicsBody;
  107377. private _bodyUpdateRequired;
  107378. private _onBeforePhysicsStepCallbacks;
  107379. private _onAfterPhysicsStepCallbacks;
  107380. /** @hidden */
  107381. _onPhysicsCollideCallbacks: Array<{
  107382. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107383. otherImpostors: Array<PhysicsImpostor>;
  107384. }>;
  107385. private _deltaPosition;
  107386. private _deltaRotation;
  107387. private _deltaRotationConjugated;
  107388. /** @hidden */
  107389. _isFromLine: boolean;
  107390. private _parent;
  107391. private _isDisposed;
  107392. private static _tmpVecs;
  107393. private static _tmpQuat;
  107394. /**
  107395. * Specifies if the physics imposter is disposed
  107396. */
  107397. get isDisposed(): boolean;
  107398. /**
  107399. * Gets the mass of the physics imposter
  107400. */
  107401. get mass(): number;
  107402. set mass(value: number);
  107403. /**
  107404. * Gets the coefficient of friction
  107405. */
  107406. get friction(): number;
  107407. /**
  107408. * Sets the coefficient of friction
  107409. */
  107410. set friction(value: number);
  107411. /**
  107412. * Gets the coefficient of restitution
  107413. */
  107414. get restitution(): number;
  107415. /**
  107416. * Sets the coefficient of restitution
  107417. */
  107418. set restitution(value: number);
  107419. /**
  107420. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107421. */
  107422. get pressure(): number;
  107423. /**
  107424. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107425. */
  107426. set pressure(value: number);
  107427. /**
  107428. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107429. */
  107430. get stiffness(): number;
  107431. /**
  107432. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107433. */
  107434. set stiffness(value: number);
  107435. /**
  107436. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107437. */
  107438. get velocityIterations(): number;
  107439. /**
  107440. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107441. */
  107442. set velocityIterations(value: number);
  107443. /**
  107444. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107445. */
  107446. get positionIterations(): number;
  107447. /**
  107448. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107449. */
  107450. set positionIterations(value: number);
  107451. /**
  107452. * The unique id of the physics imposter
  107453. * set by the physics engine when adding this impostor to the array
  107454. */
  107455. uniqueId: number;
  107456. /**
  107457. * @hidden
  107458. */
  107459. soft: boolean;
  107460. /**
  107461. * @hidden
  107462. */
  107463. segments: number;
  107464. private _joints;
  107465. /**
  107466. * Initializes the physics imposter
  107467. * @param object The physics-enabled object used as the physics imposter
  107468. * @param type The type of the physics imposter
  107469. * @param _options The options for the physics imposter
  107470. * @param _scene The Babylon scene
  107471. */
  107472. constructor(
  107473. /**
  107474. * The physics-enabled object used as the physics imposter
  107475. */
  107476. object: IPhysicsEnabledObject,
  107477. /**
  107478. * The type of the physics imposter
  107479. */
  107480. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107481. /**
  107482. * This function will completly initialize this impostor.
  107483. * It will create a new body - but only if this mesh has no parent.
  107484. * If it has, this impostor will not be used other than to define the impostor
  107485. * of the child mesh.
  107486. * @hidden
  107487. */
  107488. _init(): void;
  107489. private _getPhysicsParent;
  107490. /**
  107491. * Should a new body be generated.
  107492. * @returns boolean specifying if body initialization is required
  107493. */
  107494. isBodyInitRequired(): boolean;
  107495. /**
  107496. * Sets the updated scaling
  107497. * @param updated Specifies if the scaling is updated
  107498. */
  107499. setScalingUpdated(): void;
  107500. /**
  107501. * Force a regeneration of this or the parent's impostor's body.
  107502. * Use under cautious - This will remove all joints already implemented.
  107503. */
  107504. forceUpdate(): void;
  107505. /**
  107506. * Gets the body that holds this impostor. Either its own, or its parent.
  107507. */
  107508. get physicsBody(): any;
  107509. /**
  107510. * Get the parent of the physics imposter
  107511. * @returns Physics imposter or null
  107512. */
  107513. get parent(): Nullable<PhysicsImpostor>;
  107514. /**
  107515. * Sets the parent of the physics imposter
  107516. */
  107517. set parent(value: Nullable<PhysicsImpostor>);
  107518. /**
  107519. * Set the physics body. Used mainly by the physics engine/plugin
  107520. */
  107521. set physicsBody(physicsBody: any);
  107522. /**
  107523. * Resets the update flags
  107524. */
  107525. resetUpdateFlags(): void;
  107526. /**
  107527. * Gets the object extend size
  107528. * @returns the object extend size
  107529. */
  107530. getObjectExtendSize(): Vector3;
  107531. /**
  107532. * Gets the object center
  107533. * @returns The object center
  107534. */
  107535. getObjectCenter(): Vector3;
  107536. /**
  107537. * Get a specific parameter from the options parameters
  107538. * @param paramName The object parameter name
  107539. * @returns The object parameter
  107540. */
  107541. getParam(paramName: string): any;
  107542. /**
  107543. * Sets a specific parameter in the options given to the physics plugin
  107544. * @param paramName The parameter name
  107545. * @param value The value of the parameter
  107546. */
  107547. setParam(paramName: string, value: number): void;
  107548. /**
  107549. * Specifically change the body's mass option. Won't recreate the physics body object
  107550. * @param mass The mass of the physics imposter
  107551. */
  107552. setMass(mass: number): void;
  107553. /**
  107554. * Gets the linear velocity
  107555. * @returns linear velocity or null
  107556. */
  107557. getLinearVelocity(): Nullable<Vector3>;
  107558. /**
  107559. * Sets the linear velocity
  107560. * @param velocity linear velocity or null
  107561. */
  107562. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107563. /**
  107564. * Gets the angular velocity
  107565. * @returns angular velocity or null
  107566. */
  107567. getAngularVelocity(): Nullable<Vector3>;
  107568. /**
  107569. * Sets the angular velocity
  107570. * @param velocity The velocity or null
  107571. */
  107572. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107573. /**
  107574. * Execute a function with the physics plugin native code
  107575. * Provide a function the will have two variables - the world object and the physics body object
  107576. * @param func The function to execute with the physics plugin native code
  107577. */
  107578. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107579. /**
  107580. * Register a function that will be executed before the physics world is stepping forward
  107581. * @param func The function to execute before the physics world is stepped forward
  107582. */
  107583. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107584. /**
  107585. * Unregister a function that will be executed before the physics world is stepping forward
  107586. * @param func The function to execute before the physics world is stepped forward
  107587. */
  107588. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107589. /**
  107590. * Register a function that will be executed after the physics step
  107591. * @param func The function to execute after physics step
  107592. */
  107593. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107594. /**
  107595. * Unregisters a function that will be executed after the physics step
  107596. * @param func The function to execute after physics step
  107597. */
  107598. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107599. /**
  107600. * register a function that will be executed when this impostor collides against a different body
  107601. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107602. * @param func Callback that is executed on collision
  107603. */
  107604. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107605. /**
  107606. * Unregisters the physics imposter on contact
  107607. * @param collideAgainst The physics object to collide against
  107608. * @param func Callback to execute on collision
  107609. */
  107610. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107611. private _tmpQuat;
  107612. private _tmpQuat2;
  107613. /**
  107614. * Get the parent rotation
  107615. * @returns The parent rotation
  107616. */
  107617. getParentsRotation(): Quaternion;
  107618. /**
  107619. * this function is executed by the physics engine.
  107620. */
  107621. beforeStep: () => void;
  107622. /**
  107623. * this function is executed by the physics engine
  107624. */
  107625. afterStep: () => void;
  107626. /**
  107627. * Legacy collision detection event support
  107628. */
  107629. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107630. /**
  107631. * event and body object due to cannon's event-based architecture.
  107632. */
  107633. onCollide: (e: {
  107634. body: any;
  107635. }) => void;
  107636. /**
  107637. * Apply a force
  107638. * @param force The force to apply
  107639. * @param contactPoint The contact point for the force
  107640. * @returns The physics imposter
  107641. */
  107642. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107643. /**
  107644. * Apply an impulse
  107645. * @param force The impulse force
  107646. * @param contactPoint The contact point for the impulse force
  107647. * @returns The physics imposter
  107648. */
  107649. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107650. /**
  107651. * A help function to create a joint
  107652. * @param otherImpostor A physics imposter used to create a joint
  107653. * @param jointType The type of joint
  107654. * @param jointData The data for the joint
  107655. * @returns The physics imposter
  107656. */
  107657. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107658. /**
  107659. * Add a joint to this impostor with a different impostor
  107660. * @param otherImpostor A physics imposter used to add a joint
  107661. * @param joint The joint to add
  107662. * @returns The physics imposter
  107663. */
  107664. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107665. /**
  107666. * Add an anchor to a cloth impostor
  107667. * @param otherImpostor rigid impostor to anchor to
  107668. * @param width ratio across width from 0 to 1
  107669. * @param height ratio up height from 0 to 1
  107670. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107671. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107672. * @returns impostor the soft imposter
  107673. */
  107674. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107675. /**
  107676. * Add a hook to a rope impostor
  107677. * @param otherImpostor rigid impostor to anchor to
  107678. * @param length ratio across rope from 0 to 1
  107679. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107680. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107681. * @returns impostor the rope imposter
  107682. */
  107683. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107684. /**
  107685. * Will keep this body still, in a sleep mode.
  107686. * @returns the physics imposter
  107687. */
  107688. sleep(): PhysicsImpostor;
  107689. /**
  107690. * Wake the body up.
  107691. * @returns The physics imposter
  107692. */
  107693. wakeUp(): PhysicsImpostor;
  107694. /**
  107695. * Clones the physics imposter
  107696. * @param newObject The physics imposter clones to this physics-enabled object
  107697. * @returns A nullable physics imposter
  107698. */
  107699. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107700. /**
  107701. * Disposes the physics imposter
  107702. */
  107703. dispose(): void;
  107704. /**
  107705. * Sets the delta position
  107706. * @param position The delta position amount
  107707. */
  107708. setDeltaPosition(position: Vector3): void;
  107709. /**
  107710. * Sets the delta rotation
  107711. * @param rotation The delta rotation amount
  107712. */
  107713. setDeltaRotation(rotation: Quaternion): void;
  107714. /**
  107715. * Gets the box size of the physics imposter and stores the result in the input parameter
  107716. * @param result Stores the box size
  107717. * @returns The physics imposter
  107718. */
  107719. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107720. /**
  107721. * Gets the radius of the physics imposter
  107722. * @returns Radius of the physics imposter
  107723. */
  107724. getRadius(): number;
  107725. /**
  107726. * Sync a bone with this impostor
  107727. * @param bone The bone to sync to the impostor.
  107728. * @param boneMesh The mesh that the bone is influencing.
  107729. * @param jointPivot The pivot of the joint / bone in local space.
  107730. * @param distToJoint Optional distance from the impostor to the joint.
  107731. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107732. */
  107733. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107734. /**
  107735. * Sync impostor to a bone
  107736. * @param bone The bone that the impostor will be synced to.
  107737. * @param boneMesh The mesh that the bone is influencing.
  107738. * @param jointPivot The pivot of the joint / bone in local space.
  107739. * @param distToJoint Optional distance from the impostor to the joint.
  107740. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107741. * @param boneAxis Optional vector3 axis the bone is aligned with
  107742. */
  107743. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107744. /**
  107745. * No-Imposter type
  107746. */
  107747. static NoImpostor: number;
  107748. /**
  107749. * Sphere-Imposter type
  107750. */
  107751. static SphereImpostor: number;
  107752. /**
  107753. * Box-Imposter type
  107754. */
  107755. static BoxImpostor: number;
  107756. /**
  107757. * Plane-Imposter type
  107758. */
  107759. static PlaneImpostor: number;
  107760. /**
  107761. * Mesh-imposter type
  107762. */
  107763. static MeshImpostor: number;
  107764. /**
  107765. * Capsule-Impostor type (Ammo.js plugin only)
  107766. */
  107767. static CapsuleImpostor: number;
  107768. /**
  107769. * Cylinder-Imposter type
  107770. */
  107771. static CylinderImpostor: number;
  107772. /**
  107773. * Particle-Imposter type
  107774. */
  107775. static ParticleImpostor: number;
  107776. /**
  107777. * Heightmap-Imposter type
  107778. */
  107779. static HeightmapImpostor: number;
  107780. /**
  107781. * ConvexHull-Impostor type (Ammo.js plugin only)
  107782. */
  107783. static ConvexHullImpostor: number;
  107784. /**
  107785. * Custom-Imposter type (Ammo.js plugin only)
  107786. */
  107787. static CustomImpostor: number;
  107788. /**
  107789. * Rope-Imposter type
  107790. */
  107791. static RopeImpostor: number;
  107792. /**
  107793. * Cloth-Imposter type
  107794. */
  107795. static ClothImpostor: number;
  107796. /**
  107797. * Softbody-Imposter type
  107798. */
  107799. static SoftbodyImpostor: number;
  107800. }
  107801. }
  107802. declare module BABYLON {
  107803. /**
  107804. * @hidden
  107805. **/
  107806. export class _CreationDataStorage {
  107807. closePath?: boolean;
  107808. closeArray?: boolean;
  107809. idx: number[];
  107810. dashSize: number;
  107811. gapSize: number;
  107812. path3D: Path3D;
  107813. pathArray: Vector3[][];
  107814. arc: number;
  107815. radius: number;
  107816. cap: number;
  107817. tessellation: number;
  107818. }
  107819. /**
  107820. * @hidden
  107821. **/
  107822. class _InstanceDataStorage {
  107823. visibleInstances: any;
  107824. batchCache: _InstancesBatch;
  107825. instancesBufferSize: number;
  107826. instancesBuffer: Nullable<Buffer>;
  107827. instancesData: Float32Array;
  107828. overridenInstanceCount: number;
  107829. isFrozen: boolean;
  107830. previousBatch: Nullable<_InstancesBatch>;
  107831. hardwareInstancedRendering: boolean;
  107832. sideOrientation: number;
  107833. manualUpdate: boolean;
  107834. }
  107835. /**
  107836. * @hidden
  107837. **/
  107838. export class _InstancesBatch {
  107839. mustReturn: boolean;
  107840. visibleInstances: Nullable<InstancedMesh[]>[];
  107841. renderSelf: boolean[];
  107842. hardwareInstancedRendering: boolean[];
  107843. }
  107844. /**
  107845. * @hidden
  107846. **/
  107847. class _ThinInstanceDataStorage {
  107848. instancesCount: number;
  107849. matrixBuffer: Nullable<Buffer>;
  107850. matrixBufferSize: number;
  107851. matrixData: Nullable<Float32Array>;
  107852. boundingVectors: Array<Vector3>;
  107853. worldMatrices: Nullable<Matrix[]>;
  107854. }
  107855. /**
  107856. * Class used to represent renderable models
  107857. */
  107858. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107859. /**
  107860. * Mesh side orientation : usually the external or front surface
  107861. */
  107862. static readonly FRONTSIDE: number;
  107863. /**
  107864. * Mesh side orientation : usually the internal or back surface
  107865. */
  107866. static readonly BACKSIDE: number;
  107867. /**
  107868. * Mesh side orientation : both internal and external or front and back surfaces
  107869. */
  107870. static readonly DOUBLESIDE: number;
  107871. /**
  107872. * Mesh side orientation : by default, `FRONTSIDE`
  107873. */
  107874. static readonly DEFAULTSIDE: number;
  107875. /**
  107876. * Mesh cap setting : no cap
  107877. */
  107878. static readonly NO_CAP: number;
  107879. /**
  107880. * Mesh cap setting : one cap at the beginning of the mesh
  107881. */
  107882. static readonly CAP_START: number;
  107883. /**
  107884. * Mesh cap setting : one cap at the end of the mesh
  107885. */
  107886. static readonly CAP_END: number;
  107887. /**
  107888. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107889. */
  107890. static readonly CAP_ALL: number;
  107891. /**
  107892. * Mesh pattern setting : no flip or rotate
  107893. */
  107894. static readonly NO_FLIP: number;
  107895. /**
  107896. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107897. */
  107898. static readonly FLIP_TILE: number;
  107899. /**
  107900. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107901. */
  107902. static readonly ROTATE_TILE: number;
  107903. /**
  107904. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107905. */
  107906. static readonly FLIP_ROW: number;
  107907. /**
  107908. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107909. */
  107910. static readonly ROTATE_ROW: number;
  107911. /**
  107912. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107913. */
  107914. static readonly FLIP_N_ROTATE_TILE: number;
  107915. /**
  107916. * Mesh pattern setting : rotate pattern and rotate
  107917. */
  107918. static readonly FLIP_N_ROTATE_ROW: number;
  107919. /**
  107920. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107921. */
  107922. static readonly CENTER: number;
  107923. /**
  107924. * Mesh tile positioning : part tiles on left
  107925. */
  107926. static readonly LEFT: number;
  107927. /**
  107928. * Mesh tile positioning : part tiles on right
  107929. */
  107930. static readonly RIGHT: number;
  107931. /**
  107932. * Mesh tile positioning : part tiles on top
  107933. */
  107934. static readonly TOP: number;
  107935. /**
  107936. * Mesh tile positioning : part tiles on bottom
  107937. */
  107938. static readonly BOTTOM: number;
  107939. /**
  107940. * Gets the default side orientation.
  107941. * @param orientation the orientation to value to attempt to get
  107942. * @returns the default orientation
  107943. * @hidden
  107944. */
  107945. static _GetDefaultSideOrientation(orientation?: number): number;
  107946. private _internalMeshDataInfo;
  107947. get computeBonesUsingShaders(): boolean;
  107948. set computeBonesUsingShaders(value: boolean);
  107949. /**
  107950. * An event triggered before rendering the mesh
  107951. */
  107952. get onBeforeRenderObservable(): Observable<Mesh>;
  107953. /**
  107954. * An event triggered before binding the mesh
  107955. */
  107956. get onBeforeBindObservable(): Observable<Mesh>;
  107957. /**
  107958. * An event triggered after rendering the mesh
  107959. */
  107960. get onAfterRenderObservable(): Observable<Mesh>;
  107961. /**
  107962. * An event triggered before drawing the mesh
  107963. */
  107964. get onBeforeDrawObservable(): Observable<Mesh>;
  107965. private _onBeforeDrawObserver;
  107966. /**
  107967. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107968. */
  107969. set onBeforeDraw(callback: () => void);
  107970. get hasInstances(): boolean;
  107971. get hasThinInstances(): boolean;
  107972. /**
  107973. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107974. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107975. */
  107976. delayLoadState: number;
  107977. /**
  107978. * Gets the list of instances created from this mesh
  107979. * it is not supposed to be modified manually.
  107980. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107981. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107982. */
  107983. instances: InstancedMesh[];
  107984. /**
  107985. * Gets the file containing delay loading data for this mesh
  107986. */
  107987. delayLoadingFile: string;
  107988. /** @hidden */
  107989. _binaryInfo: any;
  107990. /**
  107991. * User defined function used to change how LOD level selection is done
  107992. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107993. */
  107994. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107995. /**
  107996. * Gets or sets the morph target manager
  107997. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107998. */
  107999. get morphTargetManager(): Nullable<MorphTargetManager>;
  108000. set morphTargetManager(value: Nullable<MorphTargetManager>);
  108001. /** @hidden */
  108002. _creationDataStorage: Nullable<_CreationDataStorage>;
  108003. /** @hidden */
  108004. _geometry: Nullable<Geometry>;
  108005. /** @hidden */
  108006. _delayInfo: Array<string>;
  108007. /** @hidden */
  108008. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  108009. /** @hidden */
  108010. _instanceDataStorage: _InstanceDataStorage;
  108011. /** @hidden */
  108012. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  108013. private _effectiveMaterial;
  108014. /** @hidden */
  108015. _shouldGenerateFlatShading: boolean;
  108016. /** @hidden */
  108017. _originalBuilderSideOrientation: number;
  108018. /**
  108019. * Use this property to change the original side orientation defined at construction time
  108020. */
  108021. overrideMaterialSideOrientation: Nullable<number>;
  108022. /**
  108023. * Gets the source mesh (the one used to clone this one from)
  108024. */
  108025. get source(): Nullable<Mesh>;
  108026. /**
  108027. * Gets the list of clones of this mesh
  108028. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  108029. * Note that useClonedMeshMap=true is the default setting
  108030. */
  108031. get cloneMeshMap(): Nullable<{
  108032. [id: string]: Mesh | undefined;
  108033. }>;
  108034. /**
  108035. * Gets or sets a boolean indicating that this mesh does not use index buffer
  108036. */
  108037. get isUnIndexed(): boolean;
  108038. set isUnIndexed(value: boolean);
  108039. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  108040. get worldMatrixInstancedBuffer(): Float32Array;
  108041. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  108042. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  108043. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  108044. /**
  108045. * @constructor
  108046. * @param name The value used by scene.getMeshByName() to do a lookup.
  108047. * @param scene The scene to add this mesh to.
  108048. * @param parent The parent of this mesh, if it has one
  108049. * @param source An optional Mesh from which geometry is shared, cloned.
  108050. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  108051. * When false, achieved by calling a clone(), also passing False.
  108052. * This will make creation of children, recursive.
  108053. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  108054. */
  108055. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  108056. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  108057. doNotInstantiate: boolean;
  108058. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  108059. /**
  108060. * Gets the class name
  108061. * @returns the string "Mesh".
  108062. */
  108063. getClassName(): string;
  108064. /** @hidden */
  108065. get _isMesh(): boolean;
  108066. /**
  108067. * Returns a description of this mesh
  108068. * @param fullDetails define if full details about this mesh must be used
  108069. * @returns a descriptive string representing this mesh
  108070. */
  108071. toString(fullDetails?: boolean): string;
  108072. /** @hidden */
  108073. _unBindEffect(): void;
  108074. /**
  108075. * Gets a boolean indicating if this mesh has LOD
  108076. */
  108077. get hasLODLevels(): boolean;
  108078. /**
  108079. * Gets the list of MeshLODLevel associated with the current mesh
  108080. * @returns an array of MeshLODLevel
  108081. */
  108082. getLODLevels(): MeshLODLevel[];
  108083. private _sortLODLevels;
  108084. /**
  108085. * Add a mesh as LOD level triggered at the given distance.
  108086. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108087. * @param distance The distance from the center of the object to show this level
  108088. * @param mesh The mesh to be added as LOD level (can be null)
  108089. * @return This mesh (for chaining)
  108090. */
  108091. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108092. /**
  108093. * Returns the LOD level mesh at the passed distance or null if not found.
  108094. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108095. * @param distance The distance from the center of the object to show this level
  108096. * @returns a Mesh or `null`
  108097. */
  108098. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108099. /**
  108100. * Remove a mesh from the LOD array
  108101. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108102. * @param mesh defines the mesh to be removed
  108103. * @return This mesh (for chaining)
  108104. */
  108105. removeLODLevel(mesh: Mesh): Mesh;
  108106. /**
  108107. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108108. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108109. * @param camera defines the camera to use to compute distance
  108110. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108111. * @return This mesh (for chaining)
  108112. */
  108113. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108114. /**
  108115. * Gets the mesh internal Geometry object
  108116. */
  108117. get geometry(): Nullable<Geometry>;
  108118. /**
  108119. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108120. * @returns the total number of vertices
  108121. */
  108122. getTotalVertices(): number;
  108123. /**
  108124. * Returns the content of an associated vertex buffer
  108125. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108126. * - VertexBuffer.PositionKind
  108127. * - VertexBuffer.UVKind
  108128. * - VertexBuffer.UV2Kind
  108129. * - VertexBuffer.UV3Kind
  108130. * - VertexBuffer.UV4Kind
  108131. * - VertexBuffer.UV5Kind
  108132. * - VertexBuffer.UV6Kind
  108133. * - VertexBuffer.ColorKind
  108134. * - VertexBuffer.MatricesIndicesKind
  108135. * - VertexBuffer.MatricesIndicesExtraKind
  108136. * - VertexBuffer.MatricesWeightsKind
  108137. * - VertexBuffer.MatricesWeightsExtraKind
  108138. * @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
  108139. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108140. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108141. */
  108142. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108143. /**
  108144. * Returns the mesh VertexBuffer object from the requested `kind`
  108145. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108146. * - VertexBuffer.PositionKind
  108147. * - VertexBuffer.NormalKind
  108148. * - VertexBuffer.UVKind
  108149. * - VertexBuffer.UV2Kind
  108150. * - VertexBuffer.UV3Kind
  108151. * - VertexBuffer.UV4Kind
  108152. * - VertexBuffer.UV5Kind
  108153. * - VertexBuffer.UV6Kind
  108154. * - VertexBuffer.ColorKind
  108155. * - VertexBuffer.MatricesIndicesKind
  108156. * - VertexBuffer.MatricesIndicesExtraKind
  108157. * - VertexBuffer.MatricesWeightsKind
  108158. * - VertexBuffer.MatricesWeightsExtraKind
  108159. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108160. */
  108161. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108162. /**
  108163. * Tests if a specific vertex buffer is associated with this mesh
  108164. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108165. * - VertexBuffer.PositionKind
  108166. * - VertexBuffer.NormalKind
  108167. * - VertexBuffer.UVKind
  108168. * - VertexBuffer.UV2Kind
  108169. * - VertexBuffer.UV3Kind
  108170. * - VertexBuffer.UV4Kind
  108171. * - VertexBuffer.UV5Kind
  108172. * - VertexBuffer.UV6Kind
  108173. * - VertexBuffer.ColorKind
  108174. * - VertexBuffer.MatricesIndicesKind
  108175. * - VertexBuffer.MatricesIndicesExtraKind
  108176. * - VertexBuffer.MatricesWeightsKind
  108177. * - VertexBuffer.MatricesWeightsExtraKind
  108178. * @returns a boolean
  108179. */
  108180. isVerticesDataPresent(kind: string): boolean;
  108181. /**
  108182. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108183. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108184. * - VertexBuffer.PositionKind
  108185. * - VertexBuffer.UVKind
  108186. * - VertexBuffer.UV2Kind
  108187. * - VertexBuffer.UV3Kind
  108188. * - VertexBuffer.UV4Kind
  108189. * - VertexBuffer.UV5Kind
  108190. * - VertexBuffer.UV6Kind
  108191. * - VertexBuffer.ColorKind
  108192. * - VertexBuffer.MatricesIndicesKind
  108193. * - VertexBuffer.MatricesIndicesExtraKind
  108194. * - VertexBuffer.MatricesWeightsKind
  108195. * - VertexBuffer.MatricesWeightsExtraKind
  108196. * @returns a boolean
  108197. */
  108198. isVertexBufferUpdatable(kind: string): boolean;
  108199. /**
  108200. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108201. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108202. * - VertexBuffer.PositionKind
  108203. * - VertexBuffer.NormalKind
  108204. * - VertexBuffer.UVKind
  108205. * - VertexBuffer.UV2Kind
  108206. * - VertexBuffer.UV3Kind
  108207. * - VertexBuffer.UV4Kind
  108208. * - VertexBuffer.UV5Kind
  108209. * - VertexBuffer.UV6Kind
  108210. * - VertexBuffer.ColorKind
  108211. * - VertexBuffer.MatricesIndicesKind
  108212. * - VertexBuffer.MatricesIndicesExtraKind
  108213. * - VertexBuffer.MatricesWeightsKind
  108214. * - VertexBuffer.MatricesWeightsExtraKind
  108215. * @returns an array of strings
  108216. */
  108217. getVerticesDataKinds(): string[];
  108218. /**
  108219. * Returns a positive integer : the total number of indices in this mesh geometry.
  108220. * @returns the numner of indices or zero if the mesh has no geometry.
  108221. */
  108222. getTotalIndices(): number;
  108223. /**
  108224. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108225. * @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.
  108226. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108227. * @returns the indices array or an empty array if the mesh has no geometry
  108228. */
  108229. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108230. get isBlocked(): boolean;
  108231. /**
  108232. * Determine if the current mesh is ready to be rendered
  108233. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108234. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108235. * @returns true if all associated assets are ready (material, textures, shaders)
  108236. */
  108237. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108238. /**
  108239. * 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.
  108240. */
  108241. get areNormalsFrozen(): boolean;
  108242. /**
  108243. * 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.
  108244. * @returns the current mesh
  108245. */
  108246. freezeNormals(): Mesh;
  108247. /**
  108248. * 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
  108249. * @returns the current mesh
  108250. */
  108251. unfreezeNormals(): Mesh;
  108252. /**
  108253. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108254. */
  108255. set overridenInstanceCount(count: number);
  108256. /** @hidden */
  108257. _preActivate(): Mesh;
  108258. /** @hidden */
  108259. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108260. /** @hidden */
  108261. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108262. protected _afterComputeWorldMatrix(): void;
  108263. /** @hidden */
  108264. _postActivate(): void;
  108265. /**
  108266. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108267. * This means the mesh underlying bounding box and sphere are recomputed.
  108268. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108269. * @returns the current mesh
  108270. */
  108271. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108272. /** @hidden */
  108273. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108274. /**
  108275. * This function will subdivide the mesh into multiple submeshes
  108276. * @param count defines the expected number of submeshes
  108277. */
  108278. subdivide(count: number): void;
  108279. /**
  108280. * Copy a FloatArray into a specific associated vertex buffer
  108281. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108282. * - VertexBuffer.PositionKind
  108283. * - VertexBuffer.UVKind
  108284. * - VertexBuffer.UV2Kind
  108285. * - VertexBuffer.UV3Kind
  108286. * - VertexBuffer.UV4Kind
  108287. * - VertexBuffer.UV5Kind
  108288. * - VertexBuffer.UV6Kind
  108289. * - VertexBuffer.ColorKind
  108290. * - VertexBuffer.MatricesIndicesKind
  108291. * - VertexBuffer.MatricesIndicesExtraKind
  108292. * - VertexBuffer.MatricesWeightsKind
  108293. * - VertexBuffer.MatricesWeightsExtraKind
  108294. * @param data defines the data source
  108295. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108296. * @param stride defines the data stride size (can be null)
  108297. * @returns the current mesh
  108298. */
  108299. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108300. /**
  108301. * Delete a vertex buffer associated with this mesh
  108302. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108303. * - VertexBuffer.PositionKind
  108304. * - VertexBuffer.UVKind
  108305. * - VertexBuffer.UV2Kind
  108306. * - VertexBuffer.UV3Kind
  108307. * - VertexBuffer.UV4Kind
  108308. * - VertexBuffer.UV5Kind
  108309. * - VertexBuffer.UV6Kind
  108310. * - VertexBuffer.ColorKind
  108311. * - VertexBuffer.MatricesIndicesKind
  108312. * - VertexBuffer.MatricesIndicesExtraKind
  108313. * - VertexBuffer.MatricesWeightsKind
  108314. * - VertexBuffer.MatricesWeightsExtraKind
  108315. */
  108316. removeVerticesData(kind: string): void;
  108317. /**
  108318. * Flags an associated vertex buffer as updatable
  108319. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108320. * - VertexBuffer.PositionKind
  108321. * - VertexBuffer.UVKind
  108322. * - VertexBuffer.UV2Kind
  108323. * - VertexBuffer.UV3Kind
  108324. * - VertexBuffer.UV4Kind
  108325. * - VertexBuffer.UV5Kind
  108326. * - VertexBuffer.UV6Kind
  108327. * - VertexBuffer.ColorKind
  108328. * - VertexBuffer.MatricesIndicesKind
  108329. * - VertexBuffer.MatricesIndicesExtraKind
  108330. * - VertexBuffer.MatricesWeightsKind
  108331. * - VertexBuffer.MatricesWeightsExtraKind
  108332. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108333. */
  108334. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108335. /**
  108336. * Sets the mesh global Vertex Buffer
  108337. * @param buffer defines the buffer to use
  108338. * @returns the current mesh
  108339. */
  108340. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108341. /**
  108342. * Update a specific associated vertex buffer
  108343. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108344. * - VertexBuffer.PositionKind
  108345. * - VertexBuffer.UVKind
  108346. * - VertexBuffer.UV2Kind
  108347. * - VertexBuffer.UV3Kind
  108348. * - VertexBuffer.UV4Kind
  108349. * - VertexBuffer.UV5Kind
  108350. * - VertexBuffer.UV6Kind
  108351. * - VertexBuffer.ColorKind
  108352. * - VertexBuffer.MatricesIndicesKind
  108353. * - VertexBuffer.MatricesIndicesExtraKind
  108354. * - VertexBuffer.MatricesWeightsKind
  108355. * - VertexBuffer.MatricesWeightsExtraKind
  108356. * @param data defines the data source
  108357. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108358. * @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)
  108359. * @returns the current mesh
  108360. */
  108361. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108362. /**
  108363. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108364. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108365. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108366. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108367. * @returns the current mesh
  108368. */
  108369. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108370. /**
  108371. * Creates a un-shared specific occurence of the geometry for the mesh.
  108372. * @returns the current mesh
  108373. */
  108374. makeGeometryUnique(): Mesh;
  108375. /**
  108376. * Set the index buffer of this mesh
  108377. * @param indices defines the source data
  108378. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108379. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108380. * @returns the current mesh
  108381. */
  108382. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108383. /**
  108384. * Update the current index buffer
  108385. * @param indices defines the source data
  108386. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108387. * @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)
  108388. * @returns the current mesh
  108389. */
  108390. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108391. /**
  108392. * Invert the geometry to move from a right handed system to a left handed one.
  108393. * @returns the current mesh
  108394. */
  108395. toLeftHanded(): Mesh;
  108396. /** @hidden */
  108397. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108398. /** @hidden */
  108399. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108400. /**
  108401. * Registers for this mesh a javascript function called just before the rendering process
  108402. * @param func defines the function to call before rendering this mesh
  108403. * @returns the current mesh
  108404. */
  108405. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108406. /**
  108407. * Disposes a previously registered javascript function called before the rendering
  108408. * @param func defines the function to remove
  108409. * @returns the current mesh
  108410. */
  108411. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108412. /**
  108413. * Registers for this mesh a javascript function called just after the rendering is complete
  108414. * @param func defines the function to call after rendering this mesh
  108415. * @returns the current mesh
  108416. */
  108417. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108418. /**
  108419. * Disposes a previously registered javascript function called after the rendering.
  108420. * @param func defines the function to remove
  108421. * @returns the current mesh
  108422. */
  108423. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108424. /** @hidden */
  108425. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108426. /** @hidden */
  108427. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108428. /** @hidden */
  108429. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108430. /** @hidden */
  108431. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108432. /** @hidden */
  108433. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108434. /** @hidden */
  108435. _rebuild(): void;
  108436. /** @hidden */
  108437. _freeze(): void;
  108438. /** @hidden */
  108439. _unFreeze(): void;
  108440. /**
  108441. * 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
  108442. * @param subMesh defines the subMesh to render
  108443. * @param enableAlphaMode defines if alpha mode can be changed
  108444. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108445. * @returns the current mesh
  108446. */
  108447. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108448. private _onBeforeDraw;
  108449. /**
  108450. * Renormalize the mesh and patch it up if there are no weights
  108451. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108452. * However in the case of zero weights then we set just a single influence to 1.
  108453. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108454. */
  108455. cleanMatrixWeights(): void;
  108456. private normalizeSkinFourWeights;
  108457. private normalizeSkinWeightsAndExtra;
  108458. /**
  108459. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108460. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108461. * the user know there was an issue with importing the mesh
  108462. * @returns a validation object with skinned, valid and report string
  108463. */
  108464. validateSkinning(): {
  108465. skinned: boolean;
  108466. valid: boolean;
  108467. report: string;
  108468. };
  108469. /** @hidden */
  108470. _checkDelayState(): Mesh;
  108471. private _queueLoad;
  108472. /**
  108473. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108474. * A mesh is in the frustum if its bounding box intersects the frustum
  108475. * @param frustumPlanes defines the frustum to test
  108476. * @returns true if the mesh is in the frustum planes
  108477. */
  108478. isInFrustum(frustumPlanes: Plane[]): boolean;
  108479. /**
  108480. * Sets the mesh material by the material or multiMaterial `id` property
  108481. * @param id is a string identifying the material or the multiMaterial
  108482. * @returns the current mesh
  108483. */
  108484. setMaterialByID(id: string): Mesh;
  108485. /**
  108486. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108487. * @returns an array of IAnimatable
  108488. */
  108489. getAnimatables(): IAnimatable[];
  108490. /**
  108491. * Modifies the mesh geometry according to the passed transformation matrix.
  108492. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108493. * The mesh normals are modified using the same transformation.
  108494. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108495. * @param transform defines the transform matrix to use
  108496. * @see https://doc.babylonjs.com/resources/baking_transformations
  108497. * @returns the current mesh
  108498. */
  108499. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108500. /**
  108501. * Modifies the mesh geometry according to its own current World Matrix.
  108502. * The mesh World Matrix is then reset.
  108503. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108504. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108505. * @see https://doc.babylonjs.com/resources/baking_transformations
  108506. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108507. * @returns the current mesh
  108508. */
  108509. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108510. /** @hidden */
  108511. get _positions(): Nullable<Vector3[]>;
  108512. /** @hidden */
  108513. _resetPointsArrayCache(): Mesh;
  108514. /** @hidden */
  108515. _generatePointsArray(): boolean;
  108516. /**
  108517. * Returns a new Mesh object generated from the current mesh properties.
  108518. * This method must not get confused with createInstance()
  108519. * @param name is a string, the name given to the new mesh
  108520. * @param newParent can be any Node object (default `null`)
  108521. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108522. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108523. * @returns a new mesh
  108524. */
  108525. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108526. /**
  108527. * Releases resources associated with this mesh.
  108528. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108529. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108530. */
  108531. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108532. /** @hidden */
  108533. _disposeInstanceSpecificData(): void;
  108534. /** @hidden */
  108535. _disposeThinInstanceSpecificData(): void;
  108536. /**
  108537. * Modifies the mesh geometry according to a displacement map.
  108538. * 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.
  108539. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108540. * @param url is a string, the URL from the image file is to be downloaded.
  108541. * @param minHeight is the lower limit of the displacement.
  108542. * @param maxHeight is the upper limit of the displacement.
  108543. * @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.
  108544. * @param uvOffset is an optional vector2 used to offset UV.
  108545. * @param uvScale is an optional vector2 used to scale UV.
  108546. * @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.
  108547. * @returns the Mesh.
  108548. */
  108549. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108550. /**
  108551. * Modifies the mesh geometry according to a displacementMap buffer.
  108552. * 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.
  108553. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108554. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108555. * @param heightMapWidth is the width of the buffer image.
  108556. * @param heightMapHeight is the height of the buffer image.
  108557. * @param minHeight is the lower limit of the displacement.
  108558. * @param maxHeight is the upper limit of the displacement.
  108559. * @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.
  108560. * @param uvOffset is an optional vector2 used to offset UV.
  108561. * @param uvScale is an optional vector2 used to scale UV.
  108562. * @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.
  108563. * @returns the Mesh.
  108564. */
  108565. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108566. /**
  108567. * Modify the mesh to get a flat shading rendering.
  108568. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108569. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108570. * @returns current mesh
  108571. */
  108572. convertToFlatShadedMesh(): Mesh;
  108573. /**
  108574. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108575. * In other words, more vertices, no more indices and a single bigger VBO.
  108576. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108577. * @returns current mesh
  108578. */
  108579. convertToUnIndexedMesh(): Mesh;
  108580. /**
  108581. * Inverses facet orientations.
  108582. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108583. * @param flipNormals will also inverts the normals
  108584. * @returns current mesh
  108585. */
  108586. flipFaces(flipNormals?: boolean): Mesh;
  108587. /**
  108588. * Increase the number of facets and hence vertices in a mesh
  108589. * Vertex normals are interpolated from existing vertex normals
  108590. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108591. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108592. */
  108593. increaseVertices(numberPerEdge: number): void;
  108594. /**
  108595. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108596. * This will undo any application of covertToFlatShadedMesh
  108597. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108598. */
  108599. forceSharedVertices(): void;
  108600. /** @hidden */
  108601. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108602. /** @hidden */
  108603. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108604. /**
  108605. * Creates a new InstancedMesh object from the mesh model.
  108606. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108607. * @param name defines the name of the new instance
  108608. * @returns a new InstancedMesh
  108609. */
  108610. createInstance(name: string): InstancedMesh;
  108611. /**
  108612. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108613. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108614. * @returns the current mesh
  108615. */
  108616. synchronizeInstances(): Mesh;
  108617. /**
  108618. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108619. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108620. * This should be used together with the simplification to avoid disappearing triangles.
  108621. * @param successCallback an optional success callback to be called after the optimization finished.
  108622. * @returns the current mesh
  108623. */
  108624. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108625. /**
  108626. * Serialize current mesh
  108627. * @param serializationObject defines the object which will receive the serialization data
  108628. */
  108629. serialize(serializationObject: any): void;
  108630. /** @hidden */
  108631. _syncGeometryWithMorphTargetManager(): void;
  108632. /** @hidden */
  108633. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108634. /**
  108635. * Returns a new Mesh object parsed from the source provided.
  108636. * @param parsedMesh is the source
  108637. * @param scene defines the hosting scene
  108638. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108639. * @returns a new Mesh
  108640. */
  108641. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108642. /**
  108643. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108644. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108645. * @param name defines the name of the mesh to create
  108646. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108647. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108648. * @param closePath creates a seam between the first and the last points of each path of the path array
  108649. * @param offset is taken in account only if the `pathArray` is containing a single path
  108650. * @param scene defines the hosting scene
  108651. * @param updatable defines if the mesh must be flagged as updatable
  108652. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108653. * @param instance defines 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)
  108654. * @returns a new Mesh
  108655. */
  108656. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108657. /**
  108658. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108659. * @param name defines the name of the mesh to create
  108660. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108661. * @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
  108662. * @param scene defines the hosting scene
  108663. * @param updatable defines if the mesh must be flagged as updatable
  108664. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108665. * @returns a new Mesh
  108666. */
  108667. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108668. /**
  108669. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108670. * @param name defines the name of the mesh to create
  108671. * @param size sets the size (float) of each box side (default 1)
  108672. * @param scene defines the hosting scene
  108673. * @param updatable defines if the mesh must be flagged as updatable
  108674. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108675. * @returns a new Mesh
  108676. */
  108677. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108678. /**
  108679. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108680. * @param name defines the name of the mesh to create
  108681. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108682. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108683. * @param scene defines the hosting scene
  108684. * @param updatable defines if the mesh must be flagged as updatable
  108685. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108686. * @returns a new Mesh
  108687. */
  108688. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108689. /**
  108690. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108691. * @param name defines the name of the mesh to create
  108692. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108693. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108694. * @param scene defines the hosting scene
  108695. * @returns a new Mesh
  108696. */
  108697. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108698. /**
  108699. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108700. * @param name defines the name of the mesh to create
  108701. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108702. * @param diameterTop set the top cap diameter (floats, default 1)
  108703. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108704. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108705. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108706. * @param scene defines the hosting scene
  108707. * @param updatable defines if the mesh must be flagged as updatable
  108708. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108709. * @returns a new Mesh
  108710. */
  108711. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108712. /**
  108713. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108714. * @param name defines the name of the mesh to create
  108715. * @param diameter sets the diameter size (float) of the torus (default 1)
  108716. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108717. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108718. * @param scene defines the hosting scene
  108719. * @param updatable defines if the mesh must be flagged as updatable
  108720. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108721. * @returns a new Mesh
  108722. */
  108723. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108724. /**
  108725. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108726. * @param name defines the name of the mesh to create
  108727. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108728. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108729. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108730. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108731. * @param p the number of windings on X axis (positive integers, default 2)
  108732. * @param q the number of windings on Y axis (positive integers, default 3)
  108733. * @param scene defines the hosting scene
  108734. * @param updatable defines if the mesh must be flagged as updatable
  108735. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108736. * @returns a new Mesh
  108737. */
  108738. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108739. /**
  108740. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108741. * @param name defines the name of the mesh to create
  108742. * @param points is an array successive Vector3
  108743. * @param scene defines the hosting scene
  108744. * @param updatable defines if the mesh must be flagged as updatable
  108745. * @param 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).
  108746. * @returns a new Mesh
  108747. */
  108748. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108749. /**
  108750. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108751. * @param name defines the name of the mesh to create
  108752. * @param points is an array successive Vector3
  108753. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108754. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108755. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108756. * @param scene defines the hosting scene
  108757. * @param updatable defines if the mesh must be flagged as updatable
  108758. * @param 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)
  108759. * @returns a new Mesh
  108760. */
  108761. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108762. /**
  108763. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108764. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108765. * 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.
  108766. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108767. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108768. * Remember you can only change the shape positions, not their number when updating a polygon.
  108769. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108770. * @param name defines the name of the mesh to create
  108771. * @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
  108772. * @param scene defines the hosting scene
  108773. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108774. * @param updatable defines if the mesh must be flagged as updatable
  108775. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108776. * @param earcutInjection can be used to inject your own earcut reference
  108777. * @returns a new Mesh
  108778. */
  108779. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108780. /**
  108781. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108782. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108783. * @param name defines the name of the mesh to create
  108784. * @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
  108785. * @param depth defines the height of extrusion
  108786. * @param scene defines the hosting scene
  108787. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108788. * @param updatable defines if the mesh must be flagged as updatable
  108789. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108790. * @param earcutInjection can be used to inject your own earcut reference
  108791. * @returns a new Mesh
  108792. */
  108793. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108794. /**
  108795. * Creates an extruded shape mesh.
  108796. * 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
  108797. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108798. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108799. * @param name defines the name of the mesh to create
  108800. * @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
  108801. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108802. * @param scale is the value to scale the shape
  108803. * @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
  108804. * @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
  108805. * @param scene defines the hosting scene
  108806. * @param updatable defines if the mesh must be flagged as updatable
  108807. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108808. * @param 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)
  108809. * @returns a new Mesh
  108810. */
  108811. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108812. /**
  108813. * Creates an custom extruded shape mesh.
  108814. * The custom extrusion is a parametric shape.
  108815. * It has no predefined shape. Its final shape will depend on the input parameters.
  108816. * Please consider using the same method from the MeshBuilder class instead
  108817. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108818. * @param name defines the name of the mesh to create
  108819. * @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
  108820. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108821. * @param scaleFunction is a custom Javascript function called on each path point
  108822. * @param rotationFunction is a custom Javascript function called on each path point
  108823. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108824. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108825. * @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
  108826. * @param scene defines the hosting scene
  108827. * @param updatable defines if the mesh must be flagged as updatable
  108828. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108829. * @param 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)
  108830. * @returns a new Mesh
  108831. */
  108832. 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;
  108833. /**
  108834. * Creates lathe mesh.
  108835. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108836. * Please consider using the same method from the MeshBuilder class instead
  108837. * @param name defines the name of the mesh to create
  108838. * @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
  108839. * @param radius is the radius value of the lathe
  108840. * @param tessellation is the side number of the lathe.
  108841. * @param scene defines the hosting scene
  108842. * @param updatable defines if the mesh must be flagged as updatable
  108843. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108844. * @returns a new Mesh
  108845. */
  108846. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108847. /**
  108848. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108849. * @param name defines the name of the mesh to create
  108850. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108851. * @param scene defines the hosting scene
  108852. * @param updatable defines if the mesh must be flagged as updatable
  108853. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108854. * @returns a new Mesh
  108855. */
  108856. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108857. /**
  108858. * Creates a ground mesh.
  108859. * Please consider using the same method from the MeshBuilder class instead
  108860. * @param name defines the name of the mesh to create
  108861. * @param width set the width of the ground
  108862. * @param height set the height of the ground
  108863. * @param subdivisions sets the number of subdivisions per side
  108864. * @param scene defines the hosting scene
  108865. * @param updatable defines if the mesh must be flagged as updatable
  108866. * @returns a new Mesh
  108867. */
  108868. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108869. /**
  108870. * Creates a tiled ground mesh.
  108871. * Please consider using the same method from the MeshBuilder class instead
  108872. * @param name defines the name of the mesh to create
  108873. * @param xmin set the ground minimum X coordinate
  108874. * @param zmin set the ground minimum Y coordinate
  108875. * @param xmax set the ground maximum X coordinate
  108876. * @param zmax set the ground maximum Z coordinate
  108877. * @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
  108878. * @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
  108879. * @param scene defines the hosting scene
  108880. * @param updatable defines if the mesh must be flagged as updatable
  108881. * @returns a new Mesh
  108882. */
  108883. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108884. w: number;
  108885. h: number;
  108886. }, precision: {
  108887. w: number;
  108888. h: number;
  108889. }, scene: Scene, updatable?: boolean): Mesh;
  108890. /**
  108891. * Creates a ground mesh from a height map.
  108892. * Please consider using the same method from the MeshBuilder class instead
  108893. * @see https://doc.babylonjs.com/babylon101/height_map
  108894. * @param name defines the name of the mesh to create
  108895. * @param url sets the URL of the height map image resource
  108896. * @param width set the ground width size
  108897. * @param height set the ground height size
  108898. * @param subdivisions sets the number of subdivision per side
  108899. * @param minHeight is the minimum altitude on the ground
  108900. * @param maxHeight is the maximum altitude on the ground
  108901. * @param scene defines the hosting scene
  108902. * @param updatable defines if the mesh must be flagged as updatable
  108903. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108904. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108905. * @returns a new Mesh
  108906. */
  108907. 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;
  108908. /**
  108909. * Creates a tube mesh.
  108910. * The tube is a parametric shape.
  108911. * It has no predefined shape. Its final shape will depend on the input parameters.
  108912. * Please consider using the same method from the MeshBuilder class instead
  108913. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108914. * @param name defines the name of the mesh to create
  108915. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108916. * @param radius sets the tube radius size
  108917. * @param tessellation is the number of sides on the tubular surface
  108918. * @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
  108919. * @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
  108920. * @param scene defines the hosting scene
  108921. * @param updatable defines if the mesh must be flagged as updatable
  108922. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108923. * @param 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)
  108924. * @returns a new Mesh
  108925. */
  108926. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108927. (i: number, distance: number): number;
  108928. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108929. /**
  108930. * Creates a polyhedron mesh.
  108931. * Please consider using the same method from the MeshBuilder class instead.
  108932. * * 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
  108933. * * The parameter `size` (positive float, default 1) sets the polygon size
  108934. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108935. * * 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`
  108936. * * 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
  108937. * * 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)`)
  108938. * * 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
  108939. * * 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
  108940. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108941. * * 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
  108942. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108943. * @param name defines the name of the mesh to create
  108944. * @param options defines the options used to create the mesh
  108945. * @param scene defines the hosting scene
  108946. * @returns a new Mesh
  108947. */
  108948. static CreatePolyhedron(name: string, options: {
  108949. type?: number;
  108950. size?: number;
  108951. sizeX?: number;
  108952. sizeY?: number;
  108953. sizeZ?: number;
  108954. custom?: any;
  108955. faceUV?: Vector4[];
  108956. faceColors?: Color4[];
  108957. updatable?: boolean;
  108958. sideOrientation?: number;
  108959. }, scene: Scene): Mesh;
  108960. /**
  108961. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108962. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108963. * * 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`)
  108964. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108965. * * 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
  108966. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108967. * * 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
  108968. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108969. * @param name defines the name of the mesh
  108970. * @param options defines the options used to create the mesh
  108971. * @param scene defines the hosting scene
  108972. * @returns a new Mesh
  108973. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108974. */
  108975. static CreateIcoSphere(name: string, options: {
  108976. radius?: number;
  108977. flat?: boolean;
  108978. subdivisions?: number;
  108979. sideOrientation?: number;
  108980. updatable?: boolean;
  108981. }, scene: Scene): Mesh;
  108982. /**
  108983. * Creates a decal mesh.
  108984. * Please consider using the same method from the MeshBuilder class instead.
  108985. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108986. * @param name defines the name of the mesh
  108987. * @param sourceMesh defines the mesh receiving the decal
  108988. * @param position sets the position of the decal in world coordinates
  108989. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108990. * @param size sets the decal scaling
  108991. * @param angle sets the angle to rotate the decal
  108992. * @returns a new Mesh
  108993. */
  108994. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108995. /**
  108996. * Prepare internal position array for software CPU skinning
  108997. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108998. */
  108999. setPositionsForCPUSkinning(): Float32Array;
  109000. /**
  109001. * Prepare internal normal array for software CPU skinning
  109002. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  109003. */
  109004. setNormalsForCPUSkinning(): Float32Array;
  109005. /**
  109006. * Updates the vertex buffer by applying transformation from the bones
  109007. * @param skeleton defines the skeleton to apply to current mesh
  109008. * @returns the current mesh
  109009. */
  109010. applySkeleton(skeleton: Skeleton): Mesh;
  109011. /**
  109012. * 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
  109013. * @param meshes defines the list of meshes to scan
  109014. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  109015. */
  109016. static MinMax(meshes: AbstractMesh[]): {
  109017. min: Vector3;
  109018. max: Vector3;
  109019. };
  109020. /**
  109021. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  109022. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  109023. * @returns a vector3
  109024. */
  109025. static Center(meshesOrMinMaxVector: {
  109026. min: Vector3;
  109027. max: Vector3;
  109028. } | AbstractMesh[]): Vector3;
  109029. /**
  109030. * Merge the array of meshes into a single mesh for performance reasons.
  109031. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  109032. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  109033. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  109034. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  109035. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  109036. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  109037. * @returns a new mesh
  109038. */
  109039. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  109040. /** @hidden */
  109041. addInstance(instance: InstancedMesh): void;
  109042. /** @hidden */
  109043. removeInstance(instance: InstancedMesh): void;
  109044. }
  109045. }
  109046. declare module BABYLON {
  109047. /**
  109048. * This is the base class of all the camera used in the application.
  109049. * @see https://doc.babylonjs.com/features/cameras
  109050. */
  109051. export class Camera extends Node {
  109052. /** @hidden */
  109053. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  109054. /**
  109055. * This is the default projection mode used by the cameras.
  109056. * It helps recreating a feeling of perspective and better appreciate depth.
  109057. * This is the best way to simulate real life cameras.
  109058. */
  109059. static readonly PERSPECTIVE_CAMERA: number;
  109060. /**
  109061. * This helps creating camera with an orthographic mode.
  109062. * 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.
  109063. */
  109064. static readonly ORTHOGRAPHIC_CAMERA: number;
  109065. /**
  109066. * This is the default FOV mode for perspective cameras.
  109067. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  109068. */
  109069. static readonly FOVMODE_VERTICAL_FIXED: number;
  109070. /**
  109071. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  109072. */
  109073. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  109074. /**
  109075. * This specifies ther is no need for a camera rig.
  109076. * Basically only one eye is rendered corresponding to the camera.
  109077. */
  109078. static readonly RIG_MODE_NONE: number;
  109079. /**
  109080. * Simulates a camera Rig with one blue eye and one red eye.
  109081. * This can be use with 3d blue and red glasses.
  109082. */
  109083. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  109084. /**
  109085. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  109086. */
  109087. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109088. /**
  109089. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109090. */
  109091. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109092. /**
  109093. * Defines that both eyes of the camera will be rendered over under each other.
  109094. */
  109095. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109096. /**
  109097. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109098. */
  109099. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109100. /**
  109101. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109102. */
  109103. static readonly RIG_MODE_VR: number;
  109104. /**
  109105. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109106. */
  109107. static readonly RIG_MODE_WEBVR: number;
  109108. /**
  109109. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109110. */
  109111. static readonly RIG_MODE_CUSTOM: number;
  109112. /**
  109113. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109114. */
  109115. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109116. /**
  109117. * Define the input manager associated with the camera.
  109118. */
  109119. inputs: CameraInputsManager<Camera>;
  109120. /** @hidden */
  109121. _position: Vector3;
  109122. /**
  109123. * Define the current local position of the camera in the scene
  109124. */
  109125. get position(): Vector3;
  109126. set position(newPosition: Vector3);
  109127. protected _upVector: Vector3;
  109128. /**
  109129. * The vector the camera should consider as up.
  109130. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109131. */
  109132. set upVector(vec: Vector3);
  109133. get upVector(): Vector3;
  109134. /**
  109135. * Define the current limit on the left side for an orthographic camera
  109136. * In scene unit
  109137. */
  109138. orthoLeft: Nullable<number>;
  109139. /**
  109140. * Define the current limit on the right side for an orthographic camera
  109141. * In scene unit
  109142. */
  109143. orthoRight: Nullable<number>;
  109144. /**
  109145. * Define the current limit on the bottom side for an orthographic camera
  109146. * In scene unit
  109147. */
  109148. orthoBottom: Nullable<number>;
  109149. /**
  109150. * Define the current limit on the top side for an orthographic camera
  109151. * In scene unit
  109152. */
  109153. orthoTop: Nullable<number>;
  109154. /**
  109155. * Field Of View is set in Radians. (default is 0.8)
  109156. */
  109157. fov: number;
  109158. /**
  109159. * Define the minimum distance the camera can see from.
  109160. * This is important to note that the depth buffer are not infinite and the closer it starts
  109161. * the more your scene might encounter depth fighting issue.
  109162. */
  109163. minZ: number;
  109164. /**
  109165. * Define the maximum distance the camera can see to.
  109166. * This is important to note that the depth buffer are not infinite and the further it end
  109167. * the more your scene might encounter depth fighting issue.
  109168. */
  109169. maxZ: number;
  109170. /**
  109171. * Define the default inertia of the camera.
  109172. * This helps giving a smooth feeling to the camera movement.
  109173. */
  109174. inertia: number;
  109175. /**
  109176. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109177. */
  109178. mode: number;
  109179. /**
  109180. * Define whether the camera is intermediate.
  109181. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109182. */
  109183. isIntermediate: boolean;
  109184. /**
  109185. * Define the viewport of the camera.
  109186. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109187. */
  109188. viewport: Viewport;
  109189. /**
  109190. * Restricts the camera to viewing objects with the same layerMask.
  109191. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109192. */
  109193. layerMask: number;
  109194. /**
  109195. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109196. */
  109197. fovMode: number;
  109198. /**
  109199. * Rig mode of the camera.
  109200. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109201. * This is normally controlled byt the camera themselves as internal use.
  109202. */
  109203. cameraRigMode: number;
  109204. /**
  109205. * Defines the distance between both "eyes" in case of a RIG
  109206. */
  109207. interaxialDistance: number;
  109208. /**
  109209. * Defines if stereoscopic rendering is done side by side or over under.
  109210. */
  109211. isStereoscopicSideBySide: boolean;
  109212. /**
  109213. * 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
  109214. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109215. * else in the scene. (Eg. security camera)
  109216. *
  109217. * 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)
  109218. */
  109219. customRenderTargets: RenderTargetTexture[];
  109220. /**
  109221. * When set, the camera will render to this render target instead of the default canvas
  109222. *
  109223. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109224. */
  109225. outputRenderTarget: Nullable<RenderTargetTexture>;
  109226. /**
  109227. * Observable triggered when the camera view matrix has changed.
  109228. */
  109229. onViewMatrixChangedObservable: Observable<Camera>;
  109230. /**
  109231. * Observable triggered when the camera Projection matrix has changed.
  109232. */
  109233. onProjectionMatrixChangedObservable: Observable<Camera>;
  109234. /**
  109235. * Observable triggered when the inputs have been processed.
  109236. */
  109237. onAfterCheckInputsObservable: Observable<Camera>;
  109238. /**
  109239. * Observable triggered when reset has been called and applied to the camera.
  109240. */
  109241. onRestoreStateObservable: Observable<Camera>;
  109242. /**
  109243. * Is this camera a part of a rig system?
  109244. */
  109245. isRigCamera: boolean;
  109246. /**
  109247. * If isRigCamera set to true this will be set with the parent camera.
  109248. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109249. */
  109250. rigParent?: Camera;
  109251. /** @hidden */
  109252. _cameraRigParams: any;
  109253. /** @hidden */
  109254. _rigCameras: Camera[];
  109255. /** @hidden */
  109256. _rigPostProcess: Nullable<PostProcess>;
  109257. protected _webvrViewMatrix: Matrix;
  109258. /** @hidden */
  109259. _skipRendering: boolean;
  109260. /** @hidden */
  109261. _projectionMatrix: Matrix;
  109262. /** @hidden */
  109263. _postProcesses: Nullable<PostProcess>[];
  109264. /** @hidden */
  109265. _activeMeshes: SmartArray<AbstractMesh>;
  109266. protected _globalPosition: Vector3;
  109267. /** @hidden */
  109268. _computedViewMatrix: Matrix;
  109269. private _doNotComputeProjectionMatrix;
  109270. private _transformMatrix;
  109271. private _frustumPlanes;
  109272. private _refreshFrustumPlanes;
  109273. private _storedFov;
  109274. private _stateStored;
  109275. /**
  109276. * Instantiates a new camera object.
  109277. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109278. * @see https://doc.babylonjs.com/features/cameras
  109279. * @param name Defines the name of the camera in the scene
  109280. * @param position Defines the position of the camera
  109281. * @param scene Defines the scene the camera belongs too
  109282. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109283. */
  109284. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109285. /**
  109286. * Store current camera state (fov, position, etc..)
  109287. * @returns the camera
  109288. */
  109289. storeState(): Camera;
  109290. /**
  109291. * Restores the camera state values if it has been stored. You must call storeState() first
  109292. */
  109293. protected _restoreStateValues(): boolean;
  109294. /**
  109295. * Restored camera state. You must call storeState() first.
  109296. * @returns true if restored and false otherwise
  109297. */
  109298. restoreState(): boolean;
  109299. /**
  109300. * Gets the class name of the camera.
  109301. * @returns the class name
  109302. */
  109303. getClassName(): string;
  109304. /** @hidden */
  109305. readonly _isCamera: boolean;
  109306. /**
  109307. * Gets a string representation of the camera useful for debug purpose.
  109308. * @param fullDetails Defines that a more verboe level of logging is required
  109309. * @returns the string representation
  109310. */
  109311. toString(fullDetails?: boolean): string;
  109312. /**
  109313. * Gets the current world space position of the camera.
  109314. */
  109315. get globalPosition(): Vector3;
  109316. /**
  109317. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109318. * @returns the active meshe list
  109319. */
  109320. getActiveMeshes(): SmartArray<AbstractMesh>;
  109321. /**
  109322. * Check whether a mesh is part of the current active mesh list of the camera
  109323. * @param mesh Defines the mesh to check
  109324. * @returns true if active, false otherwise
  109325. */
  109326. isActiveMesh(mesh: Mesh): boolean;
  109327. /**
  109328. * Is this camera ready to be used/rendered
  109329. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109330. * @return true if the camera is ready
  109331. */
  109332. isReady(completeCheck?: boolean): boolean;
  109333. /** @hidden */
  109334. _initCache(): void;
  109335. /** @hidden */
  109336. _updateCache(ignoreParentClass?: boolean): void;
  109337. /** @hidden */
  109338. _isSynchronized(): boolean;
  109339. /** @hidden */
  109340. _isSynchronizedViewMatrix(): boolean;
  109341. /** @hidden */
  109342. _isSynchronizedProjectionMatrix(): boolean;
  109343. /**
  109344. * Attach the input controls to a specific dom element to get the input from.
  109345. * @param element Defines the element the controls should be listened from
  109346. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109347. */
  109348. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109349. /**
  109350. * Detach the current controls from the specified dom element.
  109351. * @param element Defines the element to stop listening the inputs from
  109352. */
  109353. detachControl(element: HTMLElement): void;
  109354. /**
  109355. * Update the camera state according to the different inputs gathered during the frame.
  109356. */
  109357. update(): void;
  109358. /** @hidden */
  109359. _checkInputs(): void;
  109360. /** @hidden */
  109361. get rigCameras(): Camera[];
  109362. /**
  109363. * Gets the post process used by the rig cameras
  109364. */
  109365. get rigPostProcess(): Nullable<PostProcess>;
  109366. /**
  109367. * Internal, gets the first post proces.
  109368. * @returns the first post process to be run on this camera.
  109369. */
  109370. _getFirstPostProcess(): Nullable<PostProcess>;
  109371. private _cascadePostProcessesToRigCams;
  109372. /**
  109373. * Attach a post process to the camera.
  109374. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109375. * @param postProcess The post process to attach to the camera
  109376. * @param insertAt The position of the post process in case several of them are in use in the scene
  109377. * @returns the position the post process has been inserted at
  109378. */
  109379. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109380. /**
  109381. * Detach a post process to the camera.
  109382. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109383. * @param postProcess The post process to detach from the camera
  109384. */
  109385. detachPostProcess(postProcess: PostProcess): void;
  109386. /**
  109387. * Gets the current world matrix of the camera
  109388. */
  109389. getWorldMatrix(): Matrix;
  109390. /** @hidden */
  109391. _getViewMatrix(): Matrix;
  109392. /**
  109393. * Gets the current view matrix of the camera.
  109394. * @param force forces the camera to recompute the matrix without looking at the cached state
  109395. * @returns the view matrix
  109396. */
  109397. getViewMatrix(force?: boolean): Matrix;
  109398. /**
  109399. * Freeze the projection matrix.
  109400. * It will prevent the cache check of the camera projection compute and can speed up perf
  109401. * if no parameter of the camera are meant to change
  109402. * @param projection Defines manually a projection if necessary
  109403. */
  109404. freezeProjectionMatrix(projection?: Matrix): void;
  109405. /**
  109406. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109407. */
  109408. unfreezeProjectionMatrix(): void;
  109409. /**
  109410. * Gets the current projection matrix of the camera.
  109411. * @param force forces the camera to recompute the matrix without looking at the cached state
  109412. * @returns the projection matrix
  109413. */
  109414. getProjectionMatrix(force?: boolean): Matrix;
  109415. /**
  109416. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109417. * @returns a Matrix
  109418. */
  109419. getTransformationMatrix(): Matrix;
  109420. private _updateFrustumPlanes;
  109421. /**
  109422. * Checks if a cullable object (mesh...) is in the camera frustum
  109423. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109424. * @param target The object to check
  109425. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109426. * @returns true if the object is in frustum otherwise false
  109427. */
  109428. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109429. /**
  109430. * Checks if a cullable object (mesh...) is in the camera frustum
  109431. * Unlike isInFrustum this cheks the full bounding box
  109432. * @param target The object to check
  109433. * @returns true if the object is in frustum otherwise false
  109434. */
  109435. isCompletelyInFrustum(target: ICullable): boolean;
  109436. /**
  109437. * Gets a ray in the forward direction from the camera.
  109438. * @param length Defines the length of the ray to create
  109439. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109440. * @param origin Defines the start point of the ray which defaults to the camera position
  109441. * @returns the forward ray
  109442. */
  109443. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109444. /**
  109445. * Gets a ray in the forward direction from the camera.
  109446. * @param refRay the ray to (re)use when setting the values
  109447. * @param length Defines the length of the ray to create
  109448. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109449. * @param origin Defines the start point of the ray which defaults to the camera position
  109450. * @returns the forward ray
  109451. */
  109452. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109453. /**
  109454. * Releases resources associated with this node.
  109455. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109456. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109457. */
  109458. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109459. /** @hidden */
  109460. _isLeftCamera: boolean;
  109461. /**
  109462. * Gets the left camera of a rig setup in case of Rigged Camera
  109463. */
  109464. get isLeftCamera(): boolean;
  109465. /** @hidden */
  109466. _isRightCamera: boolean;
  109467. /**
  109468. * Gets the right camera of a rig setup in case of Rigged Camera
  109469. */
  109470. get isRightCamera(): boolean;
  109471. /**
  109472. * Gets the left camera of a rig setup in case of Rigged Camera
  109473. */
  109474. get leftCamera(): Nullable<FreeCamera>;
  109475. /**
  109476. * Gets the right camera of a rig setup in case of Rigged Camera
  109477. */
  109478. get rightCamera(): Nullable<FreeCamera>;
  109479. /**
  109480. * Gets the left camera target of a rig setup in case of Rigged Camera
  109481. * @returns the target position
  109482. */
  109483. getLeftTarget(): Nullable<Vector3>;
  109484. /**
  109485. * Gets the right camera target of a rig setup in case of Rigged Camera
  109486. * @returns the target position
  109487. */
  109488. getRightTarget(): Nullable<Vector3>;
  109489. /**
  109490. * @hidden
  109491. */
  109492. setCameraRigMode(mode: number, rigParams: any): void;
  109493. /** @hidden */
  109494. static _setStereoscopicRigMode(camera: Camera): void;
  109495. /** @hidden */
  109496. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109497. /** @hidden */
  109498. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109499. /** @hidden */
  109500. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109501. /** @hidden */
  109502. _getVRProjectionMatrix(): Matrix;
  109503. protected _updateCameraRotationMatrix(): void;
  109504. protected _updateWebVRCameraRotationMatrix(): void;
  109505. /**
  109506. * This function MUST be overwritten by the different WebVR cameras available.
  109507. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109508. * @hidden
  109509. */
  109510. _getWebVRProjectionMatrix(): Matrix;
  109511. /**
  109512. * This function MUST be overwritten by the different WebVR cameras available.
  109513. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109514. * @hidden
  109515. */
  109516. _getWebVRViewMatrix(): Matrix;
  109517. /** @hidden */
  109518. setCameraRigParameter(name: string, value: any): void;
  109519. /**
  109520. * needs to be overridden by children so sub has required properties to be copied
  109521. * @hidden
  109522. */
  109523. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109524. /**
  109525. * May need to be overridden by children
  109526. * @hidden
  109527. */
  109528. _updateRigCameras(): void;
  109529. /** @hidden */
  109530. _setupInputs(): void;
  109531. /**
  109532. * Serialiaze the camera setup to a json represention
  109533. * @returns the JSON representation
  109534. */
  109535. serialize(): any;
  109536. /**
  109537. * Clones the current camera.
  109538. * @param name The cloned camera name
  109539. * @returns the cloned camera
  109540. */
  109541. clone(name: string): Camera;
  109542. /**
  109543. * Gets the direction of the camera relative to a given local axis.
  109544. * @param localAxis Defines the reference axis to provide a relative direction.
  109545. * @return the direction
  109546. */
  109547. getDirection(localAxis: Vector3): Vector3;
  109548. /**
  109549. * Returns the current camera absolute rotation
  109550. */
  109551. get absoluteRotation(): Quaternion;
  109552. /**
  109553. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109554. * @param localAxis Defines the reference axis to provide a relative direction.
  109555. * @param result Defines the vector to store the result in
  109556. */
  109557. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109558. /**
  109559. * Gets a camera constructor for a given camera type
  109560. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109561. * @param name The name of the camera the result will be able to instantiate
  109562. * @param scene The scene the result will construct the camera in
  109563. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109564. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109565. * @returns a factory method to construc the camera
  109566. */
  109567. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109568. /**
  109569. * Compute the world matrix of the camera.
  109570. * @returns the camera world matrix
  109571. */
  109572. computeWorldMatrix(): Matrix;
  109573. /**
  109574. * Parse a JSON and creates the camera from the parsed information
  109575. * @param parsedCamera The JSON to parse
  109576. * @param scene The scene to instantiate the camera in
  109577. * @returns the newly constructed camera
  109578. */
  109579. static Parse(parsedCamera: any, scene: Scene): Camera;
  109580. }
  109581. }
  109582. declare module BABYLON {
  109583. /**
  109584. * Class containing static functions to help procedurally build meshes
  109585. */
  109586. export class DiscBuilder {
  109587. /**
  109588. * Creates a plane polygonal mesh. By default, this is a disc
  109589. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109590. * * 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
  109591. * * 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
  109592. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109593. * * 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
  109594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109595. * @param name defines the name of the mesh
  109596. * @param options defines the options used to create the mesh
  109597. * @param scene defines the hosting scene
  109598. * @returns the plane polygonal mesh
  109599. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109600. */
  109601. static CreateDisc(name: string, options: {
  109602. radius?: number;
  109603. tessellation?: number;
  109604. arc?: number;
  109605. updatable?: boolean;
  109606. sideOrientation?: number;
  109607. frontUVs?: Vector4;
  109608. backUVs?: Vector4;
  109609. }, scene?: Nullable<Scene>): Mesh;
  109610. }
  109611. }
  109612. declare module BABYLON {
  109613. /**
  109614. * Options to be used when creating a FresnelParameters.
  109615. */
  109616. export type IFresnelParametersCreationOptions = {
  109617. /**
  109618. * Define the color used on edges (grazing angle)
  109619. */
  109620. leftColor?: Color3;
  109621. /**
  109622. * Define the color used on center
  109623. */
  109624. rightColor?: Color3;
  109625. /**
  109626. * Define bias applied to computed fresnel term
  109627. */
  109628. bias?: number;
  109629. /**
  109630. * Defined the power exponent applied to fresnel term
  109631. */
  109632. power?: number;
  109633. /**
  109634. * Define if the fresnel effect is enable or not.
  109635. */
  109636. isEnabled?: boolean;
  109637. };
  109638. /**
  109639. * Serialized format for FresnelParameters.
  109640. */
  109641. export type IFresnelParametersSerialized = {
  109642. /**
  109643. * Define the color used on edges (grazing angle) [as an array]
  109644. */
  109645. leftColor: number[];
  109646. /**
  109647. * Define the color used on center [as an array]
  109648. */
  109649. rightColor: number[];
  109650. /**
  109651. * Define bias applied to computed fresnel term
  109652. */
  109653. bias: number;
  109654. /**
  109655. * Defined the power exponent applied to fresnel term
  109656. */
  109657. power?: number;
  109658. /**
  109659. * Define if the fresnel effect is enable or not.
  109660. */
  109661. isEnabled: boolean;
  109662. };
  109663. /**
  109664. * This represents all the required information to add a fresnel effect on a material:
  109665. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109666. */
  109667. export class FresnelParameters {
  109668. private _isEnabled;
  109669. /**
  109670. * Define if the fresnel effect is enable or not.
  109671. */
  109672. get isEnabled(): boolean;
  109673. set isEnabled(value: boolean);
  109674. /**
  109675. * Define the color used on edges (grazing angle)
  109676. */
  109677. leftColor: Color3;
  109678. /**
  109679. * Define the color used on center
  109680. */
  109681. rightColor: Color3;
  109682. /**
  109683. * Define bias applied to computed fresnel term
  109684. */
  109685. bias: number;
  109686. /**
  109687. * Defined the power exponent applied to fresnel term
  109688. */
  109689. power: number;
  109690. /**
  109691. * Creates a new FresnelParameters object.
  109692. *
  109693. * @param options provide your own settings to optionally to override defaults
  109694. */
  109695. constructor(options?: IFresnelParametersCreationOptions);
  109696. /**
  109697. * Clones the current fresnel and its valuues
  109698. * @returns a clone fresnel configuration
  109699. */
  109700. clone(): FresnelParameters;
  109701. /**
  109702. * Determines equality between FresnelParameters objects
  109703. * @param otherFresnelParameters defines the second operand
  109704. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109705. */
  109706. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109707. /**
  109708. * Serializes the current fresnel parameters to a JSON representation.
  109709. * @return the JSON serialization
  109710. */
  109711. serialize(): IFresnelParametersSerialized;
  109712. /**
  109713. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109714. * @param parsedFresnelParameters Define the JSON representation
  109715. * @returns the parsed parameters
  109716. */
  109717. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109718. }
  109719. }
  109720. declare module BABYLON {
  109721. /**
  109722. * This groups all the flags used to control the materials channel.
  109723. */
  109724. export class MaterialFlags {
  109725. private static _DiffuseTextureEnabled;
  109726. /**
  109727. * Are diffuse textures enabled in the application.
  109728. */
  109729. static get DiffuseTextureEnabled(): boolean;
  109730. static set DiffuseTextureEnabled(value: boolean);
  109731. private static _DetailTextureEnabled;
  109732. /**
  109733. * Are detail textures enabled in the application.
  109734. */
  109735. static get DetailTextureEnabled(): boolean;
  109736. static set DetailTextureEnabled(value: boolean);
  109737. private static _AmbientTextureEnabled;
  109738. /**
  109739. * Are ambient textures enabled in the application.
  109740. */
  109741. static get AmbientTextureEnabled(): boolean;
  109742. static set AmbientTextureEnabled(value: boolean);
  109743. private static _OpacityTextureEnabled;
  109744. /**
  109745. * Are opacity textures enabled in the application.
  109746. */
  109747. static get OpacityTextureEnabled(): boolean;
  109748. static set OpacityTextureEnabled(value: boolean);
  109749. private static _ReflectionTextureEnabled;
  109750. /**
  109751. * Are reflection textures enabled in the application.
  109752. */
  109753. static get ReflectionTextureEnabled(): boolean;
  109754. static set ReflectionTextureEnabled(value: boolean);
  109755. private static _EmissiveTextureEnabled;
  109756. /**
  109757. * Are emissive textures enabled in the application.
  109758. */
  109759. static get EmissiveTextureEnabled(): boolean;
  109760. static set EmissiveTextureEnabled(value: boolean);
  109761. private static _SpecularTextureEnabled;
  109762. /**
  109763. * Are specular textures enabled in the application.
  109764. */
  109765. static get SpecularTextureEnabled(): boolean;
  109766. static set SpecularTextureEnabled(value: boolean);
  109767. private static _BumpTextureEnabled;
  109768. /**
  109769. * Are bump textures enabled in the application.
  109770. */
  109771. static get BumpTextureEnabled(): boolean;
  109772. static set BumpTextureEnabled(value: boolean);
  109773. private static _LightmapTextureEnabled;
  109774. /**
  109775. * Are lightmap textures enabled in the application.
  109776. */
  109777. static get LightmapTextureEnabled(): boolean;
  109778. static set LightmapTextureEnabled(value: boolean);
  109779. private static _RefractionTextureEnabled;
  109780. /**
  109781. * Are refraction textures enabled in the application.
  109782. */
  109783. static get RefractionTextureEnabled(): boolean;
  109784. static set RefractionTextureEnabled(value: boolean);
  109785. private static _ColorGradingTextureEnabled;
  109786. /**
  109787. * Are color grading textures enabled in the application.
  109788. */
  109789. static get ColorGradingTextureEnabled(): boolean;
  109790. static set ColorGradingTextureEnabled(value: boolean);
  109791. private static _FresnelEnabled;
  109792. /**
  109793. * Are fresnels enabled in the application.
  109794. */
  109795. static get FresnelEnabled(): boolean;
  109796. static set FresnelEnabled(value: boolean);
  109797. private static _ClearCoatTextureEnabled;
  109798. /**
  109799. * Are clear coat textures enabled in the application.
  109800. */
  109801. static get ClearCoatTextureEnabled(): boolean;
  109802. static set ClearCoatTextureEnabled(value: boolean);
  109803. private static _ClearCoatBumpTextureEnabled;
  109804. /**
  109805. * Are clear coat bump textures enabled in the application.
  109806. */
  109807. static get ClearCoatBumpTextureEnabled(): boolean;
  109808. static set ClearCoatBumpTextureEnabled(value: boolean);
  109809. private static _ClearCoatTintTextureEnabled;
  109810. /**
  109811. * Are clear coat tint textures enabled in the application.
  109812. */
  109813. static get ClearCoatTintTextureEnabled(): boolean;
  109814. static set ClearCoatTintTextureEnabled(value: boolean);
  109815. private static _SheenTextureEnabled;
  109816. /**
  109817. * Are sheen textures enabled in the application.
  109818. */
  109819. static get SheenTextureEnabled(): boolean;
  109820. static set SheenTextureEnabled(value: boolean);
  109821. private static _AnisotropicTextureEnabled;
  109822. /**
  109823. * Are anisotropic textures enabled in the application.
  109824. */
  109825. static get AnisotropicTextureEnabled(): boolean;
  109826. static set AnisotropicTextureEnabled(value: boolean);
  109827. private static _ThicknessTextureEnabled;
  109828. /**
  109829. * Are thickness textures enabled in the application.
  109830. */
  109831. static get ThicknessTextureEnabled(): boolean;
  109832. static set ThicknessTextureEnabled(value: boolean);
  109833. }
  109834. }
  109835. declare module BABYLON {
  109836. /** @hidden */
  109837. export var defaultFragmentDeclaration: {
  109838. name: string;
  109839. shader: string;
  109840. };
  109841. }
  109842. declare module BABYLON {
  109843. /** @hidden */
  109844. export var defaultUboDeclaration: {
  109845. name: string;
  109846. shader: string;
  109847. };
  109848. }
  109849. declare module BABYLON {
  109850. /** @hidden */
  109851. export var prePassDeclaration: {
  109852. name: string;
  109853. shader: string;
  109854. };
  109855. }
  109856. declare module BABYLON {
  109857. /** @hidden */
  109858. export var lightFragmentDeclaration: {
  109859. name: string;
  109860. shader: string;
  109861. };
  109862. }
  109863. declare module BABYLON {
  109864. /** @hidden */
  109865. export var lightUboDeclaration: {
  109866. name: string;
  109867. shader: string;
  109868. };
  109869. }
  109870. declare module BABYLON {
  109871. /** @hidden */
  109872. export var lightsFragmentFunctions: {
  109873. name: string;
  109874. shader: string;
  109875. };
  109876. }
  109877. declare module BABYLON {
  109878. /** @hidden */
  109879. export var shadowsFragmentFunctions: {
  109880. name: string;
  109881. shader: string;
  109882. };
  109883. }
  109884. declare module BABYLON {
  109885. /** @hidden */
  109886. export var fresnelFunction: {
  109887. name: string;
  109888. shader: string;
  109889. };
  109890. }
  109891. declare module BABYLON {
  109892. /** @hidden */
  109893. export var bumpFragmentMainFunctions: {
  109894. name: string;
  109895. shader: string;
  109896. };
  109897. }
  109898. declare module BABYLON {
  109899. /** @hidden */
  109900. export var bumpFragmentFunctions: {
  109901. name: string;
  109902. shader: string;
  109903. };
  109904. }
  109905. declare module BABYLON {
  109906. /** @hidden */
  109907. export var logDepthDeclaration: {
  109908. name: string;
  109909. shader: string;
  109910. };
  109911. }
  109912. declare module BABYLON {
  109913. /** @hidden */
  109914. export var bumpFragment: {
  109915. name: string;
  109916. shader: string;
  109917. };
  109918. }
  109919. declare module BABYLON {
  109920. /** @hidden */
  109921. export var depthPrePass: {
  109922. name: string;
  109923. shader: string;
  109924. };
  109925. }
  109926. declare module BABYLON {
  109927. /** @hidden */
  109928. export var lightFragment: {
  109929. name: string;
  109930. shader: string;
  109931. };
  109932. }
  109933. declare module BABYLON {
  109934. /** @hidden */
  109935. export var logDepthFragment: {
  109936. name: string;
  109937. shader: string;
  109938. };
  109939. }
  109940. declare module BABYLON {
  109941. /** @hidden */
  109942. export var defaultPixelShader: {
  109943. name: string;
  109944. shader: string;
  109945. };
  109946. }
  109947. declare module BABYLON {
  109948. /** @hidden */
  109949. export var defaultVertexDeclaration: {
  109950. name: string;
  109951. shader: string;
  109952. };
  109953. }
  109954. declare module BABYLON {
  109955. /** @hidden */
  109956. export var bumpVertexDeclaration: {
  109957. name: string;
  109958. shader: string;
  109959. };
  109960. }
  109961. declare module BABYLON {
  109962. /** @hidden */
  109963. export var bumpVertex: {
  109964. name: string;
  109965. shader: string;
  109966. };
  109967. }
  109968. declare module BABYLON {
  109969. /** @hidden */
  109970. export var fogVertex: {
  109971. name: string;
  109972. shader: string;
  109973. };
  109974. }
  109975. declare module BABYLON {
  109976. /** @hidden */
  109977. export var shadowsVertex: {
  109978. name: string;
  109979. shader: string;
  109980. };
  109981. }
  109982. declare module BABYLON {
  109983. /** @hidden */
  109984. export var pointCloudVertex: {
  109985. name: string;
  109986. shader: string;
  109987. };
  109988. }
  109989. declare module BABYLON {
  109990. /** @hidden */
  109991. export var logDepthVertex: {
  109992. name: string;
  109993. shader: string;
  109994. };
  109995. }
  109996. declare module BABYLON {
  109997. /** @hidden */
  109998. export var defaultVertexShader: {
  109999. name: string;
  110000. shader: string;
  110001. };
  110002. }
  110003. declare module BABYLON {
  110004. /**
  110005. * @hidden
  110006. */
  110007. export interface IMaterialDetailMapDefines {
  110008. DETAIL: boolean;
  110009. DETAILDIRECTUV: number;
  110010. DETAIL_NORMALBLENDMETHOD: number;
  110011. /** @hidden */
  110012. _areTexturesDirty: boolean;
  110013. }
  110014. /**
  110015. * Define the code related to the detail map parameters of a material
  110016. *
  110017. * Inspired from:
  110018. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  110019. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  110020. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  110021. */
  110022. export class DetailMapConfiguration {
  110023. private _texture;
  110024. /**
  110025. * The detail texture of the material.
  110026. */
  110027. texture: Nullable<BaseTexture>;
  110028. /**
  110029. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  110030. * Bigger values mean stronger blending
  110031. */
  110032. diffuseBlendLevel: number;
  110033. /**
  110034. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  110035. * Bigger values mean stronger blending. Only used with PBR materials
  110036. */
  110037. roughnessBlendLevel: number;
  110038. /**
  110039. * Defines how strong the bump effect from the detail map is
  110040. * Bigger values mean stronger effect
  110041. */
  110042. bumpLevel: number;
  110043. private _normalBlendMethod;
  110044. /**
  110045. * The method used to blend the bump and detail normals together
  110046. */
  110047. normalBlendMethod: number;
  110048. private _isEnabled;
  110049. /**
  110050. * Enable or disable the detail map on this material
  110051. */
  110052. isEnabled: boolean;
  110053. /** @hidden */
  110054. private _internalMarkAllSubMeshesAsTexturesDirty;
  110055. /** @hidden */
  110056. _markAllSubMeshesAsTexturesDirty(): void;
  110057. /**
  110058. * Instantiate a new detail map
  110059. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110060. */
  110061. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110062. /**
  110063. * Gets whether the submesh is ready to be used or not.
  110064. * @param defines the list of "defines" to update.
  110065. * @param scene defines the scene the material belongs to.
  110066. * @returns - boolean indicating that the submesh is ready or not.
  110067. */
  110068. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  110069. /**
  110070. * Update the defines for detail map usage
  110071. * @param defines the list of "defines" to update.
  110072. * @param scene defines the scene the material belongs to.
  110073. */
  110074. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  110075. /**
  110076. * Binds the material data.
  110077. * @param uniformBuffer defines the Uniform buffer to fill in.
  110078. * @param scene defines the scene the material belongs to.
  110079. * @param isFrozen defines whether the material is frozen or not.
  110080. */
  110081. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110082. /**
  110083. * Checks to see if a texture is used in the material.
  110084. * @param texture - Base texture to use.
  110085. * @returns - Boolean specifying if a texture is used in the material.
  110086. */
  110087. hasTexture(texture: BaseTexture): boolean;
  110088. /**
  110089. * Returns an array of the actively used textures.
  110090. * @param activeTextures Array of BaseTextures
  110091. */
  110092. getActiveTextures(activeTextures: BaseTexture[]): void;
  110093. /**
  110094. * Returns the animatable textures.
  110095. * @param animatables Array of animatable textures.
  110096. */
  110097. getAnimatables(animatables: IAnimatable[]): void;
  110098. /**
  110099. * Disposes the resources of the material.
  110100. * @param forceDisposeTextures - Forces the disposal of all textures.
  110101. */
  110102. dispose(forceDisposeTextures?: boolean): void;
  110103. /**
  110104. * Get the current class name useful for serialization or dynamic coding.
  110105. * @returns "DetailMap"
  110106. */
  110107. getClassName(): string;
  110108. /**
  110109. * Add the required uniforms to the current list.
  110110. * @param uniforms defines the current uniform list.
  110111. */
  110112. static AddUniforms(uniforms: string[]): void;
  110113. /**
  110114. * Add the required samplers to the current list.
  110115. * @param samplers defines the current sampler list.
  110116. */
  110117. static AddSamplers(samplers: string[]): void;
  110118. /**
  110119. * Add the required uniforms to the current buffer.
  110120. * @param uniformBuffer defines the current uniform buffer.
  110121. */
  110122. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110123. /**
  110124. * Makes a duplicate of the current instance into another one.
  110125. * @param detailMap define the instance where to copy the info
  110126. */
  110127. copyTo(detailMap: DetailMapConfiguration): void;
  110128. /**
  110129. * Serializes this detail map instance
  110130. * @returns - An object with the serialized instance.
  110131. */
  110132. serialize(): any;
  110133. /**
  110134. * Parses a detail map setting from a serialized object.
  110135. * @param source - Serialized object.
  110136. * @param scene Defines the scene we are parsing for
  110137. * @param rootUrl Defines the rootUrl to load from
  110138. */
  110139. parse(source: any, scene: Scene, rootUrl: string): void;
  110140. }
  110141. }
  110142. declare module BABYLON {
  110143. /** @hidden */
  110144. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110145. MAINUV1: boolean;
  110146. MAINUV2: boolean;
  110147. DIFFUSE: boolean;
  110148. DIFFUSEDIRECTUV: number;
  110149. DETAIL: boolean;
  110150. DETAILDIRECTUV: number;
  110151. DETAIL_NORMALBLENDMETHOD: number;
  110152. AMBIENT: boolean;
  110153. AMBIENTDIRECTUV: number;
  110154. OPACITY: boolean;
  110155. OPACITYDIRECTUV: number;
  110156. OPACITYRGB: boolean;
  110157. REFLECTION: boolean;
  110158. EMISSIVE: boolean;
  110159. EMISSIVEDIRECTUV: number;
  110160. SPECULAR: boolean;
  110161. SPECULARDIRECTUV: number;
  110162. BUMP: boolean;
  110163. BUMPDIRECTUV: number;
  110164. PARALLAX: boolean;
  110165. PARALLAXOCCLUSION: boolean;
  110166. SPECULAROVERALPHA: boolean;
  110167. CLIPPLANE: boolean;
  110168. CLIPPLANE2: boolean;
  110169. CLIPPLANE3: boolean;
  110170. CLIPPLANE4: boolean;
  110171. CLIPPLANE5: boolean;
  110172. CLIPPLANE6: boolean;
  110173. ALPHATEST: boolean;
  110174. DEPTHPREPASS: boolean;
  110175. ALPHAFROMDIFFUSE: boolean;
  110176. POINTSIZE: boolean;
  110177. FOG: boolean;
  110178. SPECULARTERM: boolean;
  110179. DIFFUSEFRESNEL: boolean;
  110180. OPACITYFRESNEL: boolean;
  110181. REFLECTIONFRESNEL: boolean;
  110182. REFRACTIONFRESNEL: boolean;
  110183. EMISSIVEFRESNEL: boolean;
  110184. FRESNEL: boolean;
  110185. NORMAL: boolean;
  110186. UV1: boolean;
  110187. UV2: boolean;
  110188. VERTEXCOLOR: boolean;
  110189. VERTEXALPHA: boolean;
  110190. NUM_BONE_INFLUENCERS: number;
  110191. BonesPerMesh: number;
  110192. BONETEXTURE: boolean;
  110193. INSTANCES: boolean;
  110194. THIN_INSTANCES: boolean;
  110195. GLOSSINESS: boolean;
  110196. ROUGHNESS: boolean;
  110197. EMISSIVEASILLUMINATION: boolean;
  110198. LINKEMISSIVEWITHDIFFUSE: boolean;
  110199. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110200. LIGHTMAP: boolean;
  110201. LIGHTMAPDIRECTUV: number;
  110202. OBJECTSPACE_NORMALMAP: boolean;
  110203. USELIGHTMAPASSHADOWMAP: boolean;
  110204. REFLECTIONMAP_3D: boolean;
  110205. REFLECTIONMAP_SPHERICAL: boolean;
  110206. REFLECTIONMAP_PLANAR: boolean;
  110207. REFLECTIONMAP_CUBIC: boolean;
  110208. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110209. REFLECTIONMAP_PROJECTION: boolean;
  110210. REFLECTIONMAP_SKYBOX: boolean;
  110211. REFLECTIONMAP_EXPLICIT: boolean;
  110212. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110213. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110214. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110215. INVERTCUBICMAP: boolean;
  110216. LOGARITHMICDEPTH: boolean;
  110217. REFRACTION: boolean;
  110218. REFRACTIONMAP_3D: boolean;
  110219. REFLECTIONOVERALPHA: boolean;
  110220. TWOSIDEDLIGHTING: boolean;
  110221. SHADOWFLOAT: boolean;
  110222. MORPHTARGETS: boolean;
  110223. MORPHTARGETS_NORMAL: boolean;
  110224. MORPHTARGETS_TANGENT: boolean;
  110225. MORPHTARGETS_UV: boolean;
  110226. NUM_MORPH_INFLUENCERS: number;
  110227. NONUNIFORMSCALING: boolean;
  110228. PREMULTIPLYALPHA: boolean;
  110229. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110230. ALPHABLEND: boolean;
  110231. PREPASS: boolean;
  110232. SCENE_MRT_COUNT: number;
  110233. RGBDLIGHTMAP: boolean;
  110234. RGBDREFLECTION: boolean;
  110235. RGBDREFRACTION: boolean;
  110236. IMAGEPROCESSING: boolean;
  110237. VIGNETTE: boolean;
  110238. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110239. VIGNETTEBLENDMODEOPAQUE: boolean;
  110240. TONEMAPPING: boolean;
  110241. TONEMAPPING_ACES: boolean;
  110242. CONTRAST: boolean;
  110243. COLORCURVES: boolean;
  110244. COLORGRADING: boolean;
  110245. COLORGRADING3D: boolean;
  110246. SAMPLER3DGREENDEPTH: boolean;
  110247. SAMPLER3DBGRMAP: boolean;
  110248. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110249. MULTIVIEW: boolean;
  110250. /**
  110251. * If the reflection texture on this material is in linear color space
  110252. * @hidden
  110253. */
  110254. IS_REFLECTION_LINEAR: boolean;
  110255. /**
  110256. * If the refraction texture on this material is in linear color space
  110257. * @hidden
  110258. */
  110259. IS_REFRACTION_LINEAR: boolean;
  110260. EXPOSURE: boolean;
  110261. constructor();
  110262. setReflectionMode(modeToEnable: string): void;
  110263. }
  110264. /**
  110265. * This is the default material used in Babylon. It is the best trade off between quality
  110266. * and performances.
  110267. * @see https://doc.babylonjs.com/babylon101/materials
  110268. */
  110269. export class StandardMaterial extends PushMaterial {
  110270. private _diffuseTexture;
  110271. /**
  110272. * The basic texture of the material as viewed under a light.
  110273. */
  110274. diffuseTexture: Nullable<BaseTexture>;
  110275. private _ambientTexture;
  110276. /**
  110277. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110278. */
  110279. ambientTexture: Nullable<BaseTexture>;
  110280. private _opacityTexture;
  110281. /**
  110282. * Define the transparency of the material from a texture.
  110283. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110284. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110285. */
  110286. opacityTexture: Nullable<BaseTexture>;
  110287. private _reflectionTexture;
  110288. /**
  110289. * Define the texture used to display the reflection.
  110290. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110291. */
  110292. reflectionTexture: Nullable<BaseTexture>;
  110293. private _emissiveTexture;
  110294. /**
  110295. * Define texture of the material as if self lit.
  110296. * This will be mixed in the final result even in the absence of light.
  110297. */
  110298. emissiveTexture: Nullable<BaseTexture>;
  110299. private _specularTexture;
  110300. /**
  110301. * Define how the color and intensity of the highlight given by the light in the material.
  110302. */
  110303. specularTexture: Nullable<BaseTexture>;
  110304. private _bumpTexture;
  110305. /**
  110306. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110307. * 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.
  110308. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110309. */
  110310. bumpTexture: Nullable<BaseTexture>;
  110311. private _lightmapTexture;
  110312. /**
  110313. * Complex lighting can be computationally expensive to compute at runtime.
  110314. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110315. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110316. */
  110317. lightmapTexture: Nullable<BaseTexture>;
  110318. private _refractionTexture;
  110319. /**
  110320. * Define the texture used to display the refraction.
  110321. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110322. */
  110323. refractionTexture: Nullable<BaseTexture>;
  110324. /**
  110325. * The color of the material lit by the environmental background lighting.
  110326. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110327. */
  110328. ambientColor: Color3;
  110329. /**
  110330. * The basic color of the material as viewed under a light.
  110331. */
  110332. diffuseColor: Color3;
  110333. /**
  110334. * Define how the color and intensity of the highlight given by the light in the material.
  110335. */
  110336. specularColor: Color3;
  110337. /**
  110338. * Define the color of the material as if self lit.
  110339. * This will be mixed in the final result even in the absence of light.
  110340. */
  110341. emissiveColor: Color3;
  110342. /**
  110343. * Defines how sharp are the highlights in the material.
  110344. * The bigger the value the sharper giving a more glossy feeling to the result.
  110345. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110346. */
  110347. specularPower: number;
  110348. private _useAlphaFromDiffuseTexture;
  110349. /**
  110350. * Does the transparency come from the diffuse texture alpha channel.
  110351. */
  110352. useAlphaFromDiffuseTexture: boolean;
  110353. private _useEmissiveAsIllumination;
  110354. /**
  110355. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110356. */
  110357. useEmissiveAsIllumination: boolean;
  110358. private _linkEmissiveWithDiffuse;
  110359. /**
  110360. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110361. * the emissive level when the final color is close to one.
  110362. */
  110363. linkEmissiveWithDiffuse: boolean;
  110364. private _useSpecularOverAlpha;
  110365. /**
  110366. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110367. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110368. */
  110369. useSpecularOverAlpha: boolean;
  110370. private _useReflectionOverAlpha;
  110371. /**
  110372. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110373. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110374. */
  110375. useReflectionOverAlpha: boolean;
  110376. private _disableLighting;
  110377. /**
  110378. * Does lights from the scene impacts this material.
  110379. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110380. */
  110381. disableLighting: boolean;
  110382. private _useObjectSpaceNormalMap;
  110383. /**
  110384. * Allows using an object space normal map (instead of tangent space).
  110385. */
  110386. useObjectSpaceNormalMap: boolean;
  110387. private _useParallax;
  110388. /**
  110389. * Is parallax enabled or not.
  110390. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110391. */
  110392. useParallax: boolean;
  110393. private _useParallaxOcclusion;
  110394. /**
  110395. * Is parallax occlusion enabled or not.
  110396. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110397. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110398. */
  110399. useParallaxOcclusion: boolean;
  110400. /**
  110401. * 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.
  110402. */
  110403. parallaxScaleBias: number;
  110404. private _roughness;
  110405. /**
  110406. * Helps to define how blurry the reflections should appears in the material.
  110407. */
  110408. roughness: number;
  110409. /**
  110410. * In case of refraction, define the value of the index of refraction.
  110411. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110412. */
  110413. indexOfRefraction: number;
  110414. /**
  110415. * Invert the refraction texture alongside the y axis.
  110416. * It can be useful with procedural textures or probe for instance.
  110417. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110418. */
  110419. invertRefractionY: boolean;
  110420. /**
  110421. * Defines the alpha limits in alpha test mode.
  110422. */
  110423. alphaCutOff: number;
  110424. private _useLightmapAsShadowmap;
  110425. /**
  110426. * In case of light mapping, define whether the map contains light or shadow informations.
  110427. */
  110428. useLightmapAsShadowmap: boolean;
  110429. private _diffuseFresnelParameters;
  110430. /**
  110431. * Define the diffuse fresnel parameters of the material.
  110432. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110433. */
  110434. diffuseFresnelParameters: FresnelParameters;
  110435. private _opacityFresnelParameters;
  110436. /**
  110437. * Define the opacity fresnel parameters of the material.
  110438. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110439. */
  110440. opacityFresnelParameters: FresnelParameters;
  110441. private _reflectionFresnelParameters;
  110442. /**
  110443. * Define the reflection fresnel parameters of the material.
  110444. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110445. */
  110446. reflectionFresnelParameters: FresnelParameters;
  110447. private _refractionFresnelParameters;
  110448. /**
  110449. * Define the refraction fresnel parameters of the material.
  110450. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110451. */
  110452. refractionFresnelParameters: FresnelParameters;
  110453. private _emissiveFresnelParameters;
  110454. /**
  110455. * Define the emissive fresnel parameters of the material.
  110456. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110457. */
  110458. emissiveFresnelParameters: FresnelParameters;
  110459. private _useReflectionFresnelFromSpecular;
  110460. /**
  110461. * If true automatically deducts the fresnels values from the material specularity.
  110462. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110463. */
  110464. useReflectionFresnelFromSpecular: boolean;
  110465. private _useGlossinessFromSpecularMapAlpha;
  110466. /**
  110467. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110468. */
  110469. useGlossinessFromSpecularMapAlpha: boolean;
  110470. private _maxSimultaneousLights;
  110471. /**
  110472. * Defines the maximum number of lights that can be used in the material
  110473. */
  110474. maxSimultaneousLights: number;
  110475. private _invertNormalMapX;
  110476. /**
  110477. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110478. */
  110479. invertNormalMapX: boolean;
  110480. private _invertNormalMapY;
  110481. /**
  110482. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110483. */
  110484. invertNormalMapY: boolean;
  110485. private _twoSidedLighting;
  110486. /**
  110487. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110488. */
  110489. twoSidedLighting: boolean;
  110490. /**
  110491. * Default configuration related to image processing available in the standard Material.
  110492. */
  110493. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110494. /**
  110495. * Gets the image processing configuration used either in this material.
  110496. */
  110497. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110498. /**
  110499. * Sets the Default image processing configuration used either in the this material.
  110500. *
  110501. * If sets to null, the scene one is in use.
  110502. */
  110503. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110504. /**
  110505. * Keep track of the image processing observer to allow dispose and replace.
  110506. */
  110507. private _imageProcessingObserver;
  110508. /**
  110509. * Attaches a new image processing configuration to the Standard Material.
  110510. * @param configuration
  110511. */
  110512. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110513. /**
  110514. * Gets wether the color curves effect is enabled.
  110515. */
  110516. get cameraColorCurvesEnabled(): boolean;
  110517. /**
  110518. * Sets wether the color curves effect is enabled.
  110519. */
  110520. set cameraColorCurvesEnabled(value: boolean);
  110521. /**
  110522. * Gets wether the color grading effect is enabled.
  110523. */
  110524. get cameraColorGradingEnabled(): boolean;
  110525. /**
  110526. * Gets wether the color grading effect is enabled.
  110527. */
  110528. set cameraColorGradingEnabled(value: boolean);
  110529. /**
  110530. * Gets wether tonemapping is enabled or not.
  110531. */
  110532. get cameraToneMappingEnabled(): boolean;
  110533. /**
  110534. * Sets wether tonemapping is enabled or not
  110535. */
  110536. set cameraToneMappingEnabled(value: boolean);
  110537. /**
  110538. * The camera exposure used on this material.
  110539. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110540. * This corresponds to a photographic exposure.
  110541. */
  110542. get cameraExposure(): number;
  110543. /**
  110544. * The camera exposure used on this material.
  110545. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110546. * This corresponds to a photographic exposure.
  110547. */
  110548. set cameraExposure(value: number);
  110549. /**
  110550. * Gets The camera contrast used on this material.
  110551. */
  110552. get cameraContrast(): number;
  110553. /**
  110554. * Sets The camera contrast used on this material.
  110555. */
  110556. set cameraContrast(value: number);
  110557. /**
  110558. * Gets the Color Grading 2D Lookup Texture.
  110559. */
  110560. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110561. /**
  110562. * Sets the Color Grading 2D Lookup Texture.
  110563. */
  110564. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110565. /**
  110566. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110567. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110568. * 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;
  110569. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110570. */
  110571. get cameraColorCurves(): Nullable<ColorCurves>;
  110572. /**
  110573. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110574. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110575. * 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;
  110576. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110577. */
  110578. set cameraColorCurves(value: Nullable<ColorCurves>);
  110579. /**
  110580. * Can this material render to several textures at once
  110581. */
  110582. get canRenderToMRT(): boolean;
  110583. /**
  110584. * Defines the detail map parameters for the material.
  110585. */
  110586. readonly detailMap: DetailMapConfiguration;
  110587. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110588. protected _worldViewProjectionMatrix: Matrix;
  110589. protected _globalAmbientColor: Color3;
  110590. protected _useLogarithmicDepth: boolean;
  110591. protected _rebuildInParallel: boolean;
  110592. /**
  110593. * Instantiates a new standard material.
  110594. * This is the default material used in Babylon. It is the best trade off between quality
  110595. * and performances.
  110596. * @see https://doc.babylonjs.com/babylon101/materials
  110597. * @param name Define the name of the material in the scene
  110598. * @param scene Define the scene the material belong to
  110599. */
  110600. constructor(name: string, scene: Scene);
  110601. /**
  110602. * Gets a boolean indicating that current material needs to register RTT
  110603. */
  110604. get hasRenderTargetTextures(): boolean;
  110605. /**
  110606. * Gets the current class name of the material e.g. "StandardMaterial"
  110607. * Mainly use in serialization.
  110608. * @returns the class name
  110609. */
  110610. getClassName(): string;
  110611. /**
  110612. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110613. * You can try switching to logarithmic depth.
  110614. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110615. */
  110616. get useLogarithmicDepth(): boolean;
  110617. set useLogarithmicDepth(value: boolean);
  110618. /**
  110619. * Specifies if the material will require alpha blending
  110620. * @returns a boolean specifying if alpha blending is needed
  110621. */
  110622. needAlphaBlending(): boolean;
  110623. /**
  110624. * Specifies if this material should be rendered in alpha test mode
  110625. * @returns a boolean specifying if an alpha test is needed.
  110626. */
  110627. needAlphaTesting(): boolean;
  110628. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110629. /**
  110630. * Get the texture used for alpha test purpose.
  110631. * @returns the diffuse texture in case of the standard material.
  110632. */
  110633. getAlphaTestTexture(): Nullable<BaseTexture>;
  110634. /**
  110635. * Get if the submesh is ready to be used and all its information available.
  110636. * Child classes can use it to update shaders
  110637. * @param mesh defines the mesh to check
  110638. * @param subMesh defines which submesh to check
  110639. * @param useInstances specifies that instances should be used
  110640. * @returns a boolean indicating that the submesh is ready or not
  110641. */
  110642. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110643. /**
  110644. * Builds the material UBO layouts.
  110645. * Used internally during the effect preparation.
  110646. */
  110647. buildUniformLayout(): void;
  110648. /**
  110649. * Unbinds the material from the mesh
  110650. */
  110651. unbind(): void;
  110652. /**
  110653. * Binds the submesh to this material by preparing the effect and shader to draw
  110654. * @param world defines the world transformation matrix
  110655. * @param mesh defines the mesh containing the submesh
  110656. * @param subMesh defines the submesh to bind the material to
  110657. */
  110658. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110659. /**
  110660. * Get the list of animatables in the material.
  110661. * @returns the list of animatables object used in the material
  110662. */
  110663. getAnimatables(): IAnimatable[];
  110664. /**
  110665. * Gets the active textures from the material
  110666. * @returns an array of textures
  110667. */
  110668. getActiveTextures(): BaseTexture[];
  110669. /**
  110670. * Specifies if the material uses a texture
  110671. * @param texture defines the texture to check against the material
  110672. * @returns a boolean specifying if the material uses the texture
  110673. */
  110674. hasTexture(texture: BaseTexture): boolean;
  110675. /**
  110676. * Disposes the material
  110677. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110678. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110679. */
  110680. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110681. /**
  110682. * Makes a duplicate of the material, and gives it a new name
  110683. * @param name defines the new name for the duplicated material
  110684. * @returns the cloned material
  110685. */
  110686. clone(name: string): StandardMaterial;
  110687. /**
  110688. * Serializes this material in a JSON representation
  110689. * @returns the serialized material object
  110690. */
  110691. serialize(): any;
  110692. /**
  110693. * Creates a standard material from parsed material data
  110694. * @param source defines the JSON representation of the material
  110695. * @param scene defines the hosting scene
  110696. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110697. * @returns a new standard material
  110698. */
  110699. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110700. /**
  110701. * Are diffuse textures enabled in the application.
  110702. */
  110703. static get DiffuseTextureEnabled(): boolean;
  110704. static set DiffuseTextureEnabled(value: boolean);
  110705. /**
  110706. * Are detail textures enabled in the application.
  110707. */
  110708. static get DetailTextureEnabled(): boolean;
  110709. static set DetailTextureEnabled(value: boolean);
  110710. /**
  110711. * Are ambient textures enabled in the application.
  110712. */
  110713. static get AmbientTextureEnabled(): boolean;
  110714. static set AmbientTextureEnabled(value: boolean);
  110715. /**
  110716. * Are opacity textures enabled in the application.
  110717. */
  110718. static get OpacityTextureEnabled(): boolean;
  110719. static set OpacityTextureEnabled(value: boolean);
  110720. /**
  110721. * Are reflection textures enabled in the application.
  110722. */
  110723. static get ReflectionTextureEnabled(): boolean;
  110724. static set ReflectionTextureEnabled(value: boolean);
  110725. /**
  110726. * Are emissive textures enabled in the application.
  110727. */
  110728. static get EmissiveTextureEnabled(): boolean;
  110729. static set EmissiveTextureEnabled(value: boolean);
  110730. /**
  110731. * Are specular textures enabled in the application.
  110732. */
  110733. static get SpecularTextureEnabled(): boolean;
  110734. static set SpecularTextureEnabled(value: boolean);
  110735. /**
  110736. * Are bump textures enabled in the application.
  110737. */
  110738. static get BumpTextureEnabled(): boolean;
  110739. static set BumpTextureEnabled(value: boolean);
  110740. /**
  110741. * Are lightmap textures enabled in the application.
  110742. */
  110743. static get LightmapTextureEnabled(): boolean;
  110744. static set LightmapTextureEnabled(value: boolean);
  110745. /**
  110746. * Are refraction textures enabled in the application.
  110747. */
  110748. static get RefractionTextureEnabled(): boolean;
  110749. static set RefractionTextureEnabled(value: boolean);
  110750. /**
  110751. * Are color grading textures enabled in the application.
  110752. */
  110753. static get ColorGradingTextureEnabled(): boolean;
  110754. static set ColorGradingTextureEnabled(value: boolean);
  110755. /**
  110756. * Are fresnels enabled in the application.
  110757. */
  110758. static get FresnelEnabled(): boolean;
  110759. static set FresnelEnabled(value: boolean);
  110760. }
  110761. }
  110762. declare module BABYLON {
  110763. /**
  110764. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110765. *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.
  110766. * The SPS is also a particle system. It provides some methods to manage the particles.
  110767. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110768. *
  110769. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110770. */
  110771. export class SolidParticleSystem implements IDisposable {
  110772. /**
  110773. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110774. * Example : var p = SPS.particles[i];
  110775. */
  110776. particles: SolidParticle[];
  110777. /**
  110778. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110779. */
  110780. nbParticles: number;
  110781. /**
  110782. * If the particles must ever face the camera (default false). Useful for planar particles.
  110783. */
  110784. billboard: boolean;
  110785. /**
  110786. * Recompute normals when adding a shape
  110787. */
  110788. recomputeNormals: boolean;
  110789. /**
  110790. * This a counter ofr your own usage. It's not set by any SPS functions.
  110791. */
  110792. counter: number;
  110793. /**
  110794. * The SPS name. This name is also given to the underlying mesh.
  110795. */
  110796. name: string;
  110797. /**
  110798. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110799. */
  110800. mesh: Mesh;
  110801. /**
  110802. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110803. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110804. */
  110805. vars: any;
  110806. /**
  110807. * This array is populated when the SPS is set as 'pickable'.
  110808. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110809. * Each element of this array is an object `{idx: int, faceId: int}`.
  110810. * `idx` is the picked particle index in the `SPS.particles` array
  110811. * `faceId` is the picked face index counted within this particle.
  110812. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110813. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110814. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110815. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110816. */
  110817. pickedParticles: {
  110818. idx: number;
  110819. faceId: number;
  110820. }[];
  110821. /**
  110822. * This array is populated when the SPS is set as 'pickable'
  110823. * Each key of this array is a submesh index.
  110824. * Each element of this array is a second array defined like this :
  110825. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110826. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110827. * `idx` is the picked particle index in the `SPS.particles` array
  110828. * `faceId` is the picked face index counted within this particle.
  110829. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110830. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110831. */
  110832. pickedBySubMesh: {
  110833. idx: number;
  110834. faceId: number;
  110835. }[][];
  110836. /**
  110837. * This array is populated when `enableDepthSort` is set to true.
  110838. * Each element of this array is an instance of the class DepthSortedParticle.
  110839. */
  110840. depthSortedParticles: DepthSortedParticle[];
  110841. /**
  110842. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110843. * @hidden
  110844. */
  110845. _bSphereOnly: boolean;
  110846. /**
  110847. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110848. * @hidden
  110849. */
  110850. _bSphereRadiusFactor: number;
  110851. private _scene;
  110852. private _positions;
  110853. private _indices;
  110854. private _normals;
  110855. private _colors;
  110856. private _uvs;
  110857. private _indices32;
  110858. private _positions32;
  110859. private _normals32;
  110860. private _fixedNormal32;
  110861. private _colors32;
  110862. private _uvs32;
  110863. private _index;
  110864. private _updatable;
  110865. private _pickable;
  110866. private _isVisibilityBoxLocked;
  110867. private _alwaysVisible;
  110868. private _depthSort;
  110869. private _expandable;
  110870. private _shapeCounter;
  110871. private _copy;
  110872. private _color;
  110873. private _computeParticleColor;
  110874. private _computeParticleTexture;
  110875. private _computeParticleRotation;
  110876. private _computeParticleVertex;
  110877. private _computeBoundingBox;
  110878. private _depthSortParticles;
  110879. private _camera;
  110880. private _mustUnrotateFixedNormals;
  110881. private _particlesIntersect;
  110882. private _needs32Bits;
  110883. private _isNotBuilt;
  110884. private _lastParticleId;
  110885. private _idxOfId;
  110886. private _multimaterialEnabled;
  110887. private _useModelMaterial;
  110888. private _indicesByMaterial;
  110889. private _materialIndexes;
  110890. private _depthSortFunction;
  110891. private _materialSortFunction;
  110892. private _materials;
  110893. private _multimaterial;
  110894. private _materialIndexesById;
  110895. private _defaultMaterial;
  110896. private _autoUpdateSubMeshes;
  110897. private _tmpVertex;
  110898. /**
  110899. * Creates a SPS (Solid Particle System) object.
  110900. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110901. * @param scene (Scene) is the scene in which the SPS is added.
  110902. * @param options defines the options of the sps e.g.
  110903. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110904. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110905. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110906. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  110907. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110908. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110909. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110910. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110911. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110912. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110913. */
  110914. constructor(name: string, scene: Scene, options?: {
  110915. updatable?: boolean;
  110916. isPickable?: boolean;
  110917. enableDepthSort?: boolean;
  110918. particleIntersection?: boolean;
  110919. boundingSphereOnly?: boolean;
  110920. bSphereRadiusFactor?: number;
  110921. expandable?: boolean;
  110922. useModelMaterial?: boolean;
  110923. enableMultiMaterial?: boolean;
  110924. });
  110925. /**
  110926. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110927. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110928. * @returns the created mesh
  110929. */
  110930. buildMesh(): Mesh;
  110931. /**
  110932. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110933. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110934. * Thus the particles generated from `digest()` have their property `position` set yet.
  110935. * @param mesh ( Mesh ) is the mesh to be digested
  110936. * @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
  110937. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110938. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110939. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110940. * @returns the current SPS
  110941. */
  110942. digest(mesh: Mesh, options?: {
  110943. facetNb?: number;
  110944. number?: number;
  110945. delta?: number;
  110946. storage?: [];
  110947. }): SolidParticleSystem;
  110948. /**
  110949. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110950. * @hidden
  110951. */
  110952. private _unrotateFixedNormals;
  110953. /**
  110954. * Resets the temporary working copy particle
  110955. * @hidden
  110956. */
  110957. private _resetCopy;
  110958. /**
  110959. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110960. * @param p the current index in the positions array to be updated
  110961. * @param ind the current index in the indices array
  110962. * @param shape a Vector3 array, the shape geometry
  110963. * @param positions the positions array to be updated
  110964. * @param meshInd the shape indices array
  110965. * @param indices the indices array to be updated
  110966. * @param meshUV the shape uv array
  110967. * @param uvs the uv array to be updated
  110968. * @param meshCol the shape color array
  110969. * @param colors the color array to be updated
  110970. * @param meshNor the shape normals array
  110971. * @param normals the normals array to be updated
  110972. * @param idx the particle index
  110973. * @param idxInShape the particle index in its shape
  110974. * @param options the addShape() method passed options
  110975. * @model the particle model
  110976. * @hidden
  110977. */
  110978. private _meshBuilder;
  110979. /**
  110980. * Returns a shape Vector3 array from positions float array
  110981. * @param positions float array
  110982. * @returns a vector3 array
  110983. * @hidden
  110984. */
  110985. private _posToShape;
  110986. /**
  110987. * Returns a shapeUV array from a float uvs (array deep copy)
  110988. * @param uvs as a float array
  110989. * @returns a shapeUV array
  110990. * @hidden
  110991. */
  110992. private _uvsToShapeUV;
  110993. /**
  110994. * Adds a new particle object in the particles array
  110995. * @param idx particle index in particles array
  110996. * @param id particle id
  110997. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110998. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110999. * @param model particle ModelShape object
  111000. * @param shapeId model shape identifier
  111001. * @param idxInShape index of the particle in the current model
  111002. * @param bInfo model bounding info object
  111003. * @param storage target storage array, if any
  111004. * @hidden
  111005. */
  111006. private _addParticle;
  111007. /**
  111008. * Adds some particles to the SPS from the model shape. Returns the shape id.
  111009. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  111010. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  111011. * @param nb (positive integer) the number of particles to be created from this model
  111012. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  111013. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  111014. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111015. * @returns the number of shapes in the system
  111016. */
  111017. addShape(mesh: Mesh, nb: number, options?: {
  111018. positionFunction?: any;
  111019. vertexFunction?: any;
  111020. storage?: [];
  111021. }): number;
  111022. /**
  111023. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  111024. * @hidden
  111025. */
  111026. private _rebuildParticle;
  111027. /**
  111028. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  111029. * @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.
  111030. * @returns the SPS.
  111031. */
  111032. rebuildMesh(reset?: boolean): SolidParticleSystem;
  111033. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  111034. * Returns an array with the removed particles.
  111035. * 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.
  111036. * The SPS can't be empty so at least one particle needs to remain in place.
  111037. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  111038. * @param start index of the first particle to remove
  111039. * @param end index of the last particle to remove (included)
  111040. * @returns an array populated with the removed particles
  111041. */
  111042. removeParticles(start: number, end: number): SolidParticle[];
  111043. /**
  111044. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  111045. * @param solidParticleArray an array populated with Solid Particles objects
  111046. * @returns the SPS
  111047. */
  111048. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  111049. /**
  111050. * Creates a new particle and modifies the SPS mesh geometry :
  111051. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  111052. * - calls _addParticle() to populate the particle array
  111053. * factorized code from addShape() and insertParticlesFromArray()
  111054. * @param idx particle index in the particles array
  111055. * @param i particle index in its shape
  111056. * @param modelShape particle ModelShape object
  111057. * @param shape shape vertex array
  111058. * @param meshInd shape indices array
  111059. * @param meshUV shape uv array
  111060. * @param meshCol shape color array
  111061. * @param meshNor shape normals array
  111062. * @param bbInfo shape bounding info
  111063. * @param storage target particle storage
  111064. * @options addShape() passed options
  111065. * @hidden
  111066. */
  111067. private _insertNewParticle;
  111068. /**
  111069. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  111070. * This method calls `updateParticle()` for each particle of the SPS.
  111071. * For an animated SPS, it is usually called within the render loop.
  111072. * 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.
  111073. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  111074. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  111075. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  111076. * @returns the SPS.
  111077. */
  111078. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  111079. /**
  111080. * Disposes the SPS.
  111081. */
  111082. dispose(): void;
  111083. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  111084. * idx is the particle index in the SPS
  111085. * faceId is the picked face index counted within this particle.
  111086. * Returns null if the pickInfo can't identify a picked particle.
  111087. * @param pickingInfo (PickingInfo object)
  111088. * @returns {idx: number, faceId: number} or null
  111089. */
  111090. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111091. idx: number;
  111092. faceId: number;
  111093. }>;
  111094. /**
  111095. * Returns a SolidParticle object from its identifier : particle.id
  111096. * @param id (integer) the particle Id
  111097. * @returns the searched particle or null if not found in the SPS.
  111098. */
  111099. getParticleById(id: number): Nullable<SolidParticle>;
  111100. /**
  111101. * Returns a new array populated with the particles having the passed shapeId.
  111102. * @param shapeId (integer) the shape identifier
  111103. * @returns a new solid particle array
  111104. */
  111105. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111106. /**
  111107. * Populates the passed array "ref" with the particles having the passed shapeId.
  111108. * @param shapeId the shape identifier
  111109. * @returns the SPS
  111110. * @param ref
  111111. */
  111112. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111113. /**
  111114. * Computes the required SubMeshes according the materials assigned to the particles.
  111115. * @returns the solid particle system.
  111116. * Does nothing if called before the SPS mesh is built.
  111117. */
  111118. computeSubMeshes(): SolidParticleSystem;
  111119. /**
  111120. * Sorts the solid particles by material when MultiMaterial is enabled.
  111121. * Updates the indices32 array.
  111122. * Updates the indicesByMaterial array.
  111123. * Updates the mesh indices array.
  111124. * @returns the SPS
  111125. * @hidden
  111126. */
  111127. private _sortParticlesByMaterial;
  111128. /**
  111129. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111130. * @hidden
  111131. */
  111132. private _setMaterialIndexesById;
  111133. /**
  111134. * Returns an array with unique values of Materials from the passed array
  111135. * @param array the material array to be checked and filtered
  111136. * @hidden
  111137. */
  111138. private _filterUniqueMaterialId;
  111139. /**
  111140. * Sets a new Standard Material as _defaultMaterial if not already set.
  111141. * @hidden
  111142. */
  111143. private _setDefaultMaterial;
  111144. /**
  111145. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111146. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111147. * @returns the SPS.
  111148. */
  111149. refreshVisibleSize(): SolidParticleSystem;
  111150. /**
  111151. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111152. * @param size the size (float) of the visibility box
  111153. * note : this doesn't lock the SPS mesh bounding box.
  111154. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111155. */
  111156. setVisibilityBox(size: number): void;
  111157. /**
  111158. * Gets whether the SPS as always visible or not
  111159. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111160. */
  111161. get isAlwaysVisible(): boolean;
  111162. /**
  111163. * Sets the SPS as always visible or not
  111164. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111165. */
  111166. set isAlwaysVisible(val: boolean);
  111167. /**
  111168. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111169. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111170. */
  111171. set isVisibilityBoxLocked(val: boolean);
  111172. /**
  111173. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111174. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111175. */
  111176. get isVisibilityBoxLocked(): boolean;
  111177. /**
  111178. * Tells to `setParticles()` to compute the particle rotations or not.
  111179. * Default value : true. The SPS is faster when it's set to false.
  111180. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111181. */
  111182. set computeParticleRotation(val: boolean);
  111183. /**
  111184. * Tells to `setParticles()` to compute the particle colors or not.
  111185. * Default value : true. The SPS is faster when it's set to false.
  111186. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111187. */
  111188. set computeParticleColor(val: boolean);
  111189. set computeParticleTexture(val: boolean);
  111190. /**
  111191. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111192. * Default value : false. The SPS is faster when it's set to false.
  111193. * Note : the particle custom vertex positions aren't stored values.
  111194. */
  111195. set computeParticleVertex(val: boolean);
  111196. /**
  111197. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111198. */
  111199. set computeBoundingBox(val: boolean);
  111200. /**
  111201. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111202. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111203. * Default : `true`
  111204. */
  111205. set depthSortParticles(val: boolean);
  111206. /**
  111207. * Gets if `setParticles()` computes the particle rotations or not.
  111208. * Default value : true. The SPS is faster when it's set to false.
  111209. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111210. */
  111211. get computeParticleRotation(): boolean;
  111212. /**
  111213. * Gets if `setParticles()` computes the particle colors or not.
  111214. * Default value : true. The SPS is faster when it's set to false.
  111215. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111216. */
  111217. get computeParticleColor(): boolean;
  111218. /**
  111219. * Gets if `setParticles()` computes the particle textures or not.
  111220. * Default value : true. The SPS is faster when it's set to false.
  111221. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111222. */
  111223. get computeParticleTexture(): boolean;
  111224. /**
  111225. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111226. * Default value : false. The SPS is faster when it's set to false.
  111227. * Note : the particle custom vertex positions aren't stored values.
  111228. */
  111229. get computeParticleVertex(): boolean;
  111230. /**
  111231. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111232. */
  111233. get computeBoundingBox(): boolean;
  111234. /**
  111235. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111236. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111237. * Default : `true`
  111238. */
  111239. get depthSortParticles(): boolean;
  111240. /**
  111241. * Gets if the SPS is created as expandable at construction time.
  111242. * Default : `false`
  111243. */
  111244. get expandable(): boolean;
  111245. /**
  111246. * Gets if the SPS supports the Multi Materials
  111247. */
  111248. get multimaterialEnabled(): boolean;
  111249. /**
  111250. * Gets if the SPS uses the model materials for its own multimaterial.
  111251. */
  111252. get useModelMaterial(): boolean;
  111253. /**
  111254. * The SPS used material array.
  111255. */
  111256. get materials(): Material[];
  111257. /**
  111258. * Sets the SPS MultiMaterial from the passed materials.
  111259. * Note : the passed array is internally copied and not used then by reference.
  111260. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111261. */
  111262. setMultiMaterial(materials: Material[]): void;
  111263. /**
  111264. * The SPS computed multimaterial object
  111265. */
  111266. get multimaterial(): MultiMaterial;
  111267. set multimaterial(mm: MultiMaterial);
  111268. /**
  111269. * If the subMeshes must be updated on the next call to setParticles()
  111270. */
  111271. get autoUpdateSubMeshes(): boolean;
  111272. set autoUpdateSubMeshes(val: boolean);
  111273. /**
  111274. * This function does nothing. It may be overwritten to set all the particle first values.
  111275. * The SPS doesn't call this function, you may have to call it by your own.
  111276. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111277. */
  111278. initParticles(): void;
  111279. /**
  111280. * This function does nothing. It may be overwritten to recycle a particle.
  111281. * The SPS doesn't call this function, you may have to call it by your own.
  111282. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111283. * @param particle The particle to recycle
  111284. * @returns the recycled particle
  111285. */
  111286. recycleParticle(particle: SolidParticle): SolidParticle;
  111287. /**
  111288. * Updates a particle : this function should be overwritten by the user.
  111289. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111290. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111291. * @example : just set a particle position or velocity and recycle conditions
  111292. * @param particle The particle to update
  111293. * @returns the updated particle
  111294. */
  111295. updateParticle(particle: SolidParticle): SolidParticle;
  111296. /**
  111297. * Updates a vertex of a particle : it can be overwritten by the user.
  111298. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111299. * @param particle the current particle
  111300. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111301. * @param pt the index of the current vertex in the particle shape
  111302. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111303. * @example : just set a vertex particle position or color
  111304. * @returns the sps
  111305. */
  111306. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111307. /**
  111308. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111309. * This does nothing and may be overwritten by the user.
  111310. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111311. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111312. * @param update the boolean update value actually passed to setParticles()
  111313. */
  111314. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111315. /**
  111316. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111317. * This will be passed three parameters.
  111318. * This does nothing and may be overwritten by the user.
  111319. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111320. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111321. * @param update the boolean update value actually passed to setParticles()
  111322. */
  111323. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111324. }
  111325. }
  111326. declare module BABYLON {
  111327. /**
  111328. * Represents one particle of a solid particle system.
  111329. */
  111330. export class SolidParticle {
  111331. /**
  111332. * particle global index
  111333. */
  111334. idx: number;
  111335. /**
  111336. * particle identifier
  111337. */
  111338. id: number;
  111339. /**
  111340. * The color of the particle
  111341. */
  111342. color: Nullable<Color4>;
  111343. /**
  111344. * The world space position of the particle.
  111345. */
  111346. position: Vector3;
  111347. /**
  111348. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111349. */
  111350. rotation: Vector3;
  111351. /**
  111352. * The world space rotation quaternion of the particle.
  111353. */
  111354. rotationQuaternion: Nullable<Quaternion>;
  111355. /**
  111356. * The scaling of the particle.
  111357. */
  111358. scaling: Vector3;
  111359. /**
  111360. * The uvs of the particle.
  111361. */
  111362. uvs: Vector4;
  111363. /**
  111364. * The current speed of the particle.
  111365. */
  111366. velocity: Vector3;
  111367. /**
  111368. * The pivot point in the particle local space.
  111369. */
  111370. pivot: Vector3;
  111371. /**
  111372. * Must the particle be translated from its pivot point in its local space ?
  111373. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111374. * Default : false
  111375. */
  111376. translateFromPivot: boolean;
  111377. /**
  111378. * Is the particle active or not ?
  111379. */
  111380. alive: boolean;
  111381. /**
  111382. * Is the particle visible or not ?
  111383. */
  111384. isVisible: boolean;
  111385. /**
  111386. * Index of this particle in the global "positions" array (Internal use)
  111387. * @hidden
  111388. */
  111389. _pos: number;
  111390. /**
  111391. * @hidden Index of this particle in the global "indices" array (Internal use)
  111392. */
  111393. _ind: number;
  111394. /**
  111395. * @hidden ModelShape of this particle (Internal use)
  111396. */
  111397. _model: ModelShape;
  111398. /**
  111399. * ModelShape id of this particle
  111400. */
  111401. shapeId: number;
  111402. /**
  111403. * Index of the particle in its shape id
  111404. */
  111405. idxInShape: number;
  111406. /**
  111407. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111408. */
  111409. _modelBoundingInfo: BoundingInfo;
  111410. /**
  111411. * @hidden Particle BoundingInfo object (Internal use)
  111412. */
  111413. _boundingInfo: BoundingInfo;
  111414. /**
  111415. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111416. */
  111417. _sps: SolidParticleSystem;
  111418. /**
  111419. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111420. */
  111421. _stillInvisible: boolean;
  111422. /**
  111423. * @hidden Last computed particle rotation matrix
  111424. */
  111425. _rotationMatrix: number[];
  111426. /**
  111427. * Parent particle Id, if any.
  111428. * Default null.
  111429. */
  111430. parentId: Nullable<number>;
  111431. /**
  111432. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111433. */
  111434. materialIndex: Nullable<number>;
  111435. /**
  111436. * Custom object or properties.
  111437. */
  111438. props: Nullable<any>;
  111439. /**
  111440. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111441. * The possible values are :
  111442. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111443. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111444. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111445. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111446. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111447. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111448. * */
  111449. cullingStrategy: number;
  111450. /**
  111451. * @hidden Internal global position in the SPS.
  111452. */
  111453. _globalPosition: Vector3;
  111454. /**
  111455. * Creates a Solid Particle object.
  111456. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111457. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111458. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111459. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111460. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111461. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111462. * @param shapeId (integer) is the model shape identifier in the SPS.
  111463. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111464. * @param sps defines the sps it is associated to
  111465. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111466. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111467. */
  111468. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111469. /**
  111470. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111471. * @param target the particle target
  111472. * @returns the current particle
  111473. */
  111474. copyToRef(target: SolidParticle): SolidParticle;
  111475. /**
  111476. * Legacy support, changed scale to scaling
  111477. */
  111478. get scale(): Vector3;
  111479. /**
  111480. * Legacy support, changed scale to scaling
  111481. */
  111482. set scale(scale: Vector3);
  111483. /**
  111484. * Legacy support, changed quaternion to rotationQuaternion
  111485. */
  111486. get quaternion(): Nullable<Quaternion>;
  111487. /**
  111488. * Legacy support, changed quaternion to rotationQuaternion
  111489. */
  111490. set quaternion(q: Nullable<Quaternion>);
  111491. /**
  111492. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111493. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111494. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111495. * @returns true if it intersects
  111496. */
  111497. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111498. /**
  111499. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111500. * A particle is in the frustum if its bounding box intersects the frustum
  111501. * @param frustumPlanes defines the frustum to test
  111502. * @returns true if the particle is in the frustum planes
  111503. */
  111504. isInFrustum(frustumPlanes: Plane[]): boolean;
  111505. /**
  111506. * get the rotation matrix of the particle
  111507. * @hidden
  111508. */
  111509. getRotationMatrix(m: Matrix): void;
  111510. }
  111511. /**
  111512. * Represents the shape of the model used by one particle of a solid particle system.
  111513. * SPS internal tool, don't use it manually.
  111514. */
  111515. export class ModelShape {
  111516. /**
  111517. * The shape id
  111518. * @hidden
  111519. */
  111520. shapeID: number;
  111521. /**
  111522. * flat array of model positions (internal use)
  111523. * @hidden
  111524. */
  111525. _shape: Vector3[];
  111526. /**
  111527. * flat array of model UVs (internal use)
  111528. * @hidden
  111529. */
  111530. _shapeUV: number[];
  111531. /**
  111532. * color array of the model
  111533. * @hidden
  111534. */
  111535. _shapeColors: number[];
  111536. /**
  111537. * indices array of the model
  111538. * @hidden
  111539. */
  111540. _indices: number[];
  111541. /**
  111542. * normals array of the model
  111543. * @hidden
  111544. */
  111545. _normals: number[];
  111546. /**
  111547. * length of the shape in the model indices array (internal use)
  111548. * @hidden
  111549. */
  111550. _indicesLength: number;
  111551. /**
  111552. * Custom position function (internal use)
  111553. * @hidden
  111554. */
  111555. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111556. /**
  111557. * Custom vertex function (internal use)
  111558. * @hidden
  111559. */
  111560. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111561. /**
  111562. * Model material (internal use)
  111563. * @hidden
  111564. */
  111565. _material: Nullable<Material>;
  111566. /**
  111567. * 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.
  111568. * SPS internal tool, don't use it manually.
  111569. * @hidden
  111570. */
  111571. 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>, material: Nullable<Material>);
  111572. }
  111573. /**
  111574. * Represents a Depth Sorted Particle in the solid particle system.
  111575. * @hidden
  111576. */
  111577. export class DepthSortedParticle {
  111578. /**
  111579. * Particle index
  111580. */
  111581. idx: number;
  111582. /**
  111583. * Index of the particle in the "indices" array
  111584. */
  111585. ind: number;
  111586. /**
  111587. * Length of the particle shape in the "indices" array
  111588. */
  111589. indicesLength: number;
  111590. /**
  111591. * Squared distance from the particle to the camera
  111592. */
  111593. sqDistance: number;
  111594. /**
  111595. * Material index when used with MultiMaterials
  111596. */
  111597. materialIndex: number;
  111598. /**
  111599. * Creates a new sorted particle
  111600. * @param materialIndex
  111601. */
  111602. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111603. }
  111604. /**
  111605. * Represents a solid particle vertex
  111606. */
  111607. export class SolidParticleVertex {
  111608. /**
  111609. * Vertex position
  111610. */
  111611. position: Vector3;
  111612. /**
  111613. * Vertex color
  111614. */
  111615. color: Color4;
  111616. /**
  111617. * Vertex UV
  111618. */
  111619. uv: Vector2;
  111620. /**
  111621. * Creates a new solid particle vertex
  111622. */
  111623. constructor();
  111624. /** Vertex x coordinate */
  111625. get x(): number;
  111626. set x(val: number);
  111627. /** Vertex y coordinate */
  111628. get y(): number;
  111629. set y(val: number);
  111630. /** Vertex z coordinate */
  111631. get z(): number;
  111632. set z(val: number);
  111633. }
  111634. }
  111635. declare module BABYLON {
  111636. /**
  111637. * @hidden
  111638. */
  111639. export class _MeshCollisionData {
  111640. _checkCollisions: boolean;
  111641. _collisionMask: number;
  111642. _collisionGroup: number;
  111643. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111644. _collider: Nullable<Collider>;
  111645. _oldPositionForCollisions: Vector3;
  111646. _diffPositionForCollisions: Vector3;
  111647. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111648. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111649. }
  111650. }
  111651. declare module BABYLON {
  111652. /** @hidden */
  111653. class _FacetDataStorage {
  111654. facetPositions: Vector3[];
  111655. facetNormals: Vector3[];
  111656. facetPartitioning: number[][];
  111657. facetNb: number;
  111658. partitioningSubdivisions: number;
  111659. partitioningBBoxRatio: number;
  111660. facetDataEnabled: boolean;
  111661. facetParameters: any;
  111662. bbSize: Vector3;
  111663. subDiv: {
  111664. max: number;
  111665. X: number;
  111666. Y: number;
  111667. Z: number;
  111668. };
  111669. facetDepthSort: boolean;
  111670. facetDepthSortEnabled: boolean;
  111671. depthSortedIndices: IndicesArray;
  111672. depthSortedFacets: {
  111673. ind: number;
  111674. sqDistance: number;
  111675. }[];
  111676. facetDepthSortFunction: (f1: {
  111677. ind: number;
  111678. sqDistance: number;
  111679. }, f2: {
  111680. ind: number;
  111681. sqDistance: number;
  111682. }) => number;
  111683. facetDepthSortFrom: Vector3;
  111684. facetDepthSortOrigin: Vector3;
  111685. invertedMatrix: Matrix;
  111686. }
  111687. /**
  111688. * @hidden
  111689. **/
  111690. class _InternalAbstractMeshDataInfo {
  111691. _hasVertexAlpha: boolean;
  111692. _useVertexColors: boolean;
  111693. _numBoneInfluencers: number;
  111694. _applyFog: boolean;
  111695. _receiveShadows: boolean;
  111696. _facetData: _FacetDataStorage;
  111697. _visibility: number;
  111698. _skeleton: Nullable<Skeleton>;
  111699. _layerMask: number;
  111700. _computeBonesUsingShaders: boolean;
  111701. _isActive: boolean;
  111702. _onlyForInstances: boolean;
  111703. _isActiveIntermediate: boolean;
  111704. _onlyForInstancesIntermediate: boolean;
  111705. _actAsRegularMesh: boolean;
  111706. }
  111707. /**
  111708. * Class used to store all common mesh properties
  111709. */
  111710. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111711. /** No occlusion */
  111712. static OCCLUSION_TYPE_NONE: number;
  111713. /** Occlusion set to optimisitic */
  111714. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111715. /** Occlusion set to strict */
  111716. static OCCLUSION_TYPE_STRICT: number;
  111717. /** Use an accurante occlusion algorithm */
  111718. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111719. /** Use a conservative occlusion algorithm */
  111720. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111721. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111722. * Test order :
  111723. * Is the bounding sphere outside the frustum ?
  111724. * If not, are the bounding box vertices outside the frustum ?
  111725. * It not, then the cullable object is in the frustum.
  111726. */
  111727. static readonly CULLINGSTRATEGY_STANDARD: number;
  111728. /** Culling strategy : Bounding Sphere Only.
  111729. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111730. * It's also less accurate than the standard because some not visible objects can still be selected.
  111731. * Test : is the bounding sphere outside the frustum ?
  111732. * If not, then the cullable object is in the frustum.
  111733. */
  111734. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111735. /** Culling strategy : Optimistic Inclusion.
  111736. * This in an inclusion test first, then the standard exclusion test.
  111737. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111738. * 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.
  111739. * Anyway, it's as accurate as the standard strategy.
  111740. * Test :
  111741. * Is the cullable object bounding sphere center in the frustum ?
  111742. * If not, apply the default culling strategy.
  111743. */
  111744. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111745. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111746. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111747. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111748. * 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.
  111749. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111750. * Test :
  111751. * Is the cullable object bounding sphere center in the frustum ?
  111752. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111753. */
  111754. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111755. /**
  111756. * No billboard
  111757. */
  111758. static get BILLBOARDMODE_NONE(): number;
  111759. /** Billboard on X axis */
  111760. static get BILLBOARDMODE_X(): number;
  111761. /** Billboard on Y axis */
  111762. static get BILLBOARDMODE_Y(): number;
  111763. /** Billboard on Z axis */
  111764. static get BILLBOARDMODE_Z(): number;
  111765. /** Billboard on all axes */
  111766. static get BILLBOARDMODE_ALL(): number;
  111767. /** Billboard on using position instead of orientation */
  111768. static get BILLBOARDMODE_USE_POSITION(): number;
  111769. /** @hidden */
  111770. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111771. /**
  111772. * The culling strategy to use to check whether the mesh must be rendered or not.
  111773. * This value can be changed at any time and will be used on the next render mesh selection.
  111774. * The possible values are :
  111775. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111776. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111777. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111778. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111779. * Please read each static variable documentation to get details about the culling process.
  111780. * */
  111781. cullingStrategy: number;
  111782. /**
  111783. * Gets the number of facets in the mesh
  111784. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111785. */
  111786. get facetNb(): number;
  111787. /**
  111788. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111789. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111790. */
  111791. get partitioningSubdivisions(): number;
  111792. set partitioningSubdivisions(nb: number);
  111793. /**
  111794. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111795. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111796. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111797. */
  111798. get partitioningBBoxRatio(): number;
  111799. set partitioningBBoxRatio(ratio: number);
  111800. /**
  111801. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111802. * Works only for updatable meshes.
  111803. * Doesn't work with multi-materials
  111804. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111805. */
  111806. get mustDepthSortFacets(): boolean;
  111807. set mustDepthSortFacets(sort: boolean);
  111808. /**
  111809. * The location (Vector3) where the facet depth sort must be computed from.
  111810. * By default, the active camera position.
  111811. * Used only when facet depth sort is enabled
  111812. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111813. */
  111814. get facetDepthSortFrom(): Vector3;
  111815. set facetDepthSortFrom(location: Vector3);
  111816. /**
  111817. * gets a boolean indicating if facetData is enabled
  111818. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111819. */
  111820. get isFacetDataEnabled(): boolean;
  111821. /** @hidden */
  111822. _updateNonUniformScalingState(value: boolean): boolean;
  111823. /**
  111824. * An event triggered when this mesh collides with another one
  111825. */
  111826. onCollideObservable: Observable<AbstractMesh>;
  111827. /** Set a function to call when this mesh collides with another one */
  111828. set onCollide(callback: () => void);
  111829. /**
  111830. * An event triggered when the collision's position changes
  111831. */
  111832. onCollisionPositionChangeObservable: Observable<Vector3>;
  111833. /** Set a function to call when the collision's position changes */
  111834. set onCollisionPositionChange(callback: () => void);
  111835. /**
  111836. * An event triggered when material is changed
  111837. */
  111838. onMaterialChangedObservable: Observable<AbstractMesh>;
  111839. /**
  111840. * Gets or sets the orientation for POV movement & rotation
  111841. */
  111842. definedFacingForward: boolean;
  111843. /** @hidden */
  111844. _occlusionQuery: Nullable<WebGLQuery>;
  111845. /** @hidden */
  111846. _renderingGroup: Nullable<RenderingGroup>;
  111847. /**
  111848. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111849. */
  111850. get visibility(): number;
  111851. /**
  111852. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111853. */
  111854. set visibility(value: number);
  111855. /** Gets or sets the alpha index used to sort transparent meshes
  111856. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111857. */
  111858. alphaIndex: number;
  111859. /**
  111860. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111861. */
  111862. isVisible: boolean;
  111863. /**
  111864. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111865. */
  111866. isPickable: boolean;
  111867. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111868. showSubMeshesBoundingBox: boolean;
  111869. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111870. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111871. */
  111872. isBlocker: boolean;
  111873. /**
  111874. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111875. */
  111876. enablePointerMoveEvents: boolean;
  111877. private _renderingGroupId;
  111878. /**
  111879. * Specifies the rendering group id for this mesh (0 by default)
  111880. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111881. */
  111882. get renderingGroupId(): number;
  111883. set renderingGroupId(value: number);
  111884. private _material;
  111885. /** Gets or sets current material */
  111886. get material(): Nullable<Material>;
  111887. set material(value: Nullable<Material>);
  111888. /**
  111889. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111890. * @see https://doc.babylonjs.com/babylon101/shadows
  111891. */
  111892. get receiveShadows(): boolean;
  111893. set receiveShadows(value: boolean);
  111894. /** Defines color to use when rendering outline */
  111895. outlineColor: Color3;
  111896. /** Define width to use when rendering outline */
  111897. outlineWidth: number;
  111898. /** Defines color to use when rendering overlay */
  111899. overlayColor: Color3;
  111900. /** Defines alpha to use when rendering overlay */
  111901. overlayAlpha: number;
  111902. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111903. get hasVertexAlpha(): boolean;
  111904. set hasVertexAlpha(value: boolean);
  111905. /** 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) */
  111906. get useVertexColors(): boolean;
  111907. set useVertexColors(value: boolean);
  111908. /**
  111909. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111910. */
  111911. get computeBonesUsingShaders(): boolean;
  111912. set computeBonesUsingShaders(value: boolean);
  111913. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111914. get numBoneInfluencers(): number;
  111915. set numBoneInfluencers(value: number);
  111916. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111917. get applyFog(): boolean;
  111918. set applyFog(value: boolean);
  111919. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111920. useOctreeForRenderingSelection: boolean;
  111921. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111922. useOctreeForPicking: boolean;
  111923. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111924. useOctreeForCollisions: boolean;
  111925. /**
  111926. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111927. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111928. */
  111929. get layerMask(): number;
  111930. set layerMask(value: number);
  111931. /**
  111932. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111933. */
  111934. alwaysSelectAsActiveMesh: boolean;
  111935. /**
  111936. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111937. */
  111938. doNotSyncBoundingInfo: boolean;
  111939. /**
  111940. * Gets or sets the current action manager
  111941. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111942. */
  111943. actionManager: Nullable<AbstractActionManager>;
  111944. private _meshCollisionData;
  111945. /**
  111946. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111947. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111948. */
  111949. ellipsoid: Vector3;
  111950. /**
  111951. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111952. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111953. */
  111954. ellipsoidOffset: Vector3;
  111955. /**
  111956. * Gets or sets a collision mask used to mask collisions (default is -1).
  111957. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111958. */
  111959. get collisionMask(): number;
  111960. set collisionMask(mask: number);
  111961. /**
  111962. * Gets or sets the current collision group mask (-1 by default).
  111963. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111964. */
  111965. get collisionGroup(): number;
  111966. set collisionGroup(mask: number);
  111967. /**
  111968. * Gets or sets current surrounding meshes (null by default).
  111969. *
  111970. * By default collision detection is tested against every mesh in the scene.
  111971. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111972. * meshes will be tested for the collision.
  111973. *
  111974. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111975. */
  111976. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111977. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111978. /**
  111979. * Defines edge width used when edgesRenderer is enabled
  111980. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111981. */
  111982. edgesWidth: number;
  111983. /**
  111984. * Defines edge color used when edgesRenderer is enabled
  111985. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111986. */
  111987. edgesColor: Color4;
  111988. /** @hidden */
  111989. _edgesRenderer: Nullable<IEdgesRenderer>;
  111990. /** @hidden */
  111991. _masterMesh: Nullable<AbstractMesh>;
  111992. /** @hidden */
  111993. _boundingInfo: Nullable<BoundingInfo>;
  111994. /** @hidden */
  111995. _renderId: number;
  111996. /**
  111997. * Gets or sets the list of subMeshes
  111998. * @see https://doc.babylonjs.com/how_to/multi_materials
  111999. */
  112000. subMeshes: SubMesh[];
  112001. /** @hidden */
  112002. _intersectionsInProgress: AbstractMesh[];
  112003. /** @hidden */
  112004. _unIndexed: boolean;
  112005. /** @hidden */
  112006. _lightSources: Light[];
  112007. /** Gets the list of lights affecting that mesh */
  112008. get lightSources(): Light[];
  112009. /** @hidden */
  112010. get _positions(): Nullable<Vector3[]>;
  112011. /** @hidden */
  112012. _waitingData: {
  112013. lods: Nullable<any>;
  112014. actions: Nullable<any>;
  112015. freezeWorldMatrix: Nullable<boolean>;
  112016. };
  112017. /** @hidden */
  112018. _bonesTransformMatrices: Nullable<Float32Array>;
  112019. /** @hidden */
  112020. _transformMatrixTexture: Nullable<RawTexture>;
  112021. /**
  112022. * Gets or sets a skeleton to apply skining transformations
  112023. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  112024. */
  112025. set skeleton(value: Nullable<Skeleton>);
  112026. get skeleton(): Nullable<Skeleton>;
  112027. /**
  112028. * An event triggered when the mesh is rebuilt.
  112029. */
  112030. onRebuildObservable: Observable<AbstractMesh>;
  112031. /**
  112032. * Creates a new AbstractMesh
  112033. * @param name defines the name of the mesh
  112034. * @param scene defines the hosting scene
  112035. */
  112036. constructor(name: string, scene?: Nullable<Scene>);
  112037. /**
  112038. * Returns the string "AbstractMesh"
  112039. * @returns "AbstractMesh"
  112040. */
  112041. getClassName(): string;
  112042. /**
  112043. * Gets a string representation of the current mesh
  112044. * @param fullDetails defines a boolean indicating if full details must be included
  112045. * @returns a string representation of the current mesh
  112046. */
  112047. toString(fullDetails?: boolean): string;
  112048. /**
  112049. * @hidden
  112050. */
  112051. protected _getEffectiveParent(): Nullable<Node>;
  112052. /** @hidden */
  112053. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112054. /** @hidden */
  112055. _rebuild(): void;
  112056. /** @hidden */
  112057. _resyncLightSources(): void;
  112058. /** @hidden */
  112059. _resyncLightSource(light: Light): void;
  112060. /** @hidden */
  112061. _unBindEffect(): void;
  112062. /** @hidden */
  112063. _removeLightSource(light: Light, dispose: boolean): void;
  112064. private _markSubMeshesAsDirty;
  112065. /** @hidden */
  112066. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  112067. /** @hidden */
  112068. _markSubMeshesAsAttributesDirty(): void;
  112069. /** @hidden */
  112070. _markSubMeshesAsMiscDirty(): void;
  112071. /**
  112072. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  112073. */
  112074. get scaling(): Vector3;
  112075. set scaling(newScaling: Vector3);
  112076. /**
  112077. * Returns true if the mesh is blocked. Implemented by child classes
  112078. */
  112079. get isBlocked(): boolean;
  112080. /**
  112081. * Returns the mesh itself by default. Implemented by child classes
  112082. * @param camera defines the camera to use to pick the right LOD level
  112083. * @returns the currentAbstractMesh
  112084. */
  112085. getLOD(camera: Camera): Nullable<AbstractMesh>;
  112086. /**
  112087. * Returns 0 by default. Implemented by child classes
  112088. * @returns an integer
  112089. */
  112090. getTotalVertices(): number;
  112091. /**
  112092. * Returns a positive integer : the total number of indices in this mesh geometry.
  112093. * @returns the numner of indices or zero if the mesh has no geometry.
  112094. */
  112095. getTotalIndices(): number;
  112096. /**
  112097. * Returns null by default. Implemented by child classes
  112098. * @returns null
  112099. */
  112100. getIndices(): Nullable<IndicesArray>;
  112101. /**
  112102. * Returns the array of the requested vertex data kind. Implemented by child classes
  112103. * @param kind defines the vertex data kind to use
  112104. * @returns null
  112105. */
  112106. getVerticesData(kind: string): Nullable<FloatArray>;
  112107. /**
  112108. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112109. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112110. * Note that a new underlying VertexBuffer object is created each call.
  112111. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112112. * @param kind defines vertex data kind:
  112113. * * VertexBuffer.PositionKind
  112114. * * VertexBuffer.UVKind
  112115. * * VertexBuffer.UV2Kind
  112116. * * VertexBuffer.UV3Kind
  112117. * * VertexBuffer.UV4Kind
  112118. * * VertexBuffer.UV5Kind
  112119. * * VertexBuffer.UV6Kind
  112120. * * VertexBuffer.ColorKind
  112121. * * VertexBuffer.MatricesIndicesKind
  112122. * * VertexBuffer.MatricesIndicesExtraKind
  112123. * * VertexBuffer.MatricesWeightsKind
  112124. * * VertexBuffer.MatricesWeightsExtraKind
  112125. * @param data defines the data source
  112126. * @param updatable defines if the data must be flagged as updatable (or static)
  112127. * @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
  112128. * @returns the current mesh
  112129. */
  112130. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112131. /**
  112132. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112133. * If the mesh has no geometry, it is simply returned as it is.
  112134. * @param kind defines vertex data kind:
  112135. * * VertexBuffer.PositionKind
  112136. * * VertexBuffer.UVKind
  112137. * * VertexBuffer.UV2Kind
  112138. * * VertexBuffer.UV3Kind
  112139. * * VertexBuffer.UV4Kind
  112140. * * VertexBuffer.UV5Kind
  112141. * * VertexBuffer.UV6Kind
  112142. * * VertexBuffer.ColorKind
  112143. * * VertexBuffer.MatricesIndicesKind
  112144. * * VertexBuffer.MatricesIndicesExtraKind
  112145. * * VertexBuffer.MatricesWeightsKind
  112146. * * VertexBuffer.MatricesWeightsExtraKind
  112147. * @param data defines the data source
  112148. * @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
  112149. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112150. * @returns the current mesh
  112151. */
  112152. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112153. /**
  112154. * Sets the mesh indices,
  112155. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112156. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112157. * @param totalVertices Defines the total number of vertices
  112158. * @returns the current mesh
  112159. */
  112160. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112161. /**
  112162. * Gets a boolean indicating if specific vertex data is present
  112163. * @param kind defines the vertex data kind to use
  112164. * @returns true is data kind is present
  112165. */
  112166. isVerticesDataPresent(kind: string): boolean;
  112167. /**
  112168. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112169. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112170. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112171. * @returns a BoundingInfo
  112172. */
  112173. getBoundingInfo(): BoundingInfo;
  112174. /**
  112175. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112176. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112177. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112178. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112179. * @returns the current mesh
  112180. */
  112181. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112182. /**
  112183. * Overwrite the current bounding info
  112184. * @param boundingInfo defines the new bounding info
  112185. * @returns the current mesh
  112186. */
  112187. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112188. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112189. get useBones(): boolean;
  112190. /** @hidden */
  112191. _preActivate(): void;
  112192. /** @hidden */
  112193. _preActivateForIntermediateRendering(renderId: number): void;
  112194. /** @hidden */
  112195. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112196. /** @hidden */
  112197. _postActivate(): void;
  112198. /** @hidden */
  112199. _freeze(): void;
  112200. /** @hidden */
  112201. _unFreeze(): void;
  112202. /**
  112203. * Gets the current world matrix
  112204. * @returns a Matrix
  112205. */
  112206. getWorldMatrix(): Matrix;
  112207. /** @hidden */
  112208. _getWorldMatrixDeterminant(): number;
  112209. /**
  112210. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112211. */
  112212. get isAnInstance(): boolean;
  112213. /**
  112214. * Gets a boolean indicating if this mesh has instances
  112215. */
  112216. get hasInstances(): boolean;
  112217. /**
  112218. * Gets a boolean indicating if this mesh has thin instances
  112219. */
  112220. get hasThinInstances(): boolean;
  112221. /**
  112222. * Perform relative position change from the point of view of behind the front of the mesh.
  112223. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112224. * Supports definition of mesh facing forward or backward
  112225. * @param amountRight defines the distance on the right axis
  112226. * @param amountUp defines the distance on the up axis
  112227. * @param amountForward defines the distance on the forward axis
  112228. * @returns the current mesh
  112229. */
  112230. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112231. /**
  112232. * Calculate relative position change from the point of view of behind the front of the mesh.
  112233. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112234. * Supports definition of mesh facing forward or backward
  112235. * @param amountRight defines the distance on the right axis
  112236. * @param amountUp defines the distance on the up axis
  112237. * @param amountForward defines the distance on the forward axis
  112238. * @returns the new displacement vector
  112239. */
  112240. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112241. /**
  112242. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112243. * Supports definition of mesh facing forward or backward
  112244. * @param flipBack defines the flip
  112245. * @param twirlClockwise defines the twirl
  112246. * @param tiltRight defines the tilt
  112247. * @returns the current mesh
  112248. */
  112249. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112250. /**
  112251. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112252. * Supports definition of mesh facing forward or backward.
  112253. * @param flipBack defines the flip
  112254. * @param twirlClockwise defines the twirl
  112255. * @param tiltRight defines the tilt
  112256. * @returns the new rotation vector
  112257. */
  112258. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112259. /**
  112260. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112261. * This means the mesh underlying bounding box and sphere are recomputed.
  112262. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112263. * @returns the current mesh
  112264. */
  112265. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112266. /** @hidden */
  112267. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112268. /** @hidden */
  112269. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112270. /** @hidden */
  112271. _updateBoundingInfo(): AbstractMesh;
  112272. /** @hidden */
  112273. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112274. /** @hidden */
  112275. protected _afterComputeWorldMatrix(): void;
  112276. /** @hidden */
  112277. get _effectiveMesh(): AbstractMesh;
  112278. /**
  112279. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112280. * A mesh is in the frustum if its bounding box intersects the frustum
  112281. * @param frustumPlanes defines the frustum to test
  112282. * @returns true if the mesh is in the frustum planes
  112283. */
  112284. isInFrustum(frustumPlanes: Plane[]): boolean;
  112285. /**
  112286. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112287. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112288. * @param frustumPlanes defines the frustum to test
  112289. * @returns true if the mesh is completely in the frustum planes
  112290. */
  112291. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112292. /**
  112293. * True if the mesh intersects another mesh or a SolidParticle object
  112294. * @param mesh defines a target mesh or SolidParticle to test
  112295. * @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)
  112296. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112297. * @returns true if there is an intersection
  112298. */
  112299. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112300. /**
  112301. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112302. * @param point defines the point to test
  112303. * @returns true if there is an intersection
  112304. */
  112305. intersectsPoint(point: Vector3): boolean;
  112306. /**
  112307. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112308. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112309. */
  112310. get checkCollisions(): boolean;
  112311. set checkCollisions(collisionEnabled: boolean);
  112312. /**
  112313. * Gets Collider object used to compute collisions (not physics)
  112314. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112315. */
  112316. get collider(): Nullable<Collider>;
  112317. /**
  112318. * Move the mesh using collision engine
  112319. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112320. * @param displacement defines the requested displacement vector
  112321. * @returns the current mesh
  112322. */
  112323. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112324. private _onCollisionPositionChange;
  112325. /** @hidden */
  112326. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112327. /** @hidden */
  112328. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112329. /** @hidden */
  112330. _checkCollision(collider: Collider): AbstractMesh;
  112331. /** @hidden */
  112332. _generatePointsArray(): boolean;
  112333. /**
  112334. * Checks if the passed Ray intersects with the mesh
  112335. * @param ray defines the ray to use
  112336. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112337. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112338. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112339. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112340. * @returns the picking info
  112341. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112342. */
  112343. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112344. /**
  112345. * Clones the current mesh
  112346. * @param name defines the mesh name
  112347. * @param newParent defines the new mesh parent
  112348. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112349. * @returns the new mesh
  112350. */
  112351. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112352. /**
  112353. * Disposes all the submeshes of the current meshnp
  112354. * @returns the current mesh
  112355. */
  112356. releaseSubMeshes(): AbstractMesh;
  112357. /**
  112358. * Releases resources associated with this abstract mesh.
  112359. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112360. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112361. */
  112362. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112363. /**
  112364. * Adds the passed mesh as a child to the current mesh
  112365. * @param mesh defines the child mesh
  112366. * @returns the current mesh
  112367. */
  112368. addChild(mesh: AbstractMesh): AbstractMesh;
  112369. /**
  112370. * Removes the passed mesh from the current mesh children list
  112371. * @param mesh defines the child mesh
  112372. * @returns the current mesh
  112373. */
  112374. removeChild(mesh: AbstractMesh): AbstractMesh;
  112375. /** @hidden */
  112376. private _initFacetData;
  112377. /**
  112378. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112379. * This method can be called within the render loop.
  112380. * 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
  112381. * @returns the current mesh
  112382. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112383. */
  112384. updateFacetData(): AbstractMesh;
  112385. /**
  112386. * Returns the facetLocalNormals array.
  112387. * The normals are expressed in the mesh local spac
  112388. * @returns an array of Vector3
  112389. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112390. */
  112391. getFacetLocalNormals(): Vector3[];
  112392. /**
  112393. * Returns the facetLocalPositions array.
  112394. * The facet positions are expressed in the mesh local space
  112395. * @returns an array of Vector3
  112396. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112397. */
  112398. getFacetLocalPositions(): Vector3[];
  112399. /**
  112400. * Returns the facetLocalPartioning array
  112401. * @returns an array of array of numbers
  112402. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112403. */
  112404. getFacetLocalPartitioning(): number[][];
  112405. /**
  112406. * Returns the i-th facet position in the world system.
  112407. * This method allocates a new Vector3 per call
  112408. * @param i defines the facet index
  112409. * @returns a new Vector3
  112410. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112411. */
  112412. getFacetPosition(i: number): Vector3;
  112413. /**
  112414. * Sets the reference Vector3 with the i-th facet position in the world system
  112415. * @param i defines the facet index
  112416. * @param ref defines the target vector
  112417. * @returns the current mesh
  112418. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112419. */
  112420. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112421. /**
  112422. * Returns the i-th facet normal in the world system.
  112423. * This method allocates a new Vector3 per call
  112424. * @param i defines the facet index
  112425. * @returns a new Vector3
  112426. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112427. */
  112428. getFacetNormal(i: number): Vector3;
  112429. /**
  112430. * Sets the reference Vector3 with the i-th facet normal in the world system
  112431. * @param i defines the facet index
  112432. * @param ref defines the target vector
  112433. * @returns the current mesh
  112434. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112435. */
  112436. getFacetNormalToRef(i: number, ref: Vector3): this;
  112437. /**
  112438. * 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)
  112439. * @param x defines x coordinate
  112440. * @param y defines y coordinate
  112441. * @param z defines z coordinate
  112442. * @returns the array of facet indexes
  112443. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112444. */
  112445. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112446. /**
  112447. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112448. * @param projected sets as the (x,y,z) world projection on the facet
  112449. * @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
  112450. * @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
  112451. * @param x defines x coordinate
  112452. * @param y defines y coordinate
  112453. * @param z defines z coordinate
  112454. * @returns the face index if found (or null instead)
  112455. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112456. */
  112457. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112458. /**
  112459. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112460. * @param projected sets as the (x,y,z) local projection on the facet
  112461. * @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
  112462. * @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
  112463. * @param x defines x coordinate
  112464. * @param y defines y coordinate
  112465. * @param z defines z coordinate
  112466. * @returns the face index if found (or null instead)
  112467. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112468. */
  112469. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112470. /**
  112471. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112472. * @returns the parameters
  112473. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112474. */
  112475. getFacetDataParameters(): any;
  112476. /**
  112477. * Disables the feature FacetData and frees the related memory
  112478. * @returns the current mesh
  112479. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112480. */
  112481. disableFacetData(): AbstractMesh;
  112482. /**
  112483. * Updates the AbstractMesh indices array
  112484. * @param indices defines the data source
  112485. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112486. * @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)
  112487. * @returns the current mesh
  112488. */
  112489. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112490. /**
  112491. * Creates new normals data for the mesh
  112492. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112493. * @returns the current mesh
  112494. */
  112495. createNormals(updatable: boolean): AbstractMesh;
  112496. /**
  112497. * Align the mesh with a normal
  112498. * @param normal defines the normal to use
  112499. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112500. * @returns the current mesh
  112501. */
  112502. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112503. /** @hidden */
  112504. _checkOcclusionQuery(): boolean;
  112505. /**
  112506. * Disables the mesh edge rendering mode
  112507. * @returns the currentAbstractMesh
  112508. */
  112509. disableEdgesRendering(): AbstractMesh;
  112510. /**
  112511. * Enables the edge rendering mode on the mesh.
  112512. * This mode makes the mesh edges visible
  112513. * @param epsilon defines the maximal distance between two angles to detect a face
  112514. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112515. * @returns the currentAbstractMesh
  112516. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112517. */
  112518. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112519. /**
  112520. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112521. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112522. */
  112523. getConnectedParticleSystems(): IParticleSystem[];
  112524. }
  112525. }
  112526. declare module BABYLON {
  112527. /**
  112528. * Interface used to define ActionEvent
  112529. */
  112530. export interface IActionEvent {
  112531. /** The mesh or sprite that triggered the action */
  112532. source: any;
  112533. /** The X mouse cursor position at the time of the event */
  112534. pointerX: number;
  112535. /** The Y mouse cursor position at the time of the event */
  112536. pointerY: number;
  112537. /** The mesh that is currently pointed at (can be null) */
  112538. meshUnderPointer: Nullable<AbstractMesh>;
  112539. /** the original (browser) event that triggered the ActionEvent */
  112540. sourceEvent?: any;
  112541. /** additional data for the event */
  112542. additionalData?: any;
  112543. }
  112544. /**
  112545. * ActionEvent is the event being sent when an action is triggered.
  112546. */
  112547. export class ActionEvent implements IActionEvent {
  112548. /** The mesh or sprite that triggered the action */
  112549. source: any;
  112550. /** The X mouse cursor position at the time of the event */
  112551. pointerX: number;
  112552. /** The Y mouse cursor position at the time of the event */
  112553. pointerY: number;
  112554. /** The mesh that is currently pointed at (can be null) */
  112555. meshUnderPointer: Nullable<AbstractMesh>;
  112556. /** the original (browser) event that triggered the ActionEvent */
  112557. sourceEvent?: any;
  112558. /** additional data for the event */
  112559. additionalData?: any;
  112560. /**
  112561. * Creates a new ActionEvent
  112562. * @param source The mesh or sprite that triggered the action
  112563. * @param pointerX The X mouse cursor position at the time of the event
  112564. * @param pointerY The Y mouse cursor position at the time of the event
  112565. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112566. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112567. * @param additionalData additional data for the event
  112568. */
  112569. constructor(
  112570. /** The mesh or sprite that triggered the action */
  112571. source: any,
  112572. /** The X mouse cursor position at the time of the event */
  112573. pointerX: number,
  112574. /** The Y mouse cursor position at the time of the event */
  112575. pointerY: number,
  112576. /** The mesh that is currently pointed at (can be null) */
  112577. meshUnderPointer: Nullable<AbstractMesh>,
  112578. /** the original (browser) event that triggered the ActionEvent */
  112579. sourceEvent?: any,
  112580. /** additional data for the event */
  112581. additionalData?: any);
  112582. /**
  112583. * Helper function to auto-create an ActionEvent from a source mesh.
  112584. * @param source The source mesh that triggered the event
  112585. * @param evt The original (browser) event
  112586. * @param additionalData additional data for the event
  112587. * @returns the new ActionEvent
  112588. */
  112589. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112590. /**
  112591. * Helper function to auto-create an ActionEvent from a source sprite
  112592. * @param source The source sprite that triggered the event
  112593. * @param scene Scene associated with the sprite
  112594. * @param evt The original (browser) event
  112595. * @param additionalData additional data for the event
  112596. * @returns the new ActionEvent
  112597. */
  112598. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112599. /**
  112600. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112601. * @param scene the scene where the event occurred
  112602. * @param evt The original (browser) event
  112603. * @returns the new ActionEvent
  112604. */
  112605. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112606. /**
  112607. * Helper function to auto-create an ActionEvent from a primitive
  112608. * @param prim defines the target primitive
  112609. * @param pointerPos defines the pointer position
  112610. * @param evt The original (browser) event
  112611. * @param additionalData additional data for the event
  112612. * @returns the new ActionEvent
  112613. */
  112614. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112615. }
  112616. }
  112617. declare module BABYLON {
  112618. /**
  112619. * Abstract class used to decouple action Manager from scene and meshes.
  112620. * Do not instantiate.
  112621. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112622. */
  112623. export abstract class AbstractActionManager implements IDisposable {
  112624. /** Gets the list of active triggers */
  112625. static Triggers: {
  112626. [key: string]: number;
  112627. };
  112628. /** Gets the cursor to use when hovering items */
  112629. hoverCursor: string;
  112630. /** Gets the list of actions */
  112631. actions: IAction[];
  112632. /**
  112633. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112634. */
  112635. isRecursive: boolean;
  112636. /**
  112637. * Releases all associated resources
  112638. */
  112639. abstract dispose(): void;
  112640. /**
  112641. * Does this action manager has pointer triggers
  112642. */
  112643. abstract get hasPointerTriggers(): boolean;
  112644. /**
  112645. * Does this action manager has pick triggers
  112646. */
  112647. abstract get hasPickTriggers(): boolean;
  112648. /**
  112649. * Process a specific trigger
  112650. * @param trigger defines the trigger to process
  112651. * @param evt defines the event details to be processed
  112652. */
  112653. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112654. /**
  112655. * Does this action manager handles actions of any of the given triggers
  112656. * @param triggers defines the triggers to be tested
  112657. * @return a boolean indicating whether one (or more) of the triggers is handled
  112658. */
  112659. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112660. /**
  112661. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112662. * speed.
  112663. * @param triggerA defines the trigger to be tested
  112664. * @param triggerB defines the trigger to be tested
  112665. * @return a boolean indicating whether one (or more) of the triggers is handled
  112666. */
  112667. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112668. /**
  112669. * Does this action manager handles actions of a given trigger
  112670. * @param trigger defines the trigger to be tested
  112671. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112672. * @return whether the trigger is handled
  112673. */
  112674. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112675. /**
  112676. * Serialize this manager to a JSON object
  112677. * @param name defines the property name to store this manager
  112678. * @returns a JSON representation of this manager
  112679. */
  112680. abstract serialize(name: string): any;
  112681. /**
  112682. * Registers an action to this action manager
  112683. * @param action defines the action to be registered
  112684. * @return the action amended (prepared) after registration
  112685. */
  112686. abstract registerAction(action: IAction): Nullable<IAction>;
  112687. /**
  112688. * Unregisters an action to this action manager
  112689. * @param action defines the action to be unregistered
  112690. * @return a boolean indicating whether the action has been unregistered
  112691. */
  112692. abstract unregisterAction(action: IAction): Boolean;
  112693. /**
  112694. * Does exist one action manager with at least one trigger
  112695. **/
  112696. static get HasTriggers(): boolean;
  112697. /**
  112698. * Does exist one action manager with at least one pick trigger
  112699. **/
  112700. static get HasPickTriggers(): boolean;
  112701. /**
  112702. * Does exist one action manager that handles actions of a given trigger
  112703. * @param trigger defines the trigger to be tested
  112704. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112705. **/
  112706. static HasSpecificTrigger(trigger: number): boolean;
  112707. }
  112708. }
  112709. declare module BABYLON {
  112710. /**
  112711. * Defines how a node can be built from a string name.
  112712. */
  112713. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112714. /**
  112715. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112716. */
  112717. export class Node implements IBehaviorAware<Node> {
  112718. /** @hidden */
  112719. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112720. private static _NodeConstructors;
  112721. /**
  112722. * Add a new node constructor
  112723. * @param type defines the type name of the node to construct
  112724. * @param constructorFunc defines the constructor function
  112725. */
  112726. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112727. /**
  112728. * Returns a node constructor based on type name
  112729. * @param type defines the type name
  112730. * @param name defines the new node name
  112731. * @param scene defines the hosting scene
  112732. * @param options defines optional options to transmit to constructors
  112733. * @returns the new constructor or null
  112734. */
  112735. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112736. /**
  112737. * Gets or sets the name of the node
  112738. */
  112739. name: string;
  112740. /**
  112741. * Gets or sets the id of the node
  112742. */
  112743. id: string;
  112744. /**
  112745. * Gets or sets the unique id of the node
  112746. */
  112747. uniqueId: number;
  112748. /**
  112749. * Gets or sets a string used to store user defined state for the node
  112750. */
  112751. state: string;
  112752. /**
  112753. * Gets or sets an object used to store user defined information for the node
  112754. */
  112755. metadata: any;
  112756. /**
  112757. * For internal use only. Please do not use.
  112758. */
  112759. reservedDataStore: any;
  112760. /**
  112761. * List of inspectable custom properties (used by the Inspector)
  112762. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112763. */
  112764. inspectableCustomProperties: IInspectable[];
  112765. private _doNotSerialize;
  112766. /**
  112767. * Gets or sets a boolean used to define if the node must be serialized
  112768. */
  112769. get doNotSerialize(): boolean;
  112770. set doNotSerialize(value: boolean);
  112771. /** @hidden */
  112772. _isDisposed: boolean;
  112773. /**
  112774. * Gets a list of Animations associated with the node
  112775. */
  112776. animations: Animation[];
  112777. protected _ranges: {
  112778. [name: string]: Nullable<AnimationRange>;
  112779. };
  112780. /**
  112781. * Callback raised when the node is ready to be used
  112782. */
  112783. onReady: Nullable<(node: Node) => void>;
  112784. private _isEnabled;
  112785. private _isParentEnabled;
  112786. private _isReady;
  112787. /** @hidden */
  112788. _currentRenderId: number;
  112789. private _parentUpdateId;
  112790. /** @hidden */
  112791. _childUpdateId: number;
  112792. /** @hidden */
  112793. _waitingParentId: Nullable<string>;
  112794. /** @hidden */
  112795. _scene: Scene;
  112796. /** @hidden */
  112797. _cache: any;
  112798. private _parentNode;
  112799. private _children;
  112800. /** @hidden */
  112801. _worldMatrix: Matrix;
  112802. /** @hidden */
  112803. _worldMatrixDeterminant: number;
  112804. /** @hidden */
  112805. _worldMatrixDeterminantIsDirty: boolean;
  112806. /** @hidden */
  112807. private _sceneRootNodesIndex;
  112808. /**
  112809. * Gets a boolean indicating if the node has been disposed
  112810. * @returns true if the node was disposed
  112811. */
  112812. isDisposed(): boolean;
  112813. /**
  112814. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112815. * @see https://doc.babylonjs.com/how_to/parenting
  112816. */
  112817. set parent(parent: Nullable<Node>);
  112818. get parent(): Nullable<Node>;
  112819. /** @hidden */
  112820. _addToSceneRootNodes(): void;
  112821. /** @hidden */
  112822. _removeFromSceneRootNodes(): void;
  112823. private _animationPropertiesOverride;
  112824. /**
  112825. * Gets or sets the animation properties override
  112826. */
  112827. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112828. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112829. /**
  112830. * Gets a string identifying the name of the class
  112831. * @returns "Node" string
  112832. */
  112833. getClassName(): string;
  112834. /** @hidden */
  112835. readonly _isNode: boolean;
  112836. /**
  112837. * An event triggered when the mesh is disposed
  112838. */
  112839. onDisposeObservable: Observable<Node>;
  112840. private _onDisposeObserver;
  112841. /**
  112842. * Sets a callback that will be raised when the node will be disposed
  112843. */
  112844. set onDispose(callback: () => void);
  112845. /**
  112846. * Creates a new Node
  112847. * @param name the name and id to be given to this node
  112848. * @param scene the scene this node will be added to
  112849. */
  112850. constructor(name: string, scene?: Nullable<Scene>);
  112851. /**
  112852. * Gets the scene of the node
  112853. * @returns a scene
  112854. */
  112855. getScene(): Scene;
  112856. /**
  112857. * Gets the engine of the node
  112858. * @returns a Engine
  112859. */
  112860. getEngine(): Engine;
  112861. private _behaviors;
  112862. /**
  112863. * Attach a behavior to the node
  112864. * @see https://doc.babylonjs.com/features/behaviour
  112865. * @param behavior defines the behavior to attach
  112866. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112867. * @returns the current Node
  112868. */
  112869. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112870. /**
  112871. * Remove an attached behavior
  112872. * @see https://doc.babylonjs.com/features/behaviour
  112873. * @param behavior defines the behavior to attach
  112874. * @returns the current Node
  112875. */
  112876. removeBehavior(behavior: Behavior<Node>): Node;
  112877. /**
  112878. * Gets the list of attached behaviors
  112879. * @see https://doc.babylonjs.com/features/behaviour
  112880. */
  112881. get behaviors(): Behavior<Node>[];
  112882. /**
  112883. * Gets an attached behavior by name
  112884. * @param name defines the name of the behavior to look for
  112885. * @see https://doc.babylonjs.com/features/behaviour
  112886. * @returns null if behavior was not found else the requested behavior
  112887. */
  112888. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112889. /**
  112890. * Returns the latest update of the World matrix
  112891. * @returns a Matrix
  112892. */
  112893. getWorldMatrix(): Matrix;
  112894. /** @hidden */
  112895. _getWorldMatrixDeterminant(): number;
  112896. /**
  112897. * Returns directly the latest state of the mesh World matrix.
  112898. * A Matrix is returned.
  112899. */
  112900. get worldMatrixFromCache(): Matrix;
  112901. /** @hidden */
  112902. _initCache(): void;
  112903. /** @hidden */
  112904. updateCache(force?: boolean): void;
  112905. /** @hidden */
  112906. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112907. /** @hidden */
  112908. _updateCache(ignoreParentClass?: boolean): void;
  112909. /** @hidden */
  112910. _isSynchronized(): boolean;
  112911. /** @hidden */
  112912. _markSyncedWithParent(): void;
  112913. /** @hidden */
  112914. isSynchronizedWithParent(): boolean;
  112915. /** @hidden */
  112916. isSynchronized(): boolean;
  112917. /**
  112918. * Is this node ready to be used/rendered
  112919. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112920. * @return true if the node is ready
  112921. */
  112922. isReady(completeCheck?: boolean): boolean;
  112923. /**
  112924. * Is this node enabled?
  112925. * 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
  112926. * @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
  112927. * @return whether this node (and its parent) is enabled
  112928. */
  112929. isEnabled(checkAncestors?: boolean): boolean;
  112930. /** @hidden */
  112931. protected _syncParentEnabledState(): void;
  112932. /**
  112933. * Set the enabled state of this node
  112934. * @param value defines the new enabled state
  112935. */
  112936. setEnabled(value: boolean): void;
  112937. /**
  112938. * Is this node a descendant of the given node?
  112939. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112940. * @param ancestor defines the parent node to inspect
  112941. * @returns a boolean indicating if this node is a descendant of the given node
  112942. */
  112943. isDescendantOf(ancestor: Node): boolean;
  112944. /** @hidden */
  112945. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112946. /**
  112947. * Will return all nodes that have this node as ascendant
  112948. * @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
  112949. * @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
  112950. * @return all children nodes of all types
  112951. */
  112952. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112953. /**
  112954. * Get all child-meshes of this node
  112955. * @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)
  112956. * @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
  112957. * @returns an array of AbstractMesh
  112958. */
  112959. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112960. /**
  112961. * Get all direct children of this node
  112962. * @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
  112963. * @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)
  112964. * @returns an array of Node
  112965. */
  112966. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112967. /** @hidden */
  112968. _setReady(state: boolean): void;
  112969. /**
  112970. * Get an animation by name
  112971. * @param name defines the name of the animation to look for
  112972. * @returns null if not found else the requested animation
  112973. */
  112974. getAnimationByName(name: string): Nullable<Animation>;
  112975. /**
  112976. * Creates an animation range for this node
  112977. * @param name defines the name of the range
  112978. * @param from defines the starting key
  112979. * @param to defines the end key
  112980. */
  112981. createAnimationRange(name: string, from: number, to: number): void;
  112982. /**
  112983. * Delete a specific animation range
  112984. * @param name defines the name of the range to delete
  112985. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112986. */
  112987. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112988. /**
  112989. * Get an animation range by name
  112990. * @param name defines the name of the animation range to look for
  112991. * @returns null if not found else the requested animation range
  112992. */
  112993. getAnimationRange(name: string): Nullable<AnimationRange>;
  112994. /**
  112995. * Gets the list of all animation ranges defined on this node
  112996. * @returns an array
  112997. */
  112998. getAnimationRanges(): Nullable<AnimationRange>[];
  112999. /**
  113000. * Will start the animation sequence
  113001. * @param name defines the range frames for animation sequence
  113002. * @param loop defines if the animation should loop (false by default)
  113003. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  113004. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  113005. * @returns the object created for this animation. If range does not exist, it will return null
  113006. */
  113007. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  113008. /**
  113009. * Serialize animation ranges into a JSON compatible object
  113010. * @returns serialization object
  113011. */
  113012. serializeAnimationRanges(): any;
  113013. /**
  113014. * Computes the world matrix of the node
  113015. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  113016. * @returns the world matrix
  113017. */
  113018. computeWorldMatrix(force?: boolean): Matrix;
  113019. /**
  113020. * Releases resources associated with this node.
  113021. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113022. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113023. */
  113024. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113025. /**
  113026. * Parse animation range data from a serialization object and store them into a given node
  113027. * @param node defines where to store the animation ranges
  113028. * @param parsedNode defines the serialization object to read data from
  113029. * @param scene defines the hosting scene
  113030. */
  113031. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  113032. /**
  113033. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  113034. * @param includeDescendants Include bounding info from descendants as well (true by default)
  113035. * @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
  113036. * @returns the new bounding vectors
  113037. */
  113038. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  113039. min: Vector3;
  113040. max: Vector3;
  113041. };
  113042. }
  113043. }
  113044. declare module BABYLON {
  113045. /**
  113046. * @hidden
  113047. */
  113048. export class _IAnimationState {
  113049. key: number;
  113050. repeatCount: number;
  113051. workValue?: any;
  113052. loopMode?: number;
  113053. offsetValue?: any;
  113054. highLimitValue?: any;
  113055. }
  113056. /**
  113057. * Class used to store any kind of animation
  113058. */
  113059. export class Animation {
  113060. /**Name of the animation */
  113061. name: string;
  113062. /**Property to animate */
  113063. targetProperty: string;
  113064. /**The frames per second of the animation */
  113065. framePerSecond: number;
  113066. /**The data type of the animation */
  113067. dataType: number;
  113068. /**The loop mode of the animation */
  113069. loopMode?: number | undefined;
  113070. /**Specifies if blending should be enabled */
  113071. enableBlending?: boolean | undefined;
  113072. /**
  113073. * Use matrix interpolation instead of using direct key value when animating matrices
  113074. */
  113075. static AllowMatricesInterpolation: boolean;
  113076. /**
  113077. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  113078. */
  113079. static AllowMatrixDecomposeForInterpolation: boolean;
  113080. /** Define the Url to load snippets */
  113081. static SnippetUrl: string;
  113082. /** Snippet ID if the animation was created from the snippet server */
  113083. snippetId: string;
  113084. /**
  113085. * Stores the key frames of the animation
  113086. */
  113087. private _keys;
  113088. /**
  113089. * Stores the easing function of the animation
  113090. */
  113091. private _easingFunction;
  113092. /**
  113093. * @hidden Internal use only
  113094. */
  113095. _runtimeAnimations: RuntimeAnimation[];
  113096. /**
  113097. * The set of event that will be linked to this animation
  113098. */
  113099. private _events;
  113100. /**
  113101. * Stores an array of target property paths
  113102. */
  113103. targetPropertyPath: string[];
  113104. /**
  113105. * Stores the blending speed of the animation
  113106. */
  113107. blendingSpeed: number;
  113108. /**
  113109. * Stores the animation ranges for the animation
  113110. */
  113111. private _ranges;
  113112. /**
  113113. * @hidden Internal use
  113114. */
  113115. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113116. /**
  113117. * Sets up an animation
  113118. * @param property The property to animate
  113119. * @param animationType The animation type to apply
  113120. * @param framePerSecond The frames per second of the animation
  113121. * @param easingFunction The easing function used in the animation
  113122. * @returns The created animation
  113123. */
  113124. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113125. /**
  113126. * Create and start an animation on a node
  113127. * @param name defines the name of the global animation that will be run on all nodes
  113128. * @param node defines the root node where the animation will take place
  113129. * @param targetProperty defines property to animate
  113130. * @param framePerSecond defines the number of frame per second yo use
  113131. * @param totalFrame defines the number of frames in total
  113132. * @param from defines the initial value
  113133. * @param to defines the final value
  113134. * @param loopMode defines which loop mode you want to use (off by default)
  113135. * @param easingFunction defines the easing function to use (linear by default)
  113136. * @param onAnimationEnd defines the callback to call when animation end
  113137. * @returns the animatable created for this animation
  113138. */
  113139. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113140. /**
  113141. * Create and start an animation on a node and its descendants
  113142. * @param name defines the name of the global animation that will be run on all nodes
  113143. * @param node defines the root node where the animation will take place
  113144. * @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
  113145. * @param targetProperty defines property to animate
  113146. * @param framePerSecond defines the number of frame per second to use
  113147. * @param totalFrame defines the number of frames in total
  113148. * @param from defines the initial value
  113149. * @param to defines the final value
  113150. * @param loopMode defines which loop mode you want to use (off by default)
  113151. * @param easingFunction defines the easing function to use (linear by default)
  113152. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113153. * @returns the list of animatables created for all nodes
  113154. * @example https://www.babylonjs-playground.com/#MH0VLI
  113155. */
  113156. 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[]>;
  113157. /**
  113158. * Creates a new animation, merges it with the existing animations and starts it
  113159. * @param name Name of the animation
  113160. * @param node Node which contains the scene that begins the animations
  113161. * @param targetProperty Specifies which property to animate
  113162. * @param framePerSecond The frames per second of the animation
  113163. * @param totalFrame The total number of frames
  113164. * @param from The frame at the beginning of the animation
  113165. * @param to The frame at the end of the animation
  113166. * @param loopMode Specifies the loop mode of the animation
  113167. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113168. * @param onAnimationEnd Callback to run once the animation is complete
  113169. * @returns Nullable animation
  113170. */
  113171. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113172. /**
  113173. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113174. * @param sourceAnimation defines the Animation containing keyframes to convert
  113175. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113176. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113177. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113178. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113179. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113180. */
  113181. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113182. /**
  113183. * Transition property of an host to the target Value
  113184. * @param property The property to transition
  113185. * @param targetValue The target Value of the property
  113186. * @param host The object where the property to animate belongs
  113187. * @param scene Scene used to run the animation
  113188. * @param frameRate Framerate (in frame/s) to use
  113189. * @param transition The transition type we want to use
  113190. * @param duration The duration of the animation, in milliseconds
  113191. * @param onAnimationEnd Callback trigger at the end of the animation
  113192. * @returns Nullable animation
  113193. */
  113194. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113195. /**
  113196. * Return the array of runtime animations currently using this animation
  113197. */
  113198. get runtimeAnimations(): RuntimeAnimation[];
  113199. /**
  113200. * Specifies if any of the runtime animations are currently running
  113201. */
  113202. get hasRunningRuntimeAnimations(): boolean;
  113203. /**
  113204. * Initializes the animation
  113205. * @param name Name of the animation
  113206. * @param targetProperty Property to animate
  113207. * @param framePerSecond The frames per second of the animation
  113208. * @param dataType The data type of the animation
  113209. * @param loopMode The loop mode of the animation
  113210. * @param enableBlending Specifies if blending should be enabled
  113211. */
  113212. constructor(
  113213. /**Name of the animation */
  113214. name: string,
  113215. /**Property to animate */
  113216. targetProperty: string,
  113217. /**The frames per second of the animation */
  113218. framePerSecond: number,
  113219. /**The data type of the animation */
  113220. dataType: number,
  113221. /**The loop mode of the animation */
  113222. loopMode?: number | undefined,
  113223. /**Specifies if blending should be enabled */
  113224. enableBlending?: boolean | undefined);
  113225. /**
  113226. * Converts the animation to a string
  113227. * @param fullDetails support for multiple levels of logging within scene loading
  113228. * @returns String form of the animation
  113229. */
  113230. toString(fullDetails?: boolean): string;
  113231. /**
  113232. * Add an event to this animation
  113233. * @param event Event to add
  113234. */
  113235. addEvent(event: AnimationEvent): void;
  113236. /**
  113237. * Remove all events found at the given frame
  113238. * @param frame The frame to remove events from
  113239. */
  113240. removeEvents(frame: number): void;
  113241. /**
  113242. * Retrieves all the events from the animation
  113243. * @returns Events from the animation
  113244. */
  113245. getEvents(): AnimationEvent[];
  113246. /**
  113247. * Creates an animation range
  113248. * @param name Name of the animation range
  113249. * @param from Starting frame of the animation range
  113250. * @param to Ending frame of the animation
  113251. */
  113252. createRange(name: string, from: number, to: number): void;
  113253. /**
  113254. * Deletes an animation range by name
  113255. * @param name Name of the animation range to delete
  113256. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113257. */
  113258. deleteRange(name: string, deleteFrames?: boolean): void;
  113259. /**
  113260. * Gets the animation range by name, or null if not defined
  113261. * @param name Name of the animation range
  113262. * @returns Nullable animation range
  113263. */
  113264. getRange(name: string): Nullable<AnimationRange>;
  113265. /**
  113266. * Gets the key frames from the animation
  113267. * @returns The key frames of the animation
  113268. */
  113269. getKeys(): Array<IAnimationKey>;
  113270. /**
  113271. * Gets the highest frame rate of the animation
  113272. * @returns Highest frame rate of the animation
  113273. */
  113274. getHighestFrame(): number;
  113275. /**
  113276. * Gets the easing function of the animation
  113277. * @returns Easing function of the animation
  113278. */
  113279. getEasingFunction(): IEasingFunction;
  113280. /**
  113281. * Sets the easing function of the animation
  113282. * @param easingFunction A custom mathematical formula for animation
  113283. */
  113284. setEasingFunction(easingFunction: EasingFunction): void;
  113285. /**
  113286. * Interpolates a scalar linearly
  113287. * @param startValue Start value of the animation curve
  113288. * @param endValue End value of the animation curve
  113289. * @param gradient Scalar amount to interpolate
  113290. * @returns Interpolated scalar value
  113291. */
  113292. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113293. /**
  113294. * Interpolates a scalar cubically
  113295. * @param startValue Start value of the animation curve
  113296. * @param outTangent End tangent of the animation
  113297. * @param endValue End value of the animation curve
  113298. * @param inTangent Start tangent of the animation curve
  113299. * @param gradient Scalar amount to interpolate
  113300. * @returns Interpolated scalar value
  113301. */
  113302. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113303. /**
  113304. * Interpolates a quaternion using a spherical linear interpolation
  113305. * @param startValue Start value of the animation curve
  113306. * @param endValue End value of the animation curve
  113307. * @param gradient Scalar amount to interpolate
  113308. * @returns Interpolated quaternion value
  113309. */
  113310. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113311. /**
  113312. * Interpolates a quaternion cubically
  113313. * @param startValue Start value of the animation curve
  113314. * @param outTangent End tangent of the animation curve
  113315. * @param endValue End value of the animation curve
  113316. * @param inTangent Start tangent of the animation curve
  113317. * @param gradient Scalar amount to interpolate
  113318. * @returns Interpolated quaternion value
  113319. */
  113320. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113321. /**
  113322. * Interpolates a Vector3 linearl
  113323. * @param startValue Start value of the animation curve
  113324. * @param endValue End value of the animation curve
  113325. * @param gradient Scalar amount to interpolate
  113326. * @returns Interpolated scalar value
  113327. */
  113328. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113329. /**
  113330. * Interpolates a Vector3 cubically
  113331. * @param startValue Start value of the animation curve
  113332. * @param outTangent End tangent of the animation
  113333. * @param endValue End value of the animation curve
  113334. * @param inTangent Start tangent of the animation curve
  113335. * @param gradient Scalar amount to interpolate
  113336. * @returns InterpolatedVector3 value
  113337. */
  113338. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113339. /**
  113340. * Interpolates a Vector2 linearly
  113341. * @param startValue Start value of the animation curve
  113342. * @param endValue End value of the animation curve
  113343. * @param gradient Scalar amount to interpolate
  113344. * @returns Interpolated Vector2 value
  113345. */
  113346. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113347. /**
  113348. * Interpolates a Vector2 cubically
  113349. * @param startValue Start value of the animation curve
  113350. * @param outTangent End tangent of the animation
  113351. * @param endValue End value of the animation curve
  113352. * @param inTangent Start tangent of the animation curve
  113353. * @param gradient Scalar amount to interpolate
  113354. * @returns Interpolated Vector2 value
  113355. */
  113356. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113357. /**
  113358. * Interpolates a size linearly
  113359. * @param startValue Start value of the animation curve
  113360. * @param endValue End value of the animation curve
  113361. * @param gradient Scalar amount to interpolate
  113362. * @returns Interpolated Size value
  113363. */
  113364. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113365. /**
  113366. * Interpolates a Color3 linearly
  113367. * @param startValue Start value of the animation curve
  113368. * @param endValue End value of the animation curve
  113369. * @param gradient Scalar amount to interpolate
  113370. * @returns Interpolated Color3 value
  113371. */
  113372. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113373. /**
  113374. * Interpolates a Color4 linearly
  113375. * @param startValue Start value of the animation curve
  113376. * @param endValue End value of the animation curve
  113377. * @param gradient Scalar amount to interpolate
  113378. * @returns Interpolated Color3 value
  113379. */
  113380. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113381. /**
  113382. * @hidden Internal use only
  113383. */
  113384. _getKeyValue(value: any): any;
  113385. /**
  113386. * @hidden Internal use only
  113387. */
  113388. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113389. /**
  113390. * Defines the function to use to interpolate matrices
  113391. * @param startValue defines the start matrix
  113392. * @param endValue defines the end matrix
  113393. * @param gradient defines the gradient between both matrices
  113394. * @param result defines an optional target matrix where to store the interpolation
  113395. * @returns the interpolated matrix
  113396. */
  113397. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113398. /**
  113399. * Makes a copy of the animation
  113400. * @returns Cloned animation
  113401. */
  113402. clone(): Animation;
  113403. /**
  113404. * Sets the key frames of the animation
  113405. * @param values The animation key frames to set
  113406. */
  113407. setKeys(values: Array<IAnimationKey>): void;
  113408. /**
  113409. * Serializes the animation to an object
  113410. * @returns Serialized object
  113411. */
  113412. serialize(): any;
  113413. /**
  113414. * Float animation type
  113415. */
  113416. static readonly ANIMATIONTYPE_FLOAT: number;
  113417. /**
  113418. * Vector3 animation type
  113419. */
  113420. static readonly ANIMATIONTYPE_VECTOR3: number;
  113421. /**
  113422. * Quaternion animation type
  113423. */
  113424. static readonly ANIMATIONTYPE_QUATERNION: number;
  113425. /**
  113426. * Matrix animation type
  113427. */
  113428. static readonly ANIMATIONTYPE_MATRIX: number;
  113429. /**
  113430. * Color3 animation type
  113431. */
  113432. static readonly ANIMATIONTYPE_COLOR3: number;
  113433. /**
  113434. * Color3 animation type
  113435. */
  113436. static readonly ANIMATIONTYPE_COLOR4: number;
  113437. /**
  113438. * Vector2 animation type
  113439. */
  113440. static readonly ANIMATIONTYPE_VECTOR2: number;
  113441. /**
  113442. * Size animation type
  113443. */
  113444. static readonly ANIMATIONTYPE_SIZE: number;
  113445. /**
  113446. * Relative Loop Mode
  113447. */
  113448. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113449. /**
  113450. * Cycle Loop Mode
  113451. */
  113452. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113453. /**
  113454. * Constant Loop Mode
  113455. */
  113456. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113457. /** @hidden */
  113458. static _UniversalLerp(left: any, right: any, amount: number): any;
  113459. /**
  113460. * Parses an animation object and creates an animation
  113461. * @param parsedAnimation Parsed animation object
  113462. * @returns Animation object
  113463. */
  113464. static Parse(parsedAnimation: any): Animation;
  113465. /**
  113466. * Appends the serialized animations from the source animations
  113467. * @param source Source containing the animations
  113468. * @param destination Target to store the animations
  113469. */
  113470. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113471. /**
  113472. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113473. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113474. * @param url defines the url to load from
  113475. * @returns a promise that will resolve to the new animation or an array of animations
  113476. */
  113477. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113478. /**
  113479. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113480. * @param snippetId defines the snippet to load
  113481. * @returns a promise that will resolve to the new animation or a new array of animations
  113482. */
  113483. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113484. }
  113485. }
  113486. declare module BABYLON {
  113487. /**
  113488. * Interface containing an array of animations
  113489. */
  113490. export interface IAnimatable {
  113491. /**
  113492. * Array of animations
  113493. */
  113494. animations: Nullable<Array<Animation>>;
  113495. }
  113496. }
  113497. declare module BABYLON {
  113498. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113499. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113500. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113501. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113502. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113503. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113504. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113505. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113506. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113507. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113508. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113509. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113510. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113511. /**
  113512. * Decorator used to define property that can be serialized as reference to a camera
  113513. * @param sourceName defines the name of the property to decorate
  113514. */
  113515. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113516. /**
  113517. * Class used to help serialization objects
  113518. */
  113519. export class SerializationHelper {
  113520. /** @hidden */
  113521. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113522. /** @hidden */
  113523. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113524. /** @hidden */
  113525. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113526. /** @hidden */
  113527. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113528. /**
  113529. * Appends the serialized animations from the source animations
  113530. * @param source Source containing the animations
  113531. * @param destination Target to store the animations
  113532. */
  113533. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113534. /**
  113535. * Static function used to serialized a specific entity
  113536. * @param entity defines the entity to serialize
  113537. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113538. * @returns a JSON compatible object representing the serialization of the entity
  113539. */
  113540. static Serialize<T>(entity: T, serializationObject?: any): any;
  113541. /**
  113542. * Creates a new entity from a serialization data object
  113543. * @param creationFunction defines a function used to instanciated the new entity
  113544. * @param source defines the source serialization data
  113545. * @param scene defines the hosting scene
  113546. * @param rootUrl defines the root url for resources
  113547. * @returns a new entity
  113548. */
  113549. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113550. /**
  113551. * Clones an object
  113552. * @param creationFunction defines the function used to instanciate the new object
  113553. * @param source defines the source object
  113554. * @returns the cloned object
  113555. */
  113556. static Clone<T>(creationFunction: () => T, source: T): T;
  113557. /**
  113558. * Instanciates a new object based on a source one (some data will be shared between both object)
  113559. * @param creationFunction defines the function used to instanciate the new object
  113560. * @param source defines the source object
  113561. * @returns the new object
  113562. */
  113563. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113564. }
  113565. }
  113566. declare module BABYLON {
  113567. /**
  113568. * Base class of all the textures in babylon.
  113569. * It groups all the common properties the materials, post process, lights... might need
  113570. * in order to make a correct use of the texture.
  113571. */
  113572. export class BaseTexture implements IAnimatable {
  113573. /**
  113574. * Default anisotropic filtering level for the application.
  113575. * It is set to 4 as a good tradeoff between perf and quality.
  113576. */
  113577. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113578. /**
  113579. * Gets or sets the unique id of the texture
  113580. */
  113581. uniqueId: number;
  113582. /**
  113583. * Define the name of the texture.
  113584. */
  113585. name: string;
  113586. /**
  113587. * Gets or sets an object used to store user defined information.
  113588. */
  113589. metadata: any;
  113590. /**
  113591. * For internal use only. Please do not use.
  113592. */
  113593. reservedDataStore: any;
  113594. private _hasAlpha;
  113595. /**
  113596. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113597. */
  113598. set hasAlpha(value: boolean);
  113599. get hasAlpha(): boolean;
  113600. /**
  113601. * Defines if the alpha value should be determined via the rgb values.
  113602. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113603. */
  113604. getAlphaFromRGB: boolean;
  113605. /**
  113606. * Intensity or strength of the texture.
  113607. * It is commonly used by materials to fine tune the intensity of the texture
  113608. */
  113609. level: number;
  113610. /**
  113611. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113612. * This is part of the texture as textures usually maps to one uv set.
  113613. */
  113614. coordinatesIndex: number;
  113615. protected _coordinatesMode: number;
  113616. /**
  113617. * How a texture is mapped.
  113618. *
  113619. * | Value | Type | Description |
  113620. * | ----- | ----------------------------------- | ----------- |
  113621. * | 0 | EXPLICIT_MODE | |
  113622. * | 1 | SPHERICAL_MODE | |
  113623. * | 2 | PLANAR_MODE | |
  113624. * | 3 | CUBIC_MODE | |
  113625. * | 4 | PROJECTION_MODE | |
  113626. * | 5 | SKYBOX_MODE | |
  113627. * | 6 | INVCUBIC_MODE | |
  113628. * | 7 | EQUIRECTANGULAR_MODE | |
  113629. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113630. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113631. */
  113632. set coordinatesMode(value: number);
  113633. get coordinatesMode(): number;
  113634. private _wrapU;
  113635. /**
  113636. * | Value | Type | Description |
  113637. * | ----- | ------------------ | ----------- |
  113638. * | 0 | CLAMP_ADDRESSMODE | |
  113639. * | 1 | WRAP_ADDRESSMODE | |
  113640. * | 2 | MIRROR_ADDRESSMODE | |
  113641. */
  113642. get wrapU(): number;
  113643. set wrapU(value: number);
  113644. private _wrapV;
  113645. /**
  113646. * | Value | Type | Description |
  113647. * | ----- | ------------------ | ----------- |
  113648. * | 0 | CLAMP_ADDRESSMODE | |
  113649. * | 1 | WRAP_ADDRESSMODE | |
  113650. * | 2 | MIRROR_ADDRESSMODE | |
  113651. */
  113652. get wrapV(): number;
  113653. set wrapV(value: number);
  113654. /**
  113655. * | Value | Type | Description |
  113656. * | ----- | ------------------ | ----------- |
  113657. * | 0 | CLAMP_ADDRESSMODE | |
  113658. * | 1 | WRAP_ADDRESSMODE | |
  113659. * | 2 | MIRROR_ADDRESSMODE | |
  113660. */
  113661. wrapR: number;
  113662. /**
  113663. * With compliant hardware and browser (supporting anisotropic filtering)
  113664. * this defines the level of anisotropic filtering in the texture.
  113665. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113666. */
  113667. anisotropicFilteringLevel: number;
  113668. /**
  113669. * Define if the texture is a cube texture or if false a 2d texture.
  113670. */
  113671. get isCube(): boolean;
  113672. set isCube(value: boolean);
  113673. /**
  113674. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113675. */
  113676. get is3D(): boolean;
  113677. set is3D(value: boolean);
  113678. /**
  113679. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113680. */
  113681. get is2DArray(): boolean;
  113682. set is2DArray(value: boolean);
  113683. /**
  113684. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113685. * HDR texture are usually stored in linear space.
  113686. * This only impacts the PBR and Background materials
  113687. */
  113688. gammaSpace: boolean;
  113689. /**
  113690. * Gets or sets whether or not the texture contains RGBD data.
  113691. */
  113692. get isRGBD(): boolean;
  113693. set isRGBD(value: boolean);
  113694. /**
  113695. * Is Z inverted in the texture (useful in a cube texture).
  113696. */
  113697. invertZ: boolean;
  113698. /**
  113699. * Are mip maps generated for this texture or not.
  113700. */
  113701. get noMipmap(): boolean;
  113702. /**
  113703. * @hidden
  113704. */
  113705. lodLevelInAlpha: boolean;
  113706. /**
  113707. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113708. */
  113709. get lodGenerationOffset(): number;
  113710. set lodGenerationOffset(value: number);
  113711. /**
  113712. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113713. */
  113714. get lodGenerationScale(): number;
  113715. set lodGenerationScale(value: number);
  113716. /**
  113717. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113718. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113719. * average roughness values.
  113720. */
  113721. get linearSpecularLOD(): boolean;
  113722. set linearSpecularLOD(value: boolean);
  113723. /**
  113724. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113725. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113726. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113727. */
  113728. get irradianceTexture(): Nullable<BaseTexture>;
  113729. set irradianceTexture(value: Nullable<BaseTexture>);
  113730. /**
  113731. * Define if the texture is a render target.
  113732. */
  113733. isRenderTarget: boolean;
  113734. /**
  113735. * Define the unique id of the texture in the scene.
  113736. */
  113737. get uid(): string;
  113738. /** @hidden */
  113739. _prefiltered: boolean;
  113740. /**
  113741. * Return a string representation of the texture.
  113742. * @returns the texture as a string
  113743. */
  113744. toString(): string;
  113745. /**
  113746. * Get the class name of the texture.
  113747. * @returns "BaseTexture"
  113748. */
  113749. getClassName(): string;
  113750. /**
  113751. * Define the list of animation attached to the texture.
  113752. */
  113753. animations: Animation[];
  113754. /**
  113755. * An event triggered when the texture is disposed.
  113756. */
  113757. onDisposeObservable: Observable<BaseTexture>;
  113758. private _onDisposeObserver;
  113759. /**
  113760. * Callback triggered when the texture has been disposed.
  113761. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113762. */
  113763. set onDispose(callback: () => void);
  113764. /**
  113765. * Define the current state of the loading sequence when in delayed load mode.
  113766. */
  113767. delayLoadState: number;
  113768. protected _scene: Nullable<Scene>;
  113769. protected _engine: Nullable<ThinEngine>;
  113770. /** @hidden */
  113771. _texture: Nullable<InternalTexture>;
  113772. private _uid;
  113773. /**
  113774. * Define if the texture is preventinga material to render or not.
  113775. * If not and the texture is not ready, the engine will use a default black texture instead.
  113776. */
  113777. get isBlocking(): boolean;
  113778. /**
  113779. * Instantiates a new BaseTexture.
  113780. * Base class of all the textures in babylon.
  113781. * It groups all the common properties the materials, post process, lights... might need
  113782. * in order to make a correct use of the texture.
  113783. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113784. */
  113785. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113786. /**
  113787. * Get the scene the texture belongs to.
  113788. * @returns the scene or null if undefined
  113789. */
  113790. getScene(): Nullable<Scene>;
  113791. /** @hidden */
  113792. protected _getEngine(): Nullable<ThinEngine>;
  113793. /**
  113794. * Get the texture transform matrix used to offset tile the texture for istance.
  113795. * @returns the transformation matrix
  113796. */
  113797. getTextureMatrix(): Matrix;
  113798. /**
  113799. * Get the texture reflection matrix used to rotate/transform the reflection.
  113800. * @returns the reflection matrix
  113801. */
  113802. getReflectionTextureMatrix(): Matrix;
  113803. /**
  113804. * Get the underlying lower level texture from Babylon.
  113805. * @returns the insternal texture
  113806. */
  113807. getInternalTexture(): Nullable<InternalTexture>;
  113808. /**
  113809. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113810. * @returns true if ready or not blocking
  113811. */
  113812. isReadyOrNotBlocking(): boolean;
  113813. /**
  113814. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113815. * @returns true if fully ready
  113816. */
  113817. isReady(): boolean;
  113818. private _cachedSize;
  113819. /**
  113820. * Get the size of the texture.
  113821. * @returns the texture size.
  113822. */
  113823. getSize(): ISize;
  113824. /**
  113825. * Get the base size of the texture.
  113826. * It can be different from the size if the texture has been resized for POT for instance
  113827. * @returns the base size
  113828. */
  113829. getBaseSize(): ISize;
  113830. /**
  113831. * Update the sampling mode of the texture.
  113832. * Default is Trilinear mode.
  113833. *
  113834. * | Value | Type | Description |
  113835. * | ----- | ------------------ | ----------- |
  113836. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113837. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113838. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113839. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113840. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113841. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113842. * | 7 | NEAREST_LINEAR | |
  113843. * | 8 | NEAREST_NEAREST | |
  113844. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113845. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113846. * | 11 | LINEAR_LINEAR | |
  113847. * | 12 | LINEAR_NEAREST | |
  113848. *
  113849. * > _mag_: magnification filter (close to the viewer)
  113850. * > _min_: minification filter (far from the viewer)
  113851. * > _mip_: filter used between mip map levels
  113852. *@param samplingMode Define the new sampling mode of the texture
  113853. */
  113854. updateSamplingMode(samplingMode: number): void;
  113855. /**
  113856. * Scales the texture if is `canRescale()`
  113857. * @param ratio the resize factor we want to use to rescale
  113858. */
  113859. scale(ratio: number): void;
  113860. /**
  113861. * Get if the texture can rescale.
  113862. */
  113863. get canRescale(): boolean;
  113864. /** @hidden */
  113865. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113866. /** @hidden */
  113867. _rebuild(): void;
  113868. /**
  113869. * Triggers the load sequence in delayed load mode.
  113870. */
  113871. delayLoad(): void;
  113872. /**
  113873. * Clones the texture.
  113874. * @returns the cloned texture
  113875. */
  113876. clone(): Nullable<BaseTexture>;
  113877. /**
  113878. * Get the texture underlying type (INT, FLOAT...)
  113879. */
  113880. get textureType(): number;
  113881. /**
  113882. * Get the texture underlying format (RGB, RGBA...)
  113883. */
  113884. get textureFormat(): number;
  113885. /**
  113886. * Indicates that textures need to be re-calculated for all materials
  113887. */
  113888. protected _markAllSubMeshesAsTexturesDirty(): void;
  113889. /**
  113890. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113891. * This will returns an RGBA array buffer containing either in values (0-255) or
  113892. * float values (0-1) depending of the underlying buffer type.
  113893. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113894. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113895. * @param buffer defines a user defined buffer to fill with data (can be null)
  113896. * @returns The Array buffer containing the pixels data.
  113897. */
  113898. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113899. /**
  113900. * Release and destroy the underlying lower level texture aka internalTexture.
  113901. */
  113902. releaseInternalTexture(): void;
  113903. /** @hidden */
  113904. get _lodTextureHigh(): Nullable<BaseTexture>;
  113905. /** @hidden */
  113906. get _lodTextureMid(): Nullable<BaseTexture>;
  113907. /** @hidden */
  113908. get _lodTextureLow(): Nullable<BaseTexture>;
  113909. /**
  113910. * Dispose the texture and release its associated resources.
  113911. */
  113912. dispose(): void;
  113913. /**
  113914. * Serialize the texture into a JSON representation that can be parsed later on.
  113915. * @returns the JSON representation of the texture
  113916. */
  113917. serialize(): any;
  113918. /**
  113919. * Helper function to be called back once a list of texture contains only ready textures.
  113920. * @param textures Define the list of textures to wait for
  113921. * @param callback Define the callback triggered once the entire list will be ready
  113922. */
  113923. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113924. private static _isScene;
  113925. }
  113926. }
  113927. declare module BABYLON {
  113928. /**
  113929. * Options to be used when creating an effect.
  113930. */
  113931. export interface IEffectCreationOptions {
  113932. /**
  113933. * Atrributes that will be used in the shader.
  113934. */
  113935. attributes: string[];
  113936. /**
  113937. * Uniform varible names that will be set in the shader.
  113938. */
  113939. uniformsNames: string[];
  113940. /**
  113941. * Uniform buffer variable names that will be set in the shader.
  113942. */
  113943. uniformBuffersNames: string[];
  113944. /**
  113945. * Sampler texture variable names that will be set in the shader.
  113946. */
  113947. samplers: string[];
  113948. /**
  113949. * Define statements that will be set in the shader.
  113950. */
  113951. defines: any;
  113952. /**
  113953. * Possible fallbacks for this effect to improve performance when needed.
  113954. */
  113955. fallbacks: Nullable<IEffectFallbacks>;
  113956. /**
  113957. * Callback that will be called when the shader is compiled.
  113958. */
  113959. onCompiled: Nullable<(effect: Effect) => void>;
  113960. /**
  113961. * Callback that will be called if an error occurs during shader compilation.
  113962. */
  113963. onError: Nullable<(effect: Effect, errors: string) => void>;
  113964. /**
  113965. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113966. */
  113967. indexParameters?: any;
  113968. /**
  113969. * Max number of lights that can be used in the shader.
  113970. */
  113971. maxSimultaneousLights?: number;
  113972. /**
  113973. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113974. */
  113975. transformFeedbackVaryings?: Nullable<string[]>;
  113976. /**
  113977. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  113978. */
  113979. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113980. /**
  113981. * Is this effect rendering to several color attachments ?
  113982. */
  113983. multiTarget?: boolean;
  113984. }
  113985. /**
  113986. * Effect containing vertex and fragment shader that can be executed on an object.
  113987. */
  113988. export class Effect implements IDisposable {
  113989. /**
  113990. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113991. */
  113992. static ShadersRepository: string;
  113993. /**
  113994. * Enable logging of the shader code when a compilation error occurs
  113995. */
  113996. static LogShaderCodeOnCompilationError: boolean;
  113997. /**
  113998. * Name of the effect.
  113999. */
  114000. name: any;
  114001. /**
  114002. * String container all the define statements that should be set on the shader.
  114003. */
  114004. defines: string;
  114005. /**
  114006. * Callback that will be called when the shader is compiled.
  114007. */
  114008. onCompiled: Nullable<(effect: Effect) => void>;
  114009. /**
  114010. * Callback that will be called if an error occurs during shader compilation.
  114011. */
  114012. onError: Nullable<(effect: Effect, errors: string) => void>;
  114013. /**
  114014. * Callback that will be called when effect is bound.
  114015. */
  114016. onBind: Nullable<(effect: Effect) => void>;
  114017. /**
  114018. * Unique ID of the effect.
  114019. */
  114020. uniqueId: number;
  114021. /**
  114022. * Observable that will be called when the shader is compiled.
  114023. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  114024. */
  114025. onCompileObservable: Observable<Effect>;
  114026. /**
  114027. * Observable that will be called if an error occurs during shader compilation.
  114028. */
  114029. onErrorObservable: Observable<Effect>;
  114030. /** @hidden */
  114031. _onBindObservable: Nullable<Observable<Effect>>;
  114032. /**
  114033. * @hidden
  114034. * Specifies if the effect was previously ready
  114035. */
  114036. _wasPreviouslyReady: boolean;
  114037. /**
  114038. * Observable that will be called when effect is bound.
  114039. */
  114040. get onBindObservable(): Observable<Effect>;
  114041. /** @hidden */
  114042. _bonesComputationForcedToCPU: boolean;
  114043. /** @hidden */
  114044. _multiTarget: boolean;
  114045. private static _uniqueIdSeed;
  114046. private _engine;
  114047. private _uniformBuffersNames;
  114048. private _uniformBuffersNamesList;
  114049. private _uniformsNames;
  114050. private _samplerList;
  114051. private _samplers;
  114052. private _isReady;
  114053. private _compilationError;
  114054. private _allFallbacksProcessed;
  114055. private _attributesNames;
  114056. private _attributes;
  114057. private _attributeLocationByName;
  114058. private _uniforms;
  114059. /**
  114060. * Key for the effect.
  114061. * @hidden
  114062. */
  114063. _key: string;
  114064. private _indexParameters;
  114065. private _fallbacks;
  114066. private _vertexSourceCode;
  114067. private _fragmentSourceCode;
  114068. private _vertexSourceCodeOverride;
  114069. private _fragmentSourceCodeOverride;
  114070. private _transformFeedbackVaryings;
  114071. /**
  114072. * Compiled shader to webGL program.
  114073. * @hidden
  114074. */
  114075. _pipelineContext: Nullable<IPipelineContext>;
  114076. private _valueCache;
  114077. private static _baseCache;
  114078. /**
  114079. * Instantiates an effect.
  114080. * An effect can be used to create/manage/execute vertex and fragment shaders.
  114081. * @param baseName Name of the effect.
  114082. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  114083. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  114084. * @param samplers List of sampler variables that will be passed to the shader.
  114085. * @param engine Engine to be used to render the effect
  114086. * @param defines Define statements to be added to the shader.
  114087. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114088. * @param onCompiled Callback that will be called when the shader is compiled.
  114089. * @param onError Callback that will be called if an error occurs during shader compilation.
  114090. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114091. */
  114092. 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);
  114093. private _useFinalCode;
  114094. /**
  114095. * Unique key for this effect
  114096. */
  114097. get key(): string;
  114098. /**
  114099. * If the effect has been compiled and prepared.
  114100. * @returns if the effect is compiled and prepared.
  114101. */
  114102. isReady(): boolean;
  114103. private _isReadyInternal;
  114104. /**
  114105. * The engine the effect was initialized with.
  114106. * @returns the engine.
  114107. */
  114108. getEngine(): Engine;
  114109. /**
  114110. * The pipeline context for this effect
  114111. * @returns the associated pipeline context
  114112. */
  114113. getPipelineContext(): Nullable<IPipelineContext>;
  114114. /**
  114115. * The set of names of attribute variables for the shader.
  114116. * @returns An array of attribute names.
  114117. */
  114118. getAttributesNames(): string[];
  114119. /**
  114120. * Returns the attribute at the given index.
  114121. * @param index The index of the attribute.
  114122. * @returns The location of the attribute.
  114123. */
  114124. getAttributeLocation(index: number): number;
  114125. /**
  114126. * Returns the attribute based on the name of the variable.
  114127. * @param name of the attribute to look up.
  114128. * @returns the attribute location.
  114129. */
  114130. getAttributeLocationByName(name: string): number;
  114131. /**
  114132. * The number of attributes.
  114133. * @returns the numnber of attributes.
  114134. */
  114135. getAttributesCount(): number;
  114136. /**
  114137. * Gets the index of a uniform variable.
  114138. * @param uniformName of the uniform to look up.
  114139. * @returns the index.
  114140. */
  114141. getUniformIndex(uniformName: string): number;
  114142. /**
  114143. * Returns the attribute based on the name of the variable.
  114144. * @param uniformName of the uniform to look up.
  114145. * @returns the location of the uniform.
  114146. */
  114147. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114148. /**
  114149. * Returns an array of sampler variable names
  114150. * @returns The array of sampler variable names.
  114151. */
  114152. getSamplers(): string[];
  114153. /**
  114154. * Returns an array of uniform variable names
  114155. * @returns The array of uniform variable names.
  114156. */
  114157. getUniformNames(): string[];
  114158. /**
  114159. * Returns an array of uniform buffer variable names
  114160. * @returns The array of uniform buffer variable names.
  114161. */
  114162. getUniformBuffersNames(): string[];
  114163. /**
  114164. * Returns the index parameters used to create the effect
  114165. * @returns The index parameters object
  114166. */
  114167. getIndexParameters(): any;
  114168. /**
  114169. * The error from the last compilation.
  114170. * @returns the error string.
  114171. */
  114172. getCompilationError(): string;
  114173. /**
  114174. * Gets a boolean indicating that all fallbacks were used during compilation
  114175. * @returns true if all fallbacks were used
  114176. */
  114177. allFallbacksProcessed(): boolean;
  114178. /**
  114179. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114180. * @param func The callback to be used.
  114181. */
  114182. executeWhenCompiled(func: (effect: Effect) => void): void;
  114183. private _checkIsReady;
  114184. private _loadShader;
  114185. /**
  114186. * Gets the vertex shader source code of this effect
  114187. */
  114188. get vertexSourceCode(): string;
  114189. /**
  114190. * Gets the fragment shader source code of this effect
  114191. */
  114192. get fragmentSourceCode(): string;
  114193. /**
  114194. * Recompiles the webGL program
  114195. * @param vertexSourceCode The source code for the vertex shader.
  114196. * @param fragmentSourceCode The source code for the fragment shader.
  114197. * @param onCompiled Callback called when completed.
  114198. * @param onError Callback called on error.
  114199. * @hidden
  114200. */
  114201. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114202. /**
  114203. * Prepares the effect
  114204. * @hidden
  114205. */
  114206. _prepareEffect(): void;
  114207. private _getShaderCodeAndErrorLine;
  114208. private _processCompilationErrors;
  114209. /**
  114210. * Checks if the effect is supported. (Must be called after compilation)
  114211. */
  114212. get isSupported(): boolean;
  114213. /**
  114214. * Binds a texture to the engine to be used as output of the shader.
  114215. * @param channel Name of the output variable.
  114216. * @param texture Texture to bind.
  114217. * @hidden
  114218. */
  114219. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114220. /**
  114221. * Sets a texture on the engine to be used in the shader.
  114222. * @param channel Name of the sampler variable.
  114223. * @param texture Texture to set.
  114224. */
  114225. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114226. /**
  114227. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114228. * @param channel Name of the sampler variable.
  114229. * @param texture Texture to set.
  114230. */
  114231. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114232. /**
  114233. * Sets an array of textures on the engine to be used in the shader.
  114234. * @param channel Name of the variable.
  114235. * @param textures Textures to set.
  114236. */
  114237. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114238. /**
  114239. * 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)
  114240. * @param channel Name of the sampler variable.
  114241. * @param postProcess Post process to get the input texture from.
  114242. */
  114243. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114244. /**
  114245. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114246. * 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)
  114247. * @param channel Name of the sampler variable.
  114248. * @param postProcess Post process to get the output texture from.
  114249. */
  114250. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114251. /** @hidden */
  114252. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114253. /** @hidden */
  114254. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114255. /** @hidden */
  114256. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114257. /** @hidden */
  114258. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114259. /**
  114260. * Binds a buffer to a uniform.
  114261. * @param buffer Buffer to bind.
  114262. * @param name Name of the uniform variable to bind to.
  114263. */
  114264. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114265. /**
  114266. * Binds block to a uniform.
  114267. * @param blockName Name of the block to bind.
  114268. * @param index Index to bind.
  114269. */
  114270. bindUniformBlock(blockName: string, index: number): void;
  114271. /**
  114272. * Sets an interger value on a uniform variable.
  114273. * @param uniformName Name of the variable.
  114274. * @param value Value to be set.
  114275. * @returns this effect.
  114276. */
  114277. setInt(uniformName: string, value: number): Effect;
  114278. /**
  114279. * Sets an int array on a uniform variable.
  114280. * @param uniformName Name of the variable.
  114281. * @param array array to be set.
  114282. * @returns this effect.
  114283. */
  114284. setIntArray(uniformName: string, array: Int32Array): Effect;
  114285. /**
  114286. * 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)
  114287. * @param uniformName Name of the variable.
  114288. * @param array array to be set.
  114289. * @returns this effect.
  114290. */
  114291. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114292. /**
  114293. * 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)
  114294. * @param uniformName Name of the variable.
  114295. * @param array array to be set.
  114296. * @returns this effect.
  114297. */
  114298. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114299. /**
  114300. * 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)
  114301. * @param uniformName Name of the variable.
  114302. * @param array array to be set.
  114303. * @returns this effect.
  114304. */
  114305. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114306. /**
  114307. * Sets an float array on a uniform variable.
  114308. * @param uniformName Name of the variable.
  114309. * @param array array to be set.
  114310. * @returns this effect.
  114311. */
  114312. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114313. /**
  114314. * 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)
  114315. * @param uniformName Name of the variable.
  114316. * @param array array to be set.
  114317. * @returns this effect.
  114318. */
  114319. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114320. /**
  114321. * 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)
  114322. * @param uniformName Name of the variable.
  114323. * @param array array to be set.
  114324. * @returns this effect.
  114325. */
  114326. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114327. /**
  114328. * 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)
  114329. * @param uniformName Name of the variable.
  114330. * @param array array to be set.
  114331. * @returns this effect.
  114332. */
  114333. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114334. /**
  114335. * Sets an array on a uniform variable.
  114336. * @param uniformName Name of the variable.
  114337. * @param array array to be set.
  114338. * @returns this effect.
  114339. */
  114340. setArray(uniformName: string, array: number[]): Effect;
  114341. /**
  114342. * 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)
  114343. * @param uniformName Name of the variable.
  114344. * @param array array to be set.
  114345. * @returns this effect.
  114346. */
  114347. setArray2(uniformName: string, array: number[]): Effect;
  114348. /**
  114349. * 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)
  114350. * @param uniformName Name of the variable.
  114351. * @param array array to be set.
  114352. * @returns this effect.
  114353. */
  114354. setArray3(uniformName: string, array: number[]): Effect;
  114355. /**
  114356. * 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)
  114357. * @param uniformName Name of the variable.
  114358. * @param array array to be set.
  114359. * @returns this effect.
  114360. */
  114361. setArray4(uniformName: string, array: number[]): Effect;
  114362. /**
  114363. * Sets matrices on a uniform variable.
  114364. * @param uniformName Name of the variable.
  114365. * @param matrices matrices to be set.
  114366. * @returns this effect.
  114367. */
  114368. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114369. /**
  114370. * Sets matrix on a uniform variable.
  114371. * @param uniformName Name of the variable.
  114372. * @param matrix matrix to be set.
  114373. * @returns this effect.
  114374. */
  114375. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114376. /**
  114377. * 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)
  114378. * @param uniformName Name of the variable.
  114379. * @param matrix matrix to be set.
  114380. * @returns this effect.
  114381. */
  114382. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114383. /**
  114384. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114385. * @param uniformName Name of the variable.
  114386. * @param matrix matrix to be set.
  114387. * @returns this effect.
  114388. */
  114389. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114390. /**
  114391. * Sets a float on a uniform variable.
  114392. * @param uniformName Name of the variable.
  114393. * @param value value to be set.
  114394. * @returns this effect.
  114395. */
  114396. setFloat(uniformName: string, value: number): Effect;
  114397. /**
  114398. * Sets a boolean on a uniform variable.
  114399. * @param uniformName Name of the variable.
  114400. * @param bool value to be set.
  114401. * @returns this effect.
  114402. */
  114403. setBool(uniformName: string, bool: boolean): Effect;
  114404. /**
  114405. * Sets a Vector2 on a uniform variable.
  114406. * @param uniformName Name of the variable.
  114407. * @param vector2 vector2 to be set.
  114408. * @returns this effect.
  114409. */
  114410. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114411. /**
  114412. * Sets a float2 on a uniform variable.
  114413. * @param uniformName Name of the variable.
  114414. * @param x First float in float2.
  114415. * @param y Second float in float2.
  114416. * @returns this effect.
  114417. */
  114418. setFloat2(uniformName: string, x: number, y: number): Effect;
  114419. /**
  114420. * Sets a Vector3 on a uniform variable.
  114421. * @param uniformName Name of the variable.
  114422. * @param vector3 Value to be set.
  114423. * @returns this effect.
  114424. */
  114425. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114426. /**
  114427. * Sets a float3 on a uniform variable.
  114428. * @param uniformName Name of the variable.
  114429. * @param x First float in float3.
  114430. * @param y Second float in float3.
  114431. * @param z Third float in float3.
  114432. * @returns this effect.
  114433. */
  114434. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114435. /**
  114436. * Sets a Vector4 on a uniform variable.
  114437. * @param uniformName Name of the variable.
  114438. * @param vector4 Value to be set.
  114439. * @returns this effect.
  114440. */
  114441. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114442. /**
  114443. * Sets a float4 on a uniform variable.
  114444. * @param uniformName Name of the variable.
  114445. * @param x First float in float4.
  114446. * @param y Second float in float4.
  114447. * @param z Third float in float4.
  114448. * @param w Fourth float in float4.
  114449. * @returns this effect.
  114450. */
  114451. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114452. /**
  114453. * Sets a Color3 on a uniform variable.
  114454. * @param uniformName Name of the variable.
  114455. * @param color3 Value to be set.
  114456. * @returns this effect.
  114457. */
  114458. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114459. /**
  114460. * Sets a Color4 on a uniform variable.
  114461. * @param uniformName Name of the variable.
  114462. * @param color3 Value to be set.
  114463. * @param alpha Alpha value to be set.
  114464. * @returns this effect.
  114465. */
  114466. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114467. /**
  114468. * Sets a Color4 on a uniform variable
  114469. * @param uniformName defines the name of the variable
  114470. * @param color4 defines the value to be set
  114471. * @returns this effect.
  114472. */
  114473. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114474. /** Release all associated resources */
  114475. dispose(): void;
  114476. /**
  114477. * This function will add a new shader to the shader store
  114478. * @param name the name of the shader
  114479. * @param pixelShader optional pixel shader content
  114480. * @param vertexShader optional vertex shader content
  114481. */
  114482. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114483. /**
  114484. * Store of each shader (The can be looked up using effect.key)
  114485. */
  114486. static ShadersStore: {
  114487. [key: string]: string;
  114488. };
  114489. /**
  114490. * Store of each included file for a shader (The can be looked up using effect.key)
  114491. */
  114492. static IncludesShadersStore: {
  114493. [key: string]: string;
  114494. };
  114495. /**
  114496. * Resets the cache of effects.
  114497. */
  114498. static ResetCache(): void;
  114499. }
  114500. }
  114501. declare module BABYLON {
  114502. /**
  114503. * Interface used to describe the capabilities of the engine relatively to the current browser
  114504. */
  114505. export interface EngineCapabilities {
  114506. /** Maximum textures units per fragment shader */
  114507. maxTexturesImageUnits: number;
  114508. /** Maximum texture units per vertex shader */
  114509. maxVertexTextureImageUnits: number;
  114510. /** Maximum textures units in the entire pipeline */
  114511. maxCombinedTexturesImageUnits: number;
  114512. /** Maximum texture size */
  114513. maxTextureSize: number;
  114514. /** Maximum texture samples */
  114515. maxSamples?: number;
  114516. /** Maximum cube texture size */
  114517. maxCubemapTextureSize: number;
  114518. /** Maximum render texture size */
  114519. maxRenderTextureSize: number;
  114520. /** Maximum number of vertex attributes */
  114521. maxVertexAttribs: number;
  114522. /** Maximum number of varyings */
  114523. maxVaryingVectors: number;
  114524. /** Maximum number of uniforms per vertex shader */
  114525. maxVertexUniformVectors: number;
  114526. /** Maximum number of uniforms per fragment shader */
  114527. maxFragmentUniformVectors: number;
  114528. /** Defines if standard derivates (dx/dy) are supported */
  114529. standardDerivatives: boolean;
  114530. /** Defines if s3tc texture compression is supported */
  114531. s3tc?: WEBGL_compressed_texture_s3tc;
  114532. /** Defines if pvrtc texture compression is supported */
  114533. pvrtc: any;
  114534. /** Defines if etc1 texture compression is supported */
  114535. etc1: any;
  114536. /** Defines if etc2 texture compression is supported */
  114537. etc2: any;
  114538. /** Defines if astc texture compression is supported */
  114539. astc: any;
  114540. /** Defines if float textures are supported */
  114541. textureFloat: boolean;
  114542. /** Defines if vertex array objects are supported */
  114543. vertexArrayObject: boolean;
  114544. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114545. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114546. /** Gets the maximum level of anisotropy supported */
  114547. maxAnisotropy: number;
  114548. /** Defines if instancing is supported */
  114549. instancedArrays: boolean;
  114550. /** Defines if 32 bits indices are supported */
  114551. uintIndices: boolean;
  114552. /** Defines if high precision shaders are supported */
  114553. highPrecisionShaderSupported: boolean;
  114554. /** Defines if depth reading in the fragment shader is supported */
  114555. fragmentDepthSupported: boolean;
  114556. /** Defines if float texture linear filtering is supported*/
  114557. textureFloatLinearFiltering: boolean;
  114558. /** Defines if rendering to float textures is supported */
  114559. textureFloatRender: boolean;
  114560. /** Defines if half float textures are supported*/
  114561. textureHalfFloat: boolean;
  114562. /** Defines if half float texture linear filtering is supported*/
  114563. textureHalfFloatLinearFiltering: boolean;
  114564. /** Defines if rendering to half float textures is supported */
  114565. textureHalfFloatRender: boolean;
  114566. /** Defines if textureLOD shader command is supported */
  114567. textureLOD: boolean;
  114568. /** Defines if draw buffers extension is supported */
  114569. drawBuffersExtension: boolean;
  114570. /** Defines if depth textures are supported */
  114571. depthTextureExtension: boolean;
  114572. /** Defines if float color buffer are supported */
  114573. colorBufferFloat: boolean;
  114574. /** Gets disjoint timer query extension (null if not supported) */
  114575. timerQuery?: EXT_disjoint_timer_query;
  114576. /** Defines if timestamp can be used with timer query */
  114577. canUseTimestampForTimerQuery: boolean;
  114578. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114579. multiview?: any;
  114580. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114581. oculusMultiview?: any;
  114582. /** Function used to let the system compiles shaders in background */
  114583. parallelShaderCompile?: {
  114584. COMPLETION_STATUS_KHR: number;
  114585. };
  114586. /** Max number of texture samples for MSAA */
  114587. maxMSAASamples: number;
  114588. /** Defines if the blend min max extension is supported */
  114589. blendMinMax: boolean;
  114590. }
  114591. }
  114592. declare module BABYLON {
  114593. /**
  114594. * @hidden
  114595. **/
  114596. export class DepthCullingState {
  114597. private _isDepthTestDirty;
  114598. private _isDepthMaskDirty;
  114599. private _isDepthFuncDirty;
  114600. private _isCullFaceDirty;
  114601. private _isCullDirty;
  114602. private _isZOffsetDirty;
  114603. private _isFrontFaceDirty;
  114604. private _depthTest;
  114605. private _depthMask;
  114606. private _depthFunc;
  114607. private _cull;
  114608. private _cullFace;
  114609. private _zOffset;
  114610. private _frontFace;
  114611. /**
  114612. * Initializes the state.
  114613. */
  114614. constructor();
  114615. get isDirty(): boolean;
  114616. get zOffset(): number;
  114617. set zOffset(value: number);
  114618. get cullFace(): Nullable<number>;
  114619. set cullFace(value: Nullable<number>);
  114620. get cull(): Nullable<boolean>;
  114621. set cull(value: Nullable<boolean>);
  114622. get depthFunc(): Nullable<number>;
  114623. set depthFunc(value: Nullable<number>);
  114624. get depthMask(): boolean;
  114625. set depthMask(value: boolean);
  114626. get depthTest(): boolean;
  114627. set depthTest(value: boolean);
  114628. get frontFace(): Nullable<number>;
  114629. set frontFace(value: Nullable<number>);
  114630. reset(): void;
  114631. apply(gl: WebGLRenderingContext): void;
  114632. }
  114633. }
  114634. declare module BABYLON {
  114635. /**
  114636. * @hidden
  114637. **/
  114638. export class StencilState {
  114639. /** 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 */
  114640. static readonly ALWAYS: number;
  114641. /** Passed to stencilOperation to specify that stencil value must be kept */
  114642. static readonly KEEP: number;
  114643. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114644. static readonly REPLACE: number;
  114645. private _isStencilTestDirty;
  114646. private _isStencilMaskDirty;
  114647. private _isStencilFuncDirty;
  114648. private _isStencilOpDirty;
  114649. private _stencilTest;
  114650. private _stencilMask;
  114651. private _stencilFunc;
  114652. private _stencilFuncRef;
  114653. private _stencilFuncMask;
  114654. private _stencilOpStencilFail;
  114655. private _stencilOpDepthFail;
  114656. private _stencilOpStencilDepthPass;
  114657. get isDirty(): boolean;
  114658. get stencilFunc(): number;
  114659. set stencilFunc(value: number);
  114660. get stencilFuncRef(): number;
  114661. set stencilFuncRef(value: number);
  114662. get stencilFuncMask(): number;
  114663. set stencilFuncMask(value: number);
  114664. get stencilOpStencilFail(): number;
  114665. set stencilOpStencilFail(value: number);
  114666. get stencilOpDepthFail(): number;
  114667. set stencilOpDepthFail(value: number);
  114668. get stencilOpStencilDepthPass(): number;
  114669. set stencilOpStencilDepthPass(value: number);
  114670. get stencilMask(): number;
  114671. set stencilMask(value: number);
  114672. get stencilTest(): boolean;
  114673. set stencilTest(value: boolean);
  114674. constructor();
  114675. reset(): void;
  114676. apply(gl: WebGLRenderingContext): void;
  114677. }
  114678. }
  114679. declare module BABYLON {
  114680. /**
  114681. * @hidden
  114682. **/
  114683. export class AlphaState {
  114684. private _isAlphaBlendDirty;
  114685. private _isBlendFunctionParametersDirty;
  114686. private _isBlendEquationParametersDirty;
  114687. private _isBlendConstantsDirty;
  114688. private _alphaBlend;
  114689. private _blendFunctionParameters;
  114690. private _blendEquationParameters;
  114691. private _blendConstants;
  114692. /**
  114693. * Initializes the state.
  114694. */
  114695. constructor();
  114696. get isDirty(): boolean;
  114697. get alphaBlend(): boolean;
  114698. set alphaBlend(value: boolean);
  114699. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114700. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114701. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114702. reset(): void;
  114703. apply(gl: WebGLRenderingContext): void;
  114704. }
  114705. }
  114706. declare module BABYLON {
  114707. /** @hidden */
  114708. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114709. attributeProcessor(attribute: string): string;
  114710. varyingProcessor(varying: string, isFragment: boolean): string;
  114711. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114712. }
  114713. }
  114714. declare module BABYLON {
  114715. /**
  114716. * Interface for attribute information associated with buffer instanciation
  114717. */
  114718. export interface InstancingAttributeInfo {
  114719. /**
  114720. * Name of the GLSL attribute
  114721. * if attribute index is not specified, this is used to retrieve the index from the effect
  114722. */
  114723. attributeName: string;
  114724. /**
  114725. * Index/offset of the attribute in the vertex shader
  114726. * if not specified, this will be computes from the name.
  114727. */
  114728. index?: number;
  114729. /**
  114730. * size of the attribute, 1, 2, 3 or 4
  114731. */
  114732. attributeSize: number;
  114733. /**
  114734. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114735. */
  114736. offset: number;
  114737. /**
  114738. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114739. * default to 1
  114740. */
  114741. divisor?: number;
  114742. /**
  114743. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114744. * default is FLOAT
  114745. */
  114746. attributeType?: number;
  114747. /**
  114748. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114749. */
  114750. normalized?: boolean;
  114751. }
  114752. }
  114753. declare module BABYLON {
  114754. interface ThinEngine {
  114755. /**
  114756. * Update a video texture
  114757. * @param texture defines the texture to update
  114758. * @param video defines the video element to use
  114759. * @param invertY defines if data must be stored with Y axis inverted
  114760. */
  114761. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114762. }
  114763. }
  114764. declare module BABYLON {
  114765. interface ThinEngine {
  114766. /**
  114767. * Creates a dynamic texture
  114768. * @param width defines the width of the texture
  114769. * @param height defines the height of the texture
  114770. * @param generateMipMaps defines if the engine should generate the mip levels
  114771. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114772. * @returns the dynamic texture inside an InternalTexture
  114773. */
  114774. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114775. /**
  114776. * Update the content of a dynamic texture
  114777. * @param texture defines the texture to update
  114778. * @param canvas defines the canvas containing the source
  114779. * @param invertY defines if data must be stored with Y axis inverted
  114780. * @param premulAlpha defines if alpha is stored as premultiplied
  114781. * @param format defines the format of the data
  114782. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114783. */
  114784. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114785. }
  114786. }
  114787. declare module BABYLON {
  114788. /**
  114789. * Settings for finer control over video usage
  114790. */
  114791. export interface VideoTextureSettings {
  114792. /**
  114793. * Applies `autoplay` to video, if specified
  114794. */
  114795. autoPlay?: boolean;
  114796. /**
  114797. * Applies `loop` to video, if specified
  114798. */
  114799. loop?: boolean;
  114800. /**
  114801. * Automatically updates internal texture from video at every frame in the render loop
  114802. */
  114803. autoUpdateTexture: boolean;
  114804. /**
  114805. * Image src displayed during the video loading or until the user interacts with the video.
  114806. */
  114807. poster?: string;
  114808. }
  114809. /**
  114810. * If you want to display a video in your scene, this is the special texture for that.
  114811. * This special texture works similar to other textures, with the exception of a few parameters.
  114812. * @see https://doc.babylonjs.com/how_to/video_texture
  114813. */
  114814. export class VideoTexture extends Texture {
  114815. /**
  114816. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114817. */
  114818. readonly autoUpdateTexture: boolean;
  114819. /**
  114820. * The video instance used by the texture internally
  114821. */
  114822. readonly video: HTMLVideoElement;
  114823. private _onUserActionRequestedObservable;
  114824. /**
  114825. * Event triggerd when a dom action is required by the user to play the video.
  114826. * This happens due to recent changes in browser policies preventing video to auto start.
  114827. */
  114828. get onUserActionRequestedObservable(): Observable<Texture>;
  114829. private _generateMipMaps;
  114830. private _stillImageCaptured;
  114831. private _displayingPosterTexture;
  114832. private _settings;
  114833. private _createInternalTextureOnEvent;
  114834. private _frameId;
  114835. private _currentSrc;
  114836. /**
  114837. * Creates a video texture.
  114838. * If you want to display a video in your scene, this is the special texture for that.
  114839. * This special texture works similar to other textures, with the exception of a few parameters.
  114840. * @see https://doc.babylonjs.com/how_to/video_texture
  114841. * @param name optional name, will detect from video source, if not defined
  114842. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114843. * @param scene is obviously the current scene.
  114844. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114845. * @param invertY is false by default but can be used to invert video on Y axis
  114846. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114847. * @param settings allows finer control over video usage
  114848. */
  114849. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114850. private _getName;
  114851. private _getVideo;
  114852. private _createInternalTexture;
  114853. private reset;
  114854. /**
  114855. * @hidden Internal method to initiate `update`.
  114856. */
  114857. _rebuild(): void;
  114858. /**
  114859. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114860. */
  114861. update(): void;
  114862. /**
  114863. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114864. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114865. */
  114866. updateTexture(isVisible: boolean): void;
  114867. protected _updateInternalTexture: () => void;
  114868. /**
  114869. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114870. * @param url New url.
  114871. */
  114872. updateURL(url: string): void;
  114873. /**
  114874. * Clones the texture.
  114875. * @returns the cloned texture
  114876. */
  114877. clone(): VideoTexture;
  114878. /**
  114879. * Dispose the texture and release its associated resources.
  114880. */
  114881. dispose(): void;
  114882. /**
  114883. * Creates a video texture straight from a stream.
  114884. * @param scene Define the scene the texture should be created in
  114885. * @param stream Define the stream the texture should be created from
  114886. * @returns The created video texture as a promise
  114887. */
  114888. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114889. /**
  114890. * Creates a video texture straight from your WebCam video feed.
  114891. * @param scene Define the scene the texture should be created in
  114892. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114893. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114894. * @returns The created video texture as a promise
  114895. */
  114896. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114897. minWidth: number;
  114898. maxWidth: number;
  114899. minHeight: number;
  114900. maxHeight: number;
  114901. deviceId: string;
  114902. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114903. /**
  114904. * Creates a video texture straight from your WebCam video feed.
  114905. * @param scene Define the scene the texture should be created in
  114906. * @param onReady Define a callback to triggered once the texture will be ready
  114907. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114908. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114909. */
  114910. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114911. minWidth: number;
  114912. maxWidth: number;
  114913. minHeight: number;
  114914. maxHeight: number;
  114915. deviceId: string;
  114916. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114917. }
  114918. }
  114919. declare module BABYLON {
  114920. /**
  114921. * Defines the interface used by objects working like Scene
  114922. * @hidden
  114923. */
  114924. export interface ISceneLike {
  114925. _addPendingData(data: any): void;
  114926. _removePendingData(data: any): void;
  114927. offlineProvider: IOfflineProvider;
  114928. }
  114929. /**
  114930. * Information about the current host
  114931. */
  114932. export interface HostInformation {
  114933. /**
  114934. * Defines if the current host is a mobile
  114935. */
  114936. isMobile: boolean;
  114937. }
  114938. /** Interface defining initialization parameters for Engine class */
  114939. export interface EngineOptions extends WebGLContextAttributes {
  114940. /**
  114941. * Defines if the engine should no exceed a specified device ratio
  114942. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114943. */
  114944. limitDeviceRatio?: number;
  114945. /**
  114946. * Defines if webvr should be enabled automatically
  114947. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114948. */
  114949. autoEnableWebVR?: boolean;
  114950. /**
  114951. * Defines if webgl2 should be turned off even if supported
  114952. * @see https://doc.babylonjs.com/features/webgl2
  114953. */
  114954. disableWebGL2Support?: boolean;
  114955. /**
  114956. * Defines if webaudio should be initialized as well
  114957. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114958. */
  114959. audioEngine?: boolean;
  114960. /**
  114961. * Defines if animations should run using a deterministic lock step
  114962. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114963. */
  114964. deterministicLockstep?: boolean;
  114965. /** Defines the maximum steps to use with deterministic lock step mode */
  114966. lockstepMaxSteps?: number;
  114967. /** Defines the seconds between each deterministic lock step */
  114968. timeStep?: number;
  114969. /**
  114970. * Defines that engine should ignore context lost events
  114971. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114972. */
  114973. doNotHandleContextLost?: boolean;
  114974. /**
  114975. * Defines that engine should ignore modifying touch action attribute and style
  114976. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114977. */
  114978. doNotHandleTouchAction?: boolean;
  114979. /**
  114980. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114981. */
  114982. useHighPrecisionFloats?: boolean;
  114983. /**
  114984. * Make the canvas XR Compatible for XR sessions
  114985. */
  114986. xrCompatible?: boolean;
  114987. /**
  114988. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114989. */
  114990. useHighPrecisionMatrix?: boolean;
  114991. }
  114992. /**
  114993. * The base engine class (root of all engines)
  114994. */
  114995. export class ThinEngine {
  114996. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114997. static ExceptionList: ({
  114998. key: string;
  114999. capture: string;
  115000. captureConstraint: number;
  115001. targets: string[];
  115002. } | {
  115003. key: string;
  115004. capture: null;
  115005. captureConstraint: null;
  115006. targets: string[];
  115007. })[];
  115008. /** @hidden */
  115009. static _TextureLoaders: IInternalTextureLoader[];
  115010. /**
  115011. * Returns the current npm package of the sdk
  115012. */
  115013. static get NpmPackage(): string;
  115014. /**
  115015. * Returns the current version of the framework
  115016. */
  115017. static get Version(): string;
  115018. /**
  115019. * Returns a string describing the current engine
  115020. */
  115021. get description(): string;
  115022. /**
  115023. * Gets or sets the epsilon value used by collision engine
  115024. */
  115025. static CollisionsEpsilon: number;
  115026. /**
  115027. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  115028. */
  115029. static get ShadersRepository(): string;
  115030. static set ShadersRepository(value: string);
  115031. /** @hidden */
  115032. _shaderProcessor: IShaderProcessor;
  115033. /**
  115034. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  115035. */
  115036. forcePOTTextures: boolean;
  115037. /**
  115038. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  115039. */
  115040. isFullscreen: boolean;
  115041. /**
  115042. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  115043. */
  115044. cullBackFaces: boolean;
  115045. /**
  115046. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  115047. */
  115048. renderEvenInBackground: boolean;
  115049. /**
  115050. * Gets or sets a boolean indicating that cache can be kept between frames
  115051. */
  115052. preventCacheWipeBetweenFrames: boolean;
  115053. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  115054. validateShaderPrograms: boolean;
  115055. /**
  115056. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  115057. * This can provide greater z depth for distant objects.
  115058. */
  115059. useReverseDepthBuffer: boolean;
  115060. /**
  115061. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  115062. */
  115063. disableUniformBuffers: boolean;
  115064. /** @hidden */
  115065. _uniformBuffers: UniformBuffer[];
  115066. /**
  115067. * Gets a boolean indicating that the engine supports uniform buffers
  115068. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  115069. */
  115070. get supportsUniformBuffers(): boolean;
  115071. /** @hidden */
  115072. _gl: WebGLRenderingContext;
  115073. /** @hidden */
  115074. _webGLVersion: number;
  115075. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  115076. protected _windowIsBackground: boolean;
  115077. protected _creationOptions: EngineOptions;
  115078. protected _highPrecisionShadersAllowed: boolean;
  115079. /** @hidden */
  115080. get _shouldUseHighPrecisionShader(): boolean;
  115081. /**
  115082. * Gets a boolean indicating that only power of 2 textures are supported
  115083. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  115084. */
  115085. get needPOTTextures(): boolean;
  115086. /** @hidden */
  115087. _badOS: boolean;
  115088. /** @hidden */
  115089. _badDesktopOS: boolean;
  115090. private _hardwareScalingLevel;
  115091. /** @hidden */
  115092. _caps: EngineCapabilities;
  115093. private _isStencilEnable;
  115094. private _glVersion;
  115095. private _glRenderer;
  115096. private _glVendor;
  115097. /** @hidden */
  115098. _videoTextureSupported: boolean;
  115099. protected _renderingQueueLaunched: boolean;
  115100. protected _activeRenderLoops: (() => void)[];
  115101. /**
  115102. * Observable signaled when a context lost event is raised
  115103. */
  115104. onContextLostObservable: Observable<ThinEngine>;
  115105. /**
  115106. * Observable signaled when a context restored event is raised
  115107. */
  115108. onContextRestoredObservable: Observable<ThinEngine>;
  115109. private _onContextLost;
  115110. private _onContextRestored;
  115111. protected _contextWasLost: boolean;
  115112. /** @hidden */
  115113. _doNotHandleContextLost: boolean;
  115114. /**
  115115. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115116. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115117. */
  115118. get doNotHandleContextLost(): boolean;
  115119. set doNotHandleContextLost(value: boolean);
  115120. /**
  115121. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115122. */
  115123. disableVertexArrayObjects: boolean;
  115124. /** @hidden */
  115125. protected _colorWrite: boolean;
  115126. /** @hidden */
  115127. protected _colorWriteChanged: boolean;
  115128. /** @hidden */
  115129. protected _depthCullingState: DepthCullingState;
  115130. /** @hidden */
  115131. protected _stencilState: StencilState;
  115132. /** @hidden */
  115133. _alphaState: AlphaState;
  115134. /** @hidden */
  115135. _alphaMode: number;
  115136. /** @hidden */
  115137. _alphaEquation: number;
  115138. /** @hidden */
  115139. _internalTexturesCache: InternalTexture[];
  115140. /** @hidden */
  115141. protected _activeChannel: number;
  115142. private _currentTextureChannel;
  115143. /** @hidden */
  115144. protected _boundTexturesCache: {
  115145. [key: string]: Nullable<InternalTexture>;
  115146. };
  115147. /** @hidden */
  115148. protected _currentEffect: Nullable<Effect>;
  115149. /** @hidden */
  115150. protected _currentProgram: Nullable<WebGLProgram>;
  115151. private _compiledEffects;
  115152. private _vertexAttribArraysEnabled;
  115153. /** @hidden */
  115154. protected _cachedViewport: Nullable<IViewportLike>;
  115155. private _cachedVertexArrayObject;
  115156. /** @hidden */
  115157. protected _cachedVertexBuffers: any;
  115158. /** @hidden */
  115159. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115160. /** @hidden */
  115161. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115162. /** @hidden */
  115163. _currentRenderTarget: Nullable<InternalTexture>;
  115164. private _uintIndicesCurrentlySet;
  115165. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115166. /** @hidden */
  115167. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115168. /** @hidden */
  115169. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115170. private _currentBufferPointers;
  115171. private _currentInstanceLocations;
  115172. private _currentInstanceBuffers;
  115173. private _textureUnits;
  115174. /** @hidden */
  115175. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115176. /** @hidden */
  115177. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115178. /** @hidden */
  115179. _boundRenderFunction: any;
  115180. private _vaoRecordInProgress;
  115181. private _mustWipeVertexAttributes;
  115182. private _emptyTexture;
  115183. private _emptyCubeTexture;
  115184. private _emptyTexture3D;
  115185. private _emptyTexture2DArray;
  115186. /** @hidden */
  115187. _frameHandler: number;
  115188. private _nextFreeTextureSlots;
  115189. private _maxSimultaneousTextures;
  115190. private _activeRequests;
  115191. /** @hidden */
  115192. _transformTextureUrl: Nullable<(url: string) => string>;
  115193. /**
  115194. * Gets information about the current host
  115195. */
  115196. hostInformation: HostInformation;
  115197. protected get _supportsHardwareTextureRescaling(): boolean;
  115198. private _framebufferDimensionsObject;
  115199. /**
  115200. * sets the object from which width and height will be taken from when getting render width and height
  115201. * Will fallback to the gl object
  115202. * @param dimensions the framebuffer width and height that will be used.
  115203. */
  115204. set framebufferDimensionsObject(dimensions: Nullable<{
  115205. framebufferWidth: number;
  115206. framebufferHeight: number;
  115207. }>);
  115208. /**
  115209. * Gets the current viewport
  115210. */
  115211. get currentViewport(): Nullable<IViewportLike>;
  115212. /**
  115213. * Gets the default empty texture
  115214. */
  115215. get emptyTexture(): InternalTexture;
  115216. /**
  115217. * Gets the default empty 3D texture
  115218. */
  115219. get emptyTexture3D(): InternalTexture;
  115220. /**
  115221. * Gets the default empty 2D array texture
  115222. */
  115223. get emptyTexture2DArray(): InternalTexture;
  115224. /**
  115225. * Gets the default empty cube texture
  115226. */
  115227. get emptyCubeTexture(): InternalTexture;
  115228. /**
  115229. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115230. */
  115231. readonly premultipliedAlpha: boolean;
  115232. /**
  115233. * Observable event triggered before each texture is initialized
  115234. */
  115235. onBeforeTextureInitObservable: Observable<Texture>;
  115236. /**
  115237. * Creates a new engine
  115238. * @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
  115239. * @param antialias defines enable antialiasing (default: false)
  115240. * @param options defines further options to be sent to the getContext() function
  115241. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115242. */
  115243. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115244. private _rebuildInternalTextures;
  115245. private _rebuildEffects;
  115246. /**
  115247. * Gets a boolean indicating if all created effects are ready
  115248. * @returns true if all effects are ready
  115249. */
  115250. areAllEffectsReady(): boolean;
  115251. protected _rebuildBuffers(): void;
  115252. protected _initGLContext(): void;
  115253. /**
  115254. * Gets version of the current webGL context
  115255. */
  115256. get webGLVersion(): number;
  115257. /**
  115258. * Gets a string identifying the name of the class
  115259. * @returns "Engine" string
  115260. */
  115261. getClassName(): string;
  115262. /**
  115263. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115264. */
  115265. get isStencilEnable(): boolean;
  115266. /** @hidden */
  115267. _prepareWorkingCanvas(): void;
  115268. /**
  115269. * Reset the texture cache to empty state
  115270. */
  115271. resetTextureCache(): void;
  115272. /**
  115273. * Gets an object containing information about the current webGL context
  115274. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115275. */
  115276. getGlInfo(): {
  115277. vendor: string;
  115278. renderer: string;
  115279. version: string;
  115280. };
  115281. /**
  115282. * Defines the hardware scaling level.
  115283. * By default the hardware scaling level is computed from the window device ratio.
  115284. * 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.
  115285. * @param level defines the level to use
  115286. */
  115287. setHardwareScalingLevel(level: number): void;
  115288. /**
  115289. * Gets the current hardware scaling level.
  115290. * By default the hardware scaling level is computed from the window device ratio.
  115291. * 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.
  115292. * @returns a number indicating the current hardware scaling level
  115293. */
  115294. getHardwareScalingLevel(): number;
  115295. /**
  115296. * Gets the list of loaded textures
  115297. * @returns an array containing all loaded textures
  115298. */
  115299. getLoadedTexturesCache(): InternalTexture[];
  115300. /**
  115301. * Gets the object containing all engine capabilities
  115302. * @returns the EngineCapabilities object
  115303. */
  115304. getCaps(): EngineCapabilities;
  115305. /**
  115306. * stop executing a render loop function and remove it from the execution array
  115307. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115308. */
  115309. stopRenderLoop(renderFunction?: () => void): void;
  115310. /** @hidden */
  115311. _renderLoop(): void;
  115312. /**
  115313. * Gets the HTML canvas attached with the current webGL context
  115314. * @returns a HTML canvas
  115315. */
  115316. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115317. /**
  115318. * Gets host window
  115319. * @returns the host window object
  115320. */
  115321. getHostWindow(): Nullable<Window>;
  115322. /**
  115323. * Gets the current render width
  115324. * @param useScreen defines if screen size must be used (or the current render target if any)
  115325. * @returns a number defining the current render width
  115326. */
  115327. getRenderWidth(useScreen?: boolean): number;
  115328. /**
  115329. * Gets the current render height
  115330. * @param useScreen defines if screen size must be used (or the current render target if any)
  115331. * @returns a number defining the current render height
  115332. */
  115333. getRenderHeight(useScreen?: boolean): number;
  115334. /**
  115335. * Can be used to override the current requestAnimationFrame requester.
  115336. * @hidden
  115337. */
  115338. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115339. /**
  115340. * Register and execute a render loop. The engine can have more than one render function
  115341. * @param renderFunction defines the function to continuously execute
  115342. */
  115343. runRenderLoop(renderFunction: () => void): void;
  115344. /**
  115345. * Clear the current render buffer or the current render target (if any is set up)
  115346. * @param color defines the color to use
  115347. * @param backBuffer defines if the back buffer must be cleared
  115348. * @param depth defines if the depth buffer must be cleared
  115349. * @param stencil defines if the stencil buffer must be cleared
  115350. */
  115351. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115352. private _viewportCached;
  115353. /** @hidden */
  115354. _viewport(x: number, y: number, width: number, height: number): void;
  115355. /**
  115356. * Set the WebGL's viewport
  115357. * @param viewport defines the viewport element to be used
  115358. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115359. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115360. */
  115361. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115362. /**
  115363. * Begin a new frame
  115364. */
  115365. beginFrame(): void;
  115366. /**
  115367. * Enf the current frame
  115368. */
  115369. endFrame(): void;
  115370. /**
  115371. * Resize the view according to the canvas' size
  115372. */
  115373. resize(): void;
  115374. /**
  115375. * Force a specific size of the canvas
  115376. * @param width defines the new canvas' width
  115377. * @param height defines the new canvas' height
  115378. * @returns true if the size was changed
  115379. */
  115380. setSize(width: number, height: number): boolean;
  115381. /**
  115382. * Binds the frame buffer to the specified texture.
  115383. * @param texture The texture to render to or null for the default canvas
  115384. * @param faceIndex The face of the texture to render to in case of cube texture
  115385. * @param requiredWidth The width of the target to render to
  115386. * @param requiredHeight The height of the target to render to
  115387. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115388. * @param lodLevel defines the lod level to bind to the frame buffer
  115389. * @param layer defines the 2d array index to bind to frame buffer to
  115390. */
  115391. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115392. /** @hidden */
  115393. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115394. /**
  115395. * Unbind the current render target texture from the webGL context
  115396. * @param texture defines the render target texture to unbind
  115397. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115398. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115399. */
  115400. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115401. /**
  115402. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115403. */
  115404. flushFramebuffer(): void;
  115405. /**
  115406. * Unbind the current render target and bind the default framebuffer
  115407. */
  115408. restoreDefaultFramebuffer(): void;
  115409. /** @hidden */
  115410. protected _resetVertexBufferBinding(): void;
  115411. /**
  115412. * Creates a vertex buffer
  115413. * @param data the data for the vertex buffer
  115414. * @returns the new WebGL static buffer
  115415. */
  115416. createVertexBuffer(data: DataArray): DataBuffer;
  115417. private _createVertexBuffer;
  115418. /**
  115419. * Creates a dynamic vertex buffer
  115420. * @param data the data for the dynamic vertex buffer
  115421. * @returns the new WebGL dynamic buffer
  115422. */
  115423. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115424. protected _resetIndexBufferBinding(): void;
  115425. /**
  115426. * Creates a new index buffer
  115427. * @param indices defines the content of the index buffer
  115428. * @param updatable defines if the index buffer must be updatable
  115429. * @returns a new webGL buffer
  115430. */
  115431. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115432. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115433. /**
  115434. * Bind a webGL buffer to the webGL context
  115435. * @param buffer defines the buffer to bind
  115436. */
  115437. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115438. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115439. private bindBuffer;
  115440. /**
  115441. * update the bound buffer with the given data
  115442. * @param data defines the data to update
  115443. */
  115444. updateArrayBuffer(data: Float32Array): void;
  115445. private _vertexAttribPointer;
  115446. /** @hidden */
  115447. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115448. private _bindVertexBuffersAttributes;
  115449. /**
  115450. * Records a vertex array object
  115451. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115452. * @param vertexBuffers defines the list of vertex buffers to store
  115453. * @param indexBuffer defines the index buffer to store
  115454. * @param effect defines the effect to store
  115455. * @returns the new vertex array object
  115456. */
  115457. recordVertexArrayObject(vertexBuffers: {
  115458. [key: string]: VertexBuffer;
  115459. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115460. /**
  115461. * Bind a specific vertex array object
  115462. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115463. * @param vertexArrayObject defines the vertex array object to bind
  115464. * @param indexBuffer defines the index buffer to bind
  115465. */
  115466. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115467. /**
  115468. * Bind webGl buffers directly to the webGL context
  115469. * @param vertexBuffer defines the vertex buffer to bind
  115470. * @param indexBuffer defines the index buffer to bind
  115471. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115472. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115473. * @param effect defines the effect associated with the vertex buffer
  115474. */
  115475. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115476. private _unbindVertexArrayObject;
  115477. /**
  115478. * Bind a list of vertex buffers to the webGL context
  115479. * @param vertexBuffers defines the list of vertex buffers to bind
  115480. * @param indexBuffer defines the index buffer to bind
  115481. * @param effect defines the effect associated with the vertex buffers
  115482. */
  115483. bindBuffers(vertexBuffers: {
  115484. [key: string]: Nullable<VertexBuffer>;
  115485. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115486. /**
  115487. * Unbind all instance attributes
  115488. */
  115489. unbindInstanceAttributes(): void;
  115490. /**
  115491. * Release and free the memory of a vertex array object
  115492. * @param vao defines the vertex array object to delete
  115493. */
  115494. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115495. /** @hidden */
  115496. _releaseBuffer(buffer: DataBuffer): boolean;
  115497. protected _deleteBuffer(buffer: DataBuffer): void;
  115498. /**
  115499. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115500. * @param instancesBuffer defines the webGL buffer to update and bind
  115501. * @param data defines the data to store in the buffer
  115502. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115503. */
  115504. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115505. /**
  115506. * Bind the content of a webGL buffer used with instantiation
  115507. * @param instancesBuffer defines the webGL buffer to bind
  115508. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115509. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115510. */
  115511. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115512. /**
  115513. * Disable the instance attribute corresponding to the name in parameter
  115514. * @param name defines the name of the attribute to disable
  115515. */
  115516. disableInstanceAttributeByName(name: string): void;
  115517. /**
  115518. * Disable the instance attribute corresponding to the location in parameter
  115519. * @param attributeLocation defines the attribute location of the attribute to disable
  115520. */
  115521. disableInstanceAttribute(attributeLocation: number): void;
  115522. /**
  115523. * Disable the attribute corresponding to the location in parameter
  115524. * @param attributeLocation defines the attribute location of the attribute to disable
  115525. */
  115526. disableAttributeByIndex(attributeLocation: number): void;
  115527. /**
  115528. * Send a draw order
  115529. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115530. * @param indexStart defines the starting index
  115531. * @param indexCount defines the number of index to draw
  115532. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115533. */
  115534. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115535. /**
  115536. * Draw a list of points
  115537. * @param verticesStart defines the index of first vertex to draw
  115538. * @param verticesCount defines the count of vertices to draw
  115539. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115540. */
  115541. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115542. /**
  115543. * Draw a list of unindexed primitives
  115544. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115545. * @param verticesStart defines the index of first vertex to draw
  115546. * @param verticesCount defines the count of vertices to draw
  115547. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115548. */
  115549. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115550. /**
  115551. * Draw a list of indexed primitives
  115552. * @param fillMode defines the primitive to use
  115553. * @param indexStart defines the starting index
  115554. * @param indexCount defines the number of index to draw
  115555. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115556. */
  115557. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115558. /**
  115559. * Draw a list of unindexed primitives
  115560. * @param fillMode defines the primitive to use
  115561. * @param verticesStart defines the index of first vertex to draw
  115562. * @param verticesCount defines the count of vertices to draw
  115563. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115564. */
  115565. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115566. private _drawMode;
  115567. /** @hidden */
  115568. protected _reportDrawCall(): void;
  115569. /** @hidden */
  115570. _releaseEffect(effect: Effect): void;
  115571. /** @hidden */
  115572. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115573. /**
  115574. * Create a new effect (used to store vertex/fragment shaders)
  115575. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115576. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115577. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115578. * @param samplers defines an array of string used to represent textures
  115579. * @param defines defines the string containing the defines to use to compile the shaders
  115580. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115581. * @param onCompiled defines a function to call when the effect creation is successful
  115582. * @param onError defines a function to call when the effect creation has failed
  115583. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115584. * @returns the new Effect
  115585. */
  115586. 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;
  115587. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115588. private _compileShader;
  115589. private _compileRawShader;
  115590. /** @hidden */
  115591. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115592. /**
  115593. * Directly creates a webGL program
  115594. * @param pipelineContext defines the pipeline context to attach to
  115595. * @param vertexCode defines the vertex shader code to use
  115596. * @param fragmentCode defines the fragment shader code to use
  115597. * @param context defines the webGL context to use (if not set, the current one will be used)
  115598. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115599. * @returns the new webGL program
  115600. */
  115601. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115602. /**
  115603. * Creates a webGL program
  115604. * @param pipelineContext defines the pipeline context to attach to
  115605. * @param vertexCode defines the vertex shader code to use
  115606. * @param fragmentCode defines the fragment shader code to use
  115607. * @param defines defines the string containing the defines to use to compile the shaders
  115608. * @param context defines the webGL context to use (if not set, the current one will be used)
  115609. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115610. * @returns the new webGL program
  115611. */
  115612. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115613. /**
  115614. * Creates a new pipeline context
  115615. * @returns the new pipeline
  115616. */
  115617. createPipelineContext(): IPipelineContext;
  115618. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115619. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115620. /** @hidden */
  115621. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115622. /** @hidden */
  115623. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115624. /** @hidden */
  115625. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115626. /**
  115627. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115628. * @param pipelineContext defines the pipeline context to use
  115629. * @param uniformsNames defines the list of uniform names
  115630. * @returns an array of webGL uniform locations
  115631. */
  115632. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115633. /**
  115634. * Gets the lsit of active attributes for a given webGL program
  115635. * @param pipelineContext defines the pipeline context to use
  115636. * @param attributesNames defines the list of attribute names to get
  115637. * @returns an array of indices indicating the offset of each attribute
  115638. */
  115639. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115640. /**
  115641. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115642. * @param effect defines the effect to activate
  115643. */
  115644. enableEffect(effect: Nullable<Effect>): void;
  115645. /**
  115646. * Set the value of an uniform to a number (int)
  115647. * @param uniform defines the webGL uniform location where to store the value
  115648. * @param value defines the int number to store
  115649. */
  115650. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115651. /**
  115652. * Set the value of an uniform to an array of int32
  115653. * @param uniform defines the webGL uniform location where to store the value
  115654. * @param array defines the array of int32 to store
  115655. */
  115656. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115657. /**
  115658. * Set the value of an uniform to an array of int32 (stored as vec2)
  115659. * @param uniform defines the webGL uniform location where to store the value
  115660. * @param array defines the array of int32 to store
  115661. */
  115662. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115663. /**
  115664. * Set the value of an uniform to an array of int32 (stored as vec3)
  115665. * @param uniform defines the webGL uniform location where to store the value
  115666. * @param array defines the array of int32 to store
  115667. */
  115668. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115669. /**
  115670. * Set the value of an uniform to an array of int32 (stored as vec4)
  115671. * @param uniform defines the webGL uniform location where to store the value
  115672. * @param array defines the array of int32 to store
  115673. */
  115674. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115675. /**
  115676. * Set the value of an uniform to an array of number
  115677. * @param uniform defines the webGL uniform location where to store the value
  115678. * @param array defines the array of number to store
  115679. */
  115680. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115681. /**
  115682. * Set the value of an uniform to an array of number (stored as vec2)
  115683. * @param uniform defines the webGL uniform location where to store the value
  115684. * @param array defines the array of number to store
  115685. */
  115686. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115687. /**
  115688. * Set the value of an uniform to an array of number (stored as vec3)
  115689. * @param uniform defines the webGL uniform location where to store the value
  115690. * @param array defines the array of number to store
  115691. */
  115692. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115693. /**
  115694. * Set the value of an uniform to an array of number (stored as vec4)
  115695. * @param uniform defines the webGL uniform location where to store the value
  115696. * @param array defines the array of number to store
  115697. */
  115698. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115699. /**
  115700. * Set the value of an uniform to an array of float32 (stored as matrices)
  115701. * @param uniform defines the webGL uniform location where to store the value
  115702. * @param matrices defines the array of float32 to store
  115703. */
  115704. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115705. /**
  115706. * Set the value of an uniform to a matrix (3x3)
  115707. * @param uniform defines the webGL uniform location where to store the value
  115708. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115709. */
  115710. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115711. /**
  115712. * Set the value of an uniform to a matrix (2x2)
  115713. * @param uniform defines the webGL uniform location where to store the value
  115714. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115715. */
  115716. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115717. /**
  115718. * Set the value of an uniform to a number (float)
  115719. * @param uniform defines the webGL uniform location where to store the value
  115720. * @param value defines the float number to store
  115721. */
  115722. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115723. /**
  115724. * Set the value of an uniform to a vec2
  115725. * @param uniform defines the webGL uniform location where to store the value
  115726. * @param x defines the 1st component of the value
  115727. * @param y defines the 2nd component of the value
  115728. */
  115729. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115730. /**
  115731. * Set the value of an uniform to a vec3
  115732. * @param uniform defines the webGL uniform location where to store the value
  115733. * @param x defines the 1st component of the value
  115734. * @param y defines the 2nd component of the value
  115735. * @param z defines the 3rd component of the value
  115736. */
  115737. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115738. /**
  115739. * Set the value of an uniform to a vec4
  115740. * @param uniform defines the webGL uniform location where to store the value
  115741. * @param x defines the 1st component of the value
  115742. * @param y defines the 2nd component of the value
  115743. * @param z defines the 3rd component of the value
  115744. * @param w defines the 4th component of the value
  115745. */
  115746. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115747. /**
  115748. * Apply all cached states (depth, culling, stencil and alpha)
  115749. */
  115750. applyStates(): void;
  115751. /**
  115752. * Enable or disable color writing
  115753. * @param enable defines the state to set
  115754. */
  115755. setColorWrite(enable: boolean): void;
  115756. /**
  115757. * Gets a boolean indicating if color writing is enabled
  115758. * @returns the current color writing state
  115759. */
  115760. getColorWrite(): boolean;
  115761. /**
  115762. * Gets the depth culling state manager
  115763. */
  115764. get depthCullingState(): DepthCullingState;
  115765. /**
  115766. * Gets the alpha state manager
  115767. */
  115768. get alphaState(): AlphaState;
  115769. /**
  115770. * Gets the stencil state manager
  115771. */
  115772. get stencilState(): StencilState;
  115773. /**
  115774. * Clears the list of texture accessible through engine.
  115775. * This can help preventing texture load conflict due to name collision.
  115776. */
  115777. clearInternalTexturesCache(): void;
  115778. /**
  115779. * Force the entire cache to be cleared
  115780. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115781. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115782. */
  115783. wipeCaches(bruteForce?: boolean): void;
  115784. /** @hidden */
  115785. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115786. min: number;
  115787. mag: number;
  115788. };
  115789. /** @hidden */
  115790. _createTexture(): WebGLTexture;
  115791. /**
  115792. * Usually called from Texture.ts.
  115793. * Passed information to create a WebGLTexture
  115794. * @param url defines a value which contains one of the following:
  115795. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115796. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115797. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115798. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115799. * @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)
  115800. * @param scene needed for loading to the correct scene
  115801. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115802. * @param onLoad optional callback to be called upon successful completion
  115803. * @param onError optional callback to be called upon failure
  115804. * @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
  115805. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115806. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115807. * @param forcedExtension defines the extension to use to pick the right loader
  115808. * @param mimeType defines an optional mime type
  115809. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115810. */
  115811. createTexture(url: 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>, mimeType?: string): InternalTexture;
  115812. /**
  115813. * Loads an image as an HTMLImageElement.
  115814. * @param input url string, ArrayBuffer, or Blob to load
  115815. * @param onLoad callback called when the image successfully loads
  115816. * @param onError callback called when the image fails to load
  115817. * @param offlineProvider offline provider for caching
  115818. * @param mimeType optional mime type
  115819. * @returns the HTMLImageElement of the loaded image
  115820. * @hidden
  115821. */
  115822. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  115823. /**
  115824. * @hidden
  115825. */
  115826. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115827. private _unpackFlipYCached;
  115828. /**
  115829. * In case you are sharing the context with other applications, it might
  115830. * be interested to not cache the unpack flip y state to ensure a consistent
  115831. * value would be set.
  115832. */
  115833. enableUnpackFlipYCached: boolean;
  115834. /** @hidden */
  115835. _unpackFlipY(value: boolean): void;
  115836. /** @hidden */
  115837. _getUnpackAlignement(): number;
  115838. private _getTextureTarget;
  115839. /**
  115840. * Update the sampling mode of a given texture
  115841. * @param samplingMode defines the required sampling mode
  115842. * @param texture defines the texture to update
  115843. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115844. */
  115845. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115846. /**
  115847. * Update the sampling mode of a given texture
  115848. * @param texture defines the texture to update
  115849. * @param wrapU defines the texture wrap mode of the u coordinates
  115850. * @param wrapV defines the texture wrap mode of the v coordinates
  115851. * @param wrapR defines the texture wrap mode of the r coordinates
  115852. */
  115853. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115854. /** @hidden */
  115855. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115856. width: number;
  115857. height: number;
  115858. layers?: number;
  115859. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115860. /** @hidden */
  115861. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115862. /** @hidden */
  115863. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115864. /**
  115865. * Update a portion of an internal texture
  115866. * @param texture defines the texture to update
  115867. * @param imageData defines the data to store into the texture
  115868. * @param xOffset defines the x coordinates of the update rectangle
  115869. * @param yOffset defines the y coordinates of the update rectangle
  115870. * @param width defines the width of the update rectangle
  115871. * @param height defines the height of the update rectangle
  115872. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115873. * @param lod defines the lod level to update (0 by default)
  115874. */
  115875. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115876. /** @hidden */
  115877. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115878. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115879. private _prepareWebGLTexture;
  115880. /** @hidden */
  115881. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115882. private _getDepthStencilBuffer;
  115883. /** @hidden */
  115884. _releaseFramebufferObjects(texture: InternalTexture): void;
  115885. /** @hidden */
  115886. _releaseTexture(texture: InternalTexture): void;
  115887. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115888. protected _setProgram(program: WebGLProgram): void;
  115889. protected _boundUniforms: {
  115890. [key: number]: WebGLUniformLocation;
  115891. };
  115892. /**
  115893. * Binds an effect to the webGL context
  115894. * @param effect defines the effect to bind
  115895. */
  115896. bindSamplers(effect: Effect): void;
  115897. private _activateCurrentTexture;
  115898. /** @hidden */
  115899. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115900. /** @hidden */
  115901. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115902. /**
  115903. * Unbind all textures from the webGL context
  115904. */
  115905. unbindAllTextures(): void;
  115906. /**
  115907. * Sets a texture to the according uniform.
  115908. * @param channel The texture channel
  115909. * @param uniform The uniform to set
  115910. * @param texture The texture to apply
  115911. */
  115912. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115913. private _bindSamplerUniformToChannel;
  115914. private _getTextureWrapMode;
  115915. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115916. /**
  115917. * Sets an array of texture to the webGL context
  115918. * @param channel defines the channel where the texture array must be set
  115919. * @param uniform defines the associated uniform location
  115920. * @param textures defines the array of textures to bind
  115921. */
  115922. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115923. /** @hidden */
  115924. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115925. private _setTextureParameterFloat;
  115926. private _setTextureParameterInteger;
  115927. /**
  115928. * Unbind all vertex attributes from the webGL context
  115929. */
  115930. unbindAllAttributes(): void;
  115931. /**
  115932. * 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
  115933. */
  115934. releaseEffects(): void;
  115935. /**
  115936. * Dispose and release all associated resources
  115937. */
  115938. dispose(): void;
  115939. /**
  115940. * Attach a new callback raised when context lost event is fired
  115941. * @param callback defines the callback to call
  115942. */
  115943. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115944. /**
  115945. * Attach a new callback raised when context restored event is fired
  115946. * @param callback defines the callback to call
  115947. */
  115948. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115949. /**
  115950. * Get the current error code of the webGL context
  115951. * @returns the error code
  115952. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115953. */
  115954. getError(): number;
  115955. private _canRenderToFloatFramebuffer;
  115956. private _canRenderToHalfFloatFramebuffer;
  115957. private _canRenderToFramebuffer;
  115958. /** @hidden */
  115959. _getWebGLTextureType(type: number): number;
  115960. /** @hidden */
  115961. _getInternalFormat(format: number): number;
  115962. /** @hidden */
  115963. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115964. /** @hidden */
  115965. _getRGBAMultiSampleBufferFormat(type: number): number;
  115966. /** @hidden */
  115967. _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;
  115968. /**
  115969. * Loads a file from a url
  115970. * @param url url to load
  115971. * @param onSuccess callback called when the file successfully loads
  115972. * @param onProgress callback called while file is loading (if the server supports this mode)
  115973. * @param offlineProvider defines the offline provider for caching
  115974. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115975. * @param onError callback called when the file fails to load
  115976. * @returns a file request object
  115977. * @hidden
  115978. */
  115979. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  115980. /**
  115981. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115982. * @param x defines the x coordinate of the rectangle where pixels must be read
  115983. * @param y defines the y coordinate of the rectangle where pixels must be read
  115984. * @param width defines the width of the rectangle where pixels must be read
  115985. * @param height defines the height of the rectangle where pixels must be read
  115986. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115987. * @returns a Uint8Array containing RGBA colors
  115988. */
  115989. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115990. private static _isSupported;
  115991. /**
  115992. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115993. * @returns true if the engine can be created
  115994. * @ignorenaming
  115995. */
  115996. static isSupported(): boolean;
  115997. /**
  115998. * Find the next highest power of two.
  115999. * @param x Number to start search from.
  116000. * @return Next highest power of two.
  116001. */
  116002. static CeilingPOT(x: number): number;
  116003. /**
  116004. * Find the next lowest power of two.
  116005. * @param x Number to start search from.
  116006. * @return Next lowest power of two.
  116007. */
  116008. static FloorPOT(x: number): number;
  116009. /**
  116010. * Find the nearest power of two.
  116011. * @param x Number to start search from.
  116012. * @return Next nearest power of two.
  116013. */
  116014. static NearestPOT(x: number): number;
  116015. /**
  116016. * Get the closest exponent of two
  116017. * @param value defines the value to approximate
  116018. * @param max defines the maximum value to return
  116019. * @param mode defines how to define the closest value
  116020. * @returns closest exponent of two of the given value
  116021. */
  116022. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  116023. /**
  116024. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  116025. * @param func - the function to be called
  116026. * @param requester - the object that will request the next frame. Falls back to window.
  116027. * @returns frame number
  116028. */
  116029. static QueueNewFrame(func: () => void, requester?: any): number;
  116030. /**
  116031. * Gets host document
  116032. * @returns the host document object
  116033. */
  116034. getHostDocument(): Nullable<Document>;
  116035. }
  116036. }
  116037. declare module BABYLON {
  116038. /**
  116039. * Class representing spherical harmonics coefficients to the 3rd degree
  116040. */
  116041. export class SphericalHarmonics {
  116042. /**
  116043. * Defines whether or not the harmonics have been prescaled for rendering.
  116044. */
  116045. preScaled: boolean;
  116046. /**
  116047. * The l0,0 coefficients of the spherical harmonics
  116048. */
  116049. l00: Vector3;
  116050. /**
  116051. * The l1,-1 coefficients of the spherical harmonics
  116052. */
  116053. l1_1: Vector3;
  116054. /**
  116055. * The l1,0 coefficients of the spherical harmonics
  116056. */
  116057. l10: Vector3;
  116058. /**
  116059. * The l1,1 coefficients of the spherical harmonics
  116060. */
  116061. l11: Vector3;
  116062. /**
  116063. * The l2,-2 coefficients of the spherical harmonics
  116064. */
  116065. l2_2: Vector3;
  116066. /**
  116067. * The l2,-1 coefficients of the spherical harmonics
  116068. */
  116069. l2_1: Vector3;
  116070. /**
  116071. * The l2,0 coefficients of the spherical harmonics
  116072. */
  116073. l20: Vector3;
  116074. /**
  116075. * The l2,1 coefficients of the spherical harmonics
  116076. */
  116077. l21: Vector3;
  116078. /**
  116079. * The l2,2 coefficients of the spherical harmonics
  116080. */
  116081. l22: Vector3;
  116082. /**
  116083. * Adds a light to the spherical harmonics
  116084. * @param direction the direction of the light
  116085. * @param color the color of the light
  116086. * @param deltaSolidAngle the delta solid angle of the light
  116087. */
  116088. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116089. /**
  116090. * Scales the spherical harmonics by the given amount
  116091. * @param scale the amount to scale
  116092. */
  116093. scaleInPlace(scale: number): void;
  116094. /**
  116095. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116096. *
  116097. * ```
  116098. * E_lm = A_l * L_lm
  116099. * ```
  116100. *
  116101. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116102. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116103. * the scaling factors are given in equation 9.
  116104. */
  116105. convertIncidentRadianceToIrradiance(): void;
  116106. /**
  116107. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116108. *
  116109. * ```
  116110. * L = (1/pi) * E * rho
  116111. * ```
  116112. *
  116113. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116114. */
  116115. convertIrradianceToLambertianRadiance(): void;
  116116. /**
  116117. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116118. * required operations at run time.
  116119. *
  116120. * This is simply done by scaling back the SH with Ylm constants parameter.
  116121. * The trigonometric part being applied by the shader at run time.
  116122. */
  116123. preScaleForRendering(): void;
  116124. /**
  116125. * Constructs a spherical harmonics from an array.
  116126. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116127. * @returns the spherical harmonics
  116128. */
  116129. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116130. /**
  116131. * Gets the spherical harmonics from polynomial
  116132. * @param polynomial the spherical polynomial
  116133. * @returns the spherical harmonics
  116134. */
  116135. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116136. }
  116137. /**
  116138. * Class representing spherical polynomial coefficients to the 3rd degree
  116139. */
  116140. export class SphericalPolynomial {
  116141. private _harmonics;
  116142. /**
  116143. * The spherical harmonics used to create the polynomials.
  116144. */
  116145. get preScaledHarmonics(): SphericalHarmonics;
  116146. /**
  116147. * The x coefficients of the spherical polynomial
  116148. */
  116149. x: Vector3;
  116150. /**
  116151. * The y coefficients of the spherical polynomial
  116152. */
  116153. y: Vector3;
  116154. /**
  116155. * The z coefficients of the spherical polynomial
  116156. */
  116157. z: Vector3;
  116158. /**
  116159. * The xx coefficients of the spherical polynomial
  116160. */
  116161. xx: Vector3;
  116162. /**
  116163. * The yy coefficients of the spherical polynomial
  116164. */
  116165. yy: Vector3;
  116166. /**
  116167. * The zz coefficients of the spherical polynomial
  116168. */
  116169. zz: Vector3;
  116170. /**
  116171. * The xy coefficients of the spherical polynomial
  116172. */
  116173. xy: Vector3;
  116174. /**
  116175. * The yz coefficients of the spherical polynomial
  116176. */
  116177. yz: Vector3;
  116178. /**
  116179. * The zx coefficients of the spherical polynomial
  116180. */
  116181. zx: Vector3;
  116182. /**
  116183. * Adds an ambient color to the spherical polynomial
  116184. * @param color the color to add
  116185. */
  116186. addAmbient(color: Color3): void;
  116187. /**
  116188. * Scales the spherical polynomial by the given amount
  116189. * @param scale the amount to scale
  116190. */
  116191. scaleInPlace(scale: number): void;
  116192. /**
  116193. * Gets the spherical polynomial from harmonics
  116194. * @param harmonics the spherical harmonics
  116195. * @returns the spherical polynomial
  116196. */
  116197. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116198. /**
  116199. * Constructs a spherical polynomial from an array.
  116200. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116201. * @returns the spherical polynomial
  116202. */
  116203. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116204. }
  116205. }
  116206. declare module BABYLON {
  116207. /**
  116208. * Defines the source of the internal texture
  116209. */
  116210. export enum InternalTextureSource {
  116211. /**
  116212. * The source of the texture data is unknown
  116213. */
  116214. Unknown = 0,
  116215. /**
  116216. * Texture data comes from an URL
  116217. */
  116218. Url = 1,
  116219. /**
  116220. * Texture data is only used for temporary storage
  116221. */
  116222. Temp = 2,
  116223. /**
  116224. * Texture data comes from raw data (ArrayBuffer)
  116225. */
  116226. Raw = 3,
  116227. /**
  116228. * Texture content is dynamic (video or dynamic texture)
  116229. */
  116230. Dynamic = 4,
  116231. /**
  116232. * Texture content is generated by rendering to it
  116233. */
  116234. RenderTarget = 5,
  116235. /**
  116236. * Texture content is part of a multi render target process
  116237. */
  116238. MultiRenderTarget = 6,
  116239. /**
  116240. * Texture data comes from a cube data file
  116241. */
  116242. Cube = 7,
  116243. /**
  116244. * Texture data comes from a raw cube data
  116245. */
  116246. CubeRaw = 8,
  116247. /**
  116248. * Texture data come from a prefiltered cube data file
  116249. */
  116250. CubePrefiltered = 9,
  116251. /**
  116252. * Texture content is raw 3D data
  116253. */
  116254. Raw3D = 10,
  116255. /**
  116256. * Texture content is raw 2D array data
  116257. */
  116258. Raw2DArray = 11,
  116259. /**
  116260. * Texture content is a depth texture
  116261. */
  116262. Depth = 12,
  116263. /**
  116264. * Texture data comes from a raw cube data encoded with RGBD
  116265. */
  116266. CubeRawRGBD = 13
  116267. }
  116268. /**
  116269. * Class used to store data associated with WebGL texture data for the engine
  116270. * This class should not be used directly
  116271. */
  116272. export class InternalTexture {
  116273. /** @hidden */
  116274. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116275. /**
  116276. * Defines if the texture is ready
  116277. */
  116278. isReady: boolean;
  116279. /**
  116280. * Defines if the texture is a cube texture
  116281. */
  116282. isCube: boolean;
  116283. /**
  116284. * Defines if the texture contains 3D data
  116285. */
  116286. is3D: boolean;
  116287. /**
  116288. * Defines if the texture contains 2D array data
  116289. */
  116290. is2DArray: boolean;
  116291. /**
  116292. * Defines if the texture contains multiview data
  116293. */
  116294. isMultiview: boolean;
  116295. /**
  116296. * Gets the URL used to load this texture
  116297. */
  116298. url: string;
  116299. /**
  116300. * Gets the sampling mode of the texture
  116301. */
  116302. samplingMode: number;
  116303. /**
  116304. * Gets a boolean indicating if the texture needs mipmaps generation
  116305. */
  116306. generateMipMaps: boolean;
  116307. /**
  116308. * Gets the number of samples used by the texture (WebGL2+ only)
  116309. */
  116310. samples: number;
  116311. /**
  116312. * Gets the type of the texture (int, float...)
  116313. */
  116314. type: number;
  116315. /**
  116316. * Gets the format of the texture (RGB, RGBA...)
  116317. */
  116318. format: number;
  116319. /**
  116320. * Observable called when the texture is loaded
  116321. */
  116322. onLoadedObservable: Observable<InternalTexture>;
  116323. /**
  116324. * Gets the width of the texture
  116325. */
  116326. width: number;
  116327. /**
  116328. * Gets the height of the texture
  116329. */
  116330. height: number;
  116331. /**
  116332. * Gets the depth of the texture
  116333. */
  116334. depth: number;
  116335. /**
  116336. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116337. */
  116338. baseWidth: number;
  116339. /**
  116340. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116341. */
  116342. baseHeight: number;
  116343. /**
  116344. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116345. */
  116346. baseDepth: number;
  116347. /**
  116348. * Gets a boolean indicating if the texture is inverted on Y axis
  116349. */
  116350. invertY: boolean;
  116351. /** @hidden */
  116352. _invertVScale: boolean;
  116353. /** @hidden */
  116354. _associatedChannel: number;
  116355. /** @hidden */
  116356. _source: InternalTextureSource;
  116357. /** @hidden */
  116358. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116359. /** @hidden */
  116360. _bufferView: Nullable<ArrayBufferView>;
  116361. /** @hidden */
  116362. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116363. /** @hidden */
  116364. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116365. /** @hidden */
  116366. _size: number;
  116367. /** @hidden */
  116368. _extension: string;
  116369. /** @hidden */
  116370. _files: Nullable<string[]>;
  116371. /** @hidden */
  116372. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116373. /** @hidden */
  116374. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116375. /** @hidden */
  116376. _framebuffer: Nullable<WebGLFramebuffer>;
  116377. /** @hidden */
  116378. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116379. /** @hidden */
  116380. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116381. /** @hidden */
  116382. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116383. /** @hidden */
  116384. _attachments: Nullable<number[]>;
  116385. /** @hidden */
  116386. _textureArray: Nullable<InternalTexture[]>;
  116387. /** @hidden */
  116388. _cachedCoordinatesMode: Nullable<number>;
  116389. /** @hidden */
  116390. _cachedWrapU: Nullable<number>;
  116391. /** @hidden */
  116392. _cachedWrapV: Nullable<number>;
  116393. /** @hidden */
  116394. _cachedWrapR: Nullable<number>;
  116395. /** @hidden */
  116396. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116397. /** @hidden */
  116398. _isDisabled: boolean;
  116399. /** @hidden */
  116400. _compression: Nullable<string>;
  116401. /** @hidden */
  116402. _generateStencilBuffer: boolean;
  116403. /** @hidden */
  116404. _generateDepthBuffer: boolean;
  116405. /** @hidden */
  116406. _comparisonFunction: number;
  116407. /** @hidden */
  116408. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116409. /** @hidden */
  116410. _lodGenerationScale: number;
  116411. /** @hidden */
  116412. _lodGenerationOffset: number;
  116413. /** @hidden */
  116414. _depthStencilTexture: Nullable<InternalTexture>;
  116415. /** @hidden */
  116416. _colorTextureArray: Nullable<WebGLTexture>;
  116417. /** @hidden */
  116418. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116419. /** @hidden */
  116420. _lodTextureHigh: Nullable<BaseTexture>;
  116421. /** @hidden */
  116422. _lodTextureMid: Nullable<BaseTexture>;
  116423. /** @hidden */
  116424. _lodTextureLow: Nullable<BaseTexture>;
  116425. /** @hidden */
  116426. _isRGBD: boolean;
  116427. /** @hidden */
  116428. _linearSpecularLOD: boolean;
  116429. /** @hidden */
  116430. _irradianceTexture: Nullable<BaseTexture>;
  116431. /** @hidden */
  116432. _webGLTexture: Nullable<WebGLTexture>;
  116433. /** @hidden */
  116434. _references: number;
  116435. private _engine;
  116436. /**
  116437. * Gets the Engine the texture belongs to.
  116438. * @returns The babylon engine
  116439. */
  116440. getEngine(): ThinEngine;
  116441. /**
  116442. * Gets the data source type of the texture
  116443. */
  116444. get source(): InternalTextureSource;
  116445. /**
  116446. * Creates a new InternalTexture
  116447. * @param engine defines the engine to use
  116448. * @param source defines the type of data that will be used
  116449. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116450. */
  116451. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116452. /**
  116453. * Increments the number of references (ie. the number of Texture that point to it)
  116454. */
  116455. incrementReferences(): void;
  116456. /**
  116457. * Change the size of the texture (not the size of the content)
  116458. * @param width defines the new width
  116459. * @param height defines the new height
  116460. * @param depth defines the new depth (1 by default)
  116461. */
  116462. updateSize(width: int, height: int, depth?: int): void;
  116463. /** @hidden */
  116464. _rebuild(): void;
  116465. /** @hidden */
  116466. _swapAndDie(target: InternalTexture): void;
  116467. /**
  116468. * Dispose the current allocated resources
  116469. */
  116470. dispose(): void;
  116471. }
  116472. }
  116473. declare module BABYLON {
  116474. /**
  116475. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116476. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116477. */
  116478. export class Analyser {
  116479. /**
  116480. * Gets or sets the smoothing
  116481. * @ignorenaming
  116482. */
  116483. SMOOTHING: number;
  116484. /**
  116485. * Gets or sets the FFT table size
  116486. * @ignorenaming
  116487. */
  116488. FFT_SIZE: number;
  116489. /**
  116490. * Gets or sets the bar graph amplitude
  116491. * @ignorenaming
  116492. */
  116493. BARGRAPHAMPLITUDE: number;
  116494. /**
  116495. * Gets or sets the position of the debug canvas
  116496. * @ignorenaming
  116497. */
  116498. DEBUGCANVASPOS: {
  116499. x: number;
  116500. y: number;
  116501. };
  116502. /**
  116503. * Gets or sets the debug canvas size
  116504. * @ignorenaming
  116505. */
  116506. DEBUGCANVASSIZE: {
  116507. width: number;
  116508. height: number;
  116509. };
  116510. private _byteFreqs;
  116511. private _byteTime;
  116512. private _floatFreqs;
  116513. private _webAudioAnalyser;
  116514. private _debugCanvas;
  116515. private _debugCanvasContext;
  116516. private _scene;
  116517. private _registerFunc;
  116518. private _audioEngine;
  116519. /**
  116520. * Creates a new analyser
  116521. * @param scene defines hosting scene
  116522. */
  116523. constructor(scene: Scene);
  116524. /**
  116525. * Get the number of data values you will have to play with for the visualization
  116526. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116527. * @returns a number
  116528. */
  116529. getFrequencyBinCount(): number;
  116530. /**
  116531. * Gets the current frequency data as a byte array
  116532. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116533. * @returns a Uint8Array
  116534. */
  116535. getByteFrequencyData(): Uint8Array;
  116536. /**
  116537. * Gets the current waveform as a byte array
  116538. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116539. * @returns a Uint8Array
  116540. */
  116541. getByteTimeDomainData(): Uint8Array;
  116542. /**
  116543. * Gets the current frequency data as a float array
  116544. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116545. * @returns a Float32Array
  116546. */
  116547. getFloatFrequencyData(): Float32Array;
  116548. /**
  116549. * Renders the debug canvas
  116550. */
  116551. drawDebugCanvas(): void;
  116552. /**
  116553. * Stops rendering the debug canvas and removes it
  116554. */
  116555. stopDebugCanvas(): void;
  116556. /**
  116557. * Connects two audio nodes
  116558. * @param inputAudioNode defines first node to connect
  116559. * @param outputAudioNode defines second node to connect
  116560. */
  116561. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116562. /**
  116563. * Releases all associated resources
  116564. */
  116565. dispose(): void;
  116566. }
  116567. }
  116568. declare module BABYLON {
  116569. /**
  116570. * This represents an audio engine and it is responsible
  116571. * to play, synchronize and analyse sounds throughout the application.
  116572. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116573. */
  116574. export interface IAudioEngine extends IDisposable {
  116575. /**
  116576. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116577. */
  116578. readonly canUseWebAudio: boolean;
  116579. /**
  116580. * Gets the current AudioContext if available.
  116581. */
  116582. readonly audioContext: Nullable<AudioContext>;
  116583. /**
  116584. * The master gain node defines the global audio volume of your audio engine.
  116585. */
  116586. readonly masterGain: GainNode;
  116587. /**
  116588. * Gets whether or not mp3 are supported by your browser.
  116589. */
  116590. readonly isMP3supported: boolean;
  116591. /**
  116592. * Gets whether or not ogg are supported by your browser.
  116593. */
  116594. readonly isOGGsupported: boolean;
  116595. /**
  116596. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116597. * @ignoreNaming
  116598. */
  116599. WarnedWebAudioUnsupported: boolean;
  116600. /**
  116601. * Defines if the audio engine relies on a custom unlocked button.
  116602. * In this case, the embedded button will not be displayed.
  116603. */
  116604. useCustomUnlockedButton: boolean;
  116605. /**
  116606. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116607. */
  116608. readonly unlocked: boolean;
  116609. /**
  116610. * Event raised when audio has been unlocked on the browser.
  116611. */
  116612. onAudioUnlockedObservable: Observable<AudioEngine>;
  116613. /**
  116614. * Event raised when audio has been locked on the browser.
  116615. */
  116616. onAudioLockedObservable: Observable<AudioEngine>;
  116617. /**
  116618. * Flags the audio engine in Locked state.
  116619. * This happens due to new browser policies preventing audio to autoplay.
  116620. */
  116621. lock(): void;
  116622. /**
  116623. * Unlocks the audio engine once a user action has been done on the dom.
  116624. * This is helpful to resume play once browser policies have been satisfied.
  116625. */
  116626. unlock(): void;
  116627. /**
  116628. * Gets the global volume sets on the master gain.
  116629. * @returns the global volume if set or -1 otherwise
  116630. */
  116631. getGlobalVolume(): number;
  116632. /**
  116633. * Sets the global volume of your experience (sets on the master gain).
  116634. * @param newVolume Defines the new global volume of the application
  116635. */
  116636. setGlobalVolume(newVolume: number): void;
  116637. /**
  116638. * Connect the audio engine to an audio analyser allowing some amazing
  116639. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116640. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116641. * @param analyser The analyser to connect to the engine
  116642. */
  116643. connectToAnalyser(analyser: Analyser): void;
  116644. }
  116645. /**
  116646. * This represents the default audio engine used in babylon.
  116647. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116648. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116649. */
  116650. export class AudioEngine implements IAudioEngine {
  116651. private _audioContext;
  116652. private _audioContextInitialized;
  116653. private _muteButton;
  116654. private _hostElement;
  116655. /**
  116656. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116657. */
  116658. canUseWebAudio: boolean;
  116659. /**
  116660. * The master gain node defines the global audio volume of your audio engine.
  116661. */
  116662. masterGain: GainNode;
  116663. /**
  116664. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116665. * @ignoreNaming
  116666. */
  116667. WarnedWebAudioUnsupported: boolean;
  116668. /**
  116669. * Gets whether or not mp3 are supported by your browser.
  116670. */
  116671. isMP3supported: boolean;
  116672. /**
  116673. * Gets whether or not ogg are supported by your browser.
  116674. */
  116675. isOGGsupported: boolean;
  116676. /**
  116677. * Gets whether audio has been unlocked on the device.
  116678. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116679. * a user interaction has happened.
  116680. */
  116681. unlocked: boolean;
  116682. /**
  116683. * Defines if the audio engine relies on a custom unlocked button.
  116684. * In this case, the embedded button will not be displayed.
  116685. */
  116686. useCustomUnlockedButton: boolean;
  116687. /**
  116688. * Event raised when audio has been unlocked on the browser.
  116689. */
  116690. onAudioUnlockedObservable: Observable<AudioEngine>;
  116691. /**
  116692. * Event raised when audio has been locked on the browser.
  116693. */
  116694. onAudioLockedObservable: Observable<AudioEngine>;
  116695. /**
  116696. * Gets the current AudioContext if available.
  116697. */
  116698. get audioContext(): Nullable<AudioContext>;
  116699. private _connectedAnalyser;
  116700. /**
  116701. * Instantiates a new audio engine.
  116702. *
  116703. * There should be only one per page as some browsers restrict the number
  116704. * of audio contexts you can create.
  116705. * @param hostElement defines the host element where to display the mute icon if necessary
  116706. */
  116707. constructor(hostElement?: Nullable<HTMLElement>);
  116708. /**
  116709. * Flags the audio engine in Locked state.
  116710. * This happens due to new browser policies preventing audio to autoplay.
  116711. */
  116712. lock(): void;
  116713. /**
  116714. * Unlocks the audio engine once a user action has been done on the dom.
  116715. * This is helpful to resume play once browser policies have been satisfied.
  116716. */
  116717. unlock(): void;
  116718. private _resumeAudioContext;
  116719. private _initializeAudioContext;
  116720. private _tryToRun;
  116721. private _triggerRunningState;
  116722. private _triggerSuspendedState;
  116723. private _displayMuteButton;
  116724. private _moveButtonToTopLeft;
  116725. private _onResize;
  116726. private _hideMuteButton;
  116727. /**
  116728. * Destroy and release the resources associated with the audio ccontext.
  116729. */
  116730. dispose(): void;
  116731. /**
  116732. * Gets the global volume sets on the master gain.
  116733. * @returns the global volume if set or -1 otherwise
  116734. */
  116735. getGlobalVolume(): number;
  116736. /**
  116737. * Sets the global volume of your experience (sets on the master gain).
  116738. * @param newVolume Defines the new global volume of the application
  116739. */
  116740. setGlobalVolume(newVolume: number): void;
  116741. /**
  116742. * Connect the audio engine to an audio analyser allowing some amazing
  116743. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116744. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116745. * @param analyser The analyser to connect to the engine
  116746. */
  116747. connectToAnalyser(analyser: Analyser): void;
  116748. }
  116749. }
  116750. declare module BABYLON {
  116751. /**
  116752. * Interface used to present a loading screen while loading a scene
  116753. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116754. */
  116755. export interface ILoadingScreen {
  116756. /**
  116757. * Function called to display the loading screen
  116758. */
  116759. displayLoadingUI: () => void;
  116760. /**
  116761. * Function called to hide the loading screen
  116762. */
  116763. hideLoadingUI: () => void;
  116764. /**
  116765. * Gets or sets the color to use for the background
  116766. */
  116767. loadingUIBackgroundColor: string;
  116768. /**
  116769. * Gets or sets the text to display while loading
  116770. */
  116771. loadingUIText: string;
  116772. }
  116773. /**
  116774. * Class used for the default loading screen
  116775. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116776. */
  116777. export class DefaultLoadingScreen implements ILoadingScreen {
  116778. private _renderingCanvas;
  116779. private _loadingText;
  116780. private _loadingDivBackgroundColor;
  116781. private _loadingDiv;
  116782. private _loadingTextDiv;
  116783. /** Gets or sets the logo url to use for the default loading screen */
  116784. static DefaultLogoUrl: string;
  116785. /** Gets or sets the spinner url to use for the default loading screen */
  116786. static DefaultSpinnerUrl: string;
  116787. /**
  116788. * Creates a new default loading screen
  116789. * @param _renderingCanvas defines the canvas used to render the scene
  116790. * @param _loadingText defines the default text to display
  116791. * @param _loadingDivBackgroundColor defines the default background color
  116792. */
  116793. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116794. /**
  116795. * Function called to display the loading screen
  116796. */
  116797. displayLoadingUI(): void;
  116798. /**
  116799. * Function called to hide the loading screen
  116800. */
  116801. hideLoadingUI(): void;
  116802. /**
  116803. * Gets or sets the text to display while loading
  116804. */
  116805. set loadingUIText(text: string);
  116806. get loadingUIText(): string;
  116807. /**
  116808. * Gets or sets the color to use for the background
  116809. */
  116810. get loadingUIBackgroundColor(): string;
  116811. set loadingUIBackgroundColor(color: string);
  116812. private _resizeLoadingUI;
  116813. }
  116814. }
  116815. declare module BABYLON {
  116816. /**
  116817. * Interface for any object that can request an animation frame
  116818. */
  116819. export interface ICustomAnimationFrameRequester {
  116820. /**
  116821. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116822. */
  116823. renderFunction?: Function;
  116824. /**
  116825. * Called to request the next frame to render to
  116826. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116827. */
  116828. requestAnimationFrame: Function;
  116829. /**
  116830. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116831. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116832. */
  116833. requestID?: number;
  116834. }
  116835. }
  116836. declare module BABYLON {
  116837. /**
  116838. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116839. */
  116840. export class PerformanceMonitor {
  116841. private _enabled;
  116842. private _rollingFrameTime;
  116843. private _lastFrameTimeMs;
  116844. /**
  116845. * constructor
  116846. * @param frameSampleSize The number of samples required to saturate the sliding window
  116847. */
  116848. constructor(frameSampleSize?: number);
  116849. /**
  116850. * Samples current frame
  116851. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116852. */
  116853. sampleFrame(timeMs?: number): void;
  116854. /**
  116855. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116856. */
  116857. get averageFrameTime(): number;
  116858. /**
  116859. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116860. */
  116861. get averageFrameTimeVariance(): number;
  116862. /**
  116863. * Returns the frame time of the most recent frame
  116864. */
  116865. get instantaneousFrameTime(): number;
  116866. /**
  116867. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116868. */
  116869. get averageFPS(): number;
  116870. /**
  116871. * Returns the average framerate in frames per second using the most recent frame time
  116872. */
  116873. get instantaneousFPS(): number;
  116874. /**
  116875. * Returns true if enough samples have been taken to completely fill the sliding window
  116876. */
  116877. get isSaturated(): boolean;
  116878. /**
  116879. * Enables contributions to the sliding window sample set
  116880. */
  116881. enable(): void;
  116882. /**
  116883. * Disables contributions to the sliding window sample set
  116884. * Samples will not be interpolated over the disabled period
  116885. */
  116886. disable(): void;
  116887. /**
  116888. * Returns true if sampling is enabled
  116889. */
  116890. get isEnabled(): boolean;
  116891. /**
  116892. * Resets performance monitor
  116893. */
  116894. reset(): void;
  116895. }
  116896. /**
  116897. * RollingAverage
  116898. *
  116899. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116900. */
  116901. export class RollingAverage {
  116902. /**
  116903. * Current average
  116904. */
  116905. average: number;
  116906. /**
  116907. * Current variance
  116908. */
  116909. variance: number;
  116910. protected _samples: Array<number>;
  116911. protected _sampleCount: number;
  116912. protected _pos: number;
  116913. protected _m2: number;
  116914. /**
  116915. * constructor
  116916. * @param length The number of samples required to saturate the sliding window
  116917. */
  116918. constructor(length: number);
  116919. /**
  116920. * Adds a sample to the sample set
  116921. * @param v The sample value
  116922. */
  116923. add(v: number): void;
  116924. /**
  116925. * Returns previously added values or null if outside of history or outside the sliding window domain
  116926. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116927. * @return Value previously recorded with add() or null if outside of range
  116928. */
  116929. history(i: number): number;
  116930. /**
  116931. * Returns true if enough samples have been taken to completely fill the sliding window
  116932. * @return true if sample-set saturated
  116933. */
  116934. isSaturated(): boolean;
  116935. /**
  116936. * Resets the rolling average (equivalent to 0 samples taken so far)
  116937. */
  116938. reset(): void;
  116939. /**
  116940. * Wraps a value around the sample range boundaries
  116941. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116942. * @return Wrapped position in sample range
  116943. */
  116944. protected _wrapPosition(i: number): number;
  116945. }
  116946. }
  116947. declare module BABYLON {
  116948. /**
  116949. * This class is used to track a performance counter which is number based.
  116950. * The user has access to many properties which give statistics of different nature.
  116951. *
  116952. * The implementer can track two kinds of Performance Counter: time and count.
  116953. * 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.
  116954. * 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.
  116955. */
  116956. export class PerfCounter {
  116957. /**
  116958. * Gets or sets a global boolean to turn on and off all the counters
  116959. */
  116960. static Enabled: boolean;
  116961. /**
  116962. * Returns the smallest value ever
  116963. */
  116964. get min(): number;
  116965. /**
  116966. * Returns the biggest value ever
  116967. */
  116968. get max(): number;
  116969. /**
  116970. * Returns the average value since the performance counter is running
  116971. */
  116972. get average(): number;
  116973. /**
  116974. * Returns the average value of the last second the counter was monitored
  116975. */
  116976. get lastSecAverage(): number;
  116977. /**
  116978. * Returns the current value
  116979. */
  116980. get current(): number;
  116981. /**
  116982. * Gets the accumulated total
  116983. */
  116984. get total(): number;
  116985. /**
  116986. * Gets the total value count
  116987. */
  116988. get count(): number;
  116989. /**
  116990. * Creates a new counter
  116991. */
  116992. constructor();
  116993. /**
  116994. * Call this method to start monitoring a new frame.
  116995. * 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.
  116996. */
  116997. fetchNewFrame(): void;
  116998. /**
  116999. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  117000. * @param newCount the count value to add to the monitored count
  117001. * @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.
  117002. */
  117003. addCount(newCount: number, fetchResult: boolean): void;
  117004. /**
  117005. * Start monitoring this performance counter
  117006. */
  117007. beginMonitoring(): void;
  117008. /**
  117009. * Compute the time lapsed since the previous beginMonitoring() call.
  117010. * @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
  117011. */
  117012. endMonitoring(newFrame?: boolean): void;
  117013. private _fetchResult;
  117014. private _startMonitoringTime;
  117015. private _min;
  117016. private _max;
  117017. private _average;
  117018. private _current;
  117019. private _totalValueCount;
  117020. private _totalAccumulated;
  117021. private _lastSecAverage;
  117022. private _lastSecAccumulated;
  117023. private _lastSecTime;
  117024. private _lastSecValueCount;
  117025. }
  117026. }
  117027. declare module BABYLON {
  117028. interface ThinEngine {
  117029. /** @hidden */
  117030. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  117031. }
  117032. }
  117033. declare module BABYLON {
  117034. /**
  117035. * Defines the interface used by display changed events
  117036. */
  117037. export interface IDisplayChangedEventArgs {
  117038. /** Gets the vrDisplay object (if any) */
  117039. vrDisplay: Nullable<any>;
  117040. /** Gets a boolean indicating if webVR is supported */
  117041. vrSupported: boolean;
  117042. }
  117043. /**
  117044. * Defines the interface used by objects containing a viewport (like a camera)
  117045. */
  117046. interface IViewportOwnerLike {
  117047. /**
  117048. * Gets or sets the viewport
  117049. */
  117050. viewport: IViewportLike;
  117051. }
  117052. /**
  117053. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  117054. */
  117055. export class Engine extends ThinEngine {
  117056. /** Defines that alpha blending is disabled */
  117057. static readonly ALPHA_DISABLE: number;
  117058. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  117059. static readonly ALPHA_ADD: number;
  117060. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  117061. static readonly ALPHA_COMBINE: number;
  117062. /** Defines that alpha blending to DEST - SRC * DEST */
  117063. static readonly ALPHA_SUBTRACT: number;
  117064. /** Defines that alpha blending to SRC * DEST */
  117065. static readonly ALPHA_MULTIPLY: number;
  117066. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  117067. static readonly ALPHA_MAXIMIZED: number;
  117068. /** Defines that alpha blending to SRC + DEST */
  117069. static readonly ALPHA_ONEONE: number;
  117070. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  117071. static readonly ALPHA_PREMULTIPLIED: number;
  117072. /**
  117073. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  117074. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  117075. */
  117076. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  117077. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  117078. static readonly ALPHA_INTERPOLATE: number;
  117079. /**
  117080. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  117081. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  117082. */
  117083. static readonly ALPHA_SCREENMODE: number;
  117084. /** Defines that the ressource is not delayed*/
  117085. static readonly DELAYLOADSTATE_NONE: number;
  117086. /** Defines that the ressource was successfully delay loaded */
  117087. static readonly DELAYLOADSTATE_LOADED: number;
  117088. /** Defines that the ressource is currently delay loading */
  117089. static readonly DELAYLOADSTATE_LOADING: number;
  117090. /** Defines that the ressource is delayed and has not started loading */
  117091. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117092. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117093. static readonly NEVER: number;
  117094. /** 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 */
  117095. static readonly ALWAYS: number;
  117096. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117097. static readonly LESS: number;
  117098. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117099. static readonly EQUAL: number;
  117100. /** 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 */
  117101. static readonly LEQUAL: number;
  117102. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117103. static readonly GREATER: number;
  117104. /** 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 */
  117105. static readonly GEQUAL: number;
  117106. /** 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 */
  117107. static readonly NOTEQUAL: number;
  117108. /** Passed to stencilOperation to specify that stencil value must be kept */
  117109. static readonly KEEP: number;
  117110. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117111. static readonly REPLACE: number;
  117112. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117113. static readonly INCR: number;
  117114. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117115. static readonly DECR: number;
  117116. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117117. static readonly INVERT: number;
  117118. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117119. static readonly INCR_WRAP: number;
  117120. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117121. static readonly DECR_WRAP: number;
  117122. /** Texture is not repeating outside of 0..1 UVs */
  117123. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117124. /** Texture is repeating outside of 0..1 UVs */
  117125. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117126. /** Texture is repeating and mirrored */
  117127. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117128. /** ALPHA */
  117129. static readonly TEXTUREFORMAT_ALPHA: number;
  117130. /** LUMINANCE */
  117131. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117132. /** LUMINANCE_ALPHA */
  117133. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117134. /** RGB */
  117135. static readonly TEXTUREFORMAT_RGB: number;
  117136. /** RGBA */
  117137. static readonly TEXTUREFORMAT_RGBA: number;
  117138. /** RED */
  117139. static readonly TEXTUREFORMAT_RED: number;
  117140. /** RED (2nd reference) */
  117141. static readonly TEXTUREFORMAT_R: number;
  117142. /** RG */
  117143. static readonly TEXTUREFORMAT_RG: number;
  117144. /** RED_INTEGER */
  117145. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117146. /** RED_INTEGER (2nd reference) */
  117147. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117148. /** RG_INTEGER */
  117149. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117150. /** RGB_INTEGER */
  117151. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117152. /** RGBA_INTEGER */
  117153. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117154. /** UNSIGNED_BYTE */
  117155. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117156. /** UNSIGNED_BYTE (2nd reference) */
  117157. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117158. /** FLOAT */
  117159. static readonly TEXTURETYPE_FLOAT: number;
  117160. /** HALF_FLOAT */
  117161. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117162. /** BYTE */
  117163. static readonly TEXTURETYPE_BYTE: number;
  117164. /** SHORT */
  117165. static readonly TEXTURETYPE_SHORT: number;
  117166. /** UNSIGNED_SHORT */
  117167. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117168. /** INT */
  117169. static readonly TEXTURETYPE_INT: number;
  117170. /** UNSIGNED_INT */
  117171. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117172. /** UNSIGNED_SHORT_4_4_4_4 */
  117173. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117174. /** UNSIGNED_SHORT_5_5_5_1 */
  117175. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117176. /** UNSIGNED_SHORT_5_6_5 */
  117177. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117178. /** UNSIGNED_INT_2_10_10_10_REV */
  117179. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117180. /** UNSIGNED_INT_24_8 */
  117181. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117182. /** UNSIGNED_INT_10F_11F_11F_REV */
  117183. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117184. /** UNSIGNED_INT_5_9_9_9_REV */
  117185. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117186. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117187. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117188. /** nearest is mag = nearest and min = nearest and mip = linear */
  117189. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117190. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117191. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117192. /** Trilinear is mag = linear and min = linear and mip = linear */
  117193. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117194. /** nearest is mag = nearest and min = nearest and mip = linear */
  117195. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117196. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117197. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117198. /** Trilinear is mag = linear and min = linear and mip = linear */
  117199. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117200. /** mag = nearest and min = nearest and mip = nearest */
  117201. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117202. /** mag = nearest and min = linear and mip = nearest */
  117203. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117204. /** mag = nearest and min = linear and mip = linear */
  117205. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117206. /** mag = nearest and min = linear and mip = none */
  117207. static readonly TEXTURE_NEAREST_LINEAR: number;
  117208. /** mag = nearest and min = nearest and mip = none */
  117209. static readonly TEXTURE_NEAREST_NEAREST: number;
  117210. /** mag = linear and min = nearest and mip = nearest */
  117211. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117212. /** mag = linear and min = nearest and mip = linear */
  117213. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117214. /** mag = linear and min = linear and mip = none */
  117215. static readonly TEXTURE_LINEAR_LINEAR: number;
  117216. /** mag = linear and min = nearest and mip = none */
  117217. static readonly TEXTURE_LINEAR_NEAREST: number;
  117218. /** Explicit coordinates mode */
  117219. static readonly TEXTURE_EXPLICIT_MODE: number;
  117220. /** Spherical coordinates mode */
  117221. static readonly TEXTURE_SPHERICAL_MODE: number;
  117222. /** Planar coordinates mode */
  117223. static readonly TEXTURE_PLANAR_MODE: number;
  117224. /** Cubic coordinates mode */
  117225. static readonly TEXTURE_CUBIC_MODE: number;
  117226. /** Projection coordinates mode */
  117227. static readonly TEXTURE_PROJECTION_MODE: number;
  117228. /** Skybox coordinates mode */
  117229. static readonly TEXTURE_SKYBOX_MODE: number;
  117230. /** Inverse Cubic coordinates mode */
  117231. static readonly TEXTURE_INVCUBIC_MODE: number;
  117232. /** Equirectangular coordinates mode */
  117233. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117234. /** Equirectangular Fixed coordinates mode */
  117235. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117236. /** Equirectangular Fixed Mirrored coordinates mode */
  117237. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117238. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117239. static readonly SCALEMODE_FLOOR: number;
  117240. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117241. static readonly SCALEMODE_NEAREST: number;
  117242. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117243. static readonly SCALEMODE_CEILING: number;
  117244. /**
  117245. * Returns the current npm package of the sdk
  117246. */
  117247. static get NpmPackage(): string;
  117248. /**
  117249. * Returns the current version of the framework
  117250. */
  117251. static get Version(): string;
  117252. /** Gets the list of created engines */
  117253. static get Instances(): Engine[];
  117254. /**
  117255. * Gets the latest created engine
  117256. */
  117257. static get LastCreatedEngine(): Nullable<Engine>;
  117258. /**
  117259. * Gets the latest created scene
  117260. */
  117261. static get LastCreatedScene(): Nullable<Scene>;
  117262. /**
  117263. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117264. * @param flag defines which part of the materials must be marked as dirty
  117265. * @param predicate defines a predicate used to filter which materials should be affected
  117266. */
  117267. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117268. /**
  117269. * Method called to create the default loading screen.
  117270. * This can be overriden in your own app.
  117271. * @param canvas The rendering canvas element
  117272. * @returns The loading screen
  117273. */
  117274. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117275. /**
  117276. * Method called to create the default rescale post process on each engine.
  117277. */
  117278. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117279. /**
  117280. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117281. **/
  117282. enableOfflineSupport: boolean;
  117283. /**
  117284. * 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)
  117285. **/
  117286. disableManifestCheck: boolean;
  117287. /**
  117288. * Gets the list of created scenes
  117289. */
  117290. scenes: Scene[];
  117291. /**
  117292. * Event raised when a new scene is created
  117293. */
  117294. onNewSceneAddedObservable: Observable<Scene>;
  117295. /**
  117296. * Gets the list of created postprocesses
  117297. */
  117298. postProcesses: PostProcess[];
  117299. /**
  117300. * Gets a boolean indicating if the pointer is currently locked
  117301. */
  117302. isPointerLock: boolean;
  117303. /**
  117304. * Observable event triggered each time the rendering canvas is resized
  117305. */
  117306. onResizeObservable: Observable<Engine>;
  117307. /**
  117308. * Observable event triggered each time the canvas loses focus
  117309. */
  117310. onCanvasBlurObservable: Observable<Engine>;
  117311. /**
  117312. * Observable event triggered each time the canvas gains focus
  117313. */
  117314. onCanvasFocusObservable: Observable<Engine>;
  117315. /**
  117316. * Observable event triggered each time the canvas receives pointerout event
  117317. */
  117318. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117319. /**
  117320. * Observable raised when the engine begins a new frame
  117321. */
  117322. onBeginFrameObservable: Observable<Engine>;
  117323. /**
  117324. * If set, will be used to request the next animation frame for the render loop
  117325. */
  117326. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117327. /**
  117328. * Observable raised when the engine ends the current frame
  117329. */
  117330. onEndFrameObservable: Observable<Engine>;
  117331. /**
  117332. * Observable raised when the engine is about to compile a shader
  117333. */
  117334. onBeforeShaderCompilationObservable: Observable<Engine>;
  117335. /**
  117336. * Observable raised when the engine has jsut compiled a shader
  117337. */
  117338. onAfterShaderCompilationObservable: Observable<Engine>;
  117339. /**
  117340. * Gets the audio engine
  117341. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117342. * @ignorenaming
  117343. */
  117344. static audioEngine: IAudioEngine;
  117345. /**
  117346. * Default AudioEngine factory responsible of creating the Audio Engine.
  117347. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117348. */
  117349. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117350. /**
  117351. * Default offline support factory responsible of creating a tool used to store data locally.
  117352. * By default, this will create a Database object if the workload has been embedded.
  117353. */
  117354. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117355. private _loadingScreen;
  117356. private _pointerLockRequested;
  117357. private _rescalePostProcess;
  117358. private _deterministicLockstep;
  117359. private _lockstepMaxSteps;
  117360. private _timeStep;
  117361. protected get _supportsHardwareTextureRescaling(): boolean;
  117362. private _fps;
  117363. private _deltaTime;
  117364. /** @hidden */
  117365. _drawCalls: PerfCounter;
  117366. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  117367. canvasTabIndex: number;
  117368. /**
  117369. * Turn this value on if you want to pause FPS computation when in background
  117370. */
  117371. disablePerformanceMonitorInBackground: boolean;
  117372. private _performanceMonitor;
  117373. /**
  117374. * Gets the performance monitor attached to this engine
  117375. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117376. */
  117377. get performanceMonitor(): PerformanceMonitor;
  117378. private _onFocus;
  117379. private _onBlur;
  117380. private _onCanvasPointerOut;
  117381. private _onCanvasBlur;
  117382. private _onCanvasFocus;
  117383. private _onFullscreenChange;
  117384. private _onPointerLockChange;
  117385. /**
  117386. * Gets the HTML element used to attach event listeners
  117387. * @returns a HTML element
  117388. */
  117389. getInputElement(): Nullable<HTMLElement>;
  117390. /**
  117391. * Creates a new engine
  117392. * @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
  117393. * @param antialias defines enable antialiasing (default: false)
  117394. * @param options defines further options to be sent to the getContext() function
  117395. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117396. */
  117397. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117398. /**
  117399. * Gets current aspect ratio
  117400. * @param viewportOwner defines the camera to use to get the aspect ratio
  117401. * @param useScreen defines if screen size must be used (or the current render target if any)
  117402. * @returns a number defining the aspect ratio
  117403. */
  117404. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117405. /**
  117406. * Gets current screen aspect ratio
  117407. * @returns a number defining the aspect ratio
  117408. */
  117409. getScreenAspectRatio(): number;
  117410. /**
  117411. * Gets the client rect of the HTML canvas attached with the current webGL context
  117412. * @returns a client rectanglee
  117413. */
  117414. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117415. /**
  117416. * Gets the client rect of the HTML element used for events
  117417. * @returns a client rectanglee
  117418. */
  117419. getInputElementClientRect(): Nullable<ClientRect>;
  117420. /**
  117421. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117422. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117423. * @returns true if engine is in deterministic lock step mode
  117424. */
  117425. isDeterministicLockStep(): boolean;
  117426. /**
  117427. * Gets the max steps when engine is running in deterministic lock step
  117428. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117429. * @returns the max steps
  117430. */
  117431. getLockstepMaxSteps(): number;
  117432. /**
  117433. * Returns the time in ms between steps when using deterministic lock step.
  117434. * @returns time step in (ms)
  117435. */
  117436. getTimeStep(): number;
  117437. /**
  117438. * Force the mipmap generation for the given render target texture
  117439. * @param texture defines the render target texture to use
  117440. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117441. */
  117442. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117443. /** States */
  117444. /**
  117445. * Set various states to the webGL context
  117446. * @param culling defines backface culling state
  117447. * @param zOffset defines the value to apply to zOffset (0 by default)
  117448. * @param force defines if states must be applied even if cache is up to date
  117449. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117450. */
  117451. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117452. /**
  117453. * Set the z offset to apply to current rendering
  117454. * @param value defines the offset to apply
  117455. */
  117456. setZOffset(value: number): void;
  117457. /**
  117458. * Gets the current value of the zOffset
  117459. * @returns the current zOffset state
  117460. */
  117461. getZOffset(): number;
  117462. /**
  117463. * Enable or disable depth buffering
  117464. * @param enable defines the state to set
  117465. */
  117466. setDepthBuffer(enable: boolean): void;
  117467. /**
  117468. * Gets a boolean indicating if depth writing is enabled
  117469. * @returns the current depth writing state
  117470. */
  117471. getDepthWrite(): boolean;
  117472. /**
  117473. * Enable or disable depth writing
  117474. * @param enable defines the state to set
  117475. */
  117476. setDepthWrite(enable: boolean): void;
  117477. /**
  117478. * Gets a boolean indicating if stencil buffer is enabled
  117479. * @returns the current stencil buffer state
  117480. */
  117481. getStencilBuffer(): boolean;
  117482. /**
  117483. * Enable or disable the stencil buffer
  117484. * @param enable defines if the stencil buffer must be enabled or disabled
  117485. */
  117486. setStencilBuffer(enable: boolean): void;
  117487. /**
  117488. * Gets the current stencil mask
  117489. * @returns a number defining the new stencil mask to use
  117490. */
  117491. getStencilMask(): number;
  117492. /**
  117493. * Sets the current stencil mask
  117494. * @param mask defines the new stencil mask to use
  117495. */
  117496. setStencilMask(mask: number): void;
  117497. /**
  117498. * Gets the current stencil function
  117499. * @returns a number defining the stencil function to use
  117500. */
  117501. getStencilFunction(): number;
  117502. /**
  117503. * Gets the current stencil reference value
  117504. * @returns a number defining the stencil reference value to use
  117505. */
  117506. getStencilFunctionReference(): number;
  117507. /**
  117508. * Gets the current stencil mask
  117509. * @returns a number defining the stencil mask to use
  117510. */
  117511. getStencilFunctionMask(): number;
  117512. /**
  117513. * Sets the current stencil function
  117514. * @param stencilFunc defines the new stencil function to use
  117515. */
  117516. setStencilFunction(stencilFunc: number): void;
  117517. /**
  117518. * Sets the current stencil reference
  117519. * @param reference defines the new stencil reference to use
  117520. */
  117521. setStencilFunctionReference(reference: number): void;
  117522. /**
  117523. * Sets the current stencil mask
  117524. * @param mask defines the new stencil mask to use
  117525. */
  117526. setStencilFunctionMask(mask: number): void;
  117527. /**
  117528. * Gets the current stencil operation when stencil fails
  117529. * @returns a number defining stencil operation to use when stencil fails
  117530. */
  117531. getStencilOperationFail(): number;
  117532. /**
  117533. * Gets the current stencil operation when depth fails
  117534. * @returns a number defining stencil operation to use when depth fails
  117535. */
  117536. getStencilOperationDepthFail(): number;
  117537. /**
  117538. * Gets the current stencil operation when stencil passes
  117539. * @returns a number defining stencil operation to use when stencil passes
  117540. */
  117541. getStencilOperationPass(): number;
  117542. /**
  117543. * Sets the stencil operation to use when stencil fails
  117544. * @param operation defines the stencil operation to use when stencil fails
  117545. */
  117546. setStencilOperationFail(operation: number): void;
  117547. /**
  117548. * Sets the stencil operation to use when depth fails
  117549. * @param operation defines the stencil operation to use when depth fails
  117550. */
  117551. setStencilOperationDepthFail(operation: number): void;
  117552. /**
  117553. * Sets the stencil operation to use when stencil passes
  117554. * @param operation defines the stencil operation to use when stencil passes
  117555. */
  117556. setStencilOperationPass(operation: number): void;
  117557. /**
  117558. * Sets a boolean indicating if the dithering state is enabled or disabled
  117559. * @param value defines the dithering state
  117560. */
  117561. setDitheringState(value: boolean): void;
  117562. /**
  117563. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117564. * @param value defines the rasterizer state
  117565. */
  117566. setRasterizerState(value: boolean): void;
  117567. /**
  117568. * Gets the current depth function
  117569. * @returns a number defining the depth function
  117570. */
  117571. getDepthFunction(): Nullable<number>;
  117572. /**
  117573. * Sets the current depth function
  117574. * @param depthFunc defines the function to use
  117575. */
  117576. setDepthFunction(depthFunc: number): void;
  117577. /**
  117578. * Sets the current depth function to GREATER
  117579. */
  117580. setDepthFunctionToGreater(): void;
  117581. /**
  117582. * Sets the current depth function to GEQUAL
  117583. */
  117584. setDepthFunctionToGreaterOrEqual(): void;
  117585. /**
  117586. * Sets the current depth function to LESS
  117587. */
  117588. setDepthFunctionToLess(): void;
  117589. /**
  117590. * Sets the current depth function to LEQUAL
  117591. */
  117592. setDepthFunctionToLessOrEqual(): void;
  117593. private _cachedStencilBuffer;
  117594. private _cachedStencilFunction;
  117595. private _cachedStencilMask;
  117596. private _cachedStencilOperationPass;
  117597. private _cachedStencilOperationFail;
  117598. private _cachedStencilOperationDepthFail;
  117599. private _cachedStencilReference;
  117600. /**
  117601. * Caches the the state of the stencil buffer
  117602. */
  117603. cacheStencilState(): void;
  117604. /**
  117605. * Restores the state of the stencil buffer
  117606. */
  117607. restoreStencilState(): void;
  117608. /**
  117609. * Directly set the WebGL Viewport
  117610. * @param x defines the x coordinate of the viewport (in screen space)
  117611. * @param y defines the y coordinate of the viewport (in screen space)
  117612. * @param width defines the width of the viewport (in screen space)
  117613. * @param height defines the height of the viewport (in screen space)
  117614. * @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
  117615. */
  117616. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117617. /**
  117618. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117619. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117620. * @param y defines the y-coordinate of the corner of the clear rectangle
  117621. * @param width defines the width of the clear rectangle
  117622. * @param height defines the height of the clear rectangle
  117623. * @param clearColor defines the clear color
  117624. */
  117625. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117626. /**
  117627. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117628. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117629. * @param y defines the y-coordinate of the corner of the clear rectangle
  117630. * @param width defines the width of the clear rectangle
  117631. * @param height defines the height of the clear rectangle
  117632. */
  117633. enableScissor(x: number, y: number, width: number, height: number): void;
  117634. /**
  117635. * Disable previously set scissor test rectangle
  117636. */
  117637. disableScissor(): void;
  117638. protected _reportDrawCall(): void;
  117639. /**
  117640. * Initializes a webVR display and starts listening to display change events
  117641. * The onVRDisplayChangedObservable will be notified upon these changes
  117642. * @returns The onVRDisplayChangedObservable
  117643. */
  117644. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117645. /** @hidden */
  117646. _prepareVRComponent(): void;
  117647. /** @hidden */
  117648. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117649. /** @hidden */
  117650. _submitVRFrame(): void;
  117651. /**
  117652. * Call this function to leave webVR mode
  117653. * Will do nothing if webVR is not supported or if there is no webVR device
  117654. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117655. */
  117656. disableVR(): void;
  117657. /**
  117658. * Gets a boolean indicating that the system is in VR mode and is presenting
  117659. * @returns true if VR mode is engaged
  117660. */
  117661. isVRPresenting(): boolean;
  117662. /** @hidden */
  117663. _requestVRFrame(): void;
  117664. /** @hidden */
  117665. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117666. /**
  117667. * Gets the source code of the vertex shader associated with a specific webGL program
  117668. * @param program defines the program to use
  117669. * @returns a string containing the source code of the vertex shader associated with the program
  117670. */
  117671. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117672. /**
  117673. * Gets the source code of the fragment shader associated with a specific webGL program
  117674. * @param program defines the program to use
  117675. * @returns a string containing the source code of the fragment shader associated with the program
  117676. */
  117677. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117678. /**
  117679. * Sets a depth stencil texture from a render target to the according uniform.
  117680. * @param channel The texture channel
  117681. * @param uniform The uniform to set
  117682. * @param texture The render target texture containing the depth stencil texture to apply
  117683. */
  117684. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117685. /**
  117686. * Sets a texture to the webGL context from a postprocess
  117687. * @param channel defines the channel to use
  117688. * @param postProcess defines the source postprocess
  117689. */
  117690. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117691. /**
  117692. * Binds the output of the passed in post process to the texture channel specified
  117693. * @param channel The channel the texture should be bound to
  117694. * @param postProcess The post process which's output should be bound
  117695. */
  117696. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117697. protected _rebuildBuffers(): void;
  117698. /** @hidden */
  117699. _renderFrame(): void;
  117700. _renderLoop(): void;
  117701. /** @hidden */
  117702. _renderViews(): boolean;
  117703. /**
  117704. * Toggle full screen mode
  117705. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117706. */
  117707. switchFullscreen(requestPointerLock: boolean): void;
  117708. /**
  117709. * Enters full screen mode
  117710. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117711. */
  117712. enterFullscreen(requestPointerLock: boolean): void;
  117713. /**
  117714. * Exits full screen mode
  117715. */
  117716. exitFullscreen(): void;
  117717. /**
  117718. * Enters Pointerlock mode
  117719. */
  117720. enterPointerlock(): void;
  117721. /**
  117722. * Exits Pointerlock mode
  117723. */
  117724. exitPointerlock(): void;
  117725. /**
  117726. * Begin a new frame
  117727. */
  117728. beginFrame(): void;
  117729. /**
  117730. * Enf the current frame
  117731. */
  117732. endFrame(): void;
  117733. resize(): void;
  117734. /**
  117735. * Force a specific size of the canvas
  117736. * @param width defines the new canvas' width
  117737. * @param height defines the new canvas' height
  117738. * @returns true if the size was changed
  117739. */
  117740. setSize(width: number, height: number): boolean;
  117741. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117742. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117743. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117744. _releaseTexture(texture: InternalTexture): void;
  117745. /**
  117746. * @hidden
  117747. * Rescales a texture
  117748. * @param source input texutre
  117749. * @param destination destination texture
  117750. * @param scene scene to use to render the resize
  117751. * @param internalFormat format to use when resizing
  117752. * @param onComplete callback to be called when resize has completed
  117753. */
  117754. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117755. /**
  117756. * Gets the current framerate
  117757. * @returns a number representing the framerate
  117758. */
  117759. getFps(): number;
  117760. /**
  117761. * Gets the time spent between current and previous frame
  117762. * @returns a number representing the delta time in ms
  117763. */
  117764. getDeltaTime(): number;
  117765. private _measureFps;
  117766. /** @hidden */
  117767. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117768. /**
  117769. * Updates the sample count of a render target texture
  117770. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117771. * @param texture defines the texture to update
  117772. * @param samples defines the sample count to set
  117773. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117774. */
  117775. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117776. /**
  117777. * Updates a depth texture Comparison Mode and Function.
  117778. * If the comparison Function is equal to 0, the mode will be set to none.
  117779. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117780. * @param texture The texture to set the comparison function for
  117781. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117782. */
  117783. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117784. /**
  117785. * Creates a webGL buffer to use with instanciation
  117786. * @param capacity defines the size of the buffer
  117787. * @returns the webGL buffer
  117788. */
  117789. createInstancesBuffer(capacity: number): DataBuffer;
  117790. /**
  117791. * Delete a webGL buffer used with instanciation
  117792. * @param buffer defines the webGL buffer to delete
  117793. */
  117794. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117795. private _clientWaitAsync;
  117796. /** @hidden */
  117797. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117798. dispose(): void;
  117799. private _disableTouchAction;
  117800. /**
  117801. * Display the loading screen
  117802. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117803. */
  117804. displayLoadingUI(): void;
  117805. /**
  117806. * Hide the loading screen
  117807. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117808. */
  117809. hideLoadingUI(): void;
  117810. /**
  117811. * Gets the current loading screen object
  117812. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117813. */
  117814. get loadingScreen(): ILoadingScreen;
  117815. /**
  117816. * Sets the current loading screen object
  117817. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117818. */
  117819. set loadingScreen(loadingScreen: ILoadingScreen);
  117820. /**
  117821. * Sets the current loading screen text
  117822. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117823. */
  117824. set loadingUIText(text: string);
  117825. /**
  117826. * Sets the current loading screen background color
  117827. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117828. */
  117829. set loadingUIBackgroundColor(color: string);
  117830. /** Pointerlock and fullscreen */
  117831. /**
  117832. * Ask the browser to promote the current element to pointerlock mode
  117833. * @param element defines the DOM element to promote
  117834. */
  117835. static _RequestPointerlock(element: HTMLElement): void;
  117836. /**
  117837. * Asks the browser to exit pointerlock mode
  117838. */
  117839. static _ExitPointerlock(): void;
  117840. /**
  117841. * Ask the browser to promote the current element to fullscreen rendering mode
  117842. * @param element defines the DOM element to promote
  117843. */
  117844. static _RequestFullscreen(element: HTMLElement): void;
  117845. /**
  117846. * Asks the browser to exit fullscreen mode
  117847. */
  117848. static _ExitFullscreen(): void;
  117849. }
  117850. }
  117851. declare module BABYLON {
  117852. /**
  117853. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117854. * during the life time of the application.
  117855. */
  117856. export class EngineStore {
  117857. /** Gets the list of created engines */
  117858. static Instances: Engine[];
  117859. /** @hidden */
  117860. static _LastCreatedScene: Nullable<Scene>;
  117861. /**
  117862. * Gets the latest created engine
  117863. */
  117864. static get LastCreatedEngine(): Nullable<Engine>;
  117865. /**
  117866. * Gets the latest created scene
  117867. */
  117868. static get LastCreatedScene(): Nullable<Scene>;
  117869. /**
  117870. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117871. * @ignorenaming
  117872. */
  117873. static UseFallbackTexture: boolean;
  117874. /**
  117875. * Texture content used if a texture cannot loaded
  117876. * @ignorenaming
  117877. */
  117878. static FallbackTexture: string;
  117879. }
  117880. }
  117881. declare module BABYLON {
  117882. /**
  117883. * Helper class that provides a small promise polyfill
  117884. */
  117885. export class PromisePolyfill {
  117886. /**
  117887. * Static function used to check if the polyfill is required
  117888. * If this is the case then the function will inject the polyfill to window.Promise
  117889. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117890. */
  117891. static Apply(force?: boolean): void;
  117892. }
  117893. }
  117894. declare module BABYLON {
  117895. /**
  117896. * Interface for screenshot methods with describe argument called `size` as object with options
  117897. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117898. */
  117899. export interface IScreenshotSize {
  117900. /**
  117901. * number in pixels for canvas height
  117902. */
  117903. height?: number;
  117904. /**
  117905. * multiplier allowing render at a higher or lower resolution
  117906. * If value is defined then height and width will be ignored and taken from camera
  117907. */
  117908. precision?: number;
  117909. /**
  117910. * number in pixels for canvas width
  117911. */
  117912. width?: number;
  117913. }
  117914. }
  117915. declare module BABYLON {
  117916. interface IColor4Like {
  117917. r: float;
  117918. g: float;
  117919. b: float;
  117920. a: float;
  117921. }
  117922. /**
  117923. * Class containing a set of static utilities functions
  117924. */
  117925. export class Tools {
  117926. /**
  117927. * Gets or sets the base URL to use to load assets
  117928. */
  117929. static get BaseUrl(): string;
  117930. static set BaseUrl(value: string);
  117931. /**
  117932. * Enable/Disable Custom HTTP Request Headers globally.
  117933. * default = false
  117934. * @see CustomRequestHeaders
  117935. */
  117936. static UseCustomRequestHeaders: boolean;
  117937. /**
  117938. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117939. * i.e. when loading files, where the server/service expects an Authorization header
  117940. */
  117941. static CustomRequestHeaders: {
  117942. [key: string]: string;
  117943. };
  117944. /**
  117945. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117946. */
  117947. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117948. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117949. /**
  117950. * Default behaviour for cors in the application.
  117951. * It can be a string if the expected behavior is identical in the entire app.
  117952. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117953. */
  117954. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117955. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117956. /**
  117957. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117958. * @ignorenaming
  117959. */
  117960. static get UseFallbackTexture(): boolean;
  117961. static set UseFallbackTexture(value: boolean);
  117962. /**
  117963. * Use this object to register external classes like custom textures or material
  117964. * to allow the laoders to instantiate them
  117965. */
  117966. static get RegisteredExternalClasses(): {
  117967. [key: string]: Object;
  117968. };
  117969. static set RegisteredExternalClasses(classes: {
  117970. [key: string]: Object;
  117971. });
  117972. /**
  117973. * Texture content used if a texture cannot loaded
  117974. * @ignorenaming
  117975. */
  117976. static get fallbackTexture(): string;
  117977. static set fallbackTexture(value: string);
  117978. /**
  117979. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117980. * @param u defines the coordinate on X axis
  117981. * @param v defines the coordinate on Y axis
  117982. * @param width defines the width of the source data
  117983. * @param height defines the height of the source data
  117984. * @param pixels defines the source byte array
  117985. * @param color defines the output color
  117986. */
  117987. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117988. /**
  117989. * Interpolates between a and b via alpha
  117990. * @param a The lower value (returned when alpha = 0)
  117991. * @param b The upper value (returned when alpha = 1)
  117992. * @param alpha The interpolation-factor
  117993. * @return The mixed value
  117994. */
  117995. static Mix(a: number, b: number, alpha: number): number;
  117996. /**
  117997. * Tries to instantiate a new object from a given class name
  117998. * @param className defines the class name to instantiate
  117999. * @returns the new object or null if the system was not able to do the instantiation
  118000. */
  118001. static Instantiate(className: string): any;
  118002. /**
  118003. * Provides a slice function that will work even on IE
  118004. * @param data defines the array to slice
  118005. * @param start defines the start of the data (optional)
  118006. * @param end defines the end of the data (optional)
  118007. * @returns the new sliced array
  118008. */
  118009. static Slice<T>(data: T, start?: number, end?: number): T;
  118010. /**
  118011. * Polyfill for setImmediate
  118012. * @param action defines the action to execute after the current execution block
  118013. */
  118014. static SetImmediate(action: () => void): void;
  118015. /**
  118016. * Function indicating if a number is an exponent of 2
  118017. * @param value defines the value to test
  118018. * @returns true if the value is an exponent of 2
  118019. */
  118020. static IsExponentOfTwo(value: number): boolean;
  118021. private static _tmpFloatArray;
  118022. /**
  118023. * Returns the nearest 32-bit single precision float representation of a Number
  118024. * @param value A Number. If the parameter is of a different type, it will get converted
  118025. * to a number or to NaN if it cannot be converted
  118026. * @returns number
  118027. */
  118028. static FloatRound(value: number): number;
  118029. /**
  118030. * Extracts the filename from a path
  118031. * @param path defines the path to use
  118032. * @returns the filename
  118033. */
  118034. static GetFilename(path: string): string;
  118035. /**
  118036. * Extracts the "folder" part of a path (everything before the filename).
  118037. * @param uri The URI to extract the info from
  118038. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  118039. * @returns The "folder" part of the path
  118040. */
  118041. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  118042. /**
  118043. * Extracts text content from a DOM element hierarchy
  118044. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  118045. */
  118046. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  118047. /**
  118048. * Convert an angle in radians to degrees
  118049. * @param angle defines the angle to convert
  118050. * @returns the angle in degrees
  118051. */
  118052. static ToDegrees(angle: number): number;
  118053. /**
  118054. * Convert an angle in degrees to radians
  118055. * @param angle defines the angle to convert
  118056. * @returns the angle in radians
  118057. */
  118058. static ToRadians(angle: number): number;
  118059. /**
  118060. * Returns an array if obj is not an array
  118061. * @param obj defines the object to evaluate as an array
  118062. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  118063. * @returns either obj directly if obj is an array or a new array containing obj
  118064. */
  118065. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  118066. /**
  118067. * Gets the pointer prefix to use
  118068. * @param engine defines the engine we are finding the prefix for
  118069. * @returns "pointer" if touch is enabled. Else returns "mouse"
  118070. */
  118071. static GetPointerPrefix(engine: Engine): string;
  118072. /**
  118073. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  118074. * @param url define the url we are trying
  118075. * @param element define the dom element where to configure the cors policy
  118076. */
  118077. static SetCorsBehavior(url: string | string[], element: {
  118078. crossOrigin: string | null;
  118079. }): void;
  118080. /**
  118081. * Removes unwanted characters from an url
  118082. * @param url defines the url to clean
  118083. * @returns the cleaned url
  118084. */
  118085. static CleanUrl(url: string): string;
  118086. /**
  118087. * Gets or sets a function used to pre-process url before using them to load assets
  118088. */
  118089. static get PreprocessUrl(): (url: string) => string;
  118090. static set PreprocessUrl(processor: (url: string) => string);
  118091. /**
  118092. * Loads an image as an HTMLImageElement.
  118093. * @param input url string, ArrayBuffer, or Blob to load
  118094. * @param onLoad callback called when the image successfully loads
  118095. * @param onError callback called when the image fails to load
  118096. * @param offlineProvider offline provider for caching
  118097. * @param mimeType optional mime type
  118098. * @returns the HTMLImageElement of the loaded image
  118099. */
  118100. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118101. /**
  118102. * Loads a file from a url
  118103. * @param url url string, ArrayBuffer, or Blob to load
  118104. * @param onSuccess callback called when the file successfully loads
  118105. * @param onProgress callback called while file is loading (if the server supports this mode)
  118106. * @param offlineProvider defines the offline provider for caching
  118107. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118108. * @param onError callback called when the file fails to load
  118109. * @returns a file request object
  118110. */
  118111. 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;
  118112. /**
  118113. * Loads a file from a url
  118114. * @param url the file url to load
  118115. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118116. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118117. */
  118118. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118119. /**
  118120. * Load a script (identified by an url). When the url returns, the
  118121. * content of this file is added into a new script element, attached to the DOM (body element)
  118122. * @param scriptUrl defines the url of the script to laod
  118123. * @param onSuccess defines the callback called when the script is loaded
  118124. * @param onError defines the callback to call if an error occurs
  118125. * @param scriptId defines the id of the script element
  118126. */
  118127. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118128. /**
  118129. * Load an asynchronous script (identified by an url). When the url returns, the
  118130. * content of this file is added into a new script element, attached to the DOM (body element)
  118131. * @param scriptUrl defines the url of the script to laod
  118132. * @param scriptId defines the id of the script element
  118133. * @returns a promise request object
  118134. */
  118135. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118136. /**
  118137. * Loads a file from a blob
  118138. * @param fileToLoad defines the blob to use
  118139. * @param callback defines the callback to call when data is loaded
  118140. * @param progressCallback defines the callback to call during loading process
  118141. * @returns a file request object
  118142. */
  118143. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118144. /**
  118145. * Reads a file from a File object
  118146. * @param file defines the file to load
  118147. * @param onSuccess defines the callback to call when data is loaded
  118148. * @param onProgress defines the callback to call during loading process
  118149. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118150. * @param onError defines the callback to call when an error occurs
  118151. * @returns a file request object
  118152. */
  118153. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118154. /**
  118155. * Creates a data url from a given string content
  118156. * @param content defines the content to convert
  118157. * @returns the new data url link
  118158. */
  118159. static FileAsURL(content: string): string;
  118160. /**
  118161. * Format the given number to a specific decimal format
  118162. * @param value defines the number to format
  118163. * @param decimals defines the number of decimals to use
  118164. * @returns the formatted string
  118165. */
  118166. static Format(value: number, decimals?: number): string;
  118167. /**
  118168. * Tries to copy an object by duplicating every property
  118169. * @param source defines the source object
  118170. * @param destination defines the target object
  118171. * @param doNotCopyList defines a list of properties to avoid
  118172. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118173. */
  118174. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118175. /**
  118176. * Gets a boolean indicating if the given object has no own property
  118177. * @param obj defines the object to test
  118178. * @returns true if object has no own property
  118179. */
  118180. static IsEmpty(obj: any): boolean;
  118181. /**
  118182. * Function used to register events at window level
  118183. * @param windowElement defines the Window object to use
  118184. * @param events defines the events to register
  118185. */
  118186. static RegisterTopRootEvents(windowElement: Window, events: {
  118187. name: string;
  118188. handler: Nullable<(e: FocusEvent) => any>;
  118189. }[]): void;
  118190. /**
  118191. * Function used to unregister events from window level
  118192. * @param windowElement defines the Window object to use
  118193. * @param events defines the events to unregister
  118194. */
  118195. static UnregisterTopRootEvents(windowElement: Window, events: {
  118196. name: string;
  118197. handler: Nullable<(e: FocusEvent) => any>;
  118198. }[]): void;
  118199. /**
  118200. * @ignore
  118201. */
  118202. static _ScreenshotCanvas: HTMLCanvasElement;
  118203. /**
  118204. * Dumps the current bound framebuffer
  118205. * @param width defines the rendering width
  118206. * @param height defines the rendering height
  118207. * @param engine defines the hosting engine
  118208. * @param successCallback defines the callback triggered once the data are available
  118209. * @param mimeType defines the mime type of the result
  118210. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118211. */
  118212. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118213. /**
  118214. * Converts the canvas data to blob.
  118215. * This acts as a polyfill for browsers not supporting the to blob function.
  118216. * @param canvas Defines the canvas to extract the data from
  118217. * @param successCallback Defines the callback triggered once the data are available
  118218. * @param mimeType Defines the mime type of the result
  118219. */
  118220. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118221. /**
  118222. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118223. * @param successCallback defines the callback triggered once the data are available
  118224. * @param mimeType defines the mime type of the result
  118225. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118226. */
  118227. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118228. /**
  118229. * Downloads a blob in the browser
  118230. * @param blob defines the blob to download
  118231. * @param fileName defines the name of the downloaded file
  118232. */
  118233. static Download(blob: Blob, fileName: string): void;
  118234. /**
  118235. * Captures a screenshot of the current rendering
  118236. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118237. * @param engine defines the rendering engine
  118238. * @param camera defines the source camera
  118239. * @param size This parameter can be set to a single number or to an object with the
  118240. * following (optional) properties: precision, width, height. If a single number is passed,
  118241. * it will be used for both width and height. If an object is passed, the screenshot size
  118242. * will be derived from the parameters. The precision property is a multiplier allowing
  118243. * rendering at a higher or lower resolution
  118244. * @param successCallback defines the callback receives a single parameter which contains the
  118245. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118246. * src parameter of an <img> to display it
  118247. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118248. * Check your browser for supported MIME types
  118249. */
  118250. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118251. /**
  118252. * Captures a screenshot of the current rendering
  118253. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118254. * @param engine defines the rendering engine
  118255. * @param camera defines the source camera
  118256. * @param size This parameter can be set to a single number or to an object with the
  118257. * following (optional) properties: precision, width, height. If a single number is passed,
  118258. * it will be used for both width and height. If an object is passed, the screenshot size
  118259. * will be derived from the parameters. The precision property is a multiplier allowing
  118260. * rendering at a higher or lower resolution
  118261. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118262. * Check your browser for supported MIME types
  118263. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118264. * to the src parameter of an <img> to display it
  118265. */
  118266. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118267. /**
  118268. * Generates an image screenshot from the specified camera.
  118269. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118270. * @param engine The engine to use for rendering
  118271. * @param camera The camera to use for rendering
  118272. * @param size This parameter can be set to a single number or to an object with the
  118273. * following (optional) properties: precision, width, height. If a single number is passed,
  118274. * it will be used for both width and height. If an object is passed, the screenshot size
  118275. * will be derived from the parameters. The precision property is a multiplier allowing
  118276. * rendering at a higher or lower resolution
  118277. * @param successCallback The callback receives a single parameter which contains the
  118278. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118279. * src parameter of an <img> to display it
  118280. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118281. * Check your browser for supported MIME types
  118282. * @param samples Texture samples (default: 1)
  118283. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118284. * @param fileName A name for for the downloaded file.
  118285. */
  118286. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118287. /**
  118288. * Generates an image screenshot from the specified camera.
  118289. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118290. * @param engine The engine to use for rendering
  118291. * @param camera The camera to use for rendering
  118292. * @param size This parameter can be set to a single number or to an object with the
  118293. * following (optional) properties: precision, width, height. If a single number is passed,
  118294. * it will be used for both width and height. If an object is passed, the screenshot size
  118295. * will be derived from the parameters. The precision property is a multiplier allowing
  118296. * rendering at a higher or lower resolution
  118297. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118298. * Check your browser for supported MIME types
  118299. * @param samples Texture samples (default: 1)
  118300. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118301. * @param fileName A name for for the downloaded file.
  118302. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118303. * to the src parameter of an <img> to display it
  118304. */
  118305. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118306. /**
  118307. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118308. * Be aware Math.random() could cause collisions, but:
  118309. * "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"
  118310. * @returns a pseudo random id
  118311. */
  118312. static RandomId(): string;
  118313. /**
  118314. * Test if the given uri is a base64 string
  118315. * @param uri The uri to test
  118316. * @return True if the uri is a base64 string or false otherwise
  118317. */
  118318. static IsBase64(uri: string): boolean;
  118319. /**
  118320. * Decode the given base64 uri.
  118321. * @param uri The uri to decode
  118322. * @return The decoded base64 data.
  118323. */
  118324. static DecodeBase64(uri: string): ArrayBuffer;
  118325. /**
  118326. * Gets the absolute url.
  118327. * @param url the input url
  118328. * @return the absolute url
  118329. */
  118330. static GetAbsoluteUrl(url: string): string;
  118331. /**
  118332. * No log
  118333. */
  118334. static readonly NoneLogLevel: number;
  118335. /**
  118336. * Only message logs
  118337. */
  118338. static readonly MessageLogLevel: number;
  118339. /**
  118340. * Only warning logs
  118341. */
  118342. static readonly WarningLogLevel: number;
  118343. /**
  118344. * Only error logs
  118345. */
  118346. static readonly ErrorLogLevel: number;
  118347. /**
  118348. * All logs
  118349. */
  118350. static readonly AllLogLevel: number;
  118351. /**
  118352. * Gets a value indicating the number of loading errors
  118353. * @ignorenaming
  118354. */
  118355. static get errorsCount(): number;
  118356. /**
  118357. * Callback called when a new log is added
  118358. */
  118359. static OnNewCacheEntry: (entry: string) => void;
  118360. /**
  118361. * Log a message to the console
  118362. * @param message defines the message to log
  118363. */
  118364. static Log(message: string): void;
  118365. /**
  118366. * Write a warning message to the console
  118367. * @param message defines the message to log
  118368. */
  118369. static Warn(message: string): void;
  118370. /**
  118371. * Write an error message to the console
  118372. * @param message defines the message to log
  118373. */
  118374. static Error(message: string): void;
  118375. /**
  118376. * Gets current log cache (list of logs)
  118377. */
  118378. static get LogCache(): string;
  118379. /**
  118380. * Clears the log cache
  118381. */
  118382. static ClearLogCache(): void;
  118383. /**
  118384. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118385. */
  118386. static set LogLevels(level: number);
  118387. /**
  118388. * Checks if the window object exists
  118389. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118390. */
  118391. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118392. /**
  118393. * No performance log
  118394. */
  118395. static readonly PerformanceNoneLogLevel: number;
  118396. /**
  118397. * Use user marks to log performance
  118398. */
  118399. static readonly PerformanceUserMarkLogLevel: number;
  118400. /**
  118401. * Log performance to the console
  118402. */
  118403. static readonly PerformanceConsoleLogLevel: number;
  118404. private static _performance;
  118405. /**
  118406. * Sets the current performance log level
  118407. */
  118408. static set PerformanceLogLevel(level: number);
  118409. private static _StartPerformanceCounterDisabled;
  118410. private static _EndPerformanceCounterDisabled;
  118411. private static _StartUserMark;
  118412. private static _EndUserMark;
  118413. private static _StartPerformanceConsole;
  118414. private static _EndPerformanceConsole;
  118415. /**
  118416. * Starts a performance counter
  118417. */
  118418. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118419. /**
  118420. * Ends a specific performance coutner
  118421. */
  118422. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118423. /**
  118424. * Gets either window.performance.now() if supported or Date.now() else
  118425. */
  118426. static get Now(): number;
  118427. /**
  118428. * This method will return the name of the class used to create the instance of the given object.
  118429. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118430. * @param object the object to get the class name from
  118431. * @param isType defines if the object is actually a type
  118432. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118433. */
  118434. static GetClassName(object: any, isType?: boolean): string;
  118435. /**
  118436. * Gets the first element of an array satisfying a given predicate
  118437. * @param array defines the array to browse
  118438. * @param predicate defines the predicate to use
  118439. * @returns null if not found or the element
  118440. */
  118441. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118442. /**
  118443. * This method will return the name of the full name of the class, including its owning module (if any).
  118444. * 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).
  118445. * @param object the object to get the class name from
  118446. * @param isType defines if the object is actually a type
  118447. * @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.
  118448. * @ignorenaming
  118449. */
  118450. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118451. /**
  118452. * Returns a promise that resolves after the given amount of time.
  118453. * @param delay Number of milliseconds to delay
  118454. * @returns Promise that resolves after the given amount of time
  118455. */
  118456. static DelayAsync(delay: number): Promise<void>;
  118457. /**
  118458. * Utility function to detect if the current user agent is Safari
  118459. * @returns whether or not the current user agent is safari
  118460. */
  118461. static IsSafari(): boolean;
  118462. }
  118463. /**
  118464. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118465. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118466. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118467. * @param name The name of the class, case should be preserved
  118468. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118469. */
  118470. export function className(name: string, module?: string): (target: Object) => void;
  118471. /**
  118472. * An implementation of a loop for asynchronous functions.
  118473. */
  118474. export class AsyncLoop {
  118475. /**
  118476. * Defines the number of iterations for the loop
  118477. */
  118478. iterations: number;
  118479. /**
  118480. * Defines the current index of the loop.
  118481. */
  118482. index: number;
  118483. private _done;
  118484. private _fn;
  118485. private _successCallback;
  118486. /**
  118487. * Constructor.
  118488. * @param iterations the number of iterations.
  118489. * @param func the function to run each iteration
  118490. * @param successCallback the callback that will be called upon succesful execution
  118491. * @param offset starting offset.
  118492. */
  118493. constructor(
  118494. /**
  118495. * Defines the number of iterations for the loop
  118496. */
  118497. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118498. /**
  118499. * Execute the next iteration. Must be called after the last iteration was finished.
  118500. */
  118501. executeNext(): void;
  118502. /**
  118503. * Break the loop and run the success callback.
  118504. */
  118505. breakLoop(): void;
  118506. /**
  118507. * Create and run an async loop.
  118508. * @param iterations the number of iterations.
  118509. * @param fn the function to run each iteration
  118510. * @param successCallback the callback that will be called upon succesful execution
  118511. * @param offset starting offset.
  118512. * @returns the created async loop object
  118513. */
  118514. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118515. /**
  118516. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118517. * @param iterations total number of iterations
  118518. * @param syncedIterations number of synchronous iterations in each async iteration.
  118519. * @param fn the function to call each iteration.
  118520. * @param callback a success call back that will be called when iterating stops.
  118521. * @param breakFunction a break condition (optional)
  118522. * @param timeout timeout settings for the setTimeout function. default - 0.
  118523. * @returns the created async loop object
  118524. */
  118525. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118526. }
  118527. }
  118528. declare module BABYLON {
  118529. /**
  118530. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118531. * The underlying implementation relies on an associative array to ensure the best performances.
  118532. * The value can be anything including 'null' but except 'undefined'
  118533. */
  118534. export class StringDictionary<T> {
  118535. /**
  118536. * This will clear this dictionary and copy the content from the 'source' one.
  118537. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118538. * @param source the dictionary to take the content from and copy to this dictionary
  118539. */
  118540. copyFrom(source: StringDictionary<T>): void;
  118541. /**
  118542. * Get a value based from its key
  118543. * @param key the given key to get the matching value from
  118544. * @return the value if found, otherwise undefined is returned
  118545. */
  118546. get(key: string): T | undefined;
  118547. /**
  118548. * Get a value from its key or add it if it doesn't exist.
  118549. * This method will ensure you that a given key/data will be present in the dictionary.
  118550. * @param key the given key to get the matching value from
  118551. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118552. * The factory will only be invoked if there's no data for the given key.
  118553. * @return the value corresponding to the key.
  118554. */
  118555. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118556. /**
  118557. * Get a value from its key if present in the dictionary otherwise add it
  118558. * @param key the key to get the value from
  118559. * @param val if there's no such key/value pair in the dictionary add it with this value
  118560. * @return the value corresponding to the key
  118561. */
  118562. getOrAdd(key: string, val: T): T;
  118563. /**
  118564. * Check if there's a given key in the dictionary
  118565. * @param key the key to check for
  118566. * @return true if the key is present, false otherwise
  118567. */
  118568. contains(key: string): boolean;
  118569. /**
  118570. * Add a new key and its corresponding value
  118571. * @param key the key to add
  118572. * @param value the value corresponding to the key
  118573. * @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
  118574. */
  118575. add(key: string, value: T): boolean;
  118576. /**
  118577. * Update a specific value associated to a key
  118578. * @param key defines the key to use
  118579. * @param value defines the value to store
  118580. * @returns true if the value was updated (or false if the key was not found)
  118581. */
  118582. set(key: string, value: T): boolean;
  118583. /**
  118584. * Get the element of the given key and remove it from the dictionary
  118585. * @param key defines the key to search
  118586. * @returns the value associated with the key or null if not found
  118587. */
  118588. getAndRemove(key: string): Nullable<T>;
  118589. /**
  118590. * Remove a key/value from the dictionary.
  118591. * @param key the key to remove
  118592. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118593. */
  118594. remove(key: string): boolean;
  118595. /**
  118596. * Clear the whole content of the dictionary
  118597. */
  118598. clear(): void;
  118599. /**
  118600. * Gets the current count
  118601. */
  118602. get count(): number;
  118603. /**
  118604. * Execute a callback on each key/val of the dictionary.
  118605. * Note that you can remove any element in this dictionary in the callback implementation
  118606. * @param callback the callback to execute on a given key/value pair
  118607. */
  118608. forEach(callback: (key: string, val: T) => void): void;
  118609. /**
  118610. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118611. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118612. * Note that you can remove any element in this dictionary in the callback implementation
  118613. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118614. * @returns the first item
  118615. */
  118616. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118617. private _count;
  118618. private _data;
  118619. }
  118620. }
  118621. declare module BABYLON {
  118622. /** @hidden */
  118623. export interface ICollisionCoordinator {
  118624. createCollider(): Collider;
  118625. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118626. init(scene: Scene): void;
  118627. }
  118628. /** @hidden */
  118629. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118630. private _scene;
  118631. private _scaledPosition;
  118632. private _scaledVelocity;
  118633. private _finalPosition;
  118634. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118635. createCollider(): Collider;
  118636. init(scene: Scene): void;
  118637. private _collideWithWorld;
  118638. }
  118639. }
  118640. declare module BABYLON {
  118641. /**
  118642. * Class used to manage all inputs for the scene.
  118643. */
  118644. export class InputManager {
  118645. /** The distance in pixel that you have to move to prevent some events */
  118646. static DragMovementThreshold: number;
  118647. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118648. static LongPressDelay: number;
  118649. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118650. static DoubleClickDelay: number;
  118651. /** If you need to check double click without raising a single click at first click, enable this flag */
  118652. static ExclusiveDoubleClickMode: boolean;
  118653. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  118654. private _alreadyAttached;
  118655. private _wheelEventName;
  118656. private _onPointerMove;
  118657. private _onPointerDown;
  118658. private _onPointerUp;
  118659. private _initClickEvent;
  118660. private _initActionManager;
  118661. private _delayedSimpleClick;
  118662. private _delayedSimpleClickTimeout;
  118663. private _previousDelayedSimpleClickTimeout;
  118664. private _meshPickProceed;
  118665. private _previousButtonPressed;
  118666. private _currentPickResult;
  118667. private _previousPickResult;
  118668. private _totalPointersPressed;
  118669. private _doubleClickOccured;
  118670. private _pointerOverMesh;
  118671. private _pickedDownMesh;
  118672. private _pickedUpMesh;
  118673. private _pointerX;
  118674. private _pointerY;
  118675. private _unTranslatedPointerX;
  118676. private _unTranslatedPointerY;
  118677. private _startingPointerPosition;
  118678. private _previousStartingPointerPosition;
  118679. private _startingPointerTime;
  118680. private _previousStartingPointerTime;
  118681. private _pointerCaptures;
  118682. private _meshUnderPointerId;
  118683. private _onKeyDown;
  118684. private _onKeyUp;
  118685. private _onCanvasFocusObserver;
  118686. private _onCanvasBlurObserver;
  118687. private _scene;
  118688. /**
  118689. * Creates a new InputManager
  118690. * @param scene defines the hosting scene
  118691. */
  118692. constructor(scene: Scene);
  118693. /**
  118694. * Gets the mesh that is currently under the pointer
  118695. */
  118696. get meshUnderPointer(): Nullable<AbstractMesh>;
  118697. /**
  118698. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  118699. * @param pointerId the pointer id to use
  118700. * @returns The mesh under this pointer id or null if not found
  118701. */
  118702. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  118703. /**
  118704. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118705. */
  118706. get unTranslatedPointer(): Vector2;
  118707. /**
  118708. * Gets or sets the current on-screen X position of the pointer
  118709. */
  118710. get pointerX(): number;
  118711. set pointerX(value: number);
  118712. /**
  118713. * Gets or sets the current on-screen Y position of the pointer
  118714. */
  118715. get pointerY(): number;
  118716. set pointerY(value: number);
  118717. private _updatePointerPosition;
  118718. private _processPointerMove;
  118719. private _setRayOnPointerInfo;
  118720. private _checkPrePointerObservable;
  118721. /**
  118722. * Use this method to simulate a pointer move on a mesh
  118723. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118724. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118725. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118726. */
  118727. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118728. /**
  118729. * Use this method to simulate a pointer down on a mesh
  118730. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118731. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118732. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118733. */
  118734. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118735. private _processPointerDown;
  118736. /** @hidden */
  118737. _isPointerSwiping(): boolean;
  118738. /**
  118739. * Use this method to simulate a pointer up on a mesh
  118740. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118741. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118742. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118743. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118744. */
  118745. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118746. private _processPointerUp;
  118747. /**
  118748. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118749. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118750. * @returns true if the pointer was captured
  118751. */
  118752. isPointerCaptured(pointerId?: number): boolean;
  118753. /**
  118754. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118755. * @param attachUp defines if you want to attach events to pointerup
  118756. * @param attachDown defines if you want to attach events to pointerdown
  118757. * @param attachMove defines if you want to attach events to pointermove
  118758. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118759. */
  118760. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118761. /**
  118762. * Detaches all event handlers
  118763. */
  118764. detachControl(): void;
  118765. /**
  118766. * Force the value of meshUnderPointer
  118767. * @param mesh defines the mesh to use
  118768. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  118769. */
  118770. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  118771. /**
  118772. * Gets the mesh under the pointer
  118773. * @returns a Mesh or null if no mesh is under the pointer
  118774. */
  118775. getPointerOverMesh(): Nullable<AbstractMesh>;
  118776. }
  118777. }
  118778. declare module BABYLON {
  118779. /**
  118780. * This class defines the direct association between an animation and a target
  118781. */
  118782. export class TargetedAnimation {
  118783. /**
  118784. * Animation to perform
  118785. */
  118786. animation: Animation;
  118787. /**
  118788. * Target to animate
  118789. */
  118790. target: any;
  118791. /**
  118792. * Returns the string "TargetedAnimation"
  118793. * @returns "TargetedAnimation"
  118794. */
  118795. getClassName(): string;
  118796. /**
  118797. * Serialize the object
  118798. * @returns the JSON object representing the current entity
  118799. */
  118800. serialize(): any;
  118801. }
  118802. /**
  118803. * Use this class to create coordinated animations on multiple targets
  118804. */
  118805. export class AnimationGroup implements IDisposable {
  118806. /** The name of the animation group */
  118807. name: string;
  118808. private _scene;
  118809. private _targetedAnimations;
  118810. private _animatables;
  118811. private _from;
  118812. private _to;
  118813. private _isStarted;
  118814. private _isPaused;
  118815. private _speedRatio;
  118816. private _loopAnimation;
  118817. private _isAdditive;
  118818. /**
  118819. * Gets or sets the unique id of the node
  118820. */
  118821. uniqueId: number;
  118822. /**
  118823. * This observable will notify when one animation have ended
  118824. */
  118825. onAnimationEndObservable: Observable<TargetedAnimation>;
  118826. /**
  118827. * Observer raised when one animation loops
  118828. */
  118829. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118830. /**
  118831. * Observer raised when all animations have looped
  118832. */
  118833. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118834. /**
  118835. * This observable will notify when all animations have ended.
  118836. */
  118837. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118838. /**
  118839. * This observable will notify when all animations have paused.
  118840. */
  118841. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118842. /**
  118843. * This observable will notify when all animations are playing.
  118844. */
  118845. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118846. /**
  118847. * Gets the first frame
  118848. */
  118849. get from(): number;
  118850. /**
  118851. * Gets the last frame
  118852. */
  118853. get to(): number;
  118854. /**
  118855. * Define if the animations are started
  118856. */
  118857. get isStarted(): boolean;
  118858. /**
  118859. * Gets a value indicating that the current group is playing
  118860. */
  118861. get isPlaying(): boolean;
  118862. /**
  118863. * Gets or sets the speed ratio to use for all animations
  118864. */
  118865. get speedRatio(): number;
  118866. /**
  118867. * Gets or sets the speed ratio to use for all animations
  118868. */
  118869. set speedRatio(value: number);
  118870. /**
  118871. * Gets or sets if all animations should loop or not
  118872. */
  118873. get loopAnimation(): boolean;
  118874. set loopAnimation(value: boolean);
  118875. /**
  118876. * Gets or sets if all animations should be evaluated additively
  118877. */
  118878. get isAdditive(): boolean;
  118879. set isAdditive(value: boolean);
  118880. /**
  118881. * Gets the targeted animations for this animation group
  118882. */
  118883. get targetedAnimations(): Array<TargetedAnimation>;
  118884. /**
  118885. * returning the list of animatables controlled by this animation group.
  118886. */
  118887. get animatables(): Array<Animatable>;
  118888. /**
  118889. * Gets the list of target animations
  118890. */
  118891. get children(): TargetedAnimation[];
  118892. /**
  118893. * Instantiates a new Animation Group.
  118894. * This helps managing several animations at once.
  118895. * @see https://doc.babylonjs.com/how_to/group
  118896. * @param name Defines the name of the group
  118897. * @param scene Defines the scene the group belongs to
  118898. */
  118899. constructor(
  118900. /** The name of the animation group */
  118901. name: string, scene?: Nullable<Scene>);
  118902. /**
  118903. * Add an animation (with its target) in the group
  118904. * @param animation defines the animation we want to add
  118905. * @param target defines the target of the animation
  118906. * @returns the TargetedAnimation object
  118907. */
  118908. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118909. /**
  118910. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118911. * It can add constant keys at begin or end
  118912. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118913. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118914. * @returns the animation group
  118915. */
  118916. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118917. private _animationLoopCount;
  118918. private _animationLoopFlags;
  118919. private _processLoop;
  118920. /**
  118921. * Start all animations on given targets
  118922. * @param loop defines if animations must loop
  118923. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118924. * @param from defines the from key (optional)
  118925. * @param to defines the to key (optional)
  118926. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118927. * @returns the current animation group
  118928. */
  118929. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118930. /**
  118931. * Pause all animations
  118932. * @returns the animation group
  118933. */
  118934. pause(): AnimationGroup;
  118935. /**
  118936. * Play all animations to initial state
  118937. * This function will start() the animations if they were not started or will restart() them if they were paused
  118938. * @param loop defines if animations must loop
  118939. * @returns the animation group
  118940. */
  118941. play(loop?: boolean): AnimationGroup;
  118942. /**
  118943. * Reset all animations to initial state
  118944. * @returns the animation group
  118945. */
  118946. reset(): AnimationGroup;
  118947. /**
  118948. * Restart animations from key 0
  118949. * @returns the animation group
  118950. */
  118951. restart(): AnimationGroup;
  118952. /**
  118953. * Stop all animations
  118954. * @returns the animation group
  118955. */
  118956. stop(): AnimationGroup;
  118957. /**
  118958. * Set animation weight for all animatables
  118959. * @param weight defines the weight to use
  118960. * @return the animationGroup
  118961. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118962. */
  118963. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118964. /**
  118965. * Synchronize and normalize all animatables with a source animatable
  118966. * @param root defines the root animatable to synchronize with
  118967. * @return the animationGroup
  118968. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118969. */
  118970. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118971. /**
  118972. * Goes to a specific frame in this animation group
  118973. * @param frame the frame number to go to
  118974. * @return the animationGroup
  118975. */
  118976. goToFrame(frame: number): AnimationGroup;
  118977. /**
  118978. * Dispose all associated resources
  118979. */
  118980. dispose(): void;
  118981. private _checkAnimationGroupEnded;
  118982. /**
  118983. * Clone the current animation group and returns a copy
  118984. * @param newName defines the name of the new group
  118985. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118986. * @returns the new aniamtion group
  118987. */
  118988. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118989. /**
  118990. * Serializes the animationGroup to an object
  118991. * @returns Serialized object
  118992. */
  118993. serialize(): any;
  118994. /**
  118995. * Returns a new AnimationGroup object parsed from the source provided.
  118996. * @param parsedAnimationGroup defines the source
  118997. * @param scene defines the scene that will receive the animationGroup
  118998. * @returns a new AnimationGroup
  118999. */
  119000. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  119001. /**
  119002. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  119003. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  119004. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  119005. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  119006. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  119007. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  119008. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  119009. */
  119010. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  119011. /**
  119012. * Returns the string "AnimationGroup"
  119013. * @returns "AnimationGroup"
  119014. */
  119015. getClassName(): string;
  119016. /**
  119017. * Creates a detailled string about the object
  119018. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  119019. * @returns a string representing the object
  119020. */
  119021. toString(fullDetails?: boolean): string;
  119022. }
  119023. }
  119024. declare module BABYLON {
  119025. /**
  119026. * Define an interface for all classes that will hold resources
  119027. */
  119028. export interface IDisposable {
  119029. /**
  119030. * Releases all held resources
  119031. */
  119032. dispose(): void;
  119033. }
  119034. /** Interface defining initialization parameters for Scene class */
  119035. export interface SceneOptions {
  119036. /**
  119037. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  119038. * It will improve performance when the number of geometries becomes important.
  119039. */
  119040. useGeometryUniqueIdsMap?: boolean;
  119041. /**
  119042. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  119043. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119044. */
  119045. useMaterialMeshMap?: boolean;
  119046. /**
  119047. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  119048. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119049. */
  119050. useClonedMeshMap?: boolean;
  119051. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  119052. virtual?: boolean;
  119053. }
  119054. /**
  119055. * Represents a scene to be rendered by the engine.
  119056. * @see https://doc.babylonjs.com/features/scene
  119057. */
  119058. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  119059. /** The fog is deactivated */
  119060. static readonly FOGMODE_NONE: number;
  119061. /** The fog density is following an exponential function */
  119062. static readonly FOGMODE_EXP: number;
  119063. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  119064. static readonly FOGMODE_EXP2: number;
  119065. /** The fog density is following a linear function. */
  119066. static readonly FOGMODE_LINEAR: number;
  119067. /**
  119068. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  119069. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119070. */
  119071. static MinDeltaTime: number;
  119072. /**
  119073. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  119074. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119075. */
  119076. static MaxDeltaTime: number;
  119077. /**
  119078. * Factory used to create the default material.
  119079. * @param name The name of the material to create
  119080. * @param scene The scene to create the material for
  119081. * @returns The default material
  119082. */
  119083. static DefaultMaterialFactory(scene: Scene): Material;
  119084. /**
  119085. * Factory used to create the a collision coordinator.
  119086. * @returns The collision coordinator
  119087. */
  119088. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119089. /** @hidden */
  119090. _inputManager: InputManager;
  119091. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119092. cameraToUseForPointers: Nullable<Camera>;
  119093. /** @hidden */
  119094. readonly _isScene: boolean;
  119095. /** @hidden */
  119096. _blockEntityCollection: boolean;
  119097. /**
  119098. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119099. */
  119100. autoClear: boolean;
  119101. /**
  119102. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119103. */
  119104. autoClearDepthAndStencil: boolean;
  119105. /**
  119106. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119107. */
  119108. clearColor: Color4;
  119109. /**
  119110. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119111. */
  119112. ambientColor: Color3;
  119113. /**
  119114. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119115. * It should only be one of the following (if not the default embedded one):
  119116. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119117. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119118. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119119. * The material properties need to be setup according to the type of texture in use.
  119120. */
  119121. environmentBRDFTexture: BaseTexture;
  119122. /**
  119123. * Texture used in all pbr material as the reflection texture.
  119124. * As in the majority of the scene they are the same (exception for multi room and so on),
  119125. * this is easier to reference from here than from all the materials.
  119126. */
  119127. get environmentTexture(): Nullable<BaseTexture>;
  119128. /**
  119129. * Texture used in all pbr material as the reflection texture.
  119130. * As in the majority of the scene they are the same (exception for multi room and so on),
  119131. * this is easier to set here than in all the materials.
  119132. */
  119133. set environmentTexture(value: Nullable<BaseTexture>);
  119134. /** @hidden */
  119135. protected _environmentIntensity: number;
  119136. /**
  119137. * Intensity of the environment in all pbr material.
  119138. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119139. * As in the majority of the scene they are the same (exception for multi room and so on),
  119140. * this is easier to reference from here than from all the materials.
  119141. */
  119142. get environmentIntensity(): number;
  119143. /**
  119144. * Intensity of the environment in all pbr material.
  119145. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119146. * As in the majority of the scene they are the same (exception for multi room and so on),
  119147. * this is easier to set here than in all the materials.
  119148. */
  119149. set environmentIntensity(value: number);
  119150. /** @hidden */
  119151. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119152. /**
  119153. * Default image processing configuration used either in the rendering
  119154. * Forward main pass or through the imageProcessingPostProcess if present.
  119155. * As in the majority of the scene they are the same (exception for multi camera),
  119156. * this is easier to reference from here than from all the materials and post process.
  119157. *
  119158. * No setter as we it is a shared configuration, you can set the values instead.
  119159. */
  119160. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119161. private _forceWireframe;
  119162. /**
  119163. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119164. */
  119165. set forceWireframe(value: boolean);
  119166. get forceWireframe(): boolean;
  119167. private _skipFrustumClipping;
  119168. /**
  119169. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119170. */
  119171. set skipFrustumClipping(value: boolean);
  119172. get skipFrustumClipping(): boolean;
  119173. private _forcePointsCloud;
  119174. /**
  119175. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119176. */
  119177. set forcePointsCloud(value: boolean);
  119178. get forcePointsCloud(): boolean;
  119179. /**
  119180. * Gets or sets the active clipplane 1
  119181. */
  119182. clipPlane: Nullable<Plane>;
  119183. /**
  119184. * Gets or sets the active clipplane 2
  119185. */
  119186. clipPlane2: Nullable<Plane>;
  119187. /**
  119188. * Gets or sets the active clipplane 3
  119189. */
  119190. clipPlane3: Nullable<Plane>;
  119191. /**
  119192. * Gets or sets the active clipplane 4
  119193. */
  119194. clipPlane4: Nullable<Plane>;
  119195. /**
  119196. * Gets or sets the active clipplane 5
  119197. */
  119198. clipPlane5: Nullable<Plane>;
  119199. /**
  119200. * Gets or sets the active clipplane 6
  119201. */
  119202. clipPlane6: Nullable<Plane>;
  119203. /**
  119204. * Gets or sets a boolean indicating if animations are enabled
  119205. */
  119206. animationsEnabled: boolean;
  119207. private _animationPropertiesOverride;
  119208. /**
  119209. * Gets or sets the animation properties override
  119210. */
  119211. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119212. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119213. /**
  119214. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119215. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119216. */
  119217. useConstantAnimationDeltaTime: boolean;
  119218. /**
  119219. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119220. * Please note that it requires to run a ray cast through the scene on every frame
  119221. */
  119222. constantlyUpdateMeshUnderPointer: boolean;
  119223. /**
  119224. * Defines the HTML cursor to use when hovering over interactive elements
  119225. */
  119226. hoverCursor: string;
  119227. /**
  119228. * Defines the HTML default cursor to use (empty by default)
  119229. */
  119230. defaultCursor: string;
  119231. /**
  119232. * Defines whether cursors are handled by the scene.
  119233. */
  119234. doNotHandleCursors: boolean;
  119235. /**
  119236. * This is used to call preventDefault() on pointer down
  119237. * in order to block unwanted artifacts like system double clicks
  119238. */
  119239. preventDefaultOnPointerDown: boolean;
  119240. /**
  119241. * This is used to call preventDefault() on pointer up
  119242. * in order to block unwanted artifacts like system double clicks
  119243. */
  119244. preventDefaultOnPointerUp: boolean;
  119245. /**
  119246. * Gets or sets user defined metadata
  119247. */
  119248. metadata: any;
  119249. /**
  119250. * For internal use only. Please do not use.
  119251. */
  119252. reservedDataStore: any;
  119253. /**
  119254. * Gets the name of the plugin used to load this scene (null by default)
  119255. */
  119256. loadingPluginName: string;
  119257. /**
  119258. * Use this array to add regular expressions used to disable offline support for specific urls
  119259. */
  119260. disableOfflineSupportExceptionRules: RegExp[];
  119261. /**
  119262. * An event triggered when the scene is disposed.
  119263. */
  119264. onDisposeObservable: Observable<Scene>;
  119265. private _onDisposeObserver;
  119266. /** Sets a function to be executed when this scene is disposed. */
  119267. set onDispose(callback: () => void);
  119268. /**
  119269. * An event triggered before rendering the scene (right after animations and physics)
  119270. */
  119271. onBeforeRenderObservable: Observable<Scene>;
  119272. private _onBeforeRenderObserver;
  119273. /** Sets a function to be executed before rendering this scene */
  119274. set beforeRender(callback: Nullable<() => void>);
  119275. /**
  119276. * An event triggered after rendering the scene
  119277. */
  119278. onAfterRenderObservable: Observable<Scene>;
  119279. /**
  119280. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119281. */
  119282. onAfterRenderCameraObservable: Observable<Camera>;
  119283. private _onAfterRenderObserver;
  119284. /** Sets a function to be executed after rendering this scene */
  119285. set afterRender(callback: Nullable<() => void>);
  119286. /**
  119287. * An event triggered before animating the scene
  119288. */
  119289. onBeforeAnimationsObservable: Observable<Scene>;
  119290. /**
  119291. * An event triggered after animations processing
  119292. */
  119293. onAfterAnimationsObservable: Observable<Scene>;
  119294. /**
  119295. * An event triggered before draw calls are ready to be sent
  119296. */
  119297. onBeforeDrawPhaseObservable: Observable<Scene>;
  119298. /**
  119299. * An event triggered after draw calls have been sent
  119300. */
  119301. onAfterDrawPhaseObservable: Observable<Scene>;
  119302. /**
  119303. * An event triggered when the scene is ready
  119304. */
  119305. onReadyObservable: Observable<Scene>;
  119306. /**
  119307. * An event triggered before rendering a camera
  119308. */
  119309. onBeforeCameraRenderObservable: Observable<Camera>;
  119310. private _onBeforeCameraRenderObserver;
  119311. /** Sets a function to be executed before rendering a camera*/
  119312. set beforeCameraRender(callback: () => void);
  119313. /**
  119314. * An event triggered after rendering a camera
  119315. */
  119316. onAfterCameraRenderObservable: Observable<Camera>;
  119317. private _onAfterCameraRenderObserver;
  119318. /** Sets a function to be executed after rendering a camera*/
  119319. set afterCameraRender(callback: () => void);
  119320. /**
  119321. * An event triggered when active meshes evaluation is about to start
  119322. */
  119323. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119324. /**
  119325. * An event triggered when active meshes evaluation is done
  119326. */
  119327. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119328. /**
  119329. * An event triggered when particles rendering is about to start
  119330. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119331. */
  119332. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119333. /**
  119334. * An event triggered when particles rendering is done
  119335. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119336. */
  119337. onAfterParticlesRenderingObservable: Observable<Scene>;
  119338. /**
  119339. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119340. */
  119341. onDataLoadedObservable: Observable<Scene>;
  119342. /**
  119343. * An event triggered when a camera is created
  119344. */
  119345. onNewCameraAddedObservable: Observable<Camera>;
  119346. /**
  119347. * An event triggered when a camera is removed
  119348. */
  119349. onCameraRemovedObservable: Observable<Camera>;
  119350. /**
  119351. * An event triggered when a light is created
  119352. */
  119353. onNewLightAddedObservable: Observable<Light>;
  119354. /**
  119355. * An event triggered when a light is removed
  119356. */
  119357. onLightRemovedObservable: Observable<Light>;
  119358. /**
  119359. * An event triggered when a geometry is created
  119360. */
  119361. onNewGeometryAddedObservable: Observable<Geometry>;
  119362. /**
  119363. * An event triggered when a geometry is removed
  119364. */
  119365. onGeometryRemovedObservable: Observable<Geometry>;
  119366. /**
  119367. * An event triggered when a transform node is created
  119368. */
  119369. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119370. /**
  119371. * An event triggered when a transform node is removed
  119372. */
  119373. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119374. /**
  119375. * An event triggered when a mesh is created
  119376. */
  119377. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119378. /**
  119379. * An event triggered when a mesh is removed
  119380. */
  119381. onMeshRemovedObservable: Observable<AbstractMesh>;
  119382. /**
  119383. * An event triggered when a skeleton is created
  119384. */
  119385. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119386. /**
  119387. * An event triggered when a skeleton is removed
  119388. */
  119389. onSkeletonRemovedObservable: Observable<Skeleton>;
  119390. /**
  119391. * An event triggered when a material is created
  119392. */
  119393. onNewMaterialAddedObservable: Observable<Material>;
  119394. /**
  119395. * An event triggered when a material is removed
  119396. */
  119397. onMaterialRemovedObservable: Observable<Material>;
  119398. /**
  119399. * An event triggered when a texture is created
  119400. */
  119401. onNewTextureAddedObservable: Observable<BaseTexture>;
  119402. /**
  119403. * An event triggered when a texture is removed
  119404. */
  119405. onTextureRemovedObservable: Observable<BaseTexture>;
  119406. /**
  119407. * An event triggered when render targets are about to be rendered
  119408. * Can happen multiple times per frame.
  119409. */
  119410. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119411. /**
  119412. * An event triggered when render targets were rendered.
  119413. * Can happen multiple times per frame.
  119414. */
  119415. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119416. /**
  119417. * An event triggered before calculating deterministic simulation step
  119418. */
  119419. onBeforeStepObservable: Observable<Scene>;
  119420. /**
  119421. * An event triggered after calculating deterministic simulation step
  119422. */
  119423. onAfterStepObservable: Observable<Scene>;
  119424. /**
  119425. * An event triggered when the activeCamera property is updated
  119426. */
  119427. onActiveCameraChanged: Observable<Scene>;
  119428. /**
  119429. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119430. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119431. * 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)
  119432. */
  119433. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119434. /**
  119435. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119436. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119437. * 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)
  119438. */
  119439. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119440. /**
  119441. * This Observable will when a mesh has been imported into the scene.
  119442. */
  119443. onMeshImportedObservable: Observable<AbstractMesh>;
  119444. /**
  119445. * This Observable will when an animation file has been imported into the scene.
  119446. */
  119447. onAnimationFileImportedObservable: Observable<Scene>;
  119448. /**
  119449. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119450. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119451. */
  119452. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119453. /** @hidden */
  119454. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119455. /**
  119456. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119457. */
  119458. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119459. /**
  119460. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119461. */
  119462. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119463. /**
  119464. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119465. */
  119466. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119467. /** Callback called when a pointer move is detected */
  119468. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119469. /** Callback called when a pointer down is detected */
  119470. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119471. /** Callback called when a pointer up is detected */
  119472. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119473. /** Callback called when a pointer pick is detected */
  119474. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119475. /**
  119476. * 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).
  119477. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119478. */
  119479. onPrePointerObservable: Observable<PointerInfoPre>;
  119480. /**
  119481. * Observable event triggered each time an input event is received from the rendering canvas
  119482. */
  119483. onPointerObservable: Observable<PointerInfo>;
  119484. /**
  119485. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119486. */
  119487. get unTranslatedPointer(): Vector2;
  119488. /**
  119489. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119490. */
  119491. static get DragMovementThreshold(): number;
  119492. static set DragMovementThreshold(value: number);
  119493. /**
  119494. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119495. */
  119496. static get LongPressDelay(): number;
  119497. static set LongPressDelay(value: number);
  119498. /**
  119499. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119500. */
  119501. static get DoubleClickDelay(): number;
  119502. static set DoubleClickDelay(value: number);
  119503. /** If you need to check double click without raising a single click at first click, enable this flag */
  119504. static get ExclusiveDoubleClickMode(): boolean;
  119505. static set ExclusiveDoubleClickMode(value: boolean);
  119506. /** @hidden */
  119507. _mirroredCameraPosition: Nullable<Vector3>;
  119508. /**
  119509. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119510. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119511. */
  119512. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119513. /**
  119514. * Observable event triggered each time an keyboard event is received from the hosting window
  119515. */
  119516. onKeyboardObservable: Observable<KeyboardInfo>;
  119517. private _useRightHandedSystem;
  119518. /**
  119519. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119520. */
  119521. set useRightHandedSystem(value: boolean);
  119522. get useRightHandedSystem(): boolean;
  119523. private _timeAccumulator;
  119524. private _currentStepId;
  119525. private _currentInternalStep;
  119526. /**
  119527. * Sets the step Id used by deterministic lock step
  119528. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119529. * @param newStepId defines the step Id
  119530. */
  119531. setStepId(newStepId: number): void;
  119532. /**
  119533. * Gets the step Id used by deterministic lock step
  119534. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119535. * @returns the step Id
  119536. */
  119537. getStepId(): number;
  119538. /**
  119539. * Gets the internal step used by deterministic lock step
  119540. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119541. * @returns the internal step
  119542. */
  119543. getInternalStep(): number;
  119544. private _fogEnabled;
  119545. /**
  119546. * Gets or sets a boolean indicating if fog is enabled on this scene
  119547. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119548. * (Default is true)
  119549. */
  119550. set fogEnabled(value: boolean);
  119551. get fogEnabled(): boolean;
  119552. private _fogMode;
  119553. /**
  119554. * Gets or sets the fog mode to use
  119555. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119556. * | mode | value |
  119557. * | --- | --- |
  119558. * | FOGMODE_NONE | 0 |
  119559. * | FOGMODE_EXP | 1 |
  119560. * | FOGMODE_EXP2 | 2 |
  119561. * | FOGMODE_LINEAR | 3 |
  119562. */
  119563. set fogMode(value: number);
  119564. get fogMode(): number;
  119565. /**
  119566. * Gets or sets the fog color to use
  119567. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119568. * (Default is Color3(0.2, 0.2, 0.3))
  119569. */
  119570. fogColor: Color3;
  119571. /**
  119572. * Gets or sets the fog density to use
  119573. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119574. * (Default is 0.1)
  119575. */
  119576. fogDensity: number;
  119577. /**
  119578. * Gets or sets the fog start distance to use
  119579. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119580. * (Default is 0)
  119581. */
  119582. fogStart: number;
  119583. /**
  119584. * Gets or sets the fog end distance to use
  119585. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119586. * (Default is 1000)
  119587. */
  119588. fogEnd: number;
  119589. /**
  119590. * Flag indicating that the frame buffer binding is handled by another component
  119591. */
  119592. prePass: boolean;
  119593. private _shadowsEnabled;
  119594. /**
  119595. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119596. */
  119597. set shadowsEnabled(value: boolean);
  119598. get shadowsEnabled(): boolean;
  119599. private _lightsEnabled;
  119600. /**
  119601. * Gets or sets a boolean indicating if lights are enabled on this scene
  119602. */
  119603. set lightsEnabled(value: boolean);
  119604. get lightsEnabled(): boolean;
  119605. /** All of the active cameras added to this scene. */
  119606. activeCameras: Camera[];
  119607. /** @hidden */
  119608. _activeCamera: Nullable<Camera>;
  119609. /** Gets or sets the current active camera */
  119610. get activeCamera(): Nullable<Camera>;
  119611. set activeCamera(value: Nullable<Camera>);
  119612. private _defaultMaterial;
  119613. /** The default material used on meshes when no material is affected */
  119614. get defaultMaterial(): Material;
  119615. /** The default material used on meshes when no material is affected */
  119616. set defaultMaterial(value: Material);
  119617. private _texturesEnabled;
  119618. /**
  119619. * Gets or sets a boolean indicating if textures are enabled on this scene
  119620. */
  119621. set texturesEnabled(value: boolean);
  119622. get texturesEnabled(): boolean;
  119623. /**
  119624. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119625. */
  119626. physicsEnabled: boolean;
  119627. /**
  119628. * Gets or sets a boolean indicating if particles are enabled on this scene
  119629. */
  119630. particlesEnabled: boolean;
  119631. /**
  119632. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119633. */
  119634. spritesEnabled: boolean;
  119635. private _skeletonsEnabled;
  119636. /**
  119637. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119638. */
  119639. set skeletonsEnabled(value: boolean);
  119640. get skeletonsEnabled(): boolean;
  119641. /**
  119642. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119643. */
  119644. lensFlaresEnabled: boolean;
  119645. /**
  119646. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119647. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119648. */
  119649. collisionsEnabled: boolean;
  119650. private _collisionCoordinator;
  119651. /** @hidden */
  119652. get collisionCoordinator(): ICollisionCoordinator;
  119653. /**
  119654. * Defines the gravity applied to this scene (used only for collisions)
  119655. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119656. */
  119657. gravity: Vector3;
  119658. /**
  119659. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119660. */
  119661. postProcessesEnabled: boolean;
  119662. /**
  119663. * Gets the current postprocess manager
  119664. */
  119665. postProcessManager: PostProcessManager;
  119666. /**
  119667. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119668. */
  119669. renderTargetsEnabled: boolean;
  119670. /**
  119671. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119672. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119673. */
  119674. dumpNextRenderTargets: boolean;
  119675. /**
  119676. * The list of user defined render targets added to the scene
  119677. */
  119678. customRenderTargets: RenderTargetTexture[];
  119679. /**
  119680. * Defines if texture loading must be delayed
  119681. * If true, textures will only be loaded when they need to be rendered
  119682. */
  119683. useDelayedTextureLoading: boolean;
  119684. /**
  119685. * Gets the list of meshes imported to the scene through SceneLoader
  119686. */
  119687. importedMeshesFiles: String[];
  119688. /**
  119689. * Gets or sets a boolean indicating if probes are enabled on this scene
  119690. */
  119691. probesEnabled: boolean;
  119692. /**
  119693. * Gets or sets the current offline provider to use to store scene data
  119694. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119695. */
  119696. offlineProvider: IOfflineProvider;
  119697. /**
  119698. * Gets or sets the action manager associated with the scene
  119699. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119700. */
  119701. actionManager: AbstractActionManager;
  119702. private _meshesForIntersections;
  119703. /**
  119704. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119705. */
  119706. proceduralTexturesEnabled: boolean;
  119707. private _engine;
  119708. private _totalVertices;
  119709. /** @hidden */
  119710. _activeIndices: PerfCounter;
  119711. /** @hidden */
  119712. _activeParticles: PerfCounter;
  119713. /** @hidden */
  119714. _activeBones: PerfCounter;
  119715. private _animationRatio;
  119716. /** @hidden */
  119717. _animationTimeLast: number;
  119718. /** @hidden */
  119719. _animationTime: number;
  119720. /**
  119721. * Gets or sets a general scale for animation speed
  119722. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119723. */
  119724. animationTimeScale: number;
  119725. /** @hidden */
  119726. _cachedMaterial: Nullable<Material>;
  119727. /** @hidden */
  119728. _cachedEffect: Nullable<Effect>;
  119729. /** @hidden */
  119730. _cachedVisibility: Nullable<number>;
  119731. private _renderId;
  119732. private _frameId;
  119733. private _executeWhenReadyTimeoutId;
  119734. private _intermediateRendering;
  119735. private _viewUpdateFlag;
  119736. private _projectionUpdateFlag;
  119737. /** @hidden */
  119738. _toBeDisposed: Nullable<IDisposable>[];
  119739. private _activeRequests;
  119740. /** @hidden */
  119741. _pendingData: any[];
  119742. private _isDisposed;
  119743. /**
  119744. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119745. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119746. */
  119747. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119748. private _activeMeshes;
  119749. private _processedMaterials;
  119750. private _renderTargets;
  119751. /** @hidden */
  119752. _activeParticleSystems: SmartArray<IParticleSystem>;
  119753. private _activeSkeletons;
  119754. private _softwareSkinnedMeshes;
  119755. private _renderingManager;
  119756. /** @hidden */
  119757. _activeAnimatables: Animatable[];
  119758. private _transformMatrix;
  119759. private _sceneUbo;
  119760. /** @hidden */
  119761. _viewMatrix: Matrix;
  119762. private _projectionMatrix;
  119763. /** @hidden */
  119764. _forcedViewPosition: Nullable<Vector3>;
  119765. /** @hidden */
  119766. _frustumPlanes: Plane[];
  119767. /**
  119768. * Gets the list of frustum planes (built from the active camera)
  119769. */
  119770. get frustumPlanes(): Plane[];
  119771. /**
  119772. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119773. * This is useful if there are more lights that the maximum simulteanous authorized
  119774. */
  119775. requireLightSorting: boolean;
  119776. /** @hidden */
  119777. readonly useMaterialMeshMap: boolean;
  119778. /** @hidden */
  119779. readonly useClonedMeshMap: boolean;
  119780. private _externalData;
  119781. private _uid;
  119782. /**
  119783. * @hidden
  119784. * Backing store of defined scene components.
  119785. */
  119786. _components: ISceneComponent[];
  119787. /**
  119788. * @hidden
  119789. * Backing store of defined scene components.
  119790. */
  119791. _serializableComponents: ISceneSerializableComponent[];
  119792. /**
  119793. * List of components to register on the next registration step.
  119794. */
  119795. private _transientComponents;
  119796. /**
  119797. * Registers the transient components if needed.
  119798. */
  119799. private _registerTransientComponents;
  119800. /**
  119801. * @hidden
  119802. * Add a component to the scene.
  119803. * Note that the ccomponent could be registered on th next frame if this is called after
  119804. * the register component stage.
  119805. * @param component Defines the component to add to the scene
  119806. */
  119807. _addComponent(component: ISceneComponent): void;
  119808. /**
  119809. * @hidden
  119810. * Gets a component from the scene.
  119811. * @param name defines the name of the component to retrieve
  119812. * @returns the component or null if not present
  119813. */
  119814. _getComponent(name: string): Nullable<ISceneComponent>;
  119815. /**
  119816. * @hidden
  119817. * Defines the actions happening before camera updates.
  119818. */
  119819. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119820. /**
  119821. * @hidden
  119822. * Defines the actions happening before clear the canvas.
  119823. */
  119824. _beforeClearStage: Stage<SimpleStageAction>;
  119825. /**
  119826. * @hidden
  119827. * Defines the actions when collecting render targets for the frame.
  119828. */
  119829. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119830. /**
  119831. * @hidden
  119832. * Defines the actions happening for one camera in the frame.
  119833. */
  119834. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119835. /**
  119836. * @hidden
  119837. * Defines the actions happening during the per mesh ready checks.
  119838. */
  119839. _isReadyForMeshStage: Stage<MeshStageAction>;
  119840. /**
  119841. * @hidden
  119842. * Defines the actions happening before evaluate active mesh checks.
  119843. */
  119844. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119845. /**
  119846. * @hidden
  119847. * Defines the actions happening during the evaluate sub mesh checks.
  119848. */
  119849. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119850. /**
  119851. * @hidden
  119852. * Defines the actions happening during the active mesh stage.
  119853. */
  119854. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119855. /**
  119856. * @hidden
  119857. * Defines the actions happening during the per camera render target step.
  119858. */
  119859. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119860. /**
  119861. * @hidden
  119862. * Defines the actions happening just before the active camera is drawing.
  119863. */
  119864. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119865. /**
  119866. * @hidden
  119867. * Defines the actions happening just before a render target is drawing.
  119868. */
  119869. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119870. /**
  119871. * @hidden
  119872. * Defines the actions happening just before a rendering group is drawing.
  119873. */
  119874. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119875. /**
  119876. * @hidden
  119877. * Defines the actions happening just before a mesh is drawing.
  119878. */
  119879. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119880. /**
  119881. * @hidden
  119882. * Defines the actions happening just after a mesh has been drawn.
  119883. */
  119884. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119885. /**
  119886. * @hidden
  119887. * Defines the actions happening just after a rendering group has been drawn.
  119888. */
  119889. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119890. /**
  119891. * @hidden
  119892. * Defines the actions happening just after the active camera has been drawn.
  119893. */
  119894. _afterCameraDrawStage: Stage<CameraStageAction>;
  119895. /**
  119896. * @hidden
  119897. * Defines the actions happening just after a render target has been drawn.
  119898. */
  119899. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119900. /**
  119901. * @hidden
  119902. * Defines the actions happening just after rendering all cameras and computing intersections.
  119903. */
  119904. _afterRenderStage: Stage<SimpleStageAction>;
  119905. /**
  119906. * @hidden
  119907. * Defines the actions happening when a pointer move event happens.
  119908. */
  119909. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119910. /**
  119911. * @hidden
  119912. * Defines the actions happening when a pointer down event happens.
  119913. */
  119914. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119915. /**
  119916. * @hidden
  119917. * Defines the actions happening when a pointer up event happens.
  119918. */
  119919. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119920. /**
  119921. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119922. */
  119923. private geometriesByUniqueId;
  119924. /**
  119925. * Creates a new Scene
  119926. * @param engine defines the engine to use to render this scene
  119927. * @param options defines the scene options
  119928. */
  119929. constructor(engine: Engine, options?: SceneOptions);
  119930. /**
  119931. * Gets a string identifying the name of the class
  119932. * @returns "Scene" string
  119933. */
  119934. getClassName(): string;
  119935. private _defaultMeshCandidates;
  119936. /**
  119937. * @hidden
  119938. */
  119939. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119940. private _defaultSubMeshCandidates;
  119941. /**
  119942. * @hidden
  119943. */
  119944. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119945. /**
  119946. * Sets the default candidate providers for the scene.
  119947. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119948. * and getCollidingSubMeshCandidates to their default function
  119949. */
  119950. setDefaultCandidateProviders(): void;
  119951. /**
  119952. * Gets the mesh that is currently under the pointer
  119953. */
  119954. get meshUnderPointer(): Nullable<AbstractMesh>;
  119955. /**
  119956. * Gets or sets the current on-screen X position of the pointer
  119957. */
  119958. get pointerX(): number;
  119959. set pointerX(value: number);
  119960. /**
  119961. * Gets or sets the current on-screen Y position of the pointer
  119962. */
  119963. get pointerY(): number;
  119964. set pointerY(value: number);
  119965. /**
  119966. * Gets the cached material (ie. the latest rendered one)
  119967. * @returns the cached material
  119968. */
  119969. getCachedMaterial(): Nullable<Material>;
  119970. /**
  119971. * Gets the cached effect (ie. the latest rendered one)
  119972. * @returns the cached effect
  119973. */
  119974. getCachedEffect(): Nullable<Effect>;
  119975. /**
  119976. * Gets the cached visibility state (ie. the latest rendered one)
  119977. * @returns the cached visibility state
  119978. */
  119979. getCachedVisibility(): Nullable<number>;
  119980. /**
  119981. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119982. * @param material defines the current material
  119983. * @param effect defines the current effect
  119984. * @param visibility defines the current visibility state
  119985. * @returns true if one parameter is not cached
  119986. */
  119987. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119988. /**
  119989. * Gets the engine associated with the scene
  119990. * @returns an Engine
  119991. */
  119992. getEngine(): Engine;
  119993. /**
  119994. * Gets the total number of vertices rendered per frame
  119995. * @returns the total number of vertices rendered per frame
  119996. */
  119997. getTotalVertices(): number;
  119998. /**
  119999. * Gets the performance counter for total vertices
  120000. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120001. */
  120002. get totalVerticesPerfCounter(): PerfCounter;
  120003. /**
  120004. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  120005. * @returns the total number of active indices rendered per frame
  120006. */
  120007. getActiveIndices(): number;
  120008. /**
  120009. * Gets the performance counter for active indices
  120010. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120011. */
  120012. get totalActiveIndicesPerfCounter(): PerfCounter;
  120013. /**
  120014. * Gets the total number of active particles rendered per frame
  120015. * @returns the total number of active particles rendered per frame
  120016. */
  120017. getActiveParticles(): number;
  120018. /**
  120019. * Gets the performance counter for active particles
  120020. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120021. */
  120022. get activeParticlesPerfCounter(): PerfCounter;
  120023. /**
  120024. * Gets the total number of active bones rendered per frame
  120025. * @returns the total number of active bones rendered per frame
  120026. */
  120027. getActiveBones(): number;
  120028. /**
  120029. * Gets the performance counter for active bones
  120030. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120031. */
  120032. get activeBonesPerfCounter(): PerfCounter;
  120033. /**
  120034. * Gets the array of active meshes
  120035. * @returns an array of AbstractMesh
  120036. */
  120037. getActiveMeshes(): SmartArray<AbstractMesh>;
  120038. /**
  120039. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  120040. * @returns a number
  120041. */
  120042. getAnimationRatio(): number;
  120043. /**
  120044. * Gets an unique Id for the current render phase
  120045. * @returns a number
  120046. */
  120047. getRenderId(): number;
  120048. /**
  120049. * Gets an unique Id for the current frame
  120050. * @returns a number
  120051. */
  120052. getFrameId(): number;
  120053. /** Call this function if you want to manually increment the render Id*/
  120054. incrementRenderId(): void;
  120055. private _createUbo;
  120056. /**
  120057. * Use this method to simulate a pointer move on a mesh
  120058. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120059. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120060. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120061. * @returns the current scene
  120062. */
  120063. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120064. /**
  120065. * Use this method to simulate a pointer down on a mesh
  120066. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120067. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120068. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120069. * @returns the current scene
  120070. */
  120071. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120072. /**
  120073. * Use this method to simulate a pointer up on a mesh
  120074. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120075. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120076. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120077. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  120078. * @returns the current scene
  120079. */
  120080. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  120081. /**
  120082. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  120083. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  120084. * @returns true if the pointer was captured
  120085. */
  120086. isPointerCaptured(pointerId?: number): boolean;
  120087. /**
  120088. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120089. * @param attachUp defines if you want to attach events to pointerup
  120090. * @param attachDown defines if you want to attach events to pointerdown
  120091. * @param attachMove defines if you want to attach events to pointermove
  120092. */
  120093. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120094. /** Detaches all event handlers*/
  120095. detachControl(): void;
  120096. /**
  120097. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120098. * Delay loaded resources are not taking in account
  120099. * @return true if all required resources are ready
  120100. */
  120101. isReady(): boolean;
  120102. /** Resets all cached information relative to material (including effect and visibility) */
  120103. resetCachedMaterial(): void;
  120104. /**
  120105. * Registers a function to be called before every frame render
  120106. * @param func defines the function to register
  120107. */
  120108. registerBeforeRender(func: () => void): void;
  120109. /**
  120110. * Unregisters a function called before every frame render
  120111. * @param func defines the function to unregister
  120112. */
  120113. unregisterBeforeRender(func: () => void): void;
  120114. /**
  120115. * Registers a function to be called after every frame render
  120116. * @param func defines the function to register
  120117. */
  120118. registerAfterRender(func: () => void): void;
  120119. /**
  120120. * Unregisters a function called after every frame render
  120121. * @param func defines the function to unregister
  120122. */
  120123. unregisterAfterRender(func: () => void): void;
  120124. private _executeOnceBeforeRender;
  120125. /**
  120126. * The provided function will run before render once and will be disposed afterwards.
  120127. * A timeout delay can be provided so that the function will be executed in N ms.
  120128. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120129. * @param func The function to be executed.
  120130. * @param timeout optional delay in ms
  120131. */
  120132. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120133. /** @hidden */
  120134. _addPendingData(data: any): void;
  120135. /** @hidden */
  120136. _removePendingData(data: any): void;
  120137. /**
  120138. * Returns the number of items waiting to be loaded
  120139. * @returns the number of items waiting to be loaded
  120140. */
  120141. getWaitingItemsCount(): number;
  120142. /**
  120143. * Returns a boolean indicating if the scene is still loading data
  120144. */
  120145. get isLoading(): boolean;
  120146. /**
  120147. * Registers a function to be executed when the scene is ready
  120148. * @param {Function} func - the function to be executed
  120149. */
  120150. executeWhenReady(func: () => void): void;
  120151. /**
  120152. * Returns a promise that resolves when the scene is ready
  120153. * @returns A promise that resolves when the scene is ready
  120154. */
  120155. whenReadyAsync(): Promise<void>;
  120156. /** @hidden */
  120157. _checkIsReady(): void;
  120158. /**
  120159. * Gets all animatable attached to the scene
  120160. */
  120161. get animatables(): Animatable[];
  120162. /**
  120163. * Resets the last animation time frame.
  120164. * Useful to override when animations start running when loading a scene for the first time.
  120165. */
  120166. resetLastAnimationTimeFrame(): void;
  120167. /**
  120168. * Gets the current view matrix
  120169. * @returns a Matrix
  120170. */
  120171. getViewMatrix(): Matrix;
  120172. /**
  120173. * Gets the current projection matrix
  120174. * @returns a Matrix
  120175. */
  120176. getProjectionMatrix(): Matrix;
  120177. /**
  120178. * Gets the current transform matrix
  120179. * @returns a Matrix made of View * Projection
  120180. */
  120181. getTransformMatrix(): Matrix;
  120182. /**
  120183. * Sets the current transform matrix
  120184. * @param viewL defines the View matrix to use
  120185. * @param projectionL defines the Projection matrix to use
  120186. * @param viewR defines the right View matrix to use (if provided)
  120187. * @param projectionR defines the right Projection matrix to use (if provided)
  120188. */
  120189. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120190. /**
  120191. * Gets the uniform buffer used to store scene data
  120192. * @returns a UniformBuffer
  120193. */
  120194. getSceneUniformBuffer(): UniformBuffer;
  120195. /**
  120196. * Gets an unique (relatively to the current scene) Id
  120197. * @returns an unique number for the scene
  120198. */
  120199. getUniqueId(): number;
  120200. /**
  120201. * Add a mesh to the list of scene's meshes
  120202. * @param newMesh defines the mesh to add
  120203. * @param recursive if all child meshes should also be added to the scene
  120204. */
  120205. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120206. /**
  120207. * Remove a mesh for the list of scene's meshes
  120208. * @param toRemove defines the mesh to remove
  120209. * @param recursive if all child meshes should also be removed from the scene
  120210. * @returns the index where the mesh was in the mesh list
  120211. */
  120212. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120213. /**
  120214. * Add a transform node to the list of scene's transform nodes
  120215. * @param newTransformNode defines the transform node to add
  120216. */
  120217. addTransformNode(newTransformNode: TransformNode): void;
  120218. /**
  120219. * Remove a transform node for the list of scene's transform nodes
  120220. * @param toRemove defines the transform node to remove
  120221. * @returns the index where the transform node was in the transform node list
  120222. */
  120223. removeTransformNode(toRemove: TransformNode): number;
  120224. /**
  120225. * Remove a skeleton for the list of scene's skeletons
  120226. * @param toRemove defines the skeleton to remove
  120227. * @returns the index where the skeleton was in the skeleton list
  120228. */
  120229. removeSkeleton(toRemove: Skeleton): number;
  120230. /**
  120231. * Remove a morph target for the list of scene's morph targets
  120232. * @param toRemove defines the morph target to remove
  120233. * @returns the index where the morph target was in the morph target list
  120234. */
  120235. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120236. /**
  120237. * Remove a light for the list of scene's lights
  120238. * @param toRemove defines the light to remove
  120239. * @returns the index where the light was in the light list
  120240. */
  120241. removeLight(toRemove: Light): number;
  120242. /**
  120243. * Remove a camera for the list of scene's cameras
  120244. * @param toRemove defines the camera to remove
  120245. * @returns the index where the camera was in the camera list
  120246. */
  120247. removeCamera(toRemove: Camera): number;
  120248. /**
  120249. * Remove a particle system for the list of scene's particle systems
  120250. * @param toRemove defines the particle system to remove
  120251. * @returns the index where the particle system was in the particle system list
  120252. */
  120253. removeParticleSystem(toRemove: IParticleSystem): number;
  120254. /**
  120255. * Remove a animation for the list of scene's animations
  120256. * @param toRemove defines the animation to remove
  120257. * @returns the index where the animation was in the animation list
  120258. */
  120259. removeAnimation(toRemove: Animation): number;
  120260. /**
  120261. * Will stop the animation of the given target
  120262. * @param target - the target
  120263. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120264. * @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)
  120265. */
  120266. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120267. /**
  120268. * Removes the given animation group from this scene.
  120269. * @param toRemove The animation group to remove
  120270. * @returns The index of the removed animation group
  120271. */
  120272. removeAnimationGroup(toRemove: AnimationGroup): number;
  120273. /**
  120274. * Removes the given multi-material from this scene.
  120275. * @param toRemove The multi-material to remove
  120276. * @returns The index of the removed multi-material
  120277. */
  120278. removeMultiMaterial(toRemove: MultiMaterial): number;
  120279. /**
  120280. * Removes the given material from this scene.
  120281. * @param toRemove The material to remove
  120282. * @returns The index of the removed material
  120283. */
  120284. removeMaterial(toRemove: Material): number;
  120285. /**
  120286. * Removes the given action manager from this scene.
  120287. * @param toRemove The action manager to remove
  120288. * @returns The index of the removed action manager
  120289. */
  120290. removeActionManager(toRemove: AbstractActionManager): number;
  120291. /**
  120292. * Removes the given texture from this scene.
  120293. * @param toRemove The texture to remove
  120294. * @returns The index of the removed texture
  120295. */
  120296. removeTexture(toRemove: BaseTexture): number;
  120297. /**
  120298. * Adds the given light to this scene
  120299. * @param newLight The light to add
  120300. */
  120301. addLight(newLight: Light): void;
  120302. /**
  120303. * Sorts the list list based on light priorities
  120304. */
  120305. sortLightsByPriority(): void;
  120306. /**
  120307. * Adds the given camera to this scene
  120308. * @param newCamera The camera to add
  120309. */
  120310. addCamera(newCamera: Camera): void;
  120311. /**
  120312. * Adds the given skeleton to this scene
  120313. * @param newSkeleton The skeleton to add
  120314. */
  120315. addSkeleton(newSkeleton: Skeleton): void;
  120316. /**
  120317. * Adds the given particle system to this scene
  120318. * @param newParticleSystem The particle system to add
  120319. */
  120320. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120321. /**
  120322. * Adds the given animation to this scene
  120323. * @param newAnimation The animation to add
  120324. */
  120325. addAnimation(newAnimation: Animation): void;
  120326. /**
  120327. * Adds the given animation group to this scene.
  120328. * @param newAnimationGroup The animation group to add
  120329. */
  120330. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120331. /**
  120332. * Adds the given multi-material to this scene
  120333. * @param newMultiMaterial The multi-material to add
  120334. */
  120335. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120336. /**
  120337. * Adds the given material to this scene
  120338. * @param newMaterial The material to add
  120339. */
  120340. addMaterial(newMaterial: Material): void;
  120341. /**
  120342. * Adds the given morph target to this scene
  120343. * @param newMorphTargetManager The morph target to add
  120344. */
  120345. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120346. /**
  120347. * Adds the given geometry to this scene
  120348. * @param newGeometry The geometry to add
  120349. */
  120350. addGeometry(newGeometry: Geometry): void;
  120351. /**
  120352. * Adds the given action manager to this scene
  120353. * @param newActionManager The action manager to add
  120354. */
  120355. addActionManager(newActionManager: AbstractActionManager): void;
  120356. /**
  120357. * Adds the given texture to this scene.
  120358. * @param newTexture The texture to add
  120359. */
  120360. addTexture(newTexture: BaseTexture): void;
  120361. /**
  120362. * Switch active camera
  120363. * @param newCamera defines the new active camera
  120364. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120365. */
  120366. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120367. /**
  120368. * sets the active camera of the scene using its ID
  120369. * @param id defines the camera's ID
  120370. * @return the new active camera or null if none found.
  120371. */
  120372. setActiveCameraByID(id: string): Nullable<Camera>;
  120373. /**
  120374. * sets the active camera of the scene using its name
  120375. * @param name defines the camera's name
  120376. * @returns the new active camera or null if none found.
  120377. */
  120378. setActiveCameraByName(name: string): Nullable<Camera>;
  120379. /**
  120380. * get an animation group using its name
  120381. * @param name defines the material's name
  120382. * @return the animation group or null if none found.
  120383. */
  120384. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120385. /**
  120386. * Get a material using its unique id
  120387. * @param uniqueId defines the material's unique id
  120388. * @return the material or null if none found.
  120389. */
  120390. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120391. /**
  120392. * get a material using its id
  120393. * @param id defines the material's ID
  120394. * @return the material or null if none found.
  120395. */
  120396. getMaterialByID(id: string): Nullable<Material>;
  120397. /**
  120398. * Gets a the last added material using a given id
  120399. * @param id defines the material's ID
  120400. * @return the last material with the given id or null if none found.
  120401. */
  120402. getLastMaterialByID(id: string): Nullable<Material>;
  120403. /**
  120404. * Gets a material using its name
  120405. * @param name defines the material's name
  120406. * @return the material or null if none found.
  120407. */
  120408. getMaterialByName(name: string): Nullable<Material>;
  120409. /**
  120410. * Get a texture using its unique id
  120411. * @param uniqueId defines the texture's unique id
  120412. * @return the texture or null if none found.
  120413. */
  120414. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120415. /**
  120416. * Gets a camera using its id
  120417. * @param id defines the id to look for
  120418. * @returns the camera or null if not found
  120419. */
  120420. getCameraByID(id: string): Nullable<Camera>;
  120421. /**
  120422. * Gets a camera using its unique id
  120423. * @param uniqueId defines the unique id to look for
  120424. * @returns the camera or null if not found
  120425. */
  120426. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120427. /**
  120428. * Gets a camera using its name
  120429. * @param name defines the camera's name
  120430. * @return the camera or null if none found.
  120431. */
  120432. getCameraByName(name: string): Nullable<Camera>;
  120433. /**
  120434. * Gets a bone using its id
  120435. * @param id defines the bone's id
  120436. * @return the bone or null if not found
  120437. */
  120438. getBoneByID(id: string): Nullable<Bone>;
  120439. /**
  120440. * Gets a bone using its id
  120441. * @param name defines the bone's name
  120442. * @return the bone or null if not found
  120443. */
  120444. getBoneByName(name: string): Nullable<Bone>;
  120445. /**
  120446. * Gets a light node using its name
  120447. * @param name defines the the light's name
  120448. * @return the light or null if none found.
  120449. */
  120450. getLightByName(name: string): Nullable<Light>;
  120451. /**
  120452. * Gets a light node using its id
  120453. * @param id defines the light's id
  120454. * @return the light or null if none found.
  120455. */
  120456. getLightByID(id: string): Nullable<Light>;
  120457. /**
  120458. * Gets a light node using its scene-generated unique ID
  120459. * @param uniqueId defines the light's unique id
  120460. * @return the light or null if none found.
  120461. */
  120462. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120463. /**
  120464. * Gets a particle system by id
  120465. * @param id defines the particle system id
  120466. * @return the corresponding system or null if none found
  120467. */
  120468. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120469. /**
  120470. * Gets a geometry using its ID
  120471. * @param id defines the geometry's id
  120472. * @return the geometry or null if none found.
  120473. */
  120474. getGeometryByID(id: string): Nullable<Geometry>;
  120475. private _getGeometryByUniqueID;
  120476. /**
  120477. * Add a new geometry to this scene
  120478. * @param geometry defines the geometry to be added to the scene.
  120479. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120480. * @return a boolean defining if the geometry was added or not
  120481. */
  120482. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120483. /**
  120484. * Removes an existing geometry
  120485. * @param geometry defines the geometry to be removed from the scene
  120486. * @return a boolean defining if the geometry was removed or not
  120487. */
  120488. removeGeometry(geometry: Geometry): boolean;
  120489. /**
  120490. * Gets the list of geometries attached to the scene
  120491. * @returns an array of Geometry
  120492. */
  120493. getGeometries(): Geometry[];
  120494. /**
  120495. * Gets the first added mesh found of a given ID
  120496. * @param id defines the id to search for
  120497. * @return the mesh found or null if not found at all
  120498. */
  120499. getMeshByID(id: string): Nullable<AbstractMesh>;
  120500. /**
  120501. * Gets a list of meshes using their id
  120502. * @param id defines the id to search for
  120503. * @returns a list of meshes
  120504. */
  120505. getMeshesByID(id: string): Array<AbstractMesh>;
  120506. /**
  120507. * Gets the first added transform node found of a given ID
  120508. * @param id defines the id to search for
  120509. * @return the found transform node or null if not found at all.
  120510. */
  120511. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120512. /**
  120513. * Gets a transform node with its auto-generated unique id
  120514. * @param uniqueId efines the unique id to search for
  120515. * @return the found transform node or null if not found at all.
  120516. */
  120517. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120518. /**
  120519. * Gets a list of transform nodes using their id
  120520. * @param id defines the id to search for
  120521. * @returns a list of transform nodes
  120522. */
  120523. getTransformNodesByID(id: string): Array<TransformNode>;
  120524. /**
  120525. * Gets a mesh with its auto-generated unique id
  120526. * @param uniqueId defines the unique id to search for
  120527. * @return the found mesh or null if not found at all.
  120528. */
  120529. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120530. /**
  120531. * Gets a the last added mesh using a given id
  120532. * @param id defines the id to search for
  120533. * @return the found mesh or null if not found at all.
  120534. */
  120535. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120536. /**
  120537. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120538. * @param id defines the id to search for
  120539. * @return the found node or null if not found at all
  120540. */
  120541. getLastEntryByID(id: string): Nullable<Node>;
  120542. /**
  120543. * Gets a node (Mesh, Camera, Light) using a given id
  120544. * @param id defines the id to search for
  120545. * @return the found node or null if not found at all
  120546. */
  120547. getNodeByID(id: string): Nullable<Node>;
  120548. /**
  120549. * Gets a node (Mesh, Camera, Light) using a given name
  120550. * @param name defines the name to search for
  120551. * @return the found node or null if not found at all.
  120552. */
  120553. getNodeByName(name: string): Nullable<Node>;
  120554. /**
  120555. * Gets a mesh using a given name
  120556. * @param name defines the name to search for
  120557. * @return the found mesh or null if not found at all.
  120558. */
  120559. getMeshByName(name: string): Nullable<AbstractMesh>;
  120560. /**
  120561. * Gets a transform node using a given name
  120562. * @param name defines the name to search for
  120563. * @return the found transform node or null if not found at all.
  120564. */
  120565. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120566. /**
  120567. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120568. * @param id defines the id to search for
  120569. * @return the found skeleton or null if not found at all.
  120570. */
  120571. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120572. /**
  120573. * Gets a skeleton using a given auto generated unique id
  120574. * @param uniqueId defines the unique id to search for
  120575. * @return the found skeleton or null if not found at all.
  120576. */
  120577. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120578. /**
  120579. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120580. * @param id defines the id to search for
  120581. * @return the found skeleton or null if not found at all.
  120582. */
  120583. getSkeletonById(id: string): Nullable<Skeleton>;
  120584. /**
  120585. * Gets a skeleton using a given name
  120586. * @param name defines the name to search for
  120587. * @return the found skeleton or null if not found at all.
  120588. */
  120589. getSkeletonByName(name: string): Nullable<Skeleton>;
  120590. /**
  120591. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120592. * @param id defines the id to search for
  120593. * @return the found morph target manager or null if not found at all.
  120594. */
  120595. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120596. /**
  120597. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120598. * @param id defines the id to search for
  120599. * @return the found morph target or null if not found at all.
  120600. */
  120601. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120602. /**
  120603. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120604. * @param name defines the name to search for
  120605. * @return the found morph target or null if not found at all.
  120606. */
  120607. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120608. /**
  120609. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120610. * @param name defines the name to search for
  120611. * @return the found post process or null if not found at all.
  120612. */
  120613. getPostProcessByName(name: string): Nullable<PostProcess>;
  120614. /**
  120615. * Gets a boolean indicating if the given mesh is active
  120616. * @param mesh defines the mesh to look for
  120617. * @returns true if the mesh is in the active list
  120618. */
  120619. isActiveMesh(mesh: AbstractMesh): boolean;
  120620. /**
  120621. * Return a unique id as a string which can serve as an identifier for the scene
  120622. */
  120623. get uid(): string;
  120624. /**
  120625. * Add an externaly attached data from its key.
  120626. * This method call will fail and return false, if such key already exists.
  120627. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120628. * @param key the unique key that identifies the data
  120629. * @param data the data object to associate to the key for this Engine instance
  120630. * @return true if no such key were already present and the data was added successfully, false otherwise
  120631. */
  120632. addExternalData<T>(key: string, data: T): boolean;
  120633. /**
  120634. * Get an externaly attached data from its key
  120635. * @param key the unique key that identifies the data
  120636. * @return the associated data, if present (can be null), or undefined if not present
  120637. */
  120638. getExternalData<T>(key: string): Nullable<T>;
  120639. /**
  120640. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120641. * @param key the unique key that identifies the data
  120642. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120643. * @return the associated data, can be null if the factory returned null.
  120644. */
  120645. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120646. /**
  120647. * Remove an externaly attached data from the Engine instance
  120648. * @param key the unique key that identifies the data
  120649. * @return true if the data was successfully removed, false if it doesn't exist
  120650. */
  120651. removeExternalData(key: string): boolean;
  120652. private _evaluateSubMesh;
  120653. /**
  120654. * Clear the processed materials smart array preventing retention point in material dispose.
  120655. */
  120656. freeProcessedMaterials(): void;
  120657. private _preventFreeActiveMeshesAndRenderingGroups;
  120658. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120659. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120660. * when disposing several meshes in a row or a hierarchy of meshes.
  120661. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120662. */
  120663. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120664. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120665. /**
  120666. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120667. */
  120668. freeActiveMeshes(): void;
  120669. /**
  120670. * Clear the info related to rendering groups preventing retention points during dispose.
  120671. */
  120672. freeRenderingGroups(): void;
  120673. /** @hidden */
  120674. _isInIntermediateRendering(): boolean;
  120675. /**
  120676. * Lambda returning the list of potentially active meshes.
  120677. */
  120678. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120679. /**
  120680. * Lambda returning the list of potentially active sub meshes.
  120681. */
  120682. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120683. /**
  120684. * Lambda returning the list of potentially intersecting sub meshes.
  120685. */
  120686. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120687. /**
  120688. * Lambda returning the list of potentially colliding sub meshes.
  120689. */
  120690. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120691. private _activeMeshesFrozen;
  120692. private _skipEvaluateActiveMeshesCompletely;
  120693. /**
  120694. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120695. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120696. * @returns the current scene
  120697. */
  120698. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120699. /**
  120700. * Use this function to restart evaluating active meshes on every frame
  120701. * @returns the current scene
  120702. */
  120703. unfreezeActiveMeshes(): Scene;
  120704. private _evaluateActiveMeshes;
  120705. private _activeMesh;
  120706. /**
  120707. * Update the transform matrix to update from the current active camera
  120708. * @param force defines a boolean used to force the update even if cache is up to date
  120709. */
  120710. updateTransformMatrix(force?: boolean): void;
  120711. private _bindFrameBuffer;
  120712. /** @hidden */
  120713. _allowPostProcessClearColor: boolean;
  120714. /** @hidden */
  120715. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120716. private _processSubCameras;
  120717. private _checkIntersections;
  120718. /** @hidden */
  120719. _advancePhysicsEngineStep(step: number): void;
  120720. /**
  120721. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120722. */
  120723. getDeterministicFrameTime: () => number;
  120724. /** @hidden */
  120725. _animate(): void;
  120726. /** Execute all animations (for a frame) */
  120727. animate(): void;
  120728. /**
  120729. * Render the scene
  120730. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120731. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120732. */
  120733. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120734. /**
  120735. * Freeze all materials
  120736. * A frozen material will not be updatable but should be faster to render
  120737. */
  120738. freezeMaterials(): void;
  120739. /**
  120740. * Unfreeze all materials
  120741. * A frozen material will not be updatable but should be faster to render
  120742. */
  120743. unfreezeMaterials(): void;
  120744. /**
  120745. * Releases all held ressources
  120746. */
  120747. dispose(): void;
  120748. /**
  120749. * Gets if the scene is already disposed
  120750. */
  120751. get isDisposed(): boolean;
  120752. /**
  120753. * Call this function to reduce memory footprint of the scene.
  120754. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120755. */
  120756. clearCachedVertexData(): void;
  120757. /**
  120758. * This function will remove the local cached buffer data from texture.
  120759. * It will save memory but will prevent the texture from being rebuilt
  120760. */
  120761. cleanCachedTextureBuffer(): void;
  120762. /**
  120763. * Get the world extend vectors with an optional filter
  120764. *
  120765. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120766. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120767. */
  120768. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120769. min: Vector3;
  120770. max: Vector3;
  120771. };
  120772. /**
  120773. * Creates a ray that can be used to pick in the scene
  120774. * @param x defines the x coordinate of the origin (on-screen)
  120775. * @param y defines the y coordinate of the origin (on-screen)
  120776. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120777. * @param camera defines the camera to use for the picking
  120778. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120779. * @returns a Ray
  120780. */
  120781. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120782. /**
  120783. * Creates a ray that can be used to pick in the scene
  120784. * @param x defines the x coordinate of the origin (on-screen)
  120785. * @param y defines the y coordinate of the origin (on-screen)
  120786. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120787. * @param result defines the ray where to store the picking ray
  120788. * @param camera defines the camera to use for the picking
  120789. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120790. * @returns the current scene
  120791. */
  120792. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120793. /**
  120794. * Creates a ray that can be used to pick in the scene
  120795. * @param x defines the x coordinate of the origin (on-screen)
  120796. * @param y defines the y coordinate of the origin (on-screen)
  120797. * @param camera defines the camera to use for the picking
  120798. * @returns a Ray
  120799. */
  120800. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120801. /**
  120802. * Creates a ray that can be used to pick in the scene
  120803. * @param x defines the x coordinate of the origin (on-screen)
  120804. * @param y defines the y coordinate of the origin (on-screen)
  120805. * @param result defines the ray where to store the picking ray
  120806. * @param camera defines the camera to use for the picking
  120807. * @returns the current scene
  120808. */
  120809. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120810. /** Launch a ray to try to pick a mesh in the scene
  120811. * @param x position on screen
  120812. * @param y position on screen
  120813. * @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
  120814. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120815. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120816. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120817. * @returns a PickingInfo
  120818. */
  120819. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120820. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120821. * @param x position on screen
  120822. * @param y position on screen
  120823. * @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
  120824. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120825. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120826. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  120827. */
  120828. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120829. /** Use the given ray to pick a mesh in the scene
  120830. * @param ray The ray to use to pick meshes
  120831. * @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
  120832. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120833. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120834. * @returns a PickingInfo
  120835. */
  120836. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120837. /**
  120838. * Launch a ray to try to pick a mesh in the scene
  120839. * @param x X position on screen
  120840. * @param y Y position on screen
  120841. * @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
  120842. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120843. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120844. * @returns an array of PickingInfo
  120845. */
  120846. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120847. /**
  120848. * Launch a ray to try to pick a mesh in the scene
  120849. * @param ray Ray to use
  120850. * @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
  120851. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120852. * @returns an array of PickingInfo
  120853. */
  120854. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120855. /**
  120856. * Force the value of meshUnderPointer
  120857. * @param mesh defines the mesh to use
  120858. * @param pointerId optional pointer id when using more than one pointer
  120859. */
  120860. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  120861. /**
  120862. * Gets the mesh under the pointer
  120863. * @returns a Mesh or null if no mesh is under the pointer
  120864. */
  120865. getPointerOverMesh(): Nullable<AbstractMesh>;
  120866. /** @hidden */
  120867. _rebuildGeometries(): void;
  120868. /** @hidden */
  120869. _rebuildTextures(): void;
  120870. private _getByTags;
  120871. /**
  120872. * Get a list of meshes by tags
  120873. * @param tagsQuery defines the tags query to use
  120874. * @param forEach defines a predicate used to filter results
  120875. * @returns an array of Mesh
  120876. */
  120877. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120878. /**
  120879. * Get a list of cameras by tags
  120880. * @param tagsQuery defines the tags query to use
  120881. * @param forEach defines a predicate used to filter results
  120882. * @returns an array of Camera
  120883. */
  120884. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120885. /**
  120886. * Get a list of lights by tags
  120887. * @param tagsQuery defines the tags query to use
  120888. * @param forEach defines a predicate used to filter results
  120889. * @returns an array of Light
  120890. */
  120891. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120892. /**
  120893. * Get a list of materials by tags
  120894. * @param tagsQuery defines the tags query to use
  120895. * @param forEach defines a predicate used to filter results
  120896. * @returns an array of Material
  120897. */
  120898. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120899. /**
  120900. * Get a list of transform nodes by tags
  120901. * @param tagsQuery defines the tags query to use
  120902. * @param forEach defines a predicate used to filter results
  120903. * @returns an array of TransformNode
  120904. */
  120905. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120906. /**
  120907. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120908. * This allowed control for front to back rendering or reversly depending of the special needs.
  120909. *
  120910. * @param renderingGroupId The rendering group id corresponding to its index
  120911. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120912. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120913. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120914. */
  120915. 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;
  120916. /**
  120917. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120918. *
  120919. * @param renderingGroupId The rendering group id corresponding to its index
  120920. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120921. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120922. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120923. */
  120924. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120925. /**
  120926. * Gets the current auto clear configuration for one rendering group of the rendering
  120927. * manager.
  120928. * @param index the rendering group index to get the information for
  120929. * @returns The auto clear setup for the requested rendering group
  120930. */
  120931. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120932. private _blockMaterialDirtyMechanism;
  120933. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120934. get blockMaterialDirtyMechanism(): boolean;
  120935. set blockMaterialDirtyMechanism(value: boolean);
  120936. /**
  120937. * Will flag all materials as dirty to trigger new shader compilation
  120938. * @param flag defines the flag used to specify which material part must be marked as dirty
  120939. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120940. */
  120941. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120942. /** @hidden */
  120943. _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;
  120944. /** @hidden */
  120945. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120946. /** @hidden */
  120947. _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;
  120948. /** @hidden */
  120949. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120950. /** @hidden */
  120951. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120952. /** @hidden */
  120953. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120954. }
  120955. }
  120956. declare module BABYLON {
  120957. /**
  120958. * Set of assets to keep when moving a scene into an asset container.
  120959. */
  120960. export class KeepAssets extends AbstractScene {
  120961. }
  120962. /**
  120963. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120964. */
  120965. export class InstantiatedEntries {
  120966. /**
  120967. * List of new root nodes (eg. nodes with no parent)
  120968. */
  120969. rootNodes: TransformNode[];
  120970. /**
  120971. * List of new skeletons
  120972. */
  120973. skeletons: Skeleton[];
  120974. /**
  120975. * List of new animation groups
  120976. */
  120977. animationGroups: AnimationGroup[];
  120978. }
  120979. /**
  120980. * Container with a set of assets that can be added or removed from a scene.
  120981. */
  120982. export class AssetContainer extends AbstractScene {
  120983. private _wasAddedToScene;
  120984. /**
  120985. * The scene the AssetContainer belongs to.
  120986. */
  120987. scene: Scene;
  120988. /**
  120989. * Instantiates an AssetContainer.
  120990. * @param scene The scene the AssetContainer belongs to.
  120991. */
  120992. constructor(scene: Scene);
  120993. /**
  120994. * Instantiate or clone all meshes and add the new ones to the scene.
  120995. * Skeletons and animation groups will all be cloned
  120996. * @param nameFunction defines an optional function used to get new names for clones
  120997. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120998. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120999. */
  121000. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  121001. /**
  121002. * Adds all the assets from the container to the scene.
  121003. */
  121004. addAllToScene(): void;
  121005. /**
  121006. * Removes all the assets in the container from the scene
  121007. */
  121008. removeAllFromScene(): void;
  121009. /**
  121010. * Disposes all the assets in the container
  121011. */
  121012. dispose(): void;
  121013. private _moveAssets;
  121014. /**
  121015. * Removes all the assets contained in the scene and adds them to the container.
  121016. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  121017. */
  121018. moveAllFromScene(keepAssets?: KeepAssets): void;
  121019. /**
  121020. * 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.
  121021. * @returns the root mesh
  121022. */
  121023. createRootMesh(): Mesh;
  121024. /**
  121025. * Merge animations (direct and animation groups) from this asset container into a scene
  121026. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  121027. * @param animatables set of animatables to retarget to a node from the scene
  121028. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  121029. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  121030. */
  121031. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  121032. }
  121033. }
  121034. declare module BABYLON {
  121035. /**
  121036. * Defines how the parser contract is defined.
  121037. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  121038. */
  121039. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  121040. /**
  121041. * Defines how the individual parser contract is defined.
  121042. * These parser can parse an individual asset
  121043. */
  121044. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  121045. /**
  121046. * Base class of the scene acting as a container for the different elements composing a scene.
  121047. * This class is dynamically extended by the different components of the scene increasing
  121048. * flexibility and reducing coupling
  121049. */
  121050. export abstract class AbstractScene {
  121051. /**
  121052. * Stores the list of available parsers in the application.
  121053. */
  121054. private static _BabylonFileParsers;
  121055. /**
  121056. * Stores the list of available individual parsers in the application.
  121057. */
  121058. private static _IndividualBabylonFileParsers;
  121059. /**
  121060. * Adds a parser in the list of available ones
  121061. * @param name Defines the name of the parser
  121062. * @param parser Defines the parser to add
  121063. */
  121064. static AddParser(name: string, parser: BabylonFileParser): void;
  121065. /**
  121066. * Gets a general parser from the list of avaialble ones
  121067. * @param name Defines the name of the parser
  121068. * @returns the requested parser or null
  121069. */
  121070. static GetParser(name: string): Nullable<BabylonFileParser>;
  121071. /**
  121072. * Adds n individual parser in the list of available ones
  121073. * @param name Defines the name of the parser
  121074. * @param parser Defines the parser to add
  121075. */
  121076. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  121077. /**
  121078. * Gets an individual parser from the list of avaialble ones
  121079. * @param name Defines the name of the parser
  121080. * @returns the requested parser or null
  121081. */
  121082. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  121083. /**
  121084. * Parser json data and populate both a scene and its associated container object
  121085. * @param jsonData Defines the data to parse
  121086. * @param scene Defines the scene to parse the data for
  121087. * @param container Defines the container attached to the parsing sequence
  121088. * @param rootUrl Defines the root url of the data
  121089. */
  121090. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121091. /**
  121092. * Gets the list of root nodes (ie. nodes with no parent)
  121093. */
  121094. rootNodes: Node[];
  121095. /** All of the cameras added to this scene
  121096. * @see https://doc.babylonjs.com/babylon101/cameras
  121097. */
  121098. cameras: Camera[];
  121099. /**
  121100. * All of the lights added to this scene
  121101. * @see https://doc.babylonjs.com/babylon101/lights
  121102. */
  121103. lights: Light[];
  121104. /**
  121105. * All of the (abstract) meshes added to this scene
  121106. */
  121107. meshes: AbstractMesh[];
  121108. /**
  121109. * The list of skeletons added to the scene
  121110. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121111. */
  121112. skeletons: Skeleton[];
  121113. /**
  121114. * All of the particle systems added to this scene
  121115. * @see https://doc.babylonjs.com/babylon101/particles
  121116. */
  121117. particleSystems: IParticleSystem[];
  121118. /**
  121119. * Gets a list of Animations associated with the scene
  121120. */
  121121. animations: Animation[];
  121122. /**
  121123. * All of the animation groups added to this scene
  121124. * @see https://doc.babylonjs.com/how_to/group
  121125. */
  121126. animationGroups: AnimationGroup[];
  121127. /**
  121128. * All of the multi-materials added to this scene
  121129. * @see https://doc.babylonjs.com/how_to/multi_materials
  121130. */
  121131. multiMaterials: MultiMaterial[];
  121132. /**
  121133. * All of the materials added to this scene
  121134. * In the context of a Scene, it is not supposed to be modified manually.
  121135. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121136. * Note also that the order of the Material within the array is not significant and might change.
  121137. * @see https://doc.babylonjs.com/babylon101/materials
  121138. */
  121139. materials: Material[];
  121140. /**
  121141. * The list of morph target managers added to the scene
  121142. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121143. */
  121144. morphTargetManagers: MorphTargetManager[];
  121145. /**
  121146. * The list of geometries used in the scene.
  121147. */
  121148. geometries: Geometry[];
  121149. /**
  121150. * All of the tranform nodes added to this scene
  121151. * In the context of a Scene, it is not supposed to be modified manually.
  121152. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121153. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121154. * @see https://doc.babylonjs.com/how_to/transformnode
  121155. */
  121156. transformNodes: TransformNode[];
  121157. /**
  121158. * ActionManagers available on the scene.
  121159. */
  121160. actionManagers: AbstractActionManager[];
  121161. /**
  121162. * Textures to keep.
  121163. */
  121164. textures: BaseTexture[];
  121165. /** @hidden */
  121166. protected _environmentTexture: Nullable<BaseTexture>;
  121167. /**
  121168. * Texture used in all pbr material as the reflection texture.
  121169. * As in the majority of the scene they are the same (exception for multi room and so on),
  121170. * this is easier to reference from here than from all the materials.
  121171. */
  121172. get environmentTexture(): Nullable<BaseTexture>;
  121173. set environmentTexture(value: Nullable<BaseTexture>);
  121174. /**
  121175. * The list of postprocesses added to the scene
  121176. */
  121177. postProcesses: PostProcess[];
  121178. /**
  121179. * @returns all meshes, lights, cameras, transformNodes and bones
  121180. */
  121181. getNodes(): Array<Node>;
  121182. }
  121183. }
  121184. declare module BABYLON {
  121185. /**
  121186. * Interface used to define options for Sound class
  121187. */
  121188. export interface ISoundOptions {
  121189. /**
  121190. * Does the sound autoplay once loaded.
  121191. */
  121192. autoplay?: boolean;
  121193. /**
  121194. * Does the sound loop after it finishes playing once.
  121195. */
  121196. loop?: boolean;
  121197. /**
  121198. * Sound's volume
  121199. */
  121200. volume?: number;
  121201. /**
  121202. * Is it a spatial sound?
  121203. */
  121204. spatialSound?: boolean;
  121205. /**
  121206. * Maximum distance to hear that sound
  121207. */
  121208. maxDistance?: number;
  121209. /**
  121210. * Uses user defined attenuation function
  121211. */
  121212. useCustomAttenuation?: boolean;
  121213. /**
  121214. * Define the roll off factor of spatial sounds.
  121215. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121216. */
  121217. rolloffFactor?: number;
  121218. /**
  121219. * Define the reference distance the sound should be heard perfectly.
  121220. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121221. */
  121222. refDistance?: number;
  121223. /**
  121224. * Define the distance attenuation model the sound will follow.
  121225. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121226. */
  121227. distanceModel?: string;
  121228. /**
  121229. * Defines the playback speed (1 by default)
  121230. */
  121231. playbackRate?: number;
  121232. /**
  121233. * Defines if the sound is from a streaming source
  121234. */
  121235. streaming?: boolean;
  121236. /**
  121237. * Defines an optional length (in seconds) inside the sound file
  121238. */
  121239. length?: number;
  121240. /**
  121241. * Defines an optional offset (in seconds) inside the sound file
  121242. */
  121243. offset?: number;
  121244. /**
  121245. * If true, URLs will not be required to state the audio file codec to use.
  121246. */
  121247. skipCodecCheck?: boolean;
  121248. }
  121249. /**
  121250. * Defines a sound that can be played in the application.
  121251. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121252. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121253. */
  121254. export class Sound {
  121255. /**
  121256. * The name of the sound in the scene.
  121257. */
  121258. name: string;
  121259. /**
  121260. * Does the sound autoplay once loaded.
  121261. */
  121262. autoplay: boolean;
  121263. /**
  121264. * Does the sound loop after it finishes playing once.
  121265. */
  121266. loop: boolean;
  121267. /**
  121268. * Does the sound use a custom attenuation curve to simulate the falloff
  121269. * happening when the source gets further away from the camera.
  121270. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121271. */
  121272. useCustomAttenuation: boolean;
  121273. /**
  121274. * The sound track id this sound belongs to.
  121275. */
  121276. soundTrackId: number;
  121277. /**
  121278. * Is this sound currently played.
  121279. */
  121280. isPlaying: boolean;
  121281. /**
  121282. * Is this sound currently paused.
  121283. */
  121284. isPaused: boolean;
  121285. /**
  121286. * Does this sound enables spatial sound.
  121287. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121288. */
  121289. spatialSound: boolean;
  121290. /**
  121291. * Define the reference distance the sound should be heard perfectly.
  121292. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121293. */
  121294. refDistance: number;
  121295. /**
  121296. * Define the roll off factor of spatial sounds.
  121297. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121298. */
  121299. rolloffFactor: number;
  121300. /**
  121301. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121302. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121303. */
  121304. maxDistance: number;
  121305. /**
  121306. * Define the distance attenuation model the sound will follow.
  121307. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121308. */
  121309. distanceModel: string;
  121310. /**
  121311. * @hidden
  121312. * Back Compat
  121313. **/
  121314. onended: () => any;
  121315. /**
  121316. * Gets or sets an object used to store user defined information for the sound.
  121317. */
  121318. metadata: any;
  121319. /**
  121320. * Observable event when the current playing sound finishes.
  121321. */
  121322. onEndedObservable: Observable<Sound>;
  121323. private _panningModel;
  121324. private _playbackRate;
  121325. private _streaming;
  121326. private _startTime;
  121327. private _startOffset;
  121328. private _position;
  121329. /** @hidden */
  121330. _positionInEmitterSpace: boolean;
  121331. private _localDirection;
  121332. private _volume;
  121333. private _isReadyToPlay;
  121334. private _isDirectional;
  121335. private _readyToPlayCallback;
  121336. private _audioBuffer;
  121337. private _soundSource;
  121338. private _streamingSource;
  121339. private _soundPanner;
  121340. private _soundGain;
  121341. private _inputAudioNode;
  121342. private _outputAudioNode;
  121343. private _coneInnerAngle;
  121344. private _coneOuterAngle;
  121345. private _coneOuterGain;
  121346. private _scene;
  121347. private _connectedTransformNode;
  121348. private _customAttenuationFunction;
  121349. private _registerFunc;
  121350. private _isOutputConnected;
  121351. private _htmlAudioElement;
  121352. private _urlType;
  121353. private _length?;
  121354. private _offset?;
  121355. /** @hidden */
  121356. static _SceneComponentInitialization: (scene: Scene) => void;
  121357. /**
  121358. * Create a sound and attach it to a scene
  121359. * @param name Name of your sound
  121360. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121361. * @param scene defines the scene the sound belongs to
  121362. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121363. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121364. */
  121365. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121366. /**
  121367. * Release the sound and its associated resources
  121368. */
  121369. dispose(): void;
  121370. /**
  121371. * Gets if the sounds is ready to be played or not.
  121372. * @returns true if ready, otherwise false
  121373. */
  121374. isReady(): boolean;
  121375. private _soundLoaded;
  121376. /**
  121377. * Sets the data of the sound from an audiobuffer
  121378. * @param audioBuffer The audioBuffer containing the data
  121379. */
  121380. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121381. /**
  121382. * Updates the current sounds options such as maxdistance, loop...
  121383. * @param options A JSON object containing values named as the object properties
  121384. */
  121385. updateOptions(options: ISoundOptions): void;
  121386. private _createSpatialParameters;
  121387. private _updateSpatialParameters;
  121388. /**
  121389. * Switch the panning model to HRTF:
  121390. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121391. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121392. */
  121393. switchPanningModelToHRTF(): void;
  121394. /**
  121395. * Switch the panning model to Equal Power:
  121396. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121397. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121398. */
  121399. switchPanningModelToEqualPower(): void;
  121400. private _switchPanningModel;
  121401. /**
  121402. * Connect this sound to a sound track audio node like gain...
  121403. * @param soundTrackAudioNode the sound track audio node to connect to
  121404. */
  121405. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121406. /**
  121407. * Transform this sound into a directional source
  121408. * @param coneInnerAngle Size of the inner cone in degree
  121409. * @param coneOuterAngle Size of the outer cone in degree
  121410. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121411. */
  121412. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121413. /**
  121414. * Gets or sets the inner angle for the directional cone.
  121415. */
  121416. get directionalConeInnerAngle(): number;
  121417. /**
  121418. * Gets or sets the inner angle for the directional cone.
  121419. */
  121420. set directionalConeInnerAngle(value: number);
  121421. /**
  121422. * Gets or sets the outer angle for the directional cone.
  121423. */
  121424. get directionalConeOuterAngle(): number;
  121425. /**
  121426. * Gets or sets the outer angle for the directional cone.
  121427. */
  121428. set directionalConeOuterAngle(value: number);
  121429. /**
  121430. * Sets the position of the emitter if spatial sound is enabled
  121431. * @param newPosition Defines the new posisiton
  121432. */
  121433. setPosition(newPosition: Vector3): void;
  121434. /**
  121435. * Sets the local direction of the emitter if spatial sound is enabled
  121436. * @param newLocalDirection Defines the new local direction
  121437. */
  121438. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121439. private _updateDirection;
  121440. /** @hidden */
  121441. updateDistanceFromListener(): void;
  121442. /**
  121443. * Sets a new custom attenuation function for the sound.
  121444. * @param callback Defines the function used for the attenuation
  121445. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121446. */
  121447. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121448. /**
  121449. * Play the sound
  121450. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121451. * @param offset (optional) Start the sound at a specific time in seconds
  121452. * @param length (optional) Sound duration (in seconds)
  121453. */
  121454. play(time?: number, offset?: number, length?: number): void;
  121455. private _onended;
  121456. /**
  121457. * Stop the sound
  121458. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121459. */
  121460. stop(time?: number): void;
  121461. /**
  121462. * Put the sound in pause
  121463. */
  121464. pause(): void;
  121465. /**
  121466. * Sets a dedicated volume for this sounds
  121467. * @param newVolume Define the new volume of the sound
  121468. * @param time Define time for gradual change to new volume
  121469. */
  121470. setVolume(newVolume: number, time?: number): void;
  121471. /**
  121472. * Set the sound play back rate
  121473. * @param newPlaybackRate Define the playback rate the sound should be played at
  121474. */
  121475. setPlaybackRate(newPlaybackRate: number): void;
  121476. /**
  121477. * Gets the volume of the sound.
  121478. * @returns the volume of the sound
  121479. */
  121480. getVolume(): number;
  121481. /**
  121482. * Attach the sound to a dedicated mesh
  121483. * @param transformNode The transform node to connect the sound with
  121484. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121485. */
  121486. attachToMesh(transformNode: TransformNode): void;
  121487. /**
  121488. * Detach the sound from the previously attached mesh
  121489. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121490. */
  121491. detachFromMesh(): void;
  121492. private _onRegisterAfterWorldMatrixUpdate;
  121493. /**
  121494. * Clone the current sound in the scene.
  121495. * @returns the new sound clone
  121496. */
  121497. clone(): Nullable<Sound>;
  121498. /**
  121499. * Gets the current underlying audio buffer containing the data
  121500. * @returns the audio buffer
  121501. */
  121502. getAudioBuffer(): Nullable<AudioBuffer>;
  121503. /**
  121504. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121505. * @returns the source node
  121506. */
  121507. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121508. /**
  121509. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121510. * @returns the gain node
  121511. */
  121512. getSoundGain(): Nullable<GainNode>;
  121513. /**
  121514. * Serializes the Sound in a JSON representation
  121515. * @returns the JSON representation of the sound
  121516. */
  121517. serialize(): any;
  121518. /**
  121519. * Parse a JSON representation of a sound to innstantiate in a given scene
  121520. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121521. * @param scene Define the scene the new parsed sound should be created in
  121522. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121523. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121524. * @returns the newly parsed sound
  121525. */
  121526. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121527. }
  121528. }
  121529. declare module BABYLON {
  121530. /**
  121531. * This defines an action helpful to play a defined sound on a triggered action.
  121532. */
  121533. export class PlaySoundAction extends Action {
  121534. private _sound;
  121535. /**
  121536. * Instantiate the action
  121537. * @param triggerOptions defines the trigger options
  121538. * @param sound defines the sound to play
  121539. * @param condition defines the trigger related conditions
  121540. */
  121541. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121542. /** @hidden */
  121543. _prepare(): void;
  121544. /**
  121545. * Execute the action and play the sound.
  121546. */
  121547. execute(): void;
  121548. /**
  121549. * Serializes the actions and its related information.
  121550. * @param parent defines the object to serialize in
  121551. * @returns the serialized object
  121552. */
  121553. serialize(parent: any): any;
  121554. }
  121555. /**
  121556. * This defines an action helpful to stop a defined sound on a triggered action.
  121557. */
  121558. export class StopSoundAction extends Action {
  121559. private _sound;
  121560. /**
  121561. * Instantiate the action
  121562. * @param triggerOptions defines the trigger options
  121563. * @param sound defines the sound to stop
  121564. * @param condition defines the trigger related conditions
  121565. */
  121566. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121567. /** @hidden */
  121568. _prepare(): void;
  121569. /**
  121570. * Execute the action and stop the sound.
  121571. */
  121572. execute(): void;
  121573. /**
  121574. * Serializes the actions and its related information.
  121575. * @param parent defines the object to serialize in
  121576. * @returns the serialized object
  121577. */
  121578. serialize(parent: any): any;
  121579. }
  121580. }
  121581. declare module BABYLON {
  121582. /**
  121583. * This defines an action responsible to change the value of a property
  121584. * by interpolating between its current value and the newly set one once triggered.
  121585. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121586. */
  121587. export class InterpolateValueAction extends Action {
  121588. /**
  121589. * Defines the path of the property where the value should be interpolated
  121590. */
  121591. propertyPath: string;
  121592. /**
  121593. * Defines the target value at the end of the interpolation.
  121594. */
  121595. value: any;
  121596. /**
  121597. * Defines the time it will take for the property to interpolate to the value.
  121598. */
  121599. duration: number;
  121600. /**
  121601. * Defines if the other scene animations should be stopped when the action has been triggered
  121602. */
  121603. stopOtherAnimations?: boolean;
  121604. /**
  121605. * Defines a callback raised once the interpolation animation has been done.
  121606. */
  121607. onInterpolationDone?: () => void;
  121608. /**
  121609. * Observable triggered once the interpolation animation has been done.
  121610. */
  121611. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121612. private _target;
  121613. private _effectiveTarget;
  121614. private _property;
  121615. /**
  121616. * Instantiate the action
  121617. * @param triggerOptions defines the trigger options
  121618. * @param target defines the object containing the value to interpolate
  121619. * @param propertyPath defines the path to the property in the target object
  121620. * @param value defines the target value at the end of the interpolation
  121621. * @param duration deines the time it will take for the property to interpolate to the value.
  121622. * @param condition defines the trigger related conditions
  121623. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121624. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121625. */
  121626. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121627. /** @hidden */
  121628. _prepare(): void;
  121629. /**
  121630. * Execute the action starts the value interpolation.
  121631. */
  121632. execute(): void;
  121633. /**
  121634. * Serializes the actions and its related information.
  121635. * @param parent defines the object to serialize in
  121636. * @returns the serialized object
  121637. */
  121638. serialize(parent: any): any;
  121639. }
  121640. }
  121641. declare module BABYLON {
  121642. /**
  121643. * Options allowed during the creation of a sound track.
  121644. */
  121645. export interface ISoundTrackOptions {
  121646. /**
  121647. * The volume the sound track should take during creation
  121648. */
  121649. volume?: number;
  121650. /**
  121651. * Define if the sound track is the main sound track of the scene
  121652. */
  121653. mainTrack?: boolean;
  121654. }
  121655. /**
  121656. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121657. * It will be also used in a future release to apply effects on a specific track.
  121658. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121659. */
  121660. export class SoundTrack {
  121661. /**
  121662. * The unique identifier of the sound track in the scene.
  121663. */
  121664. id: number;
  121665. /**
  121666. * The list of sounds included in the sound track.
  121667. */
  121668. soundCollection: Array<Sound>;
  121669. private _outputAudioNode;
  121670. private _scene;
  121671. private _connectedAnalyser;
  121672. private _options;
  121673. private _isInitialized;
  121674. /**
  121675. * Creates a new sound track.
  121676. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121677. * @param scene Define the scene the sound track belongs to
  121678. * @param options
  121679. */
  121680. constructor(scene: Scene, options?: ISoundTrackOptions);
  121681. private _initializeSoundTrackAudioGraph;
  121682. /**
  121683. * Release the sound track and its associated resources
  121684. */
  121685. dispose(): void;
  121686. /**
  121687. * Adds a sound to this sound track
  121688. * @param sound define the cound to add
  121689. * @ignoreNaming
  121690. */
  121691. AddSound(sound: Sound): void;
  121692. /**
  121693. * Removes a sound to this sound track
  121694. * @param sound define the cound to remove
  121695. * @ignoreNaming
  121696. */
  121697. RemoveSound(sound: Sound): void;
  121698. /**
  121699. * Set a global volume for the full sound track.
  121700. * @param newVolume Define the new volume of the sound track
  121701. */
  121702. setVolume(newVolume: number): void;
  121703. /**
  121704. * Switch the panning model to HRTF:
  121705. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121706. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121707. */
  121708. switchPanningModelToHRTF(): void;
  121709. /**
  121710. * Switch the panning model to Equal Power:
  121711. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121712. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121713. */
  121714. switchPanningModelToEqualPower(): void;
  121715. /**
  121716. * Connect the sound track to an audio analyser allowing some amazing
  121717. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121718. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121719. * @param analyser The analyser to connect to the engine
  121720. */
  121721. connectToAnalyser(analyser: Analyser): void;
  121722. }
  121723. }
  121724. declare module BABYLON {
  121725. interface AbstractScene {
  121726. /**
  121727. * The list of sounds used in the scene.
  121728. */
  121729. sounds: Nullable<Array<Sound>>;
  121730. }
  121731. interface Scene {
  121732. /**
  121733. * @hidden
  121734. * Backing field
  121735. */
  121736. _mainSoundTrack: SoundTrack;
  121737. /**
  121738. * The main sound track played by the scene.
  121739. * It cotains your primary collection of sounds.
  121740. */
  121741. mainSoundTrack: SoundTrack;
  121742. /**
  121743. * The list of sound tracks added to the scene
  121744. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121745. */
  121746. soundTracks: Nullable<Array<SoundTrack>>;
  121747. /**
  121748. * Gets a sound using a given name
  121749. * @param name defines the name to search for
  121750. * @return the found sound or null if not found at all.
  121751. */
  121752. getSoundByName(name: string): Nullable<Sound>;
  121753. /**
  121754. * Gets or sets if audio support is enabled
  121755. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121756. */
  121757. audioEnabled: boolean;
  121758. /**
  121759. * Gets or sets if audio will be output to headphones
  121760. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121761. */
  121762. headphone: boolean;
  121763. /**
  121764. * Gets or sets custom audio listener position provider
  121765. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121766. */
  121767. audioListenerPositionProvider: Nullable<() => Vector3>;
  121768. /**
  121769. * Gets or sets a refresh rate when using 3D audio positioning
  121770. */
  121771. audioPositioningRefreshRate: number;
  121772. }
  121773. /**
  121774. * Defines the sound scene component responsible to manage any sounds
  121775. * in a given scene.
  121776. */
  121777. export class AudioSceneComponent implements ISceneSerializableComponent {
  121778. private static _CameraDirectionLH;
  121779. private static _CameraDirectionRH;
  121780. /**
  121781. * The component name helpfull to identify the component in the list of scene components.
  121782. */
  121783. readonly name: string;
  121784. /**
  121785. * The scene the component belongs to.
  121786. */
  121787. scene: Scene;
  121788. private _audioEnabled;
  121789. /**
  121790. * Gets whether audio is enabled or not.
  121791. * Please use related enable/disable method to switch state.
  121792. */
  121793. get audioEnabled(): boolean;
  121794. private _headphone;
  121795. /**
  121796. * Gets whether audio is outputing to headphone or not.
  121797. * Please use the according Switch methods to change output.
  121798. */
  121799. get headphone(): boolean;
  121800. /**
  121801. * Gets or sets a refresh rate when using 3D audio positioning
  121802. */
  121803. audioPositioningRefreshRate: number;
  121804. private _audioListenerPositionProvider;
  121805. /**
  121806. * Gets the current audio listener position provider
  121807. */
  121808. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121809. /**
  121810. * Sets a custom listener position for all sounds in the scene
  121811. * By default, this is the position of the first active camera
  121812. */
  121813. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121814. /**
  121815. * Creates a new instance of the component for the given scene
  121816. * @param scene Defines the scene to register the component in
  121817. */
  121818. constructor(scene: Scene);
  121819. /**
  121820. * Registers the component in a given scene
  121821. */
  121822. register(): void;
  121823. /**
  121824. * Rebuilds the elements related to this component in case of
  121825. * context lost for instance.
  121826. */
  121827. rebuild(): void;
  121828. /**
  121829. * Serializes the component data to the specified json object
  121830. * @param serializationObject The object to serialize to
  121831. */
  121832. serialize(serializationObject: any): void;
  121833. /**
  121834. * Adds all the elements from the container to the scene
  121835. * @param container the container holding the elements
  121836. */
  121837. addFromContainer(container: AbstractScene): void;
  121838. /**
  121839. * Removes all the elements in the container from the scene
  121840. * @param container contains the elements to remove
  121841. * @param dispose if the removed element should be disposed (default: false)
  121842. */
  121843. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121844. /**
  121845. * Disposes the component and the associated ressources.
  121846. */
  121847. dispose(): void;
  121848. /**
  121849. * Disables audio in the associated scene.
  121850. */
  121851. disableAudio(): void;
  121852. /**
  121853. * Enables audio in the associated scene.
  121854. */
  121855. enableAudio(): void;
  121856. /**
  121857. * Switch audio to headphone output.
  121858. */
  121859. switchAudioModeForHeadphones(): void;
  121860. /**
  121861. * Switch audio to normal speakers.
  121862. */
  121863. switchAudioModeForNormalSpeakers(): void;
  121864. private _cachedCameraDirection;
  121865. private _cachedCameraPosition;
  121866. private _lastCheck;
  121867. private _afterRender;
  121868. }
  121869. }
  121870. declare module BABYLON {
  121871. /**
  121872. * Wraps one or more Sound objects and selects one with random weight for playback.
  121873. */
  121874. export class WeightedSound {
  121875. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121876. loop: boolean;
  121877. private _coneInnerAngle;
  121878. private _coneOuterAngle;
  121879. private _volume;
  121880. /** A Sound is currently playing. */
  121881. isPlaying: boolean;
  121882. /** A Sound is currently paused. */
  121883. isPaused: boolean;
  121884. private _sounds;
  121885. private _weights;
  121886. private _currentIndex?;
  121887. /**
  121888. * Creates a new WeightedSound from the list of sounds given.
  121889. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121890. * @param sounds Array of Sounds that will be selected from.
  121891. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121892. */
  121893. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121894. /**
  121895. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121896. */
  121897. get directionalConeInnerAngle(): number;
  121898. /**
  121899. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121900. */
  121901. set directionalConeInnerAngle(value: number);
  121902. /**
  121903. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121904. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121905. */
  121906. get directionalConeOuterAngle(): number;
  121907. /**
  121908. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121909. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121910. */
  121911. set directionalConeOuterAngle(value: number);
  121912. /**
  121913. * Playback volume.
  121914. */
  121915. get volume(): number;
  121916. /**
  121917. * Playback volume.
  121918. */
  121919. set volume(value: number);
  121920. private _onended;
  121921. /**
  121922. * Suspend playback
  121923. */
  121924. pause(): void;
  121925. /**
  121926. * Stop playback
  121927. */
  121928. stop(): void;
  121929. /**
  121930. * Start playback.
  121931. * @param startOffset Position the clip head at a specific time in seconds.
  121932. */
  121933. play(startOffset?: number): void;
  121934. }
  121935. }
  121936. declare module BABYLON {
  121937. /**
  121938. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121939. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121940. */
  121941. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121942. /**
  121943. * Gets the name of the behavior.
  121944. */
  121945. get name(): string;
  121946. /**
  121947. * The easing function used by animations
  121948. */
  121949. static EasingFunction: BackEase;
  121950. /**
  121951. * The easing mode used by animations
  121952. */
  121953. static EasingMode: number;
  121954. /**
  121955. * The duration of the animation, in milliseconds
  121956. */
  121957. transitionDuration: number;
  121958. /**
  121959. * Length of the distance animated by the transition when lower radius is reached
  121960. */
  121961. lowerRadiusTransitionRange: number;
  121962. /**
  121963. * Length of the distance animated by the transition when upper radius is reached
  121964. */
  121965. upperRadiusTransitionRange: number;
  121966. private _autoTransitionRange;
  121967. /**
  121968. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121969. */
  121970. get autoTransitionRange(): boolean;
  121971. /**
  121972. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121973. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121974. */
  121975. set autoTransitionRange(value: boolean);
  121976. private _attachedCamera;
  121977. private _onAfterCheckInputsObserver;
  121978. private _onMeshTargetChangedObserver;
  121979. /**
  121980. * Initializes the behavior.
  121981. */
  121982. init(): void;
  121983. /**
  121984. * Attaches the behavior to its arc rotate camera.
  121985. * @param camera Defines the camera to attach the behavior to
  121986. */
  121987. attach(camera: ArcRotateCamera): void;
  121988. /**
  121989. * Detaches the behavior from its current arc rotate camera.
  121990. */
  121991. detach(): void;
  121992. private _radiusIsAnimating;
  121993. private _radiusBounceTransition;
  121994. private _animatables;
  121995. private _cachedWheelPrecision;
  121996. /**
  121997. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121998. * @param radiusLimit The limit to check against.
  121999. * @return Bool to indicate if at limit.
  122000. */
  122001. private _isRadiusAtLimit;
  122002. /**
  122003. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  122004. * @param radiusDelta The delta by which to animate to. Can be negative.
  122005. */
  122006. private _applyBoundRadiusAnimation;
  122007. /**
  122008. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  122009. */
  122010. protected _clearAnimationLocks(): void;
  122011. /**
  122012. * Stops and removes all animations that have been applied to the camera
  122013. */
  122014. stopAllAnimations(): void;
  122015. }
  122016. }
  122017. declare module BABYLON {
  122018. /**
  122019. * 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.
  122020. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122021. */
  122022. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  122023. /**
  122024. * Gets the name of the behavior.
  122025. */
  122026. get name(): string;
  122027. private _mode;
  122028. private _radiusScale;
  122029. private _positionScale;
  122030. private _defaultElevation;
  122031. private _elevationReturnTime;
  122032. private _elevationReturnWaitTime;
  122033. private _zoomStopsAnimation;
  122034. private _framingTime;
  122035. /**
  122036. * The easing function used by animations
  122037. */
  122038. static EasingFunction: ExponentialEase;
  122039. /**
  122040. * The easing mode used by animations
  122041. */
  122042. static EasingMode: number;
  122043. /**
  122044. * Sets the current mode used by the behavior
  122045. */
  122046. set mode(mode: number);
  122047. /**
  122048. * Gets current mode used by the behavior.
  122049. */
  122050. get mode(): number;
  122051. /**
  122052. * Sets the scale applied to the radius (1 by default)
  122053. */
  122054. set radiusScale(radius: number);
  122055. /**
  122056. * Gets the scale applied to the radius
  122057. */
  122058. get radiusScale(): number;
  122059. /**
  122060. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122061. */
  122062. set positionScale(scale: number);
  122063. /**
  122064. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122065. */
  122066. get positionScale(): number;
  122067. /**
  122068. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122069. * behaviour is triggered, in radians.
  122070. */
  122071. set defaultElevation(elevation: number);
  122072. /**
  122073. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122074. * behaviour is triggered, in radians.
  122075. */
  122076. get defaultElevation(): number;
  122077. /**
  122078. * Sets the time (in milliseconds) taken to return to the default beta position.
  122079. * Negative value indicates camera should not return to default.
  122080. */
  122081. set elevationReturnTime(speed: number);
  122082. /**
  122083. * Gets the time (in milliseconds) taken to return to the default beta position.
  122084. * Negative value indicates camera should not return to default.
  122085. */
  122086. get elevationReturnTime(): number;
  122087. /**
  122088. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122089. */
  122090. set elevationReturnWaitTime(time: number);
  122091. /**
  122092. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122093. */
  122094. get elevationReturnWaitTime(): number;
  122095. /**
  122096. * Sets the flag that indicates if user zooming should stop animation.
  122097. */
  122098. set zoomStopsAnimation(flag: boolean);
  122099. /**
  122100. * Gets the flag that indicates if user zooming should stop animation.
  122101. */
  122102. get zoomStopsAnimation(): boolean;
  122103. /**
  122104. * Sets the transition time when framing the mesh, in milliseconds
  122105. */
  122106. set framingTime(time: number);
  122107. /**
  122108. * Gets the transition time when framing the mesh, in milliseconds
  122109. */
  122110. get framingTime(): number;
  122111. /**
  122112. * Define if the behavior should automatically change the configured
  122113. * camera limits and sensibilities.
  122114. */
  122115. autoCorrectCameraLimitsAndSensibility: boolean;
  122116. private _onPrePointerObservableObserver;
  122117. private _onAfterCheckInputsObserver;
  122118. private _onMeshTargetChangedObserver;
  122119. private _attachedCamera;
  122120. private _isPointerDown;
  122121. private _lastInteractionTime;
  122122. /**
  122123. * Initializes the behavior.
  122124. */
  122125. init(): void;
  122126. /**
  122127. * Attaches the behavior to its arc rotate camera.
  122128. * @param camera Defines the camera to attach the behavior to
  122129. */
  122130. attach(camera: ArcRotateCamera): void;
  122131. /**
  122132. * Detaches the behavior from its current arc rotate camera.
  122133. */
  122134. detach(): void;
  122135. private _animatables;
  122136. private _betaIsAnimating;
  122137. private _betaTransition;
  122138. private _radiusTransition;
  122139. private _vectorTransition;
  122140. /**
  122141. * Targets the given mesh and updates zoom level accordingly.
  122142. * @param mesh The mesh to target.
  122143. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122144. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122145. */
  122146. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122147. /**
  122148. * Targets the given mesh with its children and updates zoom level accordingly.
  122149. * @param mesh The mesh to target.
  122150. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122151. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122152. */
  122153. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122154. /**
  122155. * Targets the given meshes with their children and updates zoom level accordingly.
  122156. * @param meshes The mesh to target.
  122157. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122158. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122159. */
  122160. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122161. /**
  122162. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122163. * @param minimumWorld Determines the smaller position of the bounding box extend
  122164. * @param maximumWorld Determines the bigger position of the bounding box extend
  122165. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122166. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122167. */
  122168. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122169. /**
  122170. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122171. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122172. * frustum width.
  122173. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122174. * to fully enclose the mesh in the viewing frustum.
  122175. */
  122176. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122177. /**
  122178. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122179. * is automatically returned to its default position (expected to be above ground plane).
  122180. */
  122181. private _maintainCameraAboveGround;
  122182. /**
  122183. * Returns the frustum slope based on the canvas ratio and camera FOV
  122184. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122185. */
  122186. private _getFrustumSlope;
  122187. /**
  122188. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122189. */
  122190. private _clearAnimationLocks;
  122191. /**
  122192. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122193. */
  122194. private _applyUserInteraction;
  122195. /**
  122196. * Stops and removes all animations that have been applied to the camera
  122197. */
  122198. stopAllAnimations(): void;
  122199. /**
  122200. * Gets a value indicating if the user is moving the camera
  122201. */
  122202. get isUserIsMoving(): boolean;
  122203. /**
  122204. * The camera can move all the way towards the mesh.
  122205. */
  122206. static IgnoreBoundsSizeMode: number;
  122207. /**
  122208. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122209. */
  122210. static FitFrustumSidesMode: number;
  122211. }
  122212. }
  122213. declare module BABYLON {
  122214. /**
  122215. * Base class for Camera Pointer Inputs.
  122216. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122217. * for example usage.
  122218. */
  122219. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122220. /**
  122221. * Defines the camera the input is attached to.
  122222. */
  122223. abstract camera: Camera;
  122224. /**
  122225. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122226. */
  122227. protected _altKey: boolean;
  122228. protected _ctrlKey: boolean;
  122229. protected _metaKey: boolean;
  122230. protected _shiftKey: boolean;
  122231. /**
  122232. * Which mouse buttons were pressed at time of last mouse event.
  122233. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122234. */
  122235. protected _buttonsPressed: number;
  122236. /**
  122237. * Defines the buttons associated with the input to handle camera move.
  122238. */
  122239. buttons: number[];
  122240. /**
  122241. * Attach the input controls to a specific dom element to get the input from.
  122242. * @param element Defines the element the controls should be listened from
  122243. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122244. */
  122245. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122246. /**
  122247. * Detach the current controls from the specified dom element.
  122248. * @param element Defines the element to stop listening the inputs from
  122249. */
  122250. detachControl(element: Nullable<HTMLElement>): void;
  122251. /**
  122252. * Gets the class name of the current input.
  122253. * @returns the class name
  122254. */
  122255. getClassName(): string;
  122256. /**
  122257. * Get the friendly name associated with the input class.
  122258. * @returns the input friendly name
  122259. */
  122260. getSimpleName(): string;
  122261. /**
  122262. * Called on pointer POINTERDOUBLETAP event.
  122263. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122264. */
  122265. protected onDoubleTap(type: string): void;
  122266. /**
  122267. * Called on pointer POINTERMOVE event if only a single touch is active.
  122268. * Override this method to provide functionality.
  122269. */
  122270. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122271. /**
  122272. * Called on pointer POINTERMOVE event if multiple touches are active.
  122273. * Override this method to provide functionality.
  122274. */
  122275. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122276. /**
  122277. * Called on JS contextmenu event.
  122278. * Override this method to provide functionality.
  122279. */
  122280. protected onContextMenu(evt: PointerEvent): void;
  122281. /**
  122282. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122283. * press.
  122284. * Override this method to provide functionality.
  122285. */
  122286. protected onButtonDown(evt: PointerEvent): void;
  122287. /**
  122288. * Called each time a new POINTERUP event occurs. Ie, for each button
  122289. * release.
  122290. * Override this method to provide functionality.
  122291. */
  122292. protected onButtonUp(evt: PointerEvent): void;
  122293. /**
  122294. * Called when window becomes inactive.
  122295. * Override this method to provide functionality.
  122296. */
  122297. protected onLostFocus(): void;
  122298. private _pointerInput;
  122299. private _observer;
  122300. private _onLostFocus;
  122301. private pointA;
  122302. private pointB;
  122303. }
  122304. }
  122305. declare module BABYLON {
  122306. /**
  122307. * Manage the pointers inputs to control an arc rotate camera.
  122308. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122309. */
  122310. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122311. /**
  122312. * Defines the camera the input is attached to.
  122313. */
  122314. camera: ArcRotateCamera;
  122315. /**
  122316. * Gets the class name of the current input.
  122317. * @returns the class name
  122318. */
  122319. getClassName(): string;
  122320. /**
  122321. * Defines the buttons associated with the input to handle camera move.
  122322. */
  122323. buttons: number[];
  122324. /**
  122325. * Defines the pointer angular sensibility along the X axis or how fast is
  122326. * the camera rotating.
  122327. */
  122328. angularSensibilityX: number;
  122329. /**
  122330. * Defines the pointer angular sensibility along the Y axis or how fast is
  122331. * the camera rotating.
  122332. */
  122333. angularSensibilityY: number;
  122334. /**
  122335. * Defines the pointer pinch precision or how fast is the camera zooming.
  122336. */
  122337. pinchPrecision: number;
  122338. /**
  122339. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122340. * from 0.
  122341. * It defines the percentage of current camera.radius to use as delta when
  122342. * pinch zoom is used.
  122343. */
  122344. pinchDeltaPercentage: number;
  122345. /**
  122346. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122347. * that any object in the plane at the camera's target point will scale
  122348. * perfectly with finger motion.
  122349. * Overrides pinchDeltaPercentage and pinchPrecision.
  122350. */
  122351. useNaturalPinchZoom: boolean;
  122352. /**
  122353. * Defines the pointer panning sensibility or how fast is the camera moving.
  122354. */
  122355. panningSensibility: number;
  122356. /**
  122357. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122358. */
  122359. multiTouchPanning: boolean;
  122360. /**
  122361. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122362. * zoom (pinch) through multitouch.
  122363. */
  122364. multiTouchPanAndZoom: boolean;
  122365. /**
  122366. * Revers pinch action direction.
  122367. */
  122368. pinchInwards: boolean;
  122369. private _isPanClick;
  122370. private _twoFingerActivityCount;
  122371. private _isPinching;
  122372. /**
  122373. * Called on pointer POINTERMOVE event if only a single touch is active.
  122374. */
  122375. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122376. /**
  122377. * Called on pointer POINTERDOUBLETAP event.
  122378. */
  122379. protected onDoubleTap(type: string): void;
  122380. /**
  122381. * Called on pointer POINTERMOVE event if multiple touches are active.
  122382. */
  122383. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122384. /**
  122385. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122386. * press.
  122387. */
  122388. protected onButtonDown(evt: PointerEvent): void;
  122389. /**
  122390. * Called each time a new POINTERUP event occurs. Ie, for each button
  122391. * release.
  122392. */
  122393. protected onButtonUp(evt: PointerEvent): void;
  122394. /**
  122395. * Called when window becomes inactive.
  122396. */
  122397. protected onLostFocus(): void;
  122398. }
  122399. }
  122400. declare module BABYLON {
  122401. /**
  122402. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122403. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122404. */
  122405. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122406. /**
  122407. * Defines the camera the input is attached to.
  122408. */
  122409. camera: ArcRotateCamera;
  122410. /**
  122411. * Defines the list of key codes associated with the up action (increase alpha)
  122412. */
  122413. keysUp: number[];
  122414. /**
  122415. * Defines the list of key codes associated with the down action (decrease alpha)
  122416. */
  122417. keysDown: number[];
  122418. /**
  122419. * Defines the list of key codes associated with the left action (increase beta)
  122420. */
  122421. keysLeft: number[];
  122422. /**
  122423. * Defines the list of key codes associated with the right action (decrease beta)
  122424. */
  122425. keysRight: number[];
  122426. /**
  122427. * Defines the list of key codes associated with the reset action.
  122428. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122429. */
  122430. keysReset: number[];
  122431. /**
  122432. * Defines the panning sensibility of the inputs.
  122433. * (How fast is the camera panning)
  122434. */
  122435. panningSensibility: number;
  122436. /**
  122437. * Defines the zooming sensibility of the inputs.
  122438. * (How fast is the camera zooming)
  122439. */
  122440. zoomingSensibility: number;
  122441. /**
  122442. * Defines whether maintaining the alt key down switch the movement mode from
  122443. * orientation to zoom.
  122444. */
  122445. useAltToZoom: boolean;
  122446. /**
  122447. * Rotation speed of the camera
  122448. */
  122449. angularSpeed: number;
  122450. private _keys;
  122451. private _ctrlPressed;
  122452. private _altPressed;
  122453. private _onCanvasBlurObserver;
  122454. private _onKeyboardObserver;
  122455. private _engine;
  122456. private _scene;
  122457. /**
  122458. * Attach the input controls to a specific dom element to get the input from.
  122459. * @param element Defines the element the controls should be listened from
  122460. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122461. */
  122462. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122463. /**
  122464. * Detach the current controls from the specified dom element.
  122465. * @param element Defines the element to stop listening the inputs from
  122466. */
  122467. detachControl(element: Nullable<HTMLElement>): void;
  122468. /**
  122469. * Update the current camera state depending on the inputs that have been used this frame.
  122470. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122471. */
  122472. checkInputs(): void;
  122473. /**
  122474. * Gets the class name of the current intput.
  122475. * @returns the class name
  122476. */
  122477. getClassName(): string;
  122478. /**
  122479. * Get the friendly name associated with the input class.
  122480. * @returns the input friendly name
  122481. */
  122482. getSimpleName(): string;
  122483. }
  122484. }
  122485. declare module BABYLON {
  122486. /**
  122487. * Manage the mouse wheel inputs to control an arc rotate camera.
  122488. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122489. */
  122490. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122491. /**
  122492. * Defines the camera the input is attached to.
  122493. */
  122494. camera: ArcRotateCamera;
  122495. /**
  122496. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122497. */
  122498. wheelPrecision: number;
  122499. /**
  122500. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122501. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122502. */
  122503. wheelDeltaPercentage: number;
  122504. private _wheel;
  122505. private _observer;
  122506. private computeDeltaFromMouseWheelLegacyEvent;
  122507. /**
  122508. * Attach the input controls to a specific dom element to get the input from.
  122509. * @param element Defines the element the controls should be listened from
  122510. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122511. */
  122512. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122513. /**
  122514. * Detach the current controls from the specified dom element.
  122515. * @param element Defines the element to stop listening the inputs from
  122516. */
  122517. detachControl(element: Nullable<HTMLElement>): void;
  122518. /**
  122519. * Gets the class name of the current intput.
  122520. * @returns the class name
  122521. */
  122522. getClassName(): string;
  122523. /**
  122524. * Get the friendly name associated with the input class.
  122525. * @returns the input friendly name
  122526. */
  122527. getSimpleName(): string;
  122528. }
  122529. }
  122530. declare module BABYLON {
  122531. /**
  122532. * Default Inputs manager for the ArcRotateCamera.
  122533. * It groups all the default supported inputs for ease of use.
  122534. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122535. */
  122536. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122537. /**
  122538. * Instantiates a new ArcRotateCameraInputsManager.
  122539. * @param camera Defines the camera the inputs belong to
  122540. */
  122541. constructor(camera: ArcRotateCamera);
  122542. /**
  122543. * Add mouse wheel input support to the input manager.
  122544. * @returns the current input manager
  122545. */
  122546. addMouseWheel(): ArcRotateCameraInputsManager;
  122547. /**
  122548. * Add pointers input support to the input manager.
  122549. * @returns the current input manager
  122550. */
  122551. addPointers(): ArcRotateCameraInputsManager;
  122552. /**
  122553. * Add keyboard input support to the input manager.
  122554. * @returns the current input manager
  122555. */
  122556. addKeyboard(): ArcRotateCameraInputsManager;
  122557. }
  122558. }
  122559. declare module BABYLON {
  122560. /**
  122561. * This represents an orbital type of camera.
  122562. *
  122563. * 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.
  122564. * 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.
  122565. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122566. */
  122567. export class ArcRotateCamera extends TargetCamera {
  122568. /**
  122569. * Defines the rotation angle of the camera along the longitudinal axis.
  122570. */
  122571. alpha: number;
  122572. /**
  122573. * Defines the rotation angle of the camera along the latitudinal axis.
  122574. */
  122575. beta: number;
  122576. /**
  122577. * Defines the radius of the camera from it s target point.
  122578. */
  122579. radius: number;
  122580. protected _target: Vector3;
  122581. protected _targetHost: Nullable<AbstractMesh>;
  122582. /**
  122583. * Defines the target point of the camera.
  122584. * The camera looks towards it form the radius distance.
  122585. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122586. */
  122587. get target(): Vector3;
  122588. set target(value: Vector3);
  122589. /**
  122590. * Define the current local position of the camera in the scene
  122591. */
  122592. get position(): Vector3;
  122593. set position(newPosition: Vector3);
  122594. protected _upToYMatrix: Matrix;
  122595. protected _YToUpMatrix: Matrix;
  122596. /**
  122597. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122598. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122599. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122600. */
  122601. set upVector(vec: Vector3);
  122602. get upVector(): Vector3;
  122603. /**
  122604. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122605. */
  122606. setMatUp(): void;
  122607. /**
  122608. * Current inertia value on the longitudinal axis.
  122609. * The bigger this number the longer it will take for the camera to stop.
  122610. */
  122611. inertialAlphaOffset: number;
  122612. /**
  122613. * Current inertia value on the latitudinal axis.
  122614. * The bigger this number the longer it will take for the camera to stop.
  122615. */
  122616. inertialBetaOffset: number;
  122617. /**
  122618. * Current inertia value on the radius axis.
  122619. * The bigger this number the longer it will take for the camera to stop.
  122620. */
  122621. inertialRadiusOffset: number;
  122622. /**
  122623. * Minimum allowed angle on the longitudinal axis.
  122624. * This can help limiting how the Camera is able to move in the scene.
  122625. */
  122626. lowerAlphaLimit: Nullable<number>;
  122627. /**
  122628. * Maximum allowed angle on the longitudinal axis.
  122629. * This can help limiting how the Camera is able to move in the scene.
  122630. */
  122631. upperAlphaLimit: Nullable<number>;
  122632. /**
  122633. * Minimum allowed angle on the latitudinal axis.
  122634. * This can help limiting how the Camera is able to move in the scene.
  122635. */
  122636. lowerBetaLimit: number;
  122637. /**
  122638. * Maximum allowed angle on the latitudinal axis.
  122639. * This can help limiting how the Camera is able to move in the scene.
  122640. */
  122641. upperBetaLimit: number;
  122642. /**
  122643. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122644. * This can help limiting how the Camera is able to move in the scene.
  122645. */
  122646. lowerRadiusLimit: Nullable<number>;
  122647. /**
  122648. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122649. * This can help limiting how the Camera is able to move in the scene.
  122650. */
  122651. upperRadiusLimit: Nullable<number>;
  122652. /**
  122653. * Defines the current inertia value used during panning of the camera along the X axis.
  122654. */
  122655. inertialPanningX: number;
  122656. /**
  122657. * Defines the current inertia value used during panning of the camera along the Y axis.
  122658. */
  122659. inertialPanningY: number;
  122660. /**
  122661. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122662. * Basically if your fingers moves away from more than this distance you will be considered
  122663. * in pinch mode.
  122664. */
  122665. pinchToPanMaxDistance: number;
  122666. /**
  122667. * Defines the maximum distance the camera can pan.
  122668. * This could help keeping the cammera always in your scene.
  122669. */
  122670. panningDistanceLimit: Nullable<number>;
  122671. /**
  122672. * Defines the target of the camera before paning.
  122673. */
  122674. panningOriginTarget: Vector3;
  122675. /**
  122676. * Defines the value of the inertia used during panning.
  122677. * 0 would mean stop inertia and one would mean no decelleration at all.
  122678. */
  122679. panningInertia: number;
  122680. /**
  122681. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122682. */
  122683. get angularSensibilityX(): number;
  122684. set angularSensibilityX(value: number);
  122685. /**
  122686. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122687. */
  122688. get angularSensibilityY(): number;
  122689. set angularSensibilityY(value: number);
  122690. /**
  122691. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122692. */
  122693. get pinchPrecision(): number;
  122694. set pinchPrecision(value: number);
  122695. /**
  122696. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122697. * It will be used instead of pinchDeltaPrecision if different from 0.
  122698. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122699. */
  122700. get pinchDeltaPercentage(): number;
  122701. set pinchDeltaPercentage(value: number);
  122702. /**
  122703. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122704. * and pinch delta percentage.
  122705. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122706. * that any object in the plane at the camera's target point will scale
  122707. * perfectly with finger motion.
  122708. */
  122709. get useNaturalPinchZoom(): boolean;
  122710. set useNaturalPinchZoom(value: boolean);
  122711. /**
  122712. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122713. */
  122714. get panningSensibility(): number;
  122715. set panningSensibility(value: number);
  122716. /**
  122717. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122718. */
  122719. get keysUp(): number[];
  122720. set keysUp(value: number[]);
  122721. /**
  122722. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122723. */
  122724. get keysDown(): number[];
  122725. set keysDown(value: number[]);
  122726. /**
  122727. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122728. */
  122729. get keysLeft(): number[];
  122730. set keysLeft(value: number[]);
  122731. /**
  122732. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122733. */
  122734. get keysRight(): number[];
  122735. set keysRight(value: number[]);
  122736. /**
  122737. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122738. */
  122739. get wheelPrecision(): number;
  122740. set wheelPrecision(value: number);
  122741. /**
  122742. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122743. * It will be used instead of pinchDeltaPrecision if different from 0.
  122744. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122745. */
  122746. get wheelDeltaPercentage(): number;
  122747. set wheelDeltaPercentage(value: number);
  122748. /**
  122749. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122750. */
  122751. zoomOnFactor: number;
  122752. /**
  122753. * Defines a screen offset for the camera position.
  122754. */
  122755. targetScreenOffset: Vector2;
  122756. /**
  122757. * Allows the camera to be completely reversed.
  122758. * If false the camera can not arrive upside down.
  122759. */
  122760. allowUpsideDown: boolean;
  122761. /**
  122762. * Define if double tap/click is used to restore the previously saved state of the camera.
  122763. */
  122764. useInputToRestoreState: boolean;
  122765. /** @hidden */
  122766. _viewMatrix: Matrix;
  122767. /** @hidden */
  122768. _useCtrlForPanning: boolean;
  122769. /** @hidden */
  122770. _panningMouseButton: number;
  122771. /**
  122772. * Defines the input associated to the camera.
  122773. */
  122774. inputs: ArcRotateCameraInputsManager;
  122775. /** @hidden */
  122776. _reset: () => void;
  122777. /**
  122778. * Defines the allowed panning axis.
  122779. */
  122780. panningAxis: Vector3;
  122781. protected _localDirection: Vector3;
  122782. protected _transformedDirection: Vector3;
  122783. private _bouncingBehavior;
  122784. /**
  122785. * Gets the bouncing behavior of the camera if it has been enabled.
  122786. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122787. */
  122788. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122789. /**
  122790. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122791. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122792. */
  122793. get useBouncingBehavior(): boolean;
  122794. set useBouncingBehavior(value: boolean);
  122795. private _framingBehavior;
  122796. /**
  122797. * Gets the framing behavior of the camera if it has been enabled.
  122798. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122799. */
  122800. get framingBehavior(): Nullable<FramingBehavior>;
  122801. /**
  122802. * Defines if the framing behavior of the camera is enabled on the camera.
  122803. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122804. */
  122805. get useFramingBehavior(): boolean;
  122806. set useFramingBehavior(value: boolean);
  122807. private _autoRotationBehavior;
  122808. /**
  122809. * Gets the auto rotation behavior of the camera if it has been enabled.
  122810. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122811. */
  122812. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122813. /**
  122814. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122815. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122816. */
  122817. get useAutoRotationBehavior(): boolean;
  122818. set useAutoRotationBehavior(value: boolean);
  122819. /**
  122820. * Observable triggered when the mesh target has been changed on the camera.
  122821. */
  122822. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122823. /**
  122824. * Event raised when the camera is colliding with a mesh.
  122825. */
  122826. onCollide: (collidedMesh: AbstractMesh) => void;
  122827. /**
  122828. * Defines whether the camera should check collision with the objects oh the scene.
  122829. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122830. */
  122831. checkCollisions: boolean;
  122832. /**
  122833. * Defines the collision radius of the camera.
  122834. * This simulates a sphere around the camera.
  122835. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122836. */
  122837. collisionRadius: Vector3;
  122838. protected _collider: Collider;
  122839. protected _previousPosition: Vector3;
  122840. protected _collisionVelocity: Vector3;
  122841. protected _newPosition: Vector3;
  122842. protected _previousAlpha: number;
  122843. protected _previousBeta: number;
  122844. protected _previousRadius: number;
  122845. protected _collisionTriggered: boolean;
  122846. protected _targetBoundingCenter: Nullable<Vector3>;
  122847. private _computationVector;
  122848. /**
  122849. * Instantiates a new ArcRotateCamera in a given scene
  122850. * @param name Defines the name of the camera
  122851. * @param alpha Defines the camera rotation along the logitudinal axis
  122852. * @param beta Defines the camera rotation along the latitudinal axis
  122853. * @param radius Defines the camera distance from its target
  122854. * @param target Defines the camera target
  122855. * @param scene Defines the scene the camera belongs to
  122856. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122857. */
  122858. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122859. /** @hidden */
  122860. _initCache(): void;
  122861. /** @hidden */
  122862. _updateCache(ignoreParentClass?: boolean): void;
  122863. protected _getTargetPosition(): Vector3;
  122864. private _storedAlpha;
  122865. private _storedBeta;
  122866. private _storedRadius;
  122867. private _storedTarget;
  122868. private _storedTargetScreenOffset;
  122869. /**
  122870. * Stores the current state of the camera (alpha, beta, radius and target)
  122871. * @returns the camera itself
  122872. */
  122873. storeState(): Camera;
  122874. /**
  122875. * @hidden
  122876. * Restored camera state. You must call storeState() first
  122877. */
  122878. _restoreStateValues(): boolean;
  122879. /** @hidden */
  122880. _isSynchronizedViewMatrix(): boolean;
  122881. /**
  122882. * Attached controls to the current camera.
  122883. * @param element Defines the element the controls should be listened from
  122884. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122885. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122886. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122887. */
  122888. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122889. /**
  122890. * Detach the current controls from the camera.
  122891. * The camera will stop reacting to inputs.
  122892. * @param element Defines the element to stop listening the inputs from
  122893. */
  122894. detachControl(element: HTMLElement): void;
  122895. /** @hidden */
  122896. _checkInputs(): void;
  122897. protected _checkLimits(): void;
  122898. /**
  122899. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122900. */
  122901. rebuildAnglesAndRadius(): void;
  122902. /**
  122903. * Use a position to define the current camera related information like alpha, beta and radius
  122904. * @param position Defines the position to set the camera at
  122905. */
  122906. setPosition(position: Vector3): void;
  122907. /**
  122908. * Defines the target the camera should look at.
  122909. * This will automatically adapt alpha beta and radius to fit within the new target.
  122910. * @param target Defines the new target as a Vector or a mesh
  122911. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122912. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122913. */
  122914. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122915. /** @hidden */
  122916. _getViewMatrix(): Matrix;
  122917. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122918. /**
  122919. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122920. * @param meshes Defines the mesh to zoom on
  122921. * @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)
  122922. */
  122923. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122924. /**
  122925. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122926. * The target will be changed but the radius
  122927. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122928. * @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)
  122929. */
  122930. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122931. min: Vector3;
  122932. max: Vector3;
  122933. distance: number;
  122934. }, doNotUpdateMaxZ?: boolean): void;
  122935. /**
  122936. * @override
  122937. * Override Camera.createRigCamera
  122938. */
  122939. createRigCamera(name: string, cameraIndex: number): Camera;
  122940. /**
  122941. * @hidden
  122942. * @override
  122943. * Override Camera._updateRigCameras
  122944. */
  122945. _updateRigCameras(): void;
  122946. /**
  122947. * Destroy the camera and release the current resources hold by it.
  122948. */
  122949. dispose(): void;
  122950. /**
  122951. * Gets the current object class name.
  122952. * @return the class name
  122953. */
  122954. getClassName(): string;
  122955. }
  122956. }
  122957. declare module BABYLON {
  122958. /**
  122959. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122960. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122961. */
  122962. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122963. /**
  122964. * Gets the name of the behavior.
  122965. */
  122966. get name(): string;
  122967. private _zoomStopsAnimation;
  122968. private _idleRotationSpeed;
  122969. private _idleRotationWaitTime;
  122970. private _idleRotationSpinupTime;
  122971. /**
  122972. * Sets the flag that indicates if user zooming should stop animation.
  122973. */
  122974. set zoomStopsAnimation(flag: boolean);
  122975. /**
  122976. * Gets the flag that indicates if user zooming should stop animation.
  122977. */
  122978. get zoomStopsAnimation(): boolean;
  122979. /**
  122980. * Sets the default speed at which the camera rotates around the model.
  122981. */
  122982. set idleRotationSpeed(speed: number);
  122983. /**
  122984. * Gets the default speed at which the camera rotates around the model.
  122985. */
  122986. get idleRotationSpeed(): number;
  122987. /**
  122988. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122989. */
  122990. set idleRotationWaitTime(time: number);
  122991. /**
  122992. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122993. */
  122994. get idleRotationWaitTime(): number;
  122995. /**
  122996. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122997. */
  122998. set idleRotationSpinupTime(time: number);
  122999. /**
  123000. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123001. */
  123002. get idleRotationSpinupTime(): number;
  123003. /**
  123004. * Gets a value indicating if the camera is currently rotating because of this behavior
  123005. */
  123006. get rotationInProgress(): boolean;
  123007. private _onPrePointerObservableObserver;
  123008. private _onAfterCheckInputsObserver;
  123009. private _attachedCamera;
  123010. private _isPointerDown;
  123011. private _lastFrameTime;
  123012. private _lastInteractionTime;
  123013. private _cameraRotationSpeed;
  123014. /**
  123015. * Initializes the behavior.
  123016. */
  123017. init(): void;
  123018. /**
  123019. * Attaches the behavior to its arc rotate camera.
  123020. * @param camera Defines the camera to attach the behavior to
  123021. */
  123022. attach(camera: ArcRotateCamera): void;
  123023. /**
  123024. * Detaches the behavior from its current arc rotate camera.
  123025. */
  123026. detach(): void;
  123027. /**
  123028. * Returns true if user is scrolling.
  123029. * @return true if user is scrolling.
  123030. */
  123031. private _userIsZooming;
  123032. private _lastFrameRadius;
  123033. private _shouldAnimationStopForInteraction;
  123034. /**
  123035. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  123036. */
  123037. private _applyUserInteraction;
  123038. private _userIsMoving;
  123039. }
  123040. }
  123041. declare module BABYLON {
  123042. /**
  123043. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  123044. */
  123045. export class AttachToBoxBehavior implements Behavior<Mesh> {
  123046. private ui;
  123047. /**
  123048. * The name of the behavior
  123049. */
  123050. name: string;
  123051. /**
  123052. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  123053. */
  123054. distanceAwayFromFace: number;
  123055. /**
  123056. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  123057. */
  123058. distanceAwayFromBottomOfFace: number;
  123059. private _faceVectors;
  123060. private _target;
  123061. private _scene;
  123062. private _onRenderObserver;
  123063. private _tmpMatrix;
  123064. private _tmpVector;
  123065. /**
  123066. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  123067. * @param ui The transform node that should be attched to the mesh
  123068. */
  123069. constructor(ui: TransformNode);
  123070. /**
  123071. * Initializes the behavior
  123072. */
  123073. init(): void;
  123074. private _closestFace;
  123075. private _zeroVector;
  123076. private _lookAtTmpMatrix;
  123077. private _lookAtToRef;
  123078. /**
  123079. * Attaches the AttachToBoxBehavior to the passed in mesh
  123080. * @param target The mesh that the specified node will be attached to
  123081. */
  123082. attach(target: Mesh): void;
  123083. /**
  123084. * Detaches the behavior from the mesh
  123085. */
  123086. detach(): void;
  123087. }
  123088. }
  123089. declare module BABYLON {
  123090. /**
  123091. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123092. */
  123093. export class FadeInOutBehavior implements Behavior<Mesh> {
  123094. /**
  123095. * Time in milliseconds to delay before fading in (Default: 0)
  123096. */
  123097. delay: number;
  123098. /**
  123099. * Time in milliseconds for the mesh to fade in (Default: 300)
  123100. */
  123101. fadeInTime: number;
  123102. private _millisecondsPerFrame;
  123103. private _hovered;
  123104. private _hoverValue;
  123105. private _ownerNode;
  123106. /**
  123107. * Instatiates the FadeInOutBehavior
  123108. */
  123109. constructor();
  123110. /**
  123111. * The name of the behavior
  123112. */
  123113. get name(): string;
  123114. /**
  123115. * Initializes the behavior
  123116. */
  123117. init(): void;
  123118. /**
  123119. * Attaches the fade behavior on the passed in mesh
  123120. * @param ownerNode The mesh that will be faded in/out once attached
  123121. */
  123122. attach(ownerNode: Mesh): void;
  123123. /**
  123124. * Detaches the behavior from the mesh
  123125. */
  123126. detach(): void;
  123127. /**
  123128. * Triggers the mesh to begin fading in or out
  123129. * @param value if the object should fade in or out (true to fade in)
  123130. */
  123131. fadeIn(value: boolean): void;
  123132. private _update;
  123133. private _setAllVisibility;
  123134. }
  123135. }
  123136. declare module BABYLON {
  123137. /**
  123138. * Class containing a set of static utilities functions for managing Pivots
  123139. * @hidden
  123140. */
  123141. export class PivotTools {
  123142. private static _PivotCached;
  123143. private static _OldPivotPoint;
  123144. private static _PivotTranslation;
  123145. private static _PivotTmpVector;
  123146. private static _PivotPostMultiplyPivotMatrix;
  123147. /** @hidden */
  123148. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123149. /** @hidden */
  123150. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123151. }
  123152. }
  123153. declare module BABYLON {
  123154. /**
  123155. * Class containing static functions to help procedurally build meshes
  123156. */
  123157. export class PlaneBuilder {
  123158. /**
  123159. * Creates a plane mesh
  123160. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123161. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123162. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123163. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123164. * * 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
  123165. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123166. * @param name defines the name of the mesh
  123167. * @param options defines the options used to create the mesh
  123168. * @param scene defines the hosting scene
  123169. * @returns the plane mesh
  123170. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123171. */
  123172. static CreatePlane(name: string, options: {
  123173. size?: number;
  123174. width?: number;
  123175. height?: number;
  123176. sideOrientation?: number;
  123177. frontUVs?: Vector4;
  123178. backUVs?: Vector4;
  123179. updatable?: boolean;
  123180. sourcePlane?: Plane;
  123181. }, scene?: Nullable<Scene>): Mesh;
  123182. }
  123183. }
  123184. declare module BABYLON {
  123185. /**
  123186. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123187. */
  123188. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123189. private static _AnyMouseID;
  123190. /**
  123191. * Abstract mesh the behavior is set on
  123192. */
  123193. attachedNode: AbstractMesh;
  123194. private _dragPlane;
  123195. private _scene;
  123196. private _pointerObserver;
  123197. private _beforeRenderObserver;
  123198. private static _planeScene;
  123199. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123200. /**
  123201. * 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)
  123202. */
  123203. maxDragAngle: number;
  123204. /**
  123205. * @hidden
  123206. */
  123207. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123208. /**
  123209. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123210. */
  123211. currentDraggingPointerID: number;
  123212. /**
  123213. * The last position where the pointer hit the drag plane in world space
  123214. */
  123215. lastDragPosition: Vector3;
  123216. /**
  123217. * If the behavior is currently in a dragging state
  123218. */
  123219. dragging: boolean;
  123220. /**
  123221. * 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)
  123222. */
  123223. dragDeltaRatio: number;
  123224. /**
  123225. * If the drag plane orientation should be updated during the dragging (Default: true)
  123226. */
  123227. updateDragPlane: boolean;
  123228. private _debugMode;
  123229. private _moving;
  123230. /**
  123231. * Fires each time the attached mesh is dragged with the pointer
  123232. * * delta between last drag position and current drag position in world space
  123233. * * dragDistance along the drag axis
  123234. * * dragPlaneNormal normal of the current drag plane used during the drag
  123235. * * dragPlanePoint in world space where the drag intersects the drag plane
  123236. */
  123237. onDragObservable: Observable<{
  123238. delta: Vector3;
  123239. dragPlanePoint: Vector3;
  123240. dragPlaneNormal: Vector3;
  123241. dragDistance: number;
  123242. pointerId: number;
  123243. }>;
  123244. /**
  123245. * Fires each time a drag begins (eg. mouse down on mesh)
  123246. */
  123247. onDragStartObservable: Observable<{
  123248. dragPlanePoint: Vector3;
  123249. pointerId: number;
  123250. }>;
  123251. /**
  123252. * Fires each time a drag ends (eg. mouse release after drag)
  123253. */
  123254. onDragEndObservable: Observable<{
  123255. dragPlanePoint: Vector3;
  123256. pointerId: number;
  123257. }>;
  123258. /**
  123259. * If the attached mesh should be moved when dragged
  123260. */
  123261. moveAttached: boolean;
  123262. /**
  123263. * If the drag behavior will react to drag events (Default: true)
  123264. */
  123265. enabled: boolean;
  123266. /**
  123267. * If pointer events should start and release the drag (Default: true)
  123268. */
  123269. startAndReleaseDragOnPointerEvents: boolean;
  123270. /**
  123271. * If camera controls should be detached during the drag
  123272. */
  123273. detachCameraControls: boolean;
  123274. /**
  123275. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123276. */
  123277. useObjectOrientationForDragging: boolean;
  123278. private _options;
  123279. /**
  123280. * Gets the options used by the behavior
  123281. */
  123282. get options(): {
  123283. dragAxis?: Vector3;
  123284. dragPlaneNormal?: Vector3;
  123285. };
  123286. /**
  123287. * Sets the options used by the behavior
  123288. */
  123289. set options(options: {
  123290. dragAxis?: Vector3;
  123291. dragPlaneNormal?: Vector3;
  123292. });
  123293. /**
  123294. * Creates a pointer drag behavior that can be attached to a mesh
  123295. * @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)
  123296. */
  123297. constructor(options?: {
  123298. dragAxis?: Vector3;
  123299. dragPlaneNormal?: Vector3;
  123300. });
  123301. /**
  123302. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123303. */
  123304. validateDrag: (targetPosition: Vector3) => boolean;
  123305. /**
  123306. * The name of the behavior
  123307. */
  123308. get name(): string;
  123309. /**
  123310. * Initializes the behavior
  123311. */
  123312. init(): void;
  123313. private _tmpVector;
  123314. private _alternatePickedPoint;
  123315. private _worldDragAxis;
  123316. private _targetPosition;
  123317. private _attachedElement;
  123318. /**
  123319. * Attaches the drag behavior the passed in mesh
  123320. * @param ownerNode The mesh that will be dragged around once attached
  123321. * @param predicate Predicate to use for pick filtering
  123322. */
  123323. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123324. /**
  123325. * Force relase the drag action by code.
  123326. */
  123327. releaseDrag(): void;
  123328. private _startDragRay;
  123329. private _lastPointerRay;
  123330. /**
  123331. * Simulates the start of a pointer drag event on the behavior
  123332. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123333. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123334. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123335. */
  123336. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123337. private _startDrag;
  123338. private _dragDelta;
  123339. private _moveDrag;
  123340. private _pickWithRayOnDragPlane;
  123341. private _pointA;
  123342. private _pointC;
  123343. private _localAxis;
  123344. private _lookAt;
  123345. private _updateDragPlanePosition;
  123346. /**
  123347. * Detaches the behavior from the mesh
  123348. */
  123349. detach(): void;
  123350. }
  123351. }
  123352. declare module BABYLON {
  123353. /**
  123354. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123355. */
  123356. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123357. private _dragBehaviorA;
  123358. private _dragBehaviorB;
  123359. private _startDistance;
  123360. private _initialScale;
  123361. private _targetScale;
  123362. private _ownerNode;
  123363. private _sceneRenderObserver;
  123364. /**
  123365. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123366. */
  123367. constructor();
  123368. /**
  123369. * The name of the behavior
  123370. */
  123371. get name(): string;
  123372. /**
  123373. * Initializes the behavior
  123374. */
  123375. init(): void;
  123376. private _getCurrentDistance;
  123377. /**
  123378. * Attaches the scale behavior the passed in mesh
  123379. * @param ownerNode The mesh that will be scaled around once attached
  123380. */
  123381. attach(ownerNode: Mesh): void;
  123382. /**
  123383. * Detaches the behavior from the mesh
  123384. */
  123385. detach(): void;
  123386. }
  123387. }
  123388. declare module BABYLON {
  123389. /**
  123390. * 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
  123391. */
  123392. export class SixDofDragBehavior implements Behavior<Mesh> {
  123393. private static _virtualScene;
  123394. private _ownerNode;
  123395. private _sceneRenderObserver;
  123396. private _scene;
  123397. private _targetPosition;
  123398. private _virtualOriginMesh;
  123399. private _virtualDragMesh;
  123400. private _pointerObserver;
  123401. private _moving;
  123402. private _startingOrientation;
  123403. private _attachedElement;
  123404. /**
  123405. * 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)
  123406. */
  123407. private zDragFactor;
  123408. /**
  123409. * If the object should rotate to face the drag origin
  123410. */
  123411. rotateDraggedObject: boolean;
  123412. /**
  123413. * If the behavior is currently in a dragging state
  123414. */
  123415. dragging: boolean;
  123416. /**
  123417. * 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)
  123418. */
  123419. dragDeltaRatio: number;
  123420. /**
  123421. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123422. */
  123423. currentDraggingPointerID: number;
  123424. /**
  123425. * If camera controls should be detached during the drag
  123426. */
  123427. detachCameraControls: boolean;
  123428. /**
  123429. * Fires each time a drag starts
  123430. */
  123431. onDragStartObservable: Observable<{}>;
  123432. /**
  123433. * Fires each time a drag ends (eg. mouse release after drag)
  123434. */
  123435. onDragEndObservable: Observable<{}>;
  123436. /**
  123437. * 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
  123438. */
  123439. constructor();
  123440. /**
  123441. * The name of the behavior
  123442. */
  123443. get name(): string;
  123444. /**
  123445. * Initializes the behavior
  123446. */
  123447. init(): void;
  123448. /**
  123449. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123450. */
  123451. private get _pointerCamera();
  123452. /**
  123453. * Attaches the scale behavior the passed in mesh
  123454. * @param ownerNode The mesh that will be scaled around once attached
  123455. */
  123456. attach(ownerNode: Mesh): void;
  123457. /**
  123458. * Detaches the behavior from the mesh
  123459. */
  123460. detach(): void;
  123461. }
  123462. }
  123463. declare module BABYLON {
  123464. /**
  123465. * Class used to apply inverse kinematics to bones
  123466. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123467. */
  123468. export class BoneIKController {
  123469. private static _tmpVecs;
  123470. private static _tmpQuat;
  123471. private static _tmpMats;
  123472. /**
  123473. * Gets or sets the target mesh
  123474. */
  123475. targetMesh: AbstractMesh;
  123476. /** Gets or sets the mesh used as pole */
  123477. poleTargetMesh: AbstractMesh;
  123478. /**
  123479. * Gets or sets the bone used as pole
  123480. */
  123481. poleTargetBone: Nullable<Bone>;
  123482. /**
  123483. * Gets or sets the target position
  123484. */
  123485. targetPosition: Vector3;
  123486. /**
  123487. * Gets or sets the pole target position
  123488. */
  123489. poleTargetPosition: Vector3;
  123490. /**
  123491. * Gets or sets the pole target local offset
  123492. */
  123493. poleTargetLocalOffset: Vector3;
  123494. /**
  123495. * Gets or sets the pole angle
  123496. */
  123497. poleAngle: number;
  123498. /**
  123499. * Gets or sets the mesh associated with the controller
  123500. */
  123501. mesh: AbstractMesh;
  123502. /**
  123503. * 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)
  123504. */
  123505. slerpAmount: number;
  123506. private _bone1Quat;
  123507. private _bone1Mat;
  123508. private _bone2Ang;
  123509. private _bone1;
  123510. private _bone2;
  123511. private _bone1Length;
  123512. private _bone2Length;
  123513. private _maxAngle;
  123514. private _maxReach;
  123515. private _rightHandedSystem;
  123516. private _bendAxis;
  123517. private _slerping;
  123518. private _adjustRoll;
  123519. /**
  123520. * Gets or sets maximum allowed angle
  123521. */
  123522. get maxAngle(): number;
  123523. set maxAngle(value: number);
  123524. /**
  123525. * Creates a new BoneIKController
  123526. * @param mesh defines the mesh to control
  123527. * @param bone defines the bone to control
  123528. * @param options defines options to set up the controller
  123529. */
  123530. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123531. targetMesh?: AbstractMesh;
  123532. poleTargetMesh?: AbstractMesh;
  123533. poleTargetBone?: Bone;
  123534. poleTargetLocalOffset?: Vector3;
  123535. poleAngle?: number;
  123536. bendAxis?: Vector3;
  123537. maxAngle?: number;
  123538. slerpAmount?: number;
  123539. });
  123540. private _setMaxAngle;
  123541. /**
  123542. * Force the controller to update the bones
  123543. */
  123544. update(): void;
  123545. }
  123546. }
  123547. declare module BABYLON {
  123548. /**
  123549. * Class used to make a bone look toward a point in space
  123550. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123551. */
  123552. export class BoneLookController {
  123553. private static _tmpVecs;
  123554. private static _tmpQuat;
  123555. private static _tmpMats;
  123556. /**
  123557. * The target Vector3 that the bone will look at
  123558. */
  123559. target: Vector3;
  123560. /**
  123561. * The mesh that the bone is attached to
  123562. */
  123563. mesh: AbstractMesh;
  123564. /**
  123565. * The bone that will be looking to the target
  123566. */
  123567. bone: Bone;
  123568. /**
  123569. * The up axis of the coordinate system that is used when the bone is rotated
  123570. */
  123571. upAxis: Vector3;
  123572. /**
  123573. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123574. */
  123575. upAxisSpace: Space;
  123576. /**
  123577. * Used to make an adjustment to the yaw of the bone
  123578. */
  123579. adjustYaw: number;
  123580. /**
  123581. * Used to make an adjustment to the pitch of the bone
  123582. */
  123583. adjustPitch: number;
  123584. /**
  123585. * Used to make an adjustment to the roll of the bone
  123586. */
  123587. adjustRoll: number;
  123588. /**
  123589. * 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)
  123590. */
  123591. slerpAmount: number;
  123592. private _minYaw;
  123593. private _maxYaw;
  123594. private _minPitch;
  123595. private _maxPitch;
  123596. private _minYawSin;
  123597. private _minYawCos;
  123598. private _maxYawSin;
  123599. private _maxYawCos;
  123600. private _midYawConstraint;
  123601. private _minPitchTan;
  123602. private _maxPitchTan;
  123603. private _boneQuat;
  123604. private _slerping;
  123605. private _transformYawPitch;
  123606. private _transformYawPitchInv;
  123607. private _firstFrameSkipped;
  123608. private _yawRange;
  123609. private _fowardAxis;
  123610. /**
  123611. * Gets or sets the minimum yaw angle that the bone can look to
  123612. */
  123613. get minYaw(): number;
  123614. set minYaw(value: number);
  123615. /**
  123616. * Gets or sets the maximum yaw angle that the bone can look to
  123617. */
  123618. get maxYaw(): number;
  123619. set maxYaw(value: number);
  123620. /**
  123621. * Gets or sets the minimum pitch angle that the bone can look to
  123622. */
  123623. get minPitch(): number;
  123624. set minPitch(value: number);
  123625. /**
  123626. * Gets or sets the maximum pitch angle that the bone can look to
  123627. */
  123628. get maxPitch(): number;
  123629. set maxPitch(value: number);
  123630. /**
  123631. * Create a BoneLookController
  123632. * @param mesh the mesh that the bone belongs to
  123633. * @param bone the bone that will be looking to the target
  123634. * @param target the target Vector3 to look at
  123635. * @param options optional settings:
  123636. * * maxYaw: the maximum angle the bone will yaw to
  123637. * * minYaw: the minimum angle the bone will yaw to
  123638. * * maxPitch: the maximum angle the bone will pitch to
  123639. * * minPitch: the minimum angle the bone will yaw to
  123640. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123641. * * upAxis: the up axis of the coordinate system
  123642. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123643. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123644. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123645. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123646. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123647. * * adjustRoll: used to make an adjustment to the roll of the bone
  123648. **/
  123649. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123650. maxYaw?: number;
  123651. minYaw?: number;
  123652. maxPitch?: number;
  123653. minPitch?: number;
  123654. slerpAmount?: number;
  123655. upAxis?: Vector3;
  123656. upAxisSpace?: Space;
  123657. yawAxis?: Vector3;
  123658. pitchAxis?: Vector3;
  123659. adjustYaw?: number;
  123660. adjustPitch?: number;
  123661. adjustRoll?: number;
  123662. });
  123663. /**
  123664. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123665. */
  123666. update(): void;
  123667. private _getAngleDiff;
  123668. private _getAngleBetween;
  123669. private _isAngleBetween;
  123670. }
  123671. }
  123672. declare module BABYLON {
  123673. /**
  123674. * Manage the gamepad inputs to control an arc rotate camera.
  123675. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123676. */
  123677. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123678. /**
  123679. * Defines the camera the input is attached to.
  123680. */
  123681. camera: ArcRotateCamera;
  123682. /**
  123683. * Defines the gamepad the input is gathering event from.
  123684. */
  123685. gamepad: Nullable<Gamepad>;
  123686. /**
  123687. * Defines the gamepad rotation sensiblity.
  123688. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123689. */
  123690. gamepadRotationSensibility: number;
  123691. /**
  123692. * Defines the gamepad move sensiblity.
  123693. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123694. */
  123695. gamepadMoveSensibility: number;
  123696. private _yAxisScale;
  123697. /**
  123698. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123699. */
  123700. get invertYAxis(): boolean;
  123701. set invertYAxis(value: boolean);
  123702. private _onGamepadConnectedObserver;
  123703. private _onGamepadDisconnectedObserver;
  123704. /**
  123705. * Attach the input controls to a specific dom element to get the input from.
  123706. * @param element Defines the element the controls should be listened from
  123707. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123708. */
  123709. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123710. /**
  123711. * Detach the current controls from the specified dom element.
  123712. * @param element Defines the element to stop listening the inputs from
  123713. */
  123714. detachControl(element: Nullable<HTMLElement>): void;
  123715. /**
  123716. * Update the current camera state depending on the inputs that have been used this frame.
  123717. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123718. */
  123719. checkInputs(): void;
  123720. /**
  123721. * Gets the class name of the current intput.
  123722. * @returns the class name
  123723. */
  123724. getClassName(): string;
  123725. /**
  123726. * Get the friendly name associated with the input class.
  123727. * @returns the input friendly name
  123728. */
  123729. getSimpleName(): string;
  123730. }
  123731. }
  123732. declare module BABYLON {
  123733. interface ArcRotateCameraInputsManager {
  123734. /**
  123735. * Add orientation input support to the input manager.
  123736. * @returns the current input manager
  123737. */
  123738. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123739. }
  123740. /**
  123741. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123742. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123743. */
  123744. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123745. /**
  123746. * Defines the camera the input is attached to.
  123747. */
  123748. camera: ArcRotateCamera;
  123749. /**
  123750. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123751. */
  123752. alphaCorrection: number;
  123753. /**
  123754. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123755. */
  123756. gammaCorrection: number;
  123757. private _alpha;
  123758. private _gamma;
  123759. private _dirty;
  123760. private _deviceOrientationHandler;
  123761. /**
  123762. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123763. */
  123764. constructor();
  123765. /**
  123766. * Attach the input controls to a specific dom element to get the input from.
  123767. * @param element Defines the element the controls should be listened from
  123768. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123769. */
  123770. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123771. /** @hidden */
  123772. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123773. /**
  123774. * Update the current camera state depending on the inputs that have been used this frame.
  123775. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123776. */
  123777. checkInputs(): void;
  123778. /**
  123779. * Detach the current controls from the specified dom element.
  123780. * @param element Defines the element to stop listening the inputs from
  123781. */
  123782. detachControl(element: Nullable<HTMLElement>): void;
  123783. /**
  123784. * Gets the class name of the current intput.
  123785. * @returns the class name
  123786. */
  123787. getClassName(): string;
  123788. /**
  123789. * Get the friendly name associated with the input class.
  123790. * @returns the input friendly name
  123791. */
  123792. getSimpleName(): string;
  123793. }
  123794. }
  123795. declare module BABYLON {
  123796. /**
  123797. * Listen to mouse events to control the camera.
  123798. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123799. */
  123800. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123801. /**
  123802. * Defines the camera the input is attached to.
  123803. */
  123804. camera: FlyCamera;
  123805. /**
  123806. * Defines if touch is enabled. (Default is true.)
  123807. */
  123808. touchEnabled: boolean;
  123809. /**
  123810. * Defines the buttons associated with the input to handle camera rotation.
  123811. */
  123812. buttons: number[];
  123813. /**
  123814. * Assign buttons for Yaw control.
  123815. */
  123816. buttonsYaw: number[];
  123817. /**
  123818. * Assign buttons for Pitch control.
  123819. */
  123820. buttonsPitch: number[];
  123821. /**
  123822. * Assign buttons for Roll control.
  123823. */
  123824. buttonsRoll: number[];
  123825. /**
  123826. * Detect if any button is being pressed while mouse is moved.
  123827. * -1 = Mouse locked.
  123828. * 0 = Left button.
  123829. * 1 = Middle Button.
  123830. * 2 = Right Button.
  123831. */
  123832. activeButton: number;
  123833. /**
  123834. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123835. * Higher values reduce its sensitivity.
  123836. */
  123837. angularSensibility: number;
  123838. private _mousemoveCallback;
  123839. private _observer;
  123840. private _rollObserver;
  123841. private previousPosition;
  123842. private noPreventDefault;
  123843. private element;
  123844. /**
  123845. * Listen to mouse events to control the camera.
  123846. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123847. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123848. */
  123849. constructor(touchEnabled?: boolean);
  123850. /**
  123851. * Attach the mouse control to the HTML DOM element.
  123852. * @param element Defines the element that listens to the input events.
  123853. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123854. */
  123855. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123856. /**
  123857. * Detach the current controls from the specified dom element.
  123858. * @param element Defines the element to stop listening the inputs from
  123859. */
  123860. detachControl(element: Nullable<HTMLElement>): void;
  123861. /**
  123862. * Gets the class name of the current input.
  123863. * @returns the class name.
  123864. */
  123865. getClassName(): string;
  123866. /**
  123867. * Get the friendly name associated with the input class.
  123868. * @returns the input's friendly name.
  123869. */
  123870. getSimpleName(): string;
  123871. private _pointerInput;
  123872. private _onMouseMove;
  123873. /**
  123874. * Rotate camera by mouse offset.
  123875. */
  123876. private rotateCamera;
  123877. }
  123878. }
  123879. declare module BABYLON {
  123880. /**
  123881. * Default Inputs manager for the FlyCamera.
  123882. * It groups all the default supported inputs for ease of use.
  123883. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123884. */
  123885. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123886. /**
  123887. * Instantiates a new FlyCameraInputsManager.
  123888. * @param camera Defines the camera the inputs belong to.
  123889. */
  123890. constructor(camera: FlyCamera);
  123891. /**
  123892. * Add keyboard input support to the input manager.
  123893. * @returns the new FlyCameraKeyboardMoveInput().
  123894. */
  123895. addKeyboard(): FlyCameraInputsManager;
  123896. /**
  123897. * Add mouse input support to the input manager.
  123898. * @param touchEnabled Enable touch screen support.
  123899. * @returns the new FlyCameraMouseInput().
  123900. */
  123901. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123902. }
  123903. }
  123904. declare module BABYLON {
  123905. /**
  123906. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123907. * such as in a 3D Space Shooter or a Flight Simulator.
  123908. */
  123909. export class FlyCamera extends TargetCamera {
  123910. /**
  123911. * Define the collision ellipsoid of the camera.
  123912. * This is helpful for simulating a camera body, like a player's body.
  123913. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123914. */
  123915. ellipsoid: Vector3;
  123916. /**
  123917. * Define an offset for the position of the ellipsoid around the camera.
  123918. * This can be helpful if the camera is attached away from the player's body center,
  123919. * such as at its head.
  123920. */
  123921. ellipsoidOffset: Vector3;
  123922. /**
  123923. * Enable or disable collisions of the camera with the rest of the scene objects.
  123924. */
  123925. checkCollisions: boolean;
  123926. /**
  123927. * Enable or disable gravity on the camera.
  123928. */
  123929. applyGravity: boolean;
  123930. /**
  123931. * Define the current direction the camera is moving to.
  123932. */
  123933. cameraDirection: Vector3;
  123934. /**
  123935. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123936. * This overrides and empties cameraRotation.
  123937. */
  123938. rotationQuaternion: Quaternion;
  123939. /**
  123940. * Track Roll to maintain the wanted Rolling when looking around.
  123941. */
  123942. _trackRoll: number;
  123943. /**
  123944. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123945. */
  123946. rollCorrect: number;
  123947. /**
  123948. * Mimic a banked turn, Rolling the camera when Yawing.
  123949. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123950. */
  123951. bankedTurn: boolean;
  123952. /**
  123953. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123954. */
  123955. bankedTurnLimit: number;
  123956. /**
  123957. * Value of 0 disables the banked Roll.
  123958. * Value of 1 is equal to the Yaw angle in radians.
  123959. */
  123960. bankedTurnMultiplier: number;
  123961. /**
  123962. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123963. */
  123964. inputs: FlyCameraInputsManager;
  123965. /**
  123966. * Gets the input sensibility for mouse input.
  123967. * Higher values reduce sensitivity.
  123968. */
  123969. get angularSensibility(): number;
  123970. /**
  123971. * Sets the input sensibility for a mouse input.
  123972. * Higher values reduce sensitivity.
  123973. */
  123974. set angularSensibility(value: number);
  123975. /**
  123976. * Get the keys for camera movement forward.
  123977. */
  123978. get keysForward(): number[];
  123979. /**
  123980. * Set the keys for camera movement forward.
  123981. */
  123982. set keysForward(value: number[]);
  123983. /**
  123984. * Get the keys for camera movement backward.
  123985. */
  123986. get keysBackward(): number[];
  123987. set keysBackward(value: number[]);
  123988. /**
  123989. * Get the keys for camera movement up.
  123990. */
  123991. get keysUp(): number[];
  123992. /**
  123993. * Set the keys for camera movement up.
  123994. */
  123995. set keysUp(value: number[]);
  123996. /**
  123997. * Get the keys for camera movement down.
  123998. */
  123999. get keysDown(): number[];
  124000. /**
  124001. * Set the keys for camera movement down.
  124002. */
  124003. set keysDown(value: number[]);
  124004. /**
  124005. * Get the keys for camera movement left.
  124006. */
  124007. get keysLeft(): number[];
  124008. /**
  124009. * Set the keys for camera movement left.
  124010. */
  124011. set keysLeft(value: number[]);
  124012. /**
  124013. * Set the keys for camera movement right.
  124014. */
  124015. get keysRight(): number[];
  124016. /**
  124017. * Set the keys for camera movement right.
  124018. */
  124019. set keysRight(value: number[]);
  124020. /**
  124021. * Event raised when the camera collides with a mesh in the scene.
  124022. */
  124023. onCollide: (collidedMesh: AbstractMesh) => void;
  124024. private _collider;
  124025. private _needMoveForGravity;
  124026. private _oldPosition;
  124027. private _diffPosition;
  124028. private _newPosition;
  124029. /** @hidden */
  124030. _localDirection: Vector3;
  124031. /** @hidden */
  124032. _transformedDirection: Vector3;
  124033. /**
  124034. * Instantiates a FlyCamera.
  124035. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124036. * such as in a 3D Space Shooter or a Flight Simulator.
  124037. * @param name Define the name of the camera in the scene.
  124038. * @param position Define the starting position of the camera in the scene.
  124039. * @param scene Define the scene the camera belongs to.
  124040. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  124041. */
  124042. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  124043. /**
  124044. * Attach a control to the HTML DOM element.
  124045. * @param element Defines the element that listens to the input events.
  124046. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  124047. */
  124048. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124049. /**
  124050. * Detach a control from the HTML DOM element.
  124051. * The camera will stop reacting to that input.
  124052. * @param element Defines the element that listens to the input events.
  124053. */
  124054. detachControl(element: HTMLElement): void;
  124055. private _collisionMask;
  124056. /**
  124057. * Get the mask that the camera ignores in collision events.
  124058. */
  124059. get collisionMask(): number;
  124060. /**
  124061. * Set the mask that the camera ignores in collision events.
  124062. */
  124063. set collisionMask(mask: number);
  124064. /** @hidden */
  124065. _collideWithWorld(displacement: Vector3): void;
  124066. /** @hidden */
  124067. private _onCollisionPositionChange;
  124068. /** @hidden */
  124069. _checkInputs(): void;
  124070. /** @hidden */
  124071. _decideIfNeedsToMove(): boolean;
  124072. /** @hidden */
  124073. _updatePosition(): void;
  124074. /**
  124075. * Restore the Roll to its target value at the rate specified.
  124076. * @param rate - Higher means slower restoring.
  124077. * @hidden
  124078. */
  124079. restoreRoll(rate: number): void;
  124080. /**
  124081. * Destroy the camera and release the current resources held by it.
  124082. */
  124083. dispose(): void;
  124084. /**
  124085. * Get the current object class name.
  124086. * @returns the class name.
  124087. */
  124088. getClassName(): string;
  124089. }
  124090. }
  124091. declare module BABYLON {
  124092. /**
  124093. * Listen to keyboard events to control the camera.
  124094. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124095. */
  124096. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124097. /**
  124098. * Defines the camera the input is attached to.
  124099. */
  124100. camera: FlyCamera;
  124101. /**
  124102. * The list of keyboard keys used to control the forward move of the camera.
  124103. */
  124104. keysForward: number[];
  124105. /**
  124106. * The list of keyboard keys used to control the backward move of the camera.
  124107. */
  124108. keysBackward: number[];
  124109. /**
  124110. * The list of keyboard keys used to control the forward move of the camera.
  124111. */
  124112. keysUp: number[];
  124113. /**
  124114. * The list of keyboard keys used to control the backward move of the camera.
  124115. */
  124116. keysDown: number[];
  124117. /**
  124118. * The list of keyboard keys used to control the right strafe move of the camera.
  124119. */
  124120. keysRight: number[];
  124121. /**
  124122. * The list of keyboard keys used to control the left strafe move of the camera.
  124123. */
  124124. keysLeft: number[];
  124125. private _keys;
  124126. private _onCanvasBlurObserver;
  124127. private _onKeyboardObserver;
  124128. private _engine;
  124129. private _scene;
  124130. /**
  124131. * Attach the input controls to a specific dom element to get the input from.
  124132. * @param element Defines the element the controls should be listened from
  124133. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124134. */
  124135. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124136. /**
  124137. * Detach the current controls from the specified dom element.
  124138. * @param element Defines the element to stop listening the inputs from
  124139. */
  124140. detachControl(element: Nullable<HTMLElement>): void;
  124141. /**
  124142. * Gets the class name of the current intput.
  124143. * @returns the class name
  124144. */
  124145. getClassName(): string;
  124146. /** @hidden */
  124147. _onLostFocus(e: FocusEvent): void;
  124148. /**
  124149. * Get the friendly name associated with the input class.
  124150. * @returns the input friendly name
  124151. */
  124152. getSimpleName(): string;
  124153. /**
  124154. * Update the current camera state depending on the inputs that have been used this frame.
  124155. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124156. */
  124157. checkInputs(): void;
  124158. }
  124159. }
  124160. declare module BABYLON {
  124161. /**
  124162. * Manage the mouse wheel inputs to control a follow camera.
  124163. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124164. */
  124165. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124166. /**
  124167. * Defines the camera the input is attached to.
  124168. */
  124169. camera: FollowCamera;
  124170. /**
  124171. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124172. */
  124173. axisControlRadius: boolean;
  124174. /**
  124175. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124176. */
  124177. axisControlHeight: boolean;
  124178. /**
  124179. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124180. */
  124181. axisControlRotation: boolean;
  124182. /**
  124183. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124184. * relation to mouseWheel events.
  124185. */
  124186. wheelPrecision: number;
  124187. /**
  124188. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124189. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124190. */
  124191. wheelDeltaPercentage: number;
  124192. private _wheel;
  124193. private _observer;
  124194. /**
  124195. * Attach the input controls to a specific dom element to get the input from.
  124196. * @param element Defines the element the controls should be listened from
  124197. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124198. */
  124199. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124200. /**
  124201. * Detach the current controls from the specified dom element.
  124202. * @param element Defines the element to stop listening the inputs from
  124203. */
  124204. detachControl(element: Nullable<HTMLElement>): void;
  124205. /**
  124206. * Gets the class name of the current intput.
  124207. * @returns the class name
  124208. */
  124209. getClassName(): string;
  124210. /**
  124211. * Get the friendly name associated with the input class.
  124212. * @returns the input friendly name
  124213. */
  124214. getSimpleName(): string;
  124215. }
  124216. }
  124217. declare module BABYLON {
  124218. /**
  124219. * Manage the pointers inputs to control an follow camera.
  124220. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124221. */
  124222. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124223. /**
  124224. * Defines the camera the input is attached to.
  124225. */
  124226. camera: FollowCamera;
  124227. /**
  124228. * Gets the class name of the current input.
  124229. * @returns the class name
  124230. */
  124231. getClassName(): string;
  124232. /**
  124233. * Defines the pointer angular sensibility along the X axis or how fast is
  124234. * the camera rotating.
  124235. * A negative number will reverse the axis direction.
  124236. */
  124237. angularSensibilityX: number;
  124238. /**
  124239. * Defines the pointer angular sensibility along the Y axis or how fast is
  124240. * the camera rotating.
  124241. * A negative number will reverse the axis direction.
  124242. */
  124243. angularSensibilityY: number;
  124244. /**
  124245. * Defines the pointer pinch precision or how fast is the camera zooming.
  124246. * A negative number will reverse the axis direction.
  124247. */
  124248. pinchPrecision: number;
  124249. /**
  124250. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124251. * from 0.
  124252. * It defines the percentage of current camera.radius to use as delta when
  124253. * pinch zoom is used.
  124254. */
  124255. pinchDeltaPercentage: number;
  124256. /**
  124257. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124258. */
  124259. axisXControlRadius: boolean;
  124260. /**
  124261. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124262. */
  124263. axisXControlHeight: boolean;
  124264. /**
  124265. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124266. */
  124267. axisXControlRotation: boolean;
  124268. /**
  124269. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124270. */
  124271. axisYControlRadius: boolean;
  124272. /**
  124273. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124274. */
  124275. axisYControlHeight: boolean;
  124276. /**
  124277. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124278. */
  124279. axisYControlRotation: boolean;
  124280. /**
  124281. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124282. */
  124283. axisPinchControlRadius: boolean;
  124284. /**
  124285. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124286. */
  124287. axisPinchControlHeight: boolean;
  124288. /**
  124289. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124290. */
  124291. axisPinchControlRotation: boolean;
  124292. /**
  124293. * Log error messages if basic misconfiguration has occurred.
  124294. */
  124295. warningEnable: boolean;
  124296. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124297. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124298. private _warningCounter;
  124299. private _warning;
  124300. }
  124301. }
  124302. declare module BABYLON {
  124303. /**
  124304. * Default Inputs manager for the FollowCamera.
  124305. * It groups all the default supported inputs for ease of use.
  124306. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124307. */
  124308. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124309. /**
  124310. * Instantiates a new FollowCameraInputsManager.
  124311. * @param camera Defines the camera the inputs belong to
  124312. */
  124313. constructor(camera: FollowCamera);
  124314. /**
  124315. * Add keyboard input support to the input manager.
  124316. * @returns the current input manager
  124317. */
  124318. addKeyboard(): FollowCameraInputsManager;
  124319. /**
  124320. * Add mouse wheel input support to the input manager.
  124321. * @returns the current input manager
  124322. */
  124323. addMouseWheel(): FollowCameraInputsManager;
  124324. /**
  124325. * Add pointers input support to the input manager.
  124326. * @returns the current input manager
  124327. */
  124328. addPointers(): FollowCameraInputsManager;
  124329. /**
  124330. * Add orientation input support to the input manager.
  124331. * @returns the current input manager
  124332. */
  124333. addVRDeviceOrientation(): FollowCameraInputsManager;
  124334. }
  124335. }
  124336. declare module BABYLON {
  124337. /**
  124338. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124339. * an arc rotate version arcFollowCamera are available.
  124340. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124341. */
  124342. export class FollowCamera extends TargetCamera {
  124343. /**
  124344. * Distance the follow camera should follow an object at
  124345. */
  124346. radius: number;
  124347. /**
  124348. * Minimum allowed distance of the camera to the axis of rotation
  124349. * (The camera can not get closer).
  124350. * This can help limiting how the Camera is able to move in the scene.
  124351. */
  124352. lowerRadiusLimit: Nullable<number>;
  124353. /**
  124354. * Maximum allowed distance of the camera to the axis of rotation
  124355. * (The camera can not get further).
  124356. * This can help limiting how the Camera is able to move in the scene.
  124357. */
  124358. upperRadiusLimit: Nullable<number>;
  124359. /**
  124360. * Define a rotation offset between the camera and the object it follows
  124361. */
  124362. rotationOffset: number;
  124363. /**
  124364. * Minimum allowed angle to camera position relative to target object.
  124365. * This can help limiting how the Camera is able to move in the scene.
  124366. */
  124367. lowerRotationOffsetLimit: Nullable<number>;
  124368. /**
  124369. * Maximum allowed angle to camera position relative to target object.
  124370. * This can help limiting how the Camera is able to move in the scene.
  124371. */
  124372. upperRotationOffsetLimit: Nullable<number>;
  124373. /**
  124374. * Define a height offset between the camera and the object it follows.
  124375. * It can help following an object from the top (like a car chaing a plane)
  124376. */
  124377. heightOffset: number;
  124378. /**
  124379. * Minimum allowed height of camera position relative to target object.
  124380. * This can help limiting how the Camera is able to move in the scene.
  124381. */
  124382. lowerHeightOffsetLimit: Nullable<number>;
  124383. /**
  124384. * Maximum allowed height of camera position relative to target object.
  124385. * This can help limiting how the Camera is able to move in the scene.
  124386. */
  124387. upperHeightOffsetLimit: Nullable<number>;
  124388. /**
  124389. * Define how fast the camera can accelerate to follow it s target.
  124390. */
  124391. cameraAcceleration: number;
  124392. /**
  124393. * Define the speed limit of the camera following an object.
  124394. */
  124395. maxCameraSpeed: number;
  124396. /**
  124397. * Define the target of the camera.
  124398. */
  124399. lockedTarget: Nullable<AbstractMesh>;
  124400. /**
  124401. * Defines the input associated with the camera.
  124402. */
  124403. inputs: FollowCameraInputsManager;
  124404. /**
  124405. * Instantiates the follow camera.
  124406. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124407. * @param name Define the name of the camera in the scene
  124408. * @param position Define the position of the camera
  124409. * @param scene Define the scene the camera belong to
  124410. * @param lockedTarget Define the target of the camera
  124411. */
  124412. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124413. private _follow;
  124414. /**
  124415. * Attached controls to the current camera.
  124416. * @param element Defines the element the controls should be listened from
  124417. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124418. */
  124419. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124420. /**
  124421. * Detach the current controls from the camera.
  124422. * The camera will stop reacting to inputs.
  124423. * @param element Defines the element to stop listening the inputs from
  124424. */
  124425. detachControl(element: HTMLElement): void;
  124426. /** @hidden */
  124427. _checkInputs(): void;
  124428. private _checkLimits;
  124429. /**
  124430. * Gets the camera class name.
  124431. * @returns the class name
  124432. */
  124433. getClassName(): string;
  124434. }
  124435. /**
  124436. * Arc Rotate version of the follow camera.
  124437. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124438. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124439. */
  124440. export class ArcFollowCamera extends TargetCamera {
  124441. /** The longitudinal angle of the camera */
  124442. alpha: number;
  124443. /** The latitudinal angle of the camera */
  124444. beta: number;
  124445. /** The radius of the camera from its target */
  124446. radius: number;
  124447. private _cartesianCoordinates;
  124448. /** Define the camera target (the mesh it should follow) */
  124449. private _meshTarget;
  124450. /**
  124451. * Instantiates a new ArcFollowCamera
  124452. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124453. * @param name Define the name of the camera
  124454. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124455. * @param beta Define the rotation angle of the camera around the elevation axis
  124456. * @param radius Define the radius of the camera from its target point
  124457. * @param target Define the target of the camera
  124458. * @param scene Define the scene the camera belongs to
  124459. */
  124460. constructor(name: string,
  124461. /** The longitudinal angle of the camera */
  124462. alpha: number,
  124463. /** The latitudinal angle of the camera */
  124464. beta: number,
  124465. /** The radius of the camera from its target */
  124466. radius: number,
  124467. /** Define the camera target (the mesh it should follow) */
  124468. target: Nullable<AbstractMesh>, scene: Scene);
  124469. private _follow;
  124470. /** @hidden */
  124471. _checkInputs(): void;
  124472. /**
  124473. * Returns the class name of the object.
  124474. * It is mostly used internally for serialization purposes.
  124475. */
  124476. getClassName(): string;
  124477. }
  124478. }
  124479. declare module BABYLON {
  124480. /**
  124481. * Manage the keyboard inputs to control the movement of a follow camera.
  124482. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124483. */
  124484. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124485. /**
  124486. * Defines the camera the input is attached to.
  124487. */
  124488. camera: FollowCamera;
  124489. /**
  124490. * Defines the list of key codes associated with the up action (increase heightOffset)
  124491. */
  124492. keysHeightOffsetIncr: number[];
  124493. /**
  124494. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124495. */
  124496. keysHeightOffsetDecr: number[];
  124497. /**
  124498. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124499. */
  124500. keysHeightOffsetModifierAlt: boolean;
  124501. /**
  124502. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124503. */
  124504. keysHeightOffsetModifierCtrl: boolean;
  124505. /**
  124506. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124507. */
  124508. keysHeightOffsetModifierShift: boolean;
  124509. /**
  124510. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124511. */
  124512. keysRotationOffsetIncr: number[];
  124513. /**
  124514. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124515. */
  124516. keysRotationOffsetDecr: number[];
  124517. /**
  124518. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124519. */
  124520. keysRotationOffsetModifierAlt: boolean;
  124521. /**
  124522. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124523. */
  124524. keysRotationOffsetModifierCtrl: boolean;
  124525. /**
  124526. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124527. */
  124528. keysRotationOffsetModifierShift: boolean;
  124529. /**
  124530. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124531. */
  124532. keysRadiusIncr: number[];
  124533. /**
  124534. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124535. */
  124536. keysRadiusDecr: number[];
  124537. /**
  124538. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124539. */
  124540. keysRadiusModifierAlt: boolean;
  124541. /**
  124542. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124543. */
  124544. keysRadiusModifierCtrl: boolean;
  124545. /**
  124546. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124547. */
  124548. keysRadiusModifierShift: boolean;
  124549. /**
  124550. * Defines the rate of change of heightOffset.
  124551. */
  124552. heightSensibility: number;
  124553. /**
  124554. * Defines the rate of change of rotationOffset.
  124555. */
  124556. rotationSensibility: number;
  124557. /**
  124558. * Defines the rate of change of radius.
  124559. */
  124560. radiusSensibility: number;
  124561. private _keys;
  124562. private _ctrlPressed;
  124563. private _altPressed;
  124564. private _shiftPressed;
  124565. private _onCanvasBlurObserver;
  124566. private _onKeyboardObserver;
  124567. private _engine;
  124568. private _scene;
  124569. /**
  124570. * Attach the input controls to a specific dom element to get the input from.
  124571. * @param element Defines the element the controls should be listened from
  124572. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124573. */
  124574. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124575. /**
  124576. * Detach the current controls from the specified dom element.
  124577. * @param element Defines the element to stop listening the inputs from
  124578. */
  124579. detachControl(element: Nullable<HTMLElement>): void;
  124580. /**
  124581. * Update the current camera state depending on the inputs that have been used this frame.
  124582. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124583. */
  124584. checkInputs(): void;
  124585. /**
  124586. * Gets the class name of the current input.
  124587. * @returns the class name
  124588. */
  124589. getClassName(): string;
  124590. /**
  124591. * Get the friendly name associated with the input class.
  124592. * @returns the input friendly name
  124593. */
  124594. getSimpleName(): string;
  124595. /**
  124596. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124597. * allow modification of the heightOffset value.
  124598. */
  124599. private _modifierHeightOffset;
  124600. /**
  124601. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124602. * allow modification of the rotationOffset value.
  124603. */
  124604. private _modifierRotationOffset;
  124605. /**
  124606. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124607. * allow modification of the radius value.
  124608. */
  124609. private _modifierRadius;
  124610. }
  124611. }
  124612. declare module BABYLON {
  124613. interface FreeCameraInputsManager {
  124614. /**
  124615. * @hidden
  124616. */
  124617. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124618. /**
  124619. * Add orientation input support to the input manager.
  124620. * @returns the current input manager
  124621. */
  124622. addDeviceOrientation(): FreeCameraInputsManager;
  124623. }
  124624. /**
  124625. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124626. * Screen rotation is taken into account.
  124627. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124628. */
  124629. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124630. private _camera;
  124631. private _screenOrientationAngle;
  124632. private _constantTranform;
  124633. private _screenQuaternion;
  124634. private _alpha;
  124635. private _beta;
  124636. private _gamma;
  124637. /**
  124638. * Can be used to detect if a device orientation sensor is available on a device
  124639. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124640. * @returns a promise that will resolve on orientation change
  124641. */
  124642. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124643. /**
  124644. * @hidden
  124645. */
  124646. _onDeviceOrientationChangedObservable: Observable<void>;
  124647. /**
  124648. * Instantiates a new input
  124649. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124650. */
  124651. constructor();
  124652. /**
  124653. * Define the camera controlled by the input.
  124654. */
  124655. get camera(): FreeCamera;
  124656. set camera(camera: FreeCamera);
  124657. /**
  124658. * Attach the input controls to a specific dom element to get the input from.
  124659. * @param element Defines the element the controls should be listened from
  124660. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124661. */
  124662. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124663. private _orientationChanged;
  124664. private _deviceOrientation;
  124665. /**
  124666. * Detach the current controls from the specified dom element.
  124667. * @param element Defines the element to stop listening the inputs from
  124668. */
  124669. detachControl(element: Nullable<HTMLElement>): void;
  124670. /**
  124671. * Update the current camera state depending on the inputs that have been used this frame.
  124672. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124673. */
  124674. checkInputs(): void;
  124675. /**
  124676. * Gets the class name of the current intput.
  124677. * @returns the class name
  124678. */
  124679. getClassName(): string;
  124680. /**
  124681. * Get the friendly name associated with the input class.
  124682. * @returns the input friendly name
  124683. */
  124684. getSimpleName(): string;
  124685. }
  124686. }
  124687. declare module BABYLON {
  124688. /**
  124689. * Manage the gamepad inputs to control a free camera.
  124690. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124691. */
  124692. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124693. /**
  124694. * Define the camera the input is attached to.
  124695. */
  124696. camera: FreeCamera;
  124697. /**
  124698. * Define the Gamepad controlling the input
  124699. */
  124700. gamepad: Nullable<Gamepad>;
  124701. /**
  124702. * Defines the gamepad rotation sensiblity.
  124703. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124704. */
  124705. gamepadAngularSensibility: number;
  124706. /**
  124707. * Defines the gamepad move sensiblity.
  124708. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124709. */
  124710. gamepadMoveSensibility: number;
  124711. private _yAxisScale;
  124712. /**
  124713. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124714. */
  124715. get invertYAxis(): boolean;
  124716. set invertYAxis(value: boolean);
  124717. private _onGamepadConnectedObserver;
  124718. private _onGamepadDisconnectedObserver;
  124719. private _cameraTransform;
  124720. private _deltaTransform;
  124721. private _vector3;
  124722. private _vector2;
  124723. /**
  124724. * Attach the input controls to a specific dom element to get the input from.
  124725. * @param element Defines the element the controls should be listened from
  124726. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124727. */
  124728. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124729. /**
  124730. * Detach the current controls from the specified dom element.
  124731. * @param element Defines the element to stop listening the inputs from
  124732. */
  124733. detachControl(element: Nullable<HTMLElement>): void;
  124734. /**
  124735. * Update the current camera state depending on the inputs that have been used this frame.
  124736. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124737. */
  124738. checkInputs(): void;
  124739. /**
  124740. * Gets the class name of the current intput.
  124741. * @returns the class name
  124742. */
  124743. getClassName(): string;
  124744. /**
  124745. * Get the friendly name associated with the input class.
  124746. * @returns the input friendly name
  124747. */
  124748. getSimpleName(): string;
  124749. }
  124750. }
  124751. declare module BABYLON {
  124752. /**
  124753. * Defines the potential axis of a Joystick
  124754. */
  124755. export enum JoystickAxis {
  124756. /** X axis */
  124757. X = 0,
  124758. /** Y axis */
  124759. Y = 1,
  124760. /** Z axis */
  124761. Z = 2
  124762. }
  124763. /**
  124764. * Represents the different customization options available
  124765. * for VirtualJoystick
  124766. */
  124767. interface VirtualJoystickCustomizations {
  124768. /**
  124769. * Size of the joystick's puck
  124770. */
  124771. puckSize: number;
  124772. /**
  124773. * Size of the joystick's container
  124774. */
  124775. containerSize: number;
  124776. /**
  124777. * Color of the joystick && puck
  124778. */
  124779. color: string;
  124780. /**
  124781. * Image URL for the joystick's puck
  124782. */
  124783. puckImage?: string;
  124784. /**
  124785. * Image URL for the joystick's container
  124786. */
  124787. containerImage?: string;
  124788. /**
  124789. * Defines the unmoving position of the joystick container
  124790. */
  124791. position?: {
  124792. x: number;
  124793. y: number;
  124794. };
  124795. /**
  124796. * Defines whether or not the joystick container is always visible
  124797. */
  124798. alwaysVisible: boolean;
  124799. /**
  124800. * Defines whether or not to limit the movement of the puck to the joystick's container
  124801. */
  124802. limitToContainer: boolean;
  124803. }
  124804. /**
  124805. * Class used to define virtual joystick (used in touch mode)
  124806. */
  124807. export class VirtualJoystick {
  124808. /**
  124809. * Gets or sets a boolean indicating that left and right values must be inverted
  124810. */
  124811. reverseLeftRight: boolean;
  124812. /**
  124813. * Gets or sets a boolean indicating that up and down values must be inverted
  124814. */
  124815. reverseUpDown: boolean;
  124816. /**
  124817. * Gets the offset value for the position (ie. the change of the position value)
  124818. */
  124819. deltaPosition: Vector3;
  124820. /**
  124821. * Gets a boolean indicating if the virtual joystick was pressed
  124822. */
  124823. pressed: boolean;
  124824. /**
  124825. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124826. */
  124827. static Canvas: Nullable<HTMLCanvasElement>;
  124828. /**
  124829. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124830. */
  124831. limitToContainer: boolean;
  124832. private static _globalJoystickIndex;
  124833. private static _alwaysVisibleSticks;
  124834. private static vjCanvasContext;
  124835. private static vjCanvasWidth;
  124836. private static vjCanvasHeight;
  124837. private static halfWidth;
  124838. private static _GetDefaultOptions;
  124839. private _action;
  124840. private _axisTargetedByLeftAndRight;
  124841. private _axisTargetedByUpAndDown;
  124842. private _joystickSensibility;
  124843. private _inversedSensibility;
  124844. private _joystickPointerID;
  124845. private _joystickColor;
  124846. private _joystickPointerPos;
  124847. private _joystickPreviousPointerPos;
  124848. private _joystickPointerStartPos;
  124849. private _deltaJoystickVector;
  124850. private _leftJoystick;
  124851. private _touches;
  124852. private _joystickPosition;
  124853. private _alwaysVisible;
  124854. private _puckImage;
  124855. private _containerImage;
  124856. private _joystickPuckSize;
  124857. private _joystickContainerSize;
  124858. private _clearPuckSize;
  124859. private _clearContainerSize;
  124860. private _clearPuckSizeOffset;
  124861. private _clearContainerSizeOffset;
  124862. private _onPointerDownHandlerRef;
  124863. private _onPointerMoveHandlerRef;
  124864. private _onPointerUpHandlerRef;
  124865. private _onResize;
  124866. /**
  124867. * Creates a new virtual joystick
  124868. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124869. * @param customizations Defines the options we want to customize the VirtualJoystick
  124870. */
  124871. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124872. /**
  124873. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124874. * @param newJoystickSensibility defines the new sensibility
  124875. */
  124876. setJoystickSensibility(newJoystickSensibility: number): void;
  124877. private _onPointerDown;
  124878. private _onPointerMove;
  124879. private _onPointerUp;
  124880. /**
  124881. * Change the color of the virtual joystick
  124882. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124883. */
  124884. setJoystickColor(newColor: string): void;
  124885. /**
  124886. * Size of the joystick's container
  124887. */
  124888. set containerSize(newSize: number);
  124889. get containerSize(): number;
  124890. /**
  124891. * Size of the joystick's puck
  124892. */
  124893. set puckSize(newSize: number);
  124894. get puckSize(): number;
  124895. /**
  124896. * Clears the set position of the joystick
  124897. */
  124898. clearPosition(): void;
  124899. /**
  124900. * Defines whether or not the joystick container is always visible
  124901. */
  124902. set alwaysVisible(value: boolean);
  124903. get alwaysVisible(): boolean;
  124904. /**
  124905. * Sets the constant position of the Joystick container
  124906. * @param x X axis coordinate
  124907. * @param y Y axis coordinate
  124908. */
  124909. setPosition(x: number, y: number): void;
  124910. /**
  124911. * Defines a callback to call when the joystick is touched
  124912. * @param action defines the callback
  124913. */
  124914. setActionOnTouch(action: () => any): void;
  124915. /**
  124916. * Defines which axis you'd like to control for left & right
  124917. * @param axis defines the axis to use
  124918. */
  124919. setAxisForLeftRight(axis: JoystickAxis): void;
  124920. /**
  124921. * Defines which axis you'd like to control for up & down
  124922. * @param axis defines the axis to use
  124923. */
  124924. setAxisForUpDown(axis: JoystickAxis): void;
  124925. /**
  124926. * Clears the canvas from the previous puck / container draw
  124927. */
  124928. private _clearPreviousDraw;
  124929. /**
  124930. * Loads `urlPath` to be used for the container's image
  124931. * @param urlPath defines the urlPath of an image to use
  124932. */
  124933. setContainerImage(urlPath: string): void;
  124934. /**
  124935. * Loads `urlPath` to be used for the puck's image
  124936. * @param urlPath defines the urlPath of an image to use
  124937. */
  124938. setPuckImage(urlPath: string): void;
  124939. /**
  124940. * Draws the Virtual Joystick's container
  124941. */
  124942. private _drawContainer;
  124943. /**
  124944. * Draws the Virtual Joystick's puck
  124945. */
  124946. private _drawPuck;
  124947. private _drawVirtualJoystick;
  124948. /**
  124949. * Release internal HTML canvas
  124950. */
  124951. releaseCanvas(): void;
  124952. }
  124953. }
  124954. declare module BABYLON {
  124955. interface FreeCameraInputsManager {
  124956. /**
  124957. * Add virtual joystick input support to the input manager.
  124958. * @returns the current input manager
  124959. */
  124960. addVirtualJoystick(): FreeCameraInputsManager;
  124961. }
  124962. /**
  124963. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124964. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124965. */
  124966. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124967. /**
  124968. * Defines the camera the input is attached to.
  124969. */
  124970. camera: FreeCamera;
  124971. private _leftjoystick;
  124972. private _rightjoystick;
  124973. /**
  124974. * Gets the left stick of the virtual joystick.
  124975. * @returns The virtual Joystick
  124976. */
  124977. getLeftJoystick(): VirtualJoystick;
  124978. /**
  124979. * Gets the right stick of the virtual joystick.
  124980. * @returns The virtual Joystick
  124981. */
  124982. getRightJoystick(): VirtualJoystick;
  124983. /**
  124984. * Update the current camera state depending on the inputs that have been used this frame.
  124985. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124986. */
  124987. checkInputs(): void;
  124988. /**
  124989. * Attach the input controls to a specific dom element to get the input from.
  124990. * @param element Defines the element the controls should be listened from
  124991. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124992. */
  124993. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124994. /**
  124995. * Detach the current controls from the specified dom element.
  124996. * @param element Defines the element to stop listening the inputs from
  124997. */
  124998. detachControl(element: Nullable<HTMLElement>): void;
  124999. /**
  125000. * Gets the class name of the current intput.
  125001. * @returns the class name
  125002. */
  125003. getClassName(): string;
  125004. /**
  125005. * Get the friendly name associated with the input class.
  125006. * @returns the input friendly name
  125007. */
  125008. getSimpleName(): string;
  125009. }
  125010. }
  125011. declare module BABYLON {
  125012. /**
  125013. * This represents a FPS type of camera controlled by touch.
  125014. * This is like a universal camera minus the Gamepad controls.
  125015. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125016. */
  125017. export class TouchCamera extends FreeCamera {
  125018. /**
  125019. * Defines the touch sensibility for rotation.
  125020. * The higher the faster.
  125021. */
  125022. get touchAngularSensibility(): number;
  125023. set touchAngularSensibility(value: number);
  125024. /**
  125025. * Defines the touch sensibility for move.
  125026. * The higher the faster.
  125027. */
  125028. get touchMoveSensibility(): number;
  125029. set touchMoveSensibility(value: number);
  125030. /**
  125031. * Instantiates a new touch camera.
  125032. * This represents a FPS type of camera controlled by touch.
  125033. * This is like a universal camera minus the Gamepad controls.
  125034. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125035. * @param name Define the name of the camera in the scene
  125036. * @param position Define the start position of the camera in the scene
  125037. * @param scene Define the scene the camera belongs to
  125038. */
  125039. constructor(name: string, position: Vector3, scene: Scene);
  125040. /**
  125041. * Gets the current object class name.
  125042. * @return the class name
  125043. */
  125044. getClassName(): string;
  125045. /** @hidden */
  125046. _setupInputs(): void;
  125047. }
  125048. }
  125049. declare module BABYLON {
  125050. /**
  125051. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  125052. * being tilted forward or back and left or right.
  125053. */
  125054. export class DeviceOrientationCamera extends FreeCamera {
  125055. private _initialQuaternion;
  125056. private _quaternionCache;
  125057. private _tmpDragQuaternion;
  125058. private _disablePointerInputWhenUsingDeviceOrientation;
  125059. /**
  125060. * Creates a new device orientation camera
  125061. * @param name The name of the camera
  125062. * @param position The start position camera
  125063. * @param scene The scene the camera belongs to
  125064. */
  125065. constructor(name: string, position: Vector3, scene: Scene);
  125066. /**
  125067. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  125068. */
  125069. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  125070. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  125071. private _dragFactor;
  125072. /**
  125073. * Enabled turning on the y axis when the orientation sensor is active
  125074. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  125075. */
  125076. enableHorizontalDragging(dragFactor?: number): void;
  125077. /**
  125078. * Gets the current instance class name ("DeviceOrientationCamera").
  125079. * This helps avoiding instanceof at run time.
  125080. * @returns the class name
  125081. */
  125082. getClassName(): string;
  125083. /**
  125084. * @hidden
  125085. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  125086. */
  125087. _checkInputs(): void;
  125088. /**
  125089. * Reset the camera to its default orientation on the specified axis only.
  125090. * @param axis The axis to reset
  125091. */
  125092. resetToCurrentRotation(axis?: Axis): void;
  125093. }
  125094. }
  125095. declare module BABYLON {
  125096. /**
  125097. * Defines supported buttons for XBox360 compatible gamepads
  125098. */
  125099. export enum Xbox360Button {
  125100. /** A */
  125101. A = 0,
  125102. /** B */
  125103. B = 1,
  125104. /** X */
  125105. X = 2,
  125106. /** Y */
  125107. Y = 3,
  125108. /** Left button */
  125109. LB = 4,
  125110. /** Right button */
  125111. RB = 5,
  125112. /** Back */
  125113. Back = 8,
  125114. /** Start */
  125115. Start = 9,
  125116. /** Left stick */
  125117. LeftStick = 10,
  125118. /** Right stick */
  125119. RightStick = 11
  125120. }
  125121. /** Defines values for XBox360 DPad */
  125122. export enum Xbox360Dpad {
  125123. /** Up */
  125124. Up = 12,
  125125. /** Down */
  125126. Down = 13,
  125127. /** Left */
  125128. Left = 14,
  125129. /** Right */
  125130. Right = 15
  125131. }
  125132. /**
  125133. * Defines a XBox360 gamepad
  125134. */
  125135. export class Xbox360Pad extends Gamepad {
  125136. private _leftTrigger;
  125137. private _rightTrigger;
  125138. private _onlefttriggerchanged;
  125139. private _onrighttriggerchanged;
  125140. private _onbuttondown;
  125141. private _onbuttonup;
  125142. private _ondpaddown;
  125143. private _ondpadup;
  125144. /** Observable raised when a button is pressed */
  125145. onButtonDownObservable: Observable<Xbox360Button>;
  125146. /** Observable raised when a button is released */
  125147. onButtonUpObservable: Observable<Xbox360Button>;
  125148. /** Observable raised when a pad is pressed */
  125149. onPadDownObservable: Observable<Xbox360Dpad>;
  125150. /** Observable raised when a pad is released */
  125151. onPadUpObservable: Observable<Xbox360Dpad>;
  125152. private _buttonA;
  125153. private _buttonB;
  125154. private _buttonX;
  125155. private _buttonY;
  125156. private _buttonBack;
  125157. private _buttonStart;
  125158. private _buttonLB;
  125159. private _buttonRB;
  125160. private _buttonLeftStick;
  125161. private _buttonRightStick;
  125162. private _dPadUp;
  125163. private _dPadDown;
  125164. private _dPadLeft;
  125165. private _dPadRight;
  125166. private _isXboxOnePad;
  125167. /**
  125168. * Creates a new XBox360 gamepad object
  125169. * @param id defines the id of this gamepad
  125170. * @param index defines its index
  125171. * @param gamepad defines the internal HTML gamepad object
  125172. * @param xboxOne defines if it is a XBox One gamepad
  125173. */
  125174. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125175. /**
  125176. * Defines the callback to call when left trigger is pressed
  125177. * @param callback defines the callback to use
  125178. */
  125179. onlefttriggerchanged(callback: (value: number) => void): void;
  125180. /**
  125181. * Defines the callback to call when right trigger is pressed
  125182. * @param callback defines the callback to use
  125183. */
  125184. onrighttriggerchanged(callback: (value: number) => void): void;
  125185. /**
  125186. * Gets the left trigger value
  125187. */
  125188. get leftTrigger(): number;
  125189. /**
  125190. * Sets the left trigger value
  125191. */
  125192. set leftTrigger(newValue: number);
  125193. /**
  125194. * Gets the right trigger value
  125195. */
  125196. get rightTrigger(): number;
  125197. /**
  125198. * Sets the right trigger value
  125199. */
  125200. set rightTrigger(newValue: number);
  125201. /**
  125202. * Defines the callback to call when a button is pressed
  125203. * @param callback defines the callback to use
  125204. */
  125205. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125206. /**
  125207. * Defines the callback to call when a button is released
  125208. * @param callback defines the callback to use
  125209. */
  125210. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125211. /**
  125212. * Defines the callback to call when a pad is pressed
  125213. * @param callback defines the callback to use
  125214. */
  125215. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125216. /**
  125217. * Defines the callback to call when a pad is released
  125218. * @param callback defines the callback to use
  125219. */
  125220. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125221. private _setButtonValue;
  125222. private _setDPadValue;
  125223. /**
  125224. * Gets the value of the `A` button
  125225. */
  125226. get buttonA(): number;
  125227. /**
  125228. * Sets the value of the `A` button
  125229. */
  125230. set buttonA(value: number);
  125231. /**
  125232. * Gets the value of the `B` button
  125233. */
  125234. get buttonB(): number;
  125235. /**
  125236. * Sets the value of the `B` button
  125237. */
  125238. set buttonB(value: number);
  125239. /**
  125240. * Gets the value of the `X` button
  125241. */
  125242. get buttonX(): number;
  125243. /**
  125244. * Sets the value of the `X` button
  125245. */
  125246. set buttonX(value: number);
  125247. /**
  125248. * Gets the value of the `Y` button
  125249. */
  125250. get buttonY(): number;
  125251. /**
  125252. * Sets the value of the `Y` button
  125253. */
  125254. set buttonY(value: number);
  125255. /**
  125256. * Gets the value of the `Start` button
  125257. */
  125258. get buttonStart(): number;
  125259. /**
  125260. * Sets the value of the `Start` button
  125261. */
  125262. set buttonStart(value: number);
  125263. /**
  125264. * Gets the value of the `Back` button
  125265. */
  125266. get buttonBack(): number;
  125267. /**
  125268. * Sets the value of the `Back` button
  125269. */
  125270. set buttonBack(value: number);
  125271. /**
  125272. * Gets the value of the `Left` button
  125273. */
  125274. get buttonLB(): number;
  125275. /**
  125276. * Sets the value of the `Left` button
  125277. */
  125278. set buttonLB(value: number);
  125279. /**
  125280. * Gets the value of the `Right` button
  125281. */
  125282. get buttonRB(): number;
  125283. /**
  125284. * Sets the value of the `Right` button
  125285. */
  125286. set buttonRB(value: number);
  125287. /**
  125288. * Gets the value of the Left joystick
  125289. */
  125290. get buttonLeftStick(): number;
  125291. /**
  125292. * Sets the value of the Left joystick
  125293. */
  125294. set buttonLeftStick(value: number);
  125295. /**
  125296. * Gets the value of the Right joystick
  125297. */
  125298. get buttonRightStick(): number;
  125299. /**
  125300. * Sets the value of the Right joystick
  125301. */
  125302. set buttonRightStick(value: number);
  125303. /**
  125304. * Gets the value of D-pad up
  125305. */
  125306. get dPadUp(): number;
  125307. /**
  125308. * Sets the value of D-pad up
  125309. */
  125310. set dPadUp(value: number);
  125311. /**
  125312. * Gets the value of D-pad down
  125313. */
  125314. get dPadDown(): number;
  125315. /**
  125316. * Sets the value of D-pad down
  125317. */
  125318. set dPadDown(value: number);
  125319. /**
  125320. * Gets the value of D-pad left
  125321. */
  125322. get dPadLeft(): number;
  125323. /**
  125324. * Sets the value of D-pad left
  125325. */
  125326. set dPadLeft(value: number);
  125327. /**
  125328. * Gets the value of D-pad right
  125329. */
  125330. get dPadRight(): number;
  125331. /**
  125332. * Sets the value of D-pad right
  125333. */
  125334. set dPadRight(value: number);
  125335. /**
  125336. * Force the gamepad to synchronize with device values
  125337. */
  125338. update(): void;
  125339. /**
  125340. * Disposes the gamepad
  125341. */
  125342. dispose(): void;
  125343. }
  125344. }
  125345. declare module BABYLON {
  125346. /**
  125347. * Defines supported buttons for DualShock compatible gamepads
  125348. */
  125349. export enum DualShockButton {
  125350. /** Cross */
  125351. Cross = 0,
  125352. /** Circle */
  125353. Circle = 1,
  125354. /** Square */
  125355. Square = 2,
  125356. /** Triangle */
  125357. Triangle = 3,
  125358. /** L1 */
  125359. L1 = 4,
  125360. /** R1 */
  125361. R1 = 5,
  125362. /** Share */
  125363. Share = 8,
  125364. /** Options */
  125365. Options = 9,
  125366. /** Left stick */
  125367. LeftStick = 10,
  125368. /** Right stick */
  125369. RightStick = 11
  125370. }
  125371. /** Defines values for DualShock DPad */
  125372. export enum DualShockDpad {
  125373. /** Up */
  125374. Up = 12,
  125375. /** Down */
  125376. Down = 13,
  125377. /** Left */
  125378. Left = 14,
  125379. /** Right */
  125380. Right = 15
  125381. }
  125382. /**
  125383. * Defines a DualShock gamepad
  125384. */
  125385. export class DualShockPad extends Gamepad {
  125386. private _leftTrigger;
  125387. private _rightTrigger;
  125388. private _onlefttriggerchanged;
  125389. private _onrighttriggerchanged;
  125390. private _onbuttondown;
  125391. private _onbuttonup;
  125392. private _ondpaddown;
  125393. private _ondpadup;
  125394. /** Observable raised when a button is pressed */
  125395. onButtonDownObservable: Observable<DualShockButton>;
  125396. /** Observable raised when a button is released */
  125397. onButtonUpObservable: Observable<DualShockButton>;
  125398. /** Observable raised when a pad is pressed */
  125399. onPadDownObservable: Observable<DualShockDpad>;
  125400. /** Observable raised when a pad is released */
  125401. onPadUpObservable: Observable<DualShockDpad>;
  125402. private _buttonCross;
  125403. private _buttonCircle;
  125404. private _buttonSquare;
  125405. private _buttonTriangle;
  125406. private _buttonShare;
  125407. private _buttonOptions;
  125408. private _buttonL1;
  125409. private _buttonR1;
  125410. private _buttonLeftStick;
  125411. private _buttonRightStick;
  125412. private _dPadUp;
  125413. private _dPadDown;
  125414. private _dPadLeft;
  125415. private _dPadRight;
  125416. /**
  125417. * Creates a new DualShock gamepad object
  125418. * @param id defines the id of this gamepad
  125419. * @param index defines its index
  125420. * @param gamepad defines the internal HTML gamepad object
  125421. */
  125422. constructor(id: string, index: number, gamepad: any);
  125423. /**
  125424. * Defines the callback to call when left trigger is pressed
  125425. * @param callback defines the callback to use
  125426. */
  125427. onlefttriggerchanged(callback: (value: number) => void): void;
  125428. /**
  125429. * Defines the callback to call when right trigger is pressed
  125430. * @param callback defines the callback to use
  125431. */
  125432. onrighttriggerchanged(callback: (value: number) => void): void;
  125433. /**
  125434. * Gets the left trigger value
  125435. */
  125436. get leftTrigger(): number;
  125437. /**
  125438. * Sets the left trigger value
  125439. */
  125440. set leftTrigger(newValue: number);
  125441. /**
  125442. * Gets the right trigger value
  125443. */
  125444. get rightTrigger(): number;
  125445. /**
  125446. * Sets the right trigger value
  125447. */
  125448. set rightTrigger(newValue: number);
  125449. /**
  125450. * Defines the callback to call when a button is pressed
  125451. * @param callback defines the callback to use
  125452. */
  125453. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125454. /**
  125455. * Defines the callback to call when a button is released
  125456. * @param callback defines the callback to use
  125457. */
  125458. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125459. /**
  125460. * Defines the callback to call when a pad is pressed
  125461. * @param callback defines the callback to use
  125462. */
  125463. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125464. /**
  125465. * Defines the callback to call when a pad is released
  125466. * @param callback defines the callback to use
  125467. */
  125468. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125469. private _setButtonValue;
  125470. private _setDPadValue;
  125471. /**
  125472. * Gets the value of the `Cross` button
  125473. */
  125474. get buttonCross(): number;
  125475. /**
  125476. * Sets the value of the `Cross` button
  125477. */
  125478. set buttonCross(value: number);
  125479. /**
  125480. * Gets the value of the `Circle` button
  125481. */
  125482. get buttonCircle(): number;
  125483. /**
  125484. * Sets the value of the `Circle` button
  125485. */
  125486. set buttonCircle(value: number);
  125487. /**
  125488. * Gets the value of the `Square` button
  125489. */
  125490. get buttonSquare(): number;
  125491. /**
  125492. * Sets the value of the `Square` button
  125493. */
  125494. set buttonSquare(value: number);
  125495. /**
  125496. * Gets the value of the `Triangle` button
  125497. */
  125498. get buttonTriangle(): number;
  125499. /**
  125500. * Sets the value of the `Triangle` button
  125501. */
  125502. set buttonTriangle(value: number);
  125503. /**
  125504. * Gets the value of the `Options` button
  125505. */
  125506. get buttonOptions(): number;
  125507. /**
  125508. * Sets the value of the `Options` button
  125509. */
  125510. set buttonOptions(value: number);
  125511. /**
  125512. * Gets the value of the `Share` button
  125513. */
  125514. get buttonShare(): number;
  125515. /**
  125516. * Sets the value of the `Share` button
  125517. */
  125518. set buttonShare(value: number);
  125519. /**
  125520. * Gets the value of the `L1` button
  125521. */
  125522. get buttonL1(): number;
  125523. /**
  125524. * Sets the value of the `L1` button
  125525. */
  125526. set buttonL1(value: number);
  125527. /**
  125528. * Gets the value of the `R1` button
  125529. */
  125530. get buttonR1(): number;
  125531. /**
  125532. * Sets the value of the `R1` button
  125533. */
  125534. set buttonR1(value: number);
  125535. /**
  125536. * Gets the value of the Left joystick
  125537. */
  125538. get buttonLeftStick(): number;
  125539. /**
  125540. * Sets the value of the Left joystick
  125541. */
  125542. set buttonLeftStick(value: number);
  125543. /**
  125544. * Gets the value of the Right joystick
  125545. */
  125546. get buttonRightStick(): number;
  125547. /**
  125548. * Sets the value of the Right joystick
  125549. */
  125550. set buttonRightStick(value: number);
  125551. /**
  125552. * Gets the value of D-pad up
  125553. */
  125554. get dPadUp(): number;
  125555. /**
  125556. * Sets the value of D-pad up
  125557. */
  125558. set dPadUp(value: number);
  125559. /**
  125560. * Gets the value of D-pad down
  125561. */
  125562. get dPadDown(): number;
  125563. /**
  125564. * Sets the value of D-pad down
  125565. */
  125566. set dPadDown(value: number);
  125567. /**
  125568. * Gets the value of D-pad left
  125569. */
  125570. get dPadLeft(): number;
  125571. /**
  125572. * Sets the value of D-pad left
  125573. */
  125574. set dPadLeft(value: number);
  125575. /**
  125576. * Gets the value of D-pad right
  125577. */
  125578. get dPadRight(): number;
  125579. /**
  125580. * Sets the value of D-pad right
  125581. */
  125582. set dPadRight(value: number);
  125583. /**
  125584. * Force the gamepad to synchronize with device values
  125585. */
  125586. update(): void;
  125587. /**
  125588. * Disposes the gamepad
  125589. */
  125590. dispose(): void;
  125591. }
  125592. }
  125593. declare module BABYLON {
  125594. /**
  125595. * Manager for handling gamepads
  125596. */
  125597. export class GamepadManager {
  125598. private _scene?;
  125599. private _babylonGamepads;
  125600. private _oneGamepadConnected;
  125601. /** @hidden */
  125602. _isMonitoring: boolean;
  125603. private _gamepadEventSupported;
  125604. private _gamepadSupport?;
  125605. /**
  125606. * observable to be triggered when the gamepad controller has been connected
  125607. */
  125608. onGamepadConnectedObservable: Observable<Gamepad>;
  125609. /**
  125610. * observable to be triggered when the gamepad controller has been disconnected
  125611. */
  125612. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125613. private _onGamepadConnectedEvent;
  125614. private _onGamepadDisconnectedEvent;
  125615. /**
  125616. * Initializes the gamepad manager
  125617. * @param _scene BabylonJS scene
  125618. */
  125619. constructor(_scene?: Scene | undefined);
  125620. /**
  125621. * The gamepads in the game pad manager
  125622. */
  125623. get gamepads(): Gamepad[];
  125624. /**
  125625. * Get the gamepad controllers based on type
  125626. * @param type The type of gamepad controller
  125627. * @returns Nullable gamepad
  125628. */
  125629. getGamepadByType(type?: number): Nullable<Gamepad>;
  125630. /**
  125631. * Disposes the gamepad manager
  125632. */
  125633. dispose(): void;
  125634. private _addNewGamepad;
  125635. private _startMonitoringGamepads;
  125636. private _stopMonitoringGamepads;
  125637. /** @hidden */
  125638. _checkGamepadsStatus(): void;
  125639. private _updateGamepadObjects;
  125640. }
  125641. }
  125642. declare module BABYLON {
  125643. interface Scene {
  125644. /** @hidden */
  125645. _gamepadManager: Nullable<GamepadManager>;
  125646. /**
  125647. * Gets the gamepad manager associated with the scene
  125648. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125649. */
  125650. gamepadManager: GamepadManager;
  125651. }
  125652. /**
  125653. * Interface representing a free camera inputs manager
  125654. */
  125655. interface FreeCameraInputsManager {
  125656. /**
  125657. * Adds gamepad input support to the FreeCameraInputsManager.
  125658. * @returns the FreeCameraInputsManager
  125659. */
  125660. addGamepad(): FreeCameraInputsManager;
  125661. }
  125662. /**
  125663. * Interface representing an arc rotate camera inputs manager
  125664. */
  125665. interface ArcRotateCameraInputsManager {
  125666. /**
  125667. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125668. * @returns the camera inputs manager
  125669. */
  125670. addGamepad(): ArcRotateCameraInputsManager;
  125671. }
  125672. /**
  125673. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125674. */
  125675. export class GamepadSystemSceneComponent implements ISceneComponent {
  125676. /**
  125677. * The component name helpfull to identify the component in the list of scene components.
  125678. */
  125679. readonly name: string;
  125680. /**
  125681. * The scene the component belongs to.
  125682. */
  125683. scene: Scene;
  125684. /**
  125685. * Creates a new instance of the component for the given scene
  125686. * @param scene Defines the scene to register the component in
  125687. */
  125688. constructor(scene: Scene);
  125689. /**
  125690. * Registers the component in a given scene
  125691. */
  125692. register(): void;
  125693. /**
  125694. * Rebuilds the elements related to this component in case of
  125695. * context lost for instance.
  125696. */
  125697. rebuild(): void;
  125698. /**
  125699. * Disposes the component and the associated ressources
  125700. */
  125701. dispose(): void;
  125702. private _beforeCameraUpdate;
  125703. }
  125704. }
  125705. declare module BABYLON {
  125706. /**
  125707. * 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,
  125708. * which still works and will still be found in many Playgrounds.
  125709. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125710. */
  125711. export class UniversalCamera extends TouchCamera {
  125712. /**
  125713. * Defines the gamepad rotation sensiblity.
  125714. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125715. */
  125716. get gamepadAngularSensibility(): number;
  125717. set gamepadAngularSensibility(value: number);
  125718. /**
  125719. * Defines the gamepad move sensiblity.
  125720. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125721. */
  125722. get gamepadMoveSensibility(): number;
  125723. set gamepadMoveSensibility(value: number);
  125724. /**
  125725. * 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,
  125726. * which still works and will still be found in many Playgrounds.
  125727. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125728. * @param name Define the name of the camera in the scene
  125729. * @param position Define the start position of the camera in the scene
  125730. * @param scene Define the scene the camera belongs to
  125731. */
  125732. constructor(name: string, position: Vector3, scene: Scene);
  125733. /**
  125734. * Gets the current object class name.
  125735. * @return the class name
  125736. */
  125737. getClassName(): string;
  125738. }
  125739. }
  125740. declare module BABYLON {
  125741. /**
  125742. * This represents a FPS type of camera. This is only here for back compat purpose.
  125743. * Please use the UniversalCamera instead as both are identical.
  125744. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125745. */
  125746. export class GamepadCamera extends UniversalCamera {
  125747. /**
  125748. * Instantiates a new Gamepad Camera
  125749. * This represents a FPS type of camera. This is only here for back compat purpose.
  125750. * Please use the UniversalCamera instead as both are identical.
  125751. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125752. * @param name Define the name of the camera in the scene
  125753. * @param position Define the start position of the camera in the scene
  125754. * @param scene Define the scene the camera belongs to
  125755. */
  125756. constructor(name: string, position: Vector3, scene: Scene);
  125757. /**
  125758. * Gets the current object class name.
  125759. * @return the class name
  125760. */
  125761. getClassName(): string;
  125762. }
  125763. }
  125764. declare module BABYLON {
  125765. /** @hidden */
  125766. export var passPixelShader: {
  125767. name: string;
  125768. shader: string;
  125769. };
  125770. }
  125771. declare module BABYLON {
  125772. /** @hidden */
  125773. export var passCubePixelShader: {
  125774. name: string;
  125775. shader: string;
  125776. };
  125777. }
  125778. declare module BABYLON {
  125779. /**
  125780. * PassPostProcess which produces an output the same as it's input
  125781. */
  125782. export class PassPostProcess extends PostProcess {
  125783. /**
  125784. * Gets a string identifying the name of the class
  125785. * @returns "PassPostProcess" string
  125786. */
  125787. getClassName(): string;
  125788. /**
  125789. * Creates the PassPostProcess
  125790. * @param name The name of the effect.
  125791. * @param options The required width/height ratio to downsize to before computing the render pass.
  125792. * @param camera The camera to apply the render pass to.
  125793. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125794. * @param engine The engine which the post process will be applied. (default: current engine)
  125795. * @param reusable If the post process can be reused on the same frame. (default: false)
  125796. * @param textureType The type of texture to be used when performing the post processing.
  125797. * @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)
  125798. */
  125799. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125800. /** @hidden */
  125801. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125802. }
  125803. /**
  125804. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125805. */
  125806. export class PassCubePostProcess extends PostProcess {
  125807. private _face;
  125808. /**
  125809. * Gets or sets the cube face to display.
  125810. * * 0 is +X
  125811. * * 1 is -X
  125812. * * 2 is +Y
  125813. * * 3 is -Y
  125814. * * 4 is +Z
  125815. * * 5 is -Z
  125816. */
  125817. get face(): number;
  125818. set face(value: number);
  125819. /**
  125820. * Gets a string identifying the name of the class
  125821. * @returns "PassCubePostProcess" string
  125822. */
  125823. getClassName(): string;
  125824. /**
  125825. * Creates the PassCubePostProcess
  125826. * @param name The name of the effect.
  125827. * @param options The required width/height ratio to downsize to before computing the render pass.
  125828. * @param camera The camera to apply the render pass to.
  125829. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125830. * @param engine The engine which the post process will be applied. (default: current engine)
  125831. * @param reusable If the post process can be reused on the same frame. (default: false)
  125832. * @param textureType The type of texture to be used when performing the post processing.
  125833. * @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)
  125834. */
  125835. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125836. /** @hidden */
  125837. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125838. }
  125839. }
  125840. declare module BABYLON {
  125841. /** @hidden */
  125842. export var anaglyphPixelShader: {
  125843. name: string;
  125844. shader: string;
  125845. };
  125846. }
  125847. declare module BABYLON {
  125848. /**
  125849. * Postprocess used to generate anaglyphic rendering
  125850. */
  125851. export class AnaglyphPostProcess extends PostProcess {
  125852. private _passedProcess;
  125853. /**
  125854. * Gets a string identifying the name of the class
  125855. * @returns "AnaglyphPostProcess" string
  125856. */
  125857. getClassName(): string;
  125858. /**
  125859. * Creates a new AnaglyphPostProcess
  125860. * @param name defines postprocess name
  125861. * @param options defines creation options or target ratio scale
  125862. * @param rigCameras defines cameras using this postprocess
  125863. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125864. * @param engine defines hosting engine
  125865. * @param reusable defines if the postprocess will be reused multiple times per frame
  125866. */
  125867. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125868. }
  125869. }
  125870. declare module BABYLON {
  125871. /**
  125872. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125873. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125874. */
  125875. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125876. /**
  125877. * Creates a new AnaglyphArcRotateCamera
  125878. * @param name defines camera name
  125879. * @param alpha defines alpha angle (in radians)
  125880. * @param beta defines beta angle (in radians)
  125881. * @param radius defines radius
  125882. * @param target defines camera target
  125883. * @param interaxialDistance defines distance between each color axis
  125884. * @param scene defines the hosting scene
  125885. */
  125886. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125887. /**
  125888. * Gets camera class name
  125889. * @returns AnaglyphArcRotateCamera
  125890. */
  125891. getClassName(): string;
  125892. }
  125893. }
  125894. declare module BABYLON {
  125895. /**
  125896. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125897. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125898. */
  125899. export class AnaglyphFreeCamera extends FreeCamera {
  125900. /**
  125901. * Creates a new AnaglyphFreeCamera
  125902. * @param name defines camera name
  125903. * @param position defines initial position
  125904. * @param interaxialDistance defines distance between each color axis
  125905. * @param scene defines the hosting scene
  125906. */
  125907. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125908. /**
  125909. * Gets camera class name
  125910. * @returns AnaglyphFreeCamera
  125911. */
  125912. getClassName(): string;
  125913. }
  125914. }
  125915. declare module BABYLON {
  125916. /**
  125917. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125918. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125919. */
  125920. export class AnaglyphGamepadCamera extends GamepadCamera {
  125921. /**
  125922. * Creates a new AnaglyphGamepadCamera
  125923. * @param name defines camera name
  125924. * @param position defines initial position
  125925. * @param interaxialDistance defines distance between each color axis
  125926. * @param scene defines the hosting scene
  125927. */
  125928. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125929. /**
  125930. * Gets camera class name
  125931. * @returns AnaglyphGamepadCamera
  125932. */
  125933. getClassName(): string;
  125934. }
  125935. }
  125936. declare module BABYLON {
  125937. /**
  125938. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125939. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125940. */
  125941. export class AnaglyphUniversalCamera extends UniversalCamera {
  125942. /**
  125943. * Creates a new AnaglyphUniversalCamera
  125944. * @param name defines camera name
  125945. * @param position defines initial position
  125946. * @param interaxialDistance defines distance between each color axis
  125947. * @param scene defines the hosting scene
  125948. */
  125949. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125950. /**
  125951. * Gets camera class name
  125952. * @returns AnaglyphUniversalCamera
  125953. */
  125954. getClassName(): string;
  125955. }
  125956. }
  125957. declare module BABYLON {
  125958. /**
  125959. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125960. * @see https://doc.babylonjs.com/features/cameras
  125961. */
  125962. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125963. /**
  125964. * Creates a new StereoscopicArcRotateCamera
  125965. * @param name defines camera name
  125966. * @param alpha defines alpha angle (in radians)
  125967. * @param beta defines beta angle (in radians)
  125968. * @param radius defines radius
  125969. * @param target defines camera target
  125970. * @param interaxialDistance defines distance between each color axis
  125971. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125972. * @param scene defines the hosting scene
  125973. */
  125974. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125975. /**
  125976. * Gets camera class name
  125977. * @returns StereoscopicArcRotateCamera
  125978. */
  125979. getClassName(): string;
  125980. }
  125981. }
  125982. declare module BABYLON {
  125983. /**
  125984. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125985. * @see https://doc.babylonjs.com/features/cameras
  125986. */
  125987. export class StereoscopicFreeCamera extends FreeCamera {
  125988. /**
  125989. * Creates a new StereoscopicFreeCamera
  125990. * @param name defines camera name
  125991. * @param position defines initial position
  125992. * @param interaxialDistance defines distance between each color axis
  125993. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125994. * @param scene defines the hosting scene
  125995. */
  125996. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125997. /**
  125998. * Gets camera class name
  125999. * @returns StereoscopicFreeCamera
  126000. */
  126001. getClassName(): string;
  126002. }
  126003. }
  126004. declare module BABYLON {
  126005. /**
  126006. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  126007. * @see https://doc.babylonjs.com/features/cameras
  126008. */
  126009. export class StereoscopicGamepadCamera extends GamepadCamera {
  126010. /**
  126011. * Creates a new StereoscopicGamepadCamera
  126012. * @param name defines camera name
  126013. * @param position defines initial position
  126014. * @param interaxialDistance defines distance between each color axis
  126015. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126016. * @param scene defines the hosting scene
  126017. */
  126018. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126019. /**
  126020. * Gets camera class name
  126021. * @returns StereoscopicGamepadCamera
  126022. */
  126023. getClassName(): string;
  126024. }
  126025. }
  126026. declare module BABYLON {
  126027. /**
  126028. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  126029. * @see https://doc.babylonjs.com/features/cameras
  126030. */
  126031. export class StereoscopicUniversalCamera extends UniversalCamera {
  126032. /**
  126033. * Creates a new StereoscopicUniversalCamera
  126034. * @param name defines camera name
  126035. * @param position defines initial position
  126036. * @param interaxialDistance defines distance between each color axis
  126037. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126038. * @param scene defines the hosting scene
  126039. */
  126040. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126041. /**
  126042. * Gets camera class name
  126043. * @returns StereoscopicUniversalCamera
  126044. */
  126045. getClassName(): string;
  126046. }
  126047. }
  126048. declare module BABYLON {
  126049. /**
  126050. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  126051. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126052. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126053. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126054. */
  126055. export class VirtualJoysticksCamera extends FreeCamera {
  126056. /**
  126057. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  126058. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126059. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126060. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126061. * @param name Define the name of the camera in the scene
  126062. * @param position Define the start position of the camera in the scene
  126063. * @param scene Define the scene the camera belongs to
  126064. */
  126065. constructor(name: string, position: Vector3, scene: Scene);
  126066. /**
  126067. * Gets the current object class name.
  126068. * @return the class name
  126069. */
  126070. getClassName(): string;
  126071. }
  126072. }
  126073. declare module BABYLON {
  126074. /**
  126075. * This represents all the required metrics to create a VR camera.
  126076. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  126077. */
  126078. export class VRCameraMetrics {
  126079. /**
  126080. * Define the horizontal resolution off the screen.
  126081. */
  126082. hResolution: number;
  126083. /**
  126084. * Define the vertical resolution off the screen.
  126085. */
  126086. vResolution: number;
  126087. /**
  126088. * Define the horizontal screen size.
  126089. */
  126090. hScreenSize: number;
  126091. /**
  126092. * Define the vertical screen size.
  126093. */
  126094. vScreenSize: number;
  126095. /**
  126096. * Define the vertical screen center position.
  126097. */
  126098. vScreenCenter: number;
  126099. /**
  126100. * Define the distance of the eyes to the screen.
  126101. */
  126102. eyeToScreenDistance: number;
  126103. /**
  126104. * Define the distance between both lenses
  126105. */
  126106. lensSeparationDistance: number;
  126107. /**
  126108. * Define the distance between both viewer's eyes.
  126109. */
  126110. interpupillaryDistance: number;
  126111. /**
  126112. * Define the distortion factor of the VR postprocess.
  126113. * Please, touch with care.
  126114. */
  126115. distortionK: number[];
  126116. /**
  126117. * Define the chromatic aberration correction factors for the VR post process.
  126118. */
  126119. chromaAbCorrection: number[];
  126120. /**
  126121. * Define the scale factor of the post process.
  126122. * The smaller the better but the slower.
  126123. */
  126124. postProcessScaleFactor: number;
  126125. /**
  126126. * Define an offset for the lens center.
  126127. */
  126128. lensCenterOffset: number;
  126129. /**
  126130. * Define if the current vr camera should compensate the distortion of the lense or not.
  126131. */
  126132. compensateDistortion: boolean;
  126133. /**
  126134. * Defines if multiview should be enabled when rendering (Default: false)
  126135. */
  126136. multiviewEnabled: boolean;
  126137. /**
  126138. * Gets the rendering aspect ratio based on the provided resolutions.
  126139. */
  126140. get aspectRatio(): number;
  126141. /**
  126142. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126143. */
  126144. get aspectRatioFov(): number;
  126145. /**
  126146. * @hidden
  126147. */
  126148. get leftHMatrix(): Matrix;
  126149. /**
  126150. * @hidden
  126151. */
  126152. get rightHMatrix(): Matrix;
  126153. /**
  126154. * @hidden
  126155. */
  126156. get leftPreViewMatrix(): Matrix;
  126157. /**
  126158. * @hidden
  126159. */
  126160. get rightPreViewMatrix(): Matrix;
  126161. /**
  126162. * Get the default VRMetrics based on the most generic setup.
  126163. * @returns the default vr metrics
  126164. */
  126165. static GetDefault(): VRCameraMetrics;
  126166. }
  126167. }
  126168. declare module BABYLON {
  126169. /** @hidden */
  126170. export var vrDistortionCorrectionPixelShader: {
  126171. name: string;
  126172. shader: string;
  126173. };
  126174. }
  126175. declare module BABYLON {
  126176. /**
  126177. * VRDistortionCorrectionPostProcess used for mobile VR
  126178. */
  126179. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126180. private _isRightEye;
  126181. private _distortionFactors;
  126182. private _postProcessScaleFactor;
  126183. private _lensCenterOffset;
  126184. private _scaleIn;
  126185. private _scaleFactor;
  126186. private _lensCenter;
  126187. /**
  126188. * Gets a string identifying the name of the class
  126189. * @returns "VRDistortionCorrectionPostProcess" string
  126190. */
  126191. getClassName(): string;
  126192. /**
  126193. * Initializes the VRDistortionCorrectionPostProcess
  126194. * @param name The name of the effect.
  126195. * @param camera The camera to apply the render pass to.
  126196. * @param isRightEye If this is for the right eye distortion
  126197. * @param vrMetrics All the required metrics for the VR camera
  126198. */
  126199. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126200. }
  126201. }
  126202. declare module BABYLON {
  126203. /**
  126204. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126205. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126206. */
  126207. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126208. /**
  126209. * Creates a new VRDeviceOrientationArcRotateCamera
  126210. * @param name defines camera name
  126211. * @param alpha defines the camera rotation along the logitudinal axis
  126212. * @param beta defines the camera rotation along the latitudinal axis
  126213. * @param radius defines the camera distance from its target
  126214. * @param target defines the camera target
  126215. * @param scene defines the scene the camera belongs to
  126216. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126217. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126218. */
  126219. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126220. /**
  126221. * Gets camera class name
  126222. * @returns VRDeviceOrientationArcRotateCamera
  126223. */
  126224. getClassName(): string;
  126225. }
  126226. }
  126227. declare module BABYLON {
  126228. /**
  126229. * Camera used to simulate VR rendering (based on FreeCamera)
  126230. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126231. */
  126232. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126233. /**
  126234. * Creates a new VRDeviceOrientationFreeCamera
  126235. * @param name defines camera name
  126236. * @param position defines the start position of the camera
  126237. * @param scene defines the scene the camera belongs to
  126238. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126239. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126240. */
  126241. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126242. /**
  126243. * Gets camera class name
  126244. * @returns VRDeviceOrientationFreeCamera
  126245. */
  126246. getClassName(): string;
  126247. }
  126248. }
  126249. declare module BABYLON {
  126250. /**
  126251. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126252. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126253. */
  126254. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126255. /**
  126256. * Creates a new VRDeviceOrientationGamepadCamera
  126257. * @param name defines camera name
  126258. * @param position defines the start position of the camera
  126259. * @param scene defines the scene the camera belongs to
  126260. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126261. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126262. */
  126263. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126264. /**
  126265. * Gets camera class name
  126266. * @returns VRDeviceOrientationGamepadCamera
  126267. */
  126268. getClassName(): string;
  126269. }
  126270. }
  126271. declare module BABYLON {
  126272. /**
  126273. * A class extending Texture allowing drawing on a texture
  126274. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126275. */
  126276. export class DynamicTexture extends Texture {
  126277. private _generateMipMaps;
  126278. private _canvas;
  126279. private _context;
  126280. /**
  126281. * Creates a DynamicTexture
  126282. * @param name defines the name of the texture
  126283. * @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
  126284. * @param scene defines the scene where you want the texture
  126285. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126286. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126287. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126288. */
  126289. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126290. /**
  126291. * Get the current class name of the texture useful for serialization or dynamic coding.
  126292. * @returns "DynamicTexture"
  126293. */
  126294. getClassName(): string;
  126295. /**
  126296. * Gets the current state of canRescale
  126297. */
  126298. get canRescale(): boolean;
  126299. private _recreate;
  126300. /**
  126301. * Scales the texture
  126302. * @param ratio the scale factor to apply to both width and height
  126303. */
  126304. scale(ratio: number): void;
  126305. /**
  126306. * Resizes the texture
  126307. * @param width the new width
  126308. * @param height the new height
  126309. */
  126310. scaleTo(width: number, height: number): void;
  126311. /**
  126312. * Gets the context of the canvas used by the texture
  126313. * @returns the canvas context of the dynamic texture
  126314. */
  126315. getContext(): CanvasRenderingContext2D;
  126316. /**
  126317. * Clears the texture
  126318. */
  126319. clear(): void;
  126320. /**
  126321. * Updates the texture
  126322. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126323. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126324. */
  126325. update(invertY?: boolean, premulAlpha?: boolean): void;
  126326. /**
  126327. * Draws text onto the texture
  126328. * @param text defines the text to be drawn
  126329. * @param x defines the placement of the text from the left
  126330. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126331. * @param font defines the font to be used with font-style, font-size, font-name
  126332. * @param color defines the color used for the text
  126333. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126334. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126335. * @param update defines whether texture is immediately update (default is true)
  126336. */
  126337. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126338. /**
  126339. * Clones the texture
  126340. * @returns the clone of the texture.
  126341. */
  126342. clone(): DynamicTexture;
  126343. /**
  126344. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126345. * @returns a serialized dynamic texture object
  126346. */
  126347. serialize(): any;
  126348. private _IsCanvasElement;
  126349. /** @hidden */
  126350. _rebuild(): void;
  126351. }
  126352. }
  126353. declare module BABYLON {
  126354. /**
  126355. * Class containing static functions to help procedurally build meshes
  126356. */
  126357. export class GroundBuilder {
  126358. /**
  126359. * Creates a ground mesh
  126360. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126361. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126362. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126363. * @param name defines the name of the mesh
  126364. * @param options defines the options used to create the mesh
  126365. * @param scene defines the hosting scene
  126366. * @returns the ground mesh
  126367. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126368. */
  126369. static CreateGround(name: string, options: {
  126370. width?: number;
  126371. height?: number;
  126372. subdivisions?: number;
  126373. subdivisionsX?: number;
  126374. subdivisionsY?: number;
  126375. updatable?: boolean;
  126376. }, scene: any): Mesh;
  126377. /**
  126378. * Creates a tiled ground mesh
  126379. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126380. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126381. * * 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
  126382. * * 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
  126383. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126384. * @param name defines the name of the mesh
  126385. * @param options defines the options used to create the mesh
  126386. * @param scene defines the hosting scene
  126387. * @returns the tiled ground mesh
  126388. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126389. */
  126390. static CreateTiledGround(name: string, options: {
  126391. xmin: number;
  126392. zmin: number;
  126393. xmax: number;
  126394. zmax: number;
  126395. subdivisions?: {
  126396. w: number;
  126397. h: number;
  126398. };
  126399. precision?: {
  126400. w: number;
  126401. h: number;
  126402. };
  126403. updatable?: boolean;
  126404. }, scene?: Nullable<Scene>): Mesh;
  126405. /**
  126406. * Creates a ground mesh from a height map
  126407. * * The parameter `url` sets the URL of the height map image resource.
  126408. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126409. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126410. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126411. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126412. * * 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.
  126413. * * 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).
  126414. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126415. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126416. * @param name defines the name of the mesh
  126417. * @param url defines the url to the height map
  126418. * @param options defines the options used to create the mesh
  126419. * @param scene defines the hosting scene
  126420. * @returns the ground mesh
  126421. * @see https://doc.babylonjs.com/babylon101/height_map
  126422. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126423. */
  126424. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126425. width?: number;
  126426. height?: number;
  126427. subdivisions?: number;
  126428. minHeight?: number;
  126429. maxHeight?: number;
  126430. colorFilter?: Color3;
  126431. alphaFilter?: number;
  126432. updatable?: boolean;
  126433. onReady?: (mesh: GroundMesh) => void;
  126434. }, scene?: Nullable<Scene>): GroundMesh;
  126435. }
  126436. }
  126437. declare module BABYLON {
  126438. /**
  126439. * Class containing static functions to help procedurally build meshes
  126440. */
  126441. export class TorusBuilder {
  126442. /**
  126443. * Creates a torus mesh
  126444. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126445. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126446. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126447. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126448. * * 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
  126449. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126450. * @param name defines the name of the mesh
  126451. * @param options defines the options used to create the mesh
  126452. * @param scene defines the hosting scene
  126453. * @returns the torus mesh
  126454. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126455. */
  126456. static CreateTorus(name: string, options: {
  126457. diameter?: number;
  126458. thickness?: number;
  126459. tessellation?: number;
  126460. updatable?: boolean;
  126461. sideOrientation?: number;
  126462. frontUVs?: Vector4;
  126463. backUVs?: Vector4;
  126464. }, scene: any): Mesh;
  126465. }
  126466. }
  126467. declare module BABYLON {
  126468. /**
  126469. * Class containing static functions to help procedurally build meshes
  126470. */
  126471. export class CylinderBuilder {
  126472. /**
  126473. * Creates a cylinder or a cone mesh
  126474. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126475. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126476. * * 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.
  126477. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126478. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126479. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126480. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126481. * * 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).
  126482. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126483. * * 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).
  126484. * * 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
  126485. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126486. * * 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
  126487. * * 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.
  126488. * * If `enclose` is false, a ring surface is one element.
  126489. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126490. * * 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
  126491. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126492. * * 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
  126493. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126494. * @param name defines the name of the mesh
  126495. * @param options defines the options used to create the mesh
  126496. * @param scene defines the hosting scene
  126497. * @returns the cylinder mesh
  126498. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126499. */
  126500. static CreateCylinder(name: string, options: {
  126501. height?: number;
  126502. diameterTop?: number;
  126503. diameterBottom?: number;
  126504. diameter?: number;
  126505. tessellation?: number;
  126506. subdivisions?: number;
  126507. arc?: number;
  126508. faceColors?: Color4[];
  126509. faceUV?: Vector4[];
  126510. updatable?: boolean;
  126511. hasRings?: boolean;
  126512. enclose?: boolean;
  126513. cap?: number;
  126514. sideOrientation?: number;
  126515. frontUVs?: Vector4;
  126516. backUVs?: Vector4;
  126517. }, scene: any): Mesh;
  126518. }
  126519. }
  126520. declare module BABYLON {
  126521. /**
  126522. * States of the webXR experience
  126523. */
  126524. export enum WebXRState {
  126525. /**
  126526. * Transitioning to being in XR mode
  126527. */
  126528. ENTERING_XR = 0,
  126529. /**
  126530. * Transitioning to non XR mode
  126531. */
  126532. EXITING_XR = 1,
  126533. /**
  126534. * In XR mode and presenting
  126535. */
  126536. IN_XR = 2,
  126537. /**
  126538. * Not entered XR mode
  126539. */
  126540. NOT_IN_XR = 3
  126541. }
  126542. /**
  126543. * Abstraction of the XR render target
  126544. */
  126545. export interface WebXRRenderTarget extends IDisposable {
  126546. /**
  126547. * xrpresent context of the canvas which can be used to display/mirror xr content
  126548. */
  126549. canvasContext: WebGLRenderingContext;
  126550. /**
  126551. * xr layer for the canvas
  126552. */
  126553. xrLayer: Nullable<XRWebGLLayer>;
  126554. /**
  126555. * Initializes the xr layer for the session
  126556. * @param xrSession xr session
  126557. * @returns a promise that will resolve once the XR Layer has been created
  126558. */
  126559. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126560. }
  126561. }
  126562. declare module BABYLON {
  126563. /**
  126564. * COnfiguration object for WebXR output canvas
  126565. */
  126566. export class WebXRManagedOutputCanvasOptions {
  126567. /**
  126568. * An optional canvas in case you wish to create it yourself and provide it here.
  126569. * If not provided, a new canvas will be created
  126570. */
  126571. canvasElement?: HTMLCanvasElement;
  126572. /**
  126573. * Options for this XR Layer output
  126574. */
  126575. canvasOptions?: XRWebGLLayerOptions;
  126576. /**
  126577. * CSS styling for a newly created canvas (if not provided)
  126578. */
  126579. newCanvasCssStyle?: string;
  126580. /**
  126581. * Get the default values of the configuration object
  126582. * @param engine defines the engine to use (can be null)
  126583. * @returns default values of this configuration object
  126584. */
  126585. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126586. }
  126587. /**
  126588. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126589. */
  126590. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126591. private _options;
  126592. private _canvas;
  126593. private _engine;
  126594. private _originalCanvasSize;
  126595. /**
  126596. * Rendering context of the canvas which can be used to display/mirror xr content
  126597. */
  126598. canvasContext: WebGLRenderingContext;
  126599. /**
  126600. * xr layer for the canvas
  126601. */
  126602. xrLayer: Nullable<XRWebGLLayer>;
  126603. /**
  126604. * Obseervers registered here will be triggered when the xr layer was initialized
  126605. */
  126606. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126607. /**
  126608. * Initializes the canvas to be added/removed upon entering/exiting xr
  126609. * @param _xrSessionManager The XR Session manager
  126610. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126611. */
  126612. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126613. /**
  126614. * Disposes of the object
  126615. */
  126616. dispose(): void;
  126617. /**
  126618. * Initializes the xr layer for the session
  126619. * @param xrSession xr session
  126620. * @returns a promise that will resolve once the XR Layer has been created
  126621. */
  126622. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126623. private _addCanvas;
  126624. private _removeCanvas;
  126625. private _setCanvasSize;
  126626. private _setManagedOutputCanvas;
  126627. }
  126628. }
  126629. declare module BABYLON {
  126630. /**
  126631. * Manages an XRSession to work with Babylon's engine
  126632. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126633. */
  126634. export class WebXRSessionManager implements IDisposable {
  126635. /** The scene which the session should be created for */
  126636. scene: Scene;
  126637. private _referenceSpace;
  126638. private _rttProvider;
  126639. private _sessionEnded;
  126640. private _xrNavigator;
  126641. private baseLayer;
  126642. /**
  126643. * The base reference space from which the session started. good if you want to reset your
  126644. * reference space
  126645. */
  126646. baseReferenceSpace: XRReferenceSpace;
  126647. /**
  126648. * Current XR frame
  126649. */
  126650. currentFrame: Nullable<XRFrame>;
  126651. /** WebXR timestamp updated every frame */
  126652. currentTimestamp: number;
  126653. /**
  126654. * Used just in case of a failure to initialize an immersive session.
  126655. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126656. */
  126657. defaultHeightCompensation: number;
  126658. /**
  126659. * Fires every time a new xrFrame arrives which can be used to update the camera
  126660. */
  126661. onXRFrameObservable: Observable<XRFrame>;
  126662. /**
  126663. * Fires when the reference space changed
  126664. */
  126665. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126666. /**
  126667. * Fires when the xr session is ended either by the device or manually done
  126668. */
  126669. onXRSessionEnded: Observable<any>;
  126670. /**
  126671. * Fires when the xr session is ended either by the device or manually done
  126672. */
  126673. onXRSessionInit: Observable<XRSession>;
  126674. /**
  126675. * Underlying xr session
  126676. */
  126677. session: XRSession;
  126678. /**
  126679. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126680. * or get the offset the player is currently at.
  126681. */
  126682. viewerReferenceSpace: XRReferenceSpace;
  126683. /**
  126684. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126685. * @param scene The scene which the session should be created for
  126686. */
  126687. constructor(
  126688. /** The scene which the session should be created for */
  126689. scene: Scene);
  126690. /**
  126691. * The current reference space used in this session. This reference space can constantly change!
  126692. * It is mainly used to offset the camera's position.
  126693. */
  126694. get referenceSpace(): XRReferenceSpace;
  126695. /**
  126696. * Set a new reference space and triggers the observable
  126697. */
  126698. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126699. /**
  126700. * Disposes of the session manager
  126701. */
  126702. dispose(): void;
  126703. /**
  126704. * Stops the xrSession and restores the render loop
  126705. * @returns Promise which resolves after it exits XR
  126706. */
  126707. exitXRAsync(): Promise<void>;
  126708. /**
  126709. * Gets the correct render target texture to be rendered this frame for this eye
  126710. * @param eye the eye for which to get the render target
  126711. * @returns the render target for the specified eye
  126712. */
  126713. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126714. /**
  126715. * Creates a WebXRRenderTarget object for the XR session
  126716. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126717. * @param options optional options to provide when creating a new render target
  126718. * @returns a WebXR render target to which the session can render
  126719. */
  126720. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126721. /**
  126722. * Initializes the manager
  126723. * After initialization enterXR can be called to start an XR session
  126724. * @returns Promise which resolves after it is initialized
  126725. */
  126726. initializeAsync(): Promise<void>;
  126727. /**
  126728. * Initializes an xr session
  126729. * @param xrSessionMode mode to initialize
  126730. * @param xrSessionInit defines optional and required values to pass to the session builder
  126731. * @returns a promise which will resolve once the session has been initialized
  126732. */
  126733. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126734. /**
  126735. * Checks if a session would be supported for the creation options specified
  126736. * @param sessionMode session mode to check if supported eg. immersive-vr
  126737. * @returns A Promise that resolves to true if supported and false if not
  126738. */
  126739. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126740. /**
  126741. * Resets the reference space to the one started the session
  126742. */
  126743. resetReferenceSpace(): void;
  126744. /**
  126745. * Starts rendering to the xr layer
  126746. */
  126747. runXRRenderLoop(): void;
  126748. /**
  126749. * Sets the reference space on the xr session
  126750. * @param referenceSpaceType space to set
  126751. * @returns a promise that will resolve once the reference space has been set
  126752. */
  126753. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126754. /**
  126755. * Updates the render state of the session
  126756. * @param state state to set
  126757. * @returns a promise that resolves once the render state has been updated
  126758. */
  126759. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126760. /**
  126761. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126762. * @param sessionMode defines the session to test
  126763. * @returns a promise with boolean as final value
  126764. */
  126765. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126766. private _createRenderTargetTexture;
  126767. }
  126768. }
  126769. declare module BABYLON {
  126770. /**
  126771. * WebXR Camera which holds the views for the xrSession
  126772. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126773. */
  126774. export class WebXRCamera extends FreeCamera {
  126775. private _xrSessionManager;
  126776. private _firstFrame;
  126777. private _referenceQuaternion;
  126778. private _referencedPosition;
  126779. private _xrInvPositionCache;
  126780. private _xrInvQuaternionCache;
  126781. /**
  126782. * Observable raised before camera teleportation
  126783. */
  126784. onBeforeCameraTeleport: Observable<Vector3>;
  126785. /**
  126786. * Observable raised after camera teleportation
  126787. */
  126788. onAfterCameraTeleport: Observable<Vector3>;
  126789. /**
  126790. * Should position compensation execute on first frame.
  126791. * This is used when copying the position from a native (non XR) camera
  126792. */
  126793. compensateOnFirstFrame: boolean;
  126794. /**
  126795. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126796. * @param name the name of the camera
  126797. * @param scene the scene to add the camera to
  126798. * @param _xrSessionManager a constructed xr session manager
  126799. */
  126800. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126801. /**
  126802. * Return the user's height, unrelated to the current ground.
  126803. * This will be the y position of this camera, when ground level is 0.
  126804. */
  126805. get realWorldHeight(): number;
  126806. /** @hidden */
  126807. _updateForDualEyeDebugging(): void;
  126808. /**
  126809. * Sets this camera's transformation based on a non-vr camera
  126810. * @param otherCamera the non-vr camera to copy the transformation from
  126811. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126812. */
  126813. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126814. /**
  126815. * Gets the current instance class name ("WebXRCamera").
  126816. * @returns the class name
  126817. */
  126818. getClassName(): string;
  126819. private _rotate180;
  126820. private _updateFromXRSession;
  126821. private _updateNumberOfRigCameras;
  126822. private _updateReferenceSpace;
  126823. private _updateReferenceSpaceOffset;
  126824. }
  126825. }
  126826. declare module BABYLON {
  126827. /**
  126828. * Defining the interface required for a (webxr) feature
  126829. */
  126830. export interface IWebXRFeature extends IDisposable {
  126831. /**
  126832. * Is this feature attached
  126833. */
  126834. attached: boolean;
  126835. /**
  126836. * Should auto-attach be disabled?
  126837. */
  126838. disableAutoAttach: boolean;
  126839. /**
  126840. * Attach the feature to the session
  126841. * Will usually be called by the features manager
  126842. *
  126843. * @param force should attachment be forced (even when already attached)
  126844. * @returns true if successful.
  126845. */
  126846. attach(force?: boolean): boolean;
  126847. /**
  126848. * Detach the feature from the session
  126849. * Will usually be called by the features manager
  126850. *
  126851. * @returns true if successful.
  126852. */
  126853. detach(): boolean;
  126854. /**
  126855. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126856. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126857. *
  126858. * @returns whether or not the feature is compatible in this environment
  126859. */
  126860. isCompatible(): boolean;
  126861. /**
  126862. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126863. */
  126864. xrNativeFeatureName?: string;
  126865. /**
  126866. * A list of (Babylon WebXR) features this feature depends on
  126867. */
  126868. dependsOn?: string[];
  126869. }
  126870. /**
  126871. * A list of the currently available features without referencing them
  126872. */
  126873. export class WebXRFeatureName {
  126874. /**
  126875. * The name of the anchor system feature
  126876. */
  126877. static readonly ANCHOR_SYSTEM: string;
  126878. /**
  126879. * The name of the background remover feature
  126880. */
  126881. static readonly BACKGROUND_REMOVER: string;
  126882. /**
  126883. * The name of the hit test feature
  126884. */
  126885. static readonly HIT_TEST: string;
  126886. /**
  126887. * physics impostors for xr controllers feature
  126888. */
  126889. static readonly PHYSICS_CONTROLLERS: string;
  126890. /**
  126891. * The name of the plane detection feature
  126892. */
  126893. static readonly PLANE_DETECTION: string;
  126894. /**
  126895. * The name of the pointer selection feature
  126896. */
  126897. static readonly POINTER_SELECTION: string;
  126898. /**
  126899. * The name of the teleportation feature
  126900. */
  126901. static readonly TELEPORTATION: string;
  126902. /**
  126903. * The name of the feature points feature.
  126904. */
  126905. static readonly FEATURE_POINTS: string;
  126906. /**
  126907. * The name of the hand tracking feature.
  126908. */
  126909. static readonly HAND_TRACKING: string;
  126910. }
  126911. /**
  126912. * Defining the constructor of a feature. Used to register the modules.
  126913. */
  126914. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126915. /**
  126916. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126917. * It is mainly used in AR sessions.
  126918. *
  126919. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126920. */
  126921. export class WebXRFeaturesManager implements IDisposable {
  126922. private _xrSessionManager;
  126923. private static readonly _AvailableFeatures;
  126924. private _features;
  126925. /**
  126926. * constructs a new features manages.
  126927. *
  126928. * @param _xrSessionManager an instance of WebXRSessionManager
  126929. */
  126930. constructor(_xrSessionManager: WebXRSessionManager);
  126931. /**
  126932. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126933. * Mainly used internally.
  126934. *
  126935. * @param featureName the name of the feature to register
  126936. * @param constructorFunction the function used to construct the module
  126937. * @param version the (babylon) version of the module
  126938. * @param stable is that a stable version of this module
  126939. */
  126940. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126941. /**
  126942. * Returns a constructor of a specific feature.
  126943. *
  126944. * @param featureName the name of the feature to construct
  126945. * @param version the version of the feature to load
  126946. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126947. * @param options optional options provided to the module.
  126948. * @returns a function that, when called, will return a new instance of this feature
  126949. */
  126950. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126951. /**
  126952. * Can be used to return the list of features currently registered
  126953. *
  126954. * @returns an Array of available features
  126955. */
  126956. static GetAvailableFeatures(): string[];
  126957. /**
  126958. * Gets the versions available for a specific feature
  126959. * @param featureName the name of the feature
  126960. * @returns an array with the available versions
  126961. */
  126962. static GetAvailableVersions(featureName: string): string[];
  126963. /**
  126964. * Return the latest unstable version of this feature
  126965. * @param featureName the name of the feature to search
  126966. * @returns the version number. if not found will return -1
  126967. */
  126968. static GetLatestVersionOfFeature(featureName: string): number;
  126969. /**
  126970. * Return the latest stable version of this feature
  126971. * @param featureName the name of the feature to search
  126972. * @returns the version number. if not found will return -1
  126973. */
  126974. static GetStableVersionOfFeature(featureName: string): number;
  126975. /**
  126976. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126977. * Can be used during a session to start a feature
  126978. * @param featureName the name of feature to attach
  126979. */
  126980. attachFeature(featureName: string): void;
  126981. /**
  126982. * Can be used inside a session or when the session ends to detach a specific feature
  126983. * @param featureName the name of the feature to detach
  126984. */
  126985. detachFeature(featureName: string): void;
  126986. /**
  126987. * Used to disable an already-enabled feature
  126988. * The feature will be disposed and will be recreated once enabled.
  126989. * @param featureName the feature to disable
  126990. * @returns true if disable was successful
  126991. */
  126992. disableFeature(featureName: string | {
  126993. Name: string;
  126994. }): boolean;
  126995. /**
  126996. * dispose this features manager
  126997. */
  126998. dispose(): void;
  126999. /**
  127000. * Enable a feature using its name and a version. This will enable it in the scene, and will be responsible to attach it when the session starts.
  127001. * If used twice, the old version will be disposed and a new one will be constructed. This way you can re-enable with different configuration.
  127002. *
  127003. * @param featureName the name of the feature to load or the class of the feature
  127004. * @param version optional version to load. if not provided the latest version will be enabled
  127005. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  127006. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  127007. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  127008. * @returns a new constructed feature or throws an error if feature not found.
  127009. */
  127010. enableFeature(featureName: string | {
  127011. Name: string;
  127012. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  127013. /**
  127014. * get the implementation of an enabled feature.
  127015. * @param featureName the name of the feature to load
  127016. * @returns the feature class, if found
  127017. */
  127018. getEnabledFeature(featureName: string): IWebXRFeature;
  127019. /**
  127020. * Get the list of enabled features
  127021. * @returns an array of enabled features
  127022. */
  127023. getEnabledFeatures(): string[];
  127024. /**
  127025. * This function will exten the session creation configuration object with enabled features.
  127026. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  127027. * according to the defined "required" variable, provided during enableFeature call
  127028. * @param xrSessionInit the xr Session init object to extend
  127029. *
  127030. * @returns an extended XRSessionInit object
  127031. */
  127032. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  127033. }
  127034. }
  127035. declare module BABYLON {
  127036. /**
  127037. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  127038. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  127039. */
  127040. export class WebXRExperienceHelper implements IDisposable {
  127041. private scene;
  127042. private _nonVRCamera;
  127043. private _originalSceneAutoClear;
  127044. private _supported;
  127045. /**
  127046. * Camera used to render xr content
  127047. */
  127048. camera: WebXRCamera;
  127049. /** A features manager for this xr session */
  127050. featuresManager: WebXRFeaturesManager;
  127051. /**
  127052. * Observers registered here will be triggered after the camera's initial transformation is set
  127053. * This can be used to set a different ground level or an extra rotation.
  127054. *
  127055. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  127056. * to the position set after this observable is done executing.
  127057. */
  127058. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  127059. /**
  127060. * Fires when the state of the experience helper has changed
  127061. */
  127062. onStateChangedObservable: Observable<WebXRState>;
  127063. /** Session manager used to keep track of xr session */
  127064. sessionManager: WebXRSessionManager;
  127065. /**
  127066. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  127067. */
  127068. state: WebXRState;
  127069. /**
  127070. * Creates a WebXRExperienceHelper
  127071. * @param scene The scene the helper should be created in
  127072. */
  127073. private constructor();
  127074. /**
  127075. * Creates the experience helper
  127076. * @param scene the scene to attach the experience helper to
  127077. * @returns a promise for the experience helper
  127078. */
  127079. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  127080. /**
  127081. * Disposes of the experience helper
  127082. */
  127083. dispose(): void;
  127084. /**
  127085. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  127086. * @param sessionMode options for the XR session
  127087. * @param referenceSpaceType frame of reference of the XR session
  127088. * @param renderTarget the output canvas that will be used to enter XR mode
  127089. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127090. * @returns promise that resolves after xr mode has entered
  127091. */
  127092. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127093. /**
  127094. * Exits XR mode and returns the scene to its original state
  127095. * @returns promise that resolves after xr mode has exited
  127096. */
  127097. exitXRAsync(): Promise<void>;
  127098. private _nonXRToXRCamera;
  127099. private _setState;
  127100. }
  127101. }
  127102. declare module BABYLON {
  127103. /**
  127104. * X-Y values for axes in WebXR
  127105. */
  127106. export interface IWebXRMotionControllerAxesValue {
  127107. /**
  127108. * The value of the x axis
  127109. */
  127110. x: number;
  127111. /**
  127112. * The value of the y-axis
  127113. */
  127114. y: number;
  127115. }
  127116. /**
  127117. * changed / previous values for the values of this component
  127118. */
  127119. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127120. /**
  127121. * current (this frame) value
  127122. */
  127123. current: T;
  127124. /**
  127125. * previous (last change) value
  127126. */
  127127. previous: T;
  127128. }
  127129. /**
  127130. * Represents changes in the component between current frame and last values recorded
  127131. */
  127132. export interface IWebXRMotionControllerComponentChanges {
  127133. /**
  127134. * will be populated with previous and current values if axes changed
  127135. */
  127136. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127137. /**
  127138. * will be populated with previous and current values if pressed changed
  127139. */
  127140. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127141. /**
  127142. * will be populated with previous and current values if touched changed
  127143. */
  127144. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127145. /**
  127146. * will be populated with previous and current values if value changed
  127147. */
  127148. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127149. }
  127150. /**
  127151. * This class represents a single component (for example button or thumbstick) of a motion controller
  127152. */
  127153. export class WebXRControllerComponent implements IDisposable {
  127154. /**
  127155. * the id of this component
  127156. */
  127157. id: string;
  127158. /**
  127159. * the type of the component
  127160. */
  127161. type: MotionControllerComponentType;
  127162. private _buttonIndex;
  127163. private _axesIndices;
  127164. private _axes;
  127165. private _changes;
  127166. private _currentValue;
  127167. private _hasChanges;
  127168. private _pressed;
  127169. private _touched;
  127170. /**
  127171. * button component type
  127172. */
  127173. static BUTTON_TYPE: MotionControllerComponentType;
  127174. /**
  127175. * squeeze component type
  127176. */
  127177. static SQUEEZE_TYPE: MotionControllerComponentType;
  127178. /**
  127179. * Thumbstick component type
  127180. */
  127181. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127182. /**
  127183. * Touchpad component type
  127184. */
  127185. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127186. /**
  127187. * trigger component type
  127188. */
  127189. static TRIGGER_TYPE: MotionControllerComponentType;
  127190. /**
  127191. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127192. * the axes data changes
  127193. */
  127194. onAxisValueChangedObservable: Observable<{
  127195. x: number;
  127196. y: number;
  127197. }>;
  127198. /**
  127199. * Observers registered here will be triggered when the state of a button changes
  127200. * State change is either pressed / touched / value
  127201. */
  127202. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127203. /**
  127204. * Creates a new component for a motion controller.
  127205. * It is created by the motion controller itself
  127206. *
  127207. * @param id the id of this component
  127208. * @param type the type of the component
  127209. * @param _buttonIndex index in the buttons array of the gamepad
  127210. * @param _axesIndices indices of the values in the axes array of the gamepad
  127211. */
  127212. constructor(
  127213. /**
  127214. * the id of this component
  127215. */
  127216. id: string,
  127217. /**
  127218. * the type of the component
  127219. */
  127220. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127221. /**
  127222. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127223. */
  127224. get axes(): IWebXRMotionControllerAxesValue;
  127225. /**
  127226. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127227. */
  127228. get changes(): IWebXRMotionControllerComponentChanges;
  127229. /**
  127230. * Return whether or not the component changed the last frame
  127231. */
  127232. get hasChanges(): boolean;
  127233. /**
  127234. * is the button currently pressed
  127235. */
  127236. get pressed(): boolean;
  127237. /**
  127238. * is the button currently touched
  127239. */
  127240. get touched(): boolean;
  127241. /**
  127242. * Get the current value of this component
  127243. */
  127244. get value(): number;
  127245. /**
  127246. * Dispose this component
  127247. */
  127248. dispose(): void;
  127249. /**
  127250. * Are there axes correlating to this component
  127251. * @return true is axes data is available
  127252. */
  127253. isAxes(): boolean;
  127254. /**
  127255. * Is this component a button (hence - pressable)
  127256. * @returns true if can be pressed
  127257. */
  127258. isButton(): boolean;
  127259. /**
  127260. * update this component using the gamepad object it is in. Called on every frame
  127261. * @param nativeController the native gamepad controller object
  127262. */
  127263. update(nativeController: IMinimalMotionControllerObject): void;
  127264. }
  127265. }
  127266. declare module BABYLON {
  127267. /**
  127268. * Interface used to represent data loading progression
  127269. */
  127270. export interface ISceneLoaderProgressEvent {
  127271. /**
  127272. * Defines if data length to load can be evaluated
  127273. */
  127274. readonly lengthComputable: boolean;
  127275. /**
  127276. * Defines the loaded data length
  127277. */
  127278. readonly loaded: number;
  127279. /**
  127280. * Defines the data length to load
  127281. */
  127282. readonly total: number;
  127283. }
  127284. /**
  127285. * Interface used by SceneLoader plugins to define supported file extensions
  127286. */
  127287. export interface ISceneLoaderPluginExtensions {
  127288. /**
  127289. * Defines the list of supported extensions
  127290. */
  127291. [extension: string]: {
  127292. isBinary: boolean;
  127293. };
  127294. }
  127295. /**
  127296. * Interface used by SceneLoader plugin factory
  127297. */
  127298. export interface ISceneLoaderPluginFactory {
  127299. /**
  127300. * Defines the name of the factory
  127301. */
  127302. name: string;
  127303. /**
  127304. * Function called to create a new plugin
  127305. * @return the new plugin
  127306. */
  127307. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127308. /**
  127309. * The callback that returns true if the data can be directly loaded.
  127310. * @param data string containing the file data
  127311. * @returns if the data can be loaded directly
  127312. */
  127313. canDirectLoad?(data: string): boolean;
  127314. }
  127315. /**
  127316. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127317. */
  127318. export interface ISceneLoaderPluginBase {
  127319. /**
  127320. * The friendly name of this plugin.
  127321. */
  127322. name: string;
  127323. /**
  127324. * The file extensions supported by this plugin.
  127325. */
  127326. extensions: string | ISceneLoaderPluginExtensions;
  127327. /**
  127328. * The callback called when loading from a url.
  127329. * @param scene scene loading this url
  127330. * @param url url to load
  127331. * @param onSuccess callback called when the file successfully loads
  127332. * @param onProgress callback called while file is loading (if the server supports this mode)
  127333. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127334. * @param onError callback called when the file fails to load
  127335. * @returns a file request object
  127336. */
  127337. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127338. /**
  127339. * The callback called when loading from a file object.
  127340. * @param scene scene loading this file
  127341. * @param file defines the file to load
  127342. * @param onSuccess defines the callback to call when data is loaded
  127343. * @param onProgress defines the callback to call during loading process
  127344. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127345. * @param onError defines the callback to call when an error occurs
  127346. * @returns a file request object
  127347. */
  127348. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127349. /**
  127350. * The callback that returns true if the data can be directly loaded.
  127351. * @param data string containing the file data
  127352. * @returns if the data can be loaded directly
  127353. */
  127354. canDirectLoad?(data: string): boolean;
  127355. /**
  127356. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127357. * @param scene scene loading this data
  127358. * @param data string containing the data
  127359. * @returns data to pass to the plugin
  127360. */
  127361. directLoad?(scene: Scene, data: string): any;
  127362. /**
  127363. * The callback that allows custom handling of the root url based on the response url.
  127364. * @param rootUrl the original root url
  127365. * @param responseURL the response url if available
  127366. * @returns the new root url
  127367. */
  127368. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127369. }
  127370. /**
  127371. * Interface used to define a SceneLoader plugin
  127372. */
  127373. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127374. /**
  127375. * Import meshes into a scene.
  127376. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127377. * @param scene The scene to import into
  127378. * @param data The data to import
  127379. * @param rootUrl The root url for scene and resources
  127380. * @param meshes The meshes array to import into
  127381. * @param particleSystems The particle systems array to import into
  127382. * @param skeletons The skeletons array to import into
  127383. * @param onError The callback when import fails
  127384. * @returns True if successful or false otherwise
  127385. */
  127386. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127387. /**
  127388. * Load into a scene.
  127389. * @param scene The scene to load into
  127390. * @param data The data to import
  127391. * @param rootUrl The root url for scene and resources
  127392. * @param onError The callback when import fails
  127393. * @returns True if successful or false otherwise
  127394. */
  127395. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127396. /**
  127397. * Load into an asset container.
  127398. * @param scene The scene to load into
  127399. * @param data The data to import
  127400. * @param rootUrl The root url for scene and resources
  127401. * @param onError The callback when import fails
  127402. * @returns The loaded asset container
  127403. */
  127404. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127405. }
  127406. /**
  127407. * Interface used to define an async SceneLoader plugin
  127408. */
  127409. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127410. /**
  127411. * Import meshes into a scene.
  127412. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127413. * @param scene The scene to import into
  127414. * @param data The data to import
  127415. * @param rootUrl The root url for scene and resources
  127416. * @param onProgress The callback when the load progresses
  127417. * @param fileName Defines the name of the file to load
  127418. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127419. */
  127420. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127421. meshes: AbstractMesh[];
  127422. particleSystems: IParticleSystem[];
  127423. skeletons: Skeleton[];
  127424. animationGroups: AnimationGroup[];
  127425. }>;
  127426. /**
  127427. * Load into a scene.
  127428. * @param scene The scene to load into
  127429. * @param data The data to import
  127430. * @param rootUrl The root url for scene and resources
  127431. * @param onProgress The callback when the load progresses
  127432. * @param fileName Defines the name of the file to load
  127433. * @returns Nothing
  127434. */
  127435. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127436. /**
  127437. * Load into an asset container.
  127438. * @param scene The scene to load into
  127439. * @param data The data to import
  127440. * @param rootUrl The root url for scene and resources
  127441. * @param onProgress The callback when the load progresses
  127442. * @param fileName Defines the name of the file to load
  127443. * @returns The loaded asset container
  127444. */
  127445. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127446. }
  127447. /**
  127448. * Mode that determines how to handle old animation groups before loading new ones.
  127449. */
  127450. export enum SceneLoaderAnimationGroupLoadingMode {
  127451. /**
  127452. * Reset all old animations to initial state then dispose them.
  127453. */
  127454. Clean = 0,
  127455. /**
  127456. * Stop all old animations.
  127457. */
  127458. Stop = 1,
  127459. /**
  127460. * Restart old animations from first frame.
  127461. */
  127462. Sync = 2,
  127463. /**
  127464. * Old animations remains untouched.
  127465. */
  127466. NoSync = 3
  127467. }
  127468. /**
  127469. * Defines a plugin registered by the SceneLoader
  127470. */
  127471. interface IRegisteredPlugin {
  127472. /**
  127473. * Defines the plugin to use
  127474. */
  127475. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127476. /**
  127477. * Defines if the plugin supports binary data
  127478. */
  127479. isBinary: boolean;
  127480. }
  127481. /**
  127482. * Class used to load scene from various file formats using registered plugins
  127483. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127484. */
  127485. export class SceneLoader {
  127486. /**
  127487. * No logging while loading
  127488. */
  127489. static readonly NO_LOGGING: number;
  127490. /**
  127491. * Minimal logging while loading
  127492. */
  127493. static readonly MINIMAL_LOGGING: number;
  127494. /**
  127495. * Summary logging while loading
  127496. */
  127497. static readonly SUMMARY_LOGGING: number;
  127498. /**
  127499. * Detailled logging while loading
  127500. */
  127501. static readonly DETAILED_LOGGING: number;
  127502. /**
  127503. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127504. */
  127505. static get ForceFullSceneLoadingForIncremental(): boolean;
  127506. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127507. /**
  127508. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127509. */
  127510. static get ShowLoadingScreen(): boolean;
  127511. static set ShowLoadingScreen(value: boolean);
  127512. /**
  127513. * Defines the current logging level (while loading the scene)
  127514. * @ignorenaming
  127515. */
  127516. static get loggingLevel(): number;
  127517. static set loggingLevel(value: number);
  127518. /**
  127519. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127520. */
  127521. static get CleanBoneMatrixWeights(): boolean;
  127522. static set CleanBoneMatrixWeights(value: boolean);
  127523. /**
  127524. * Event raised when a plugin is used to load a scene
  127525. */
  127526. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127527. private static _registeredPlugins;
  127528. private static _showingLoadingScreen;
  127529. /**
  127530. * Gets the default plugin (used to load Babylon files)
  127531. * @returns the .babylon plugin
  127532. */
  127533. static GetDefaultPlugin(): IRegisteredPlugin;
  127534. private static _GetPluginForExtension;
  127535. private static _GetPluginForDirectLoad;
  127536. private static _GetPluginForFilename;
  127537. private static _GetDirectLoad;
  127538. private static _LoadData;
  127539. private static _GetFileInfo;
  127540. /**
  127541. * Gets a plugin that can load the given extension
  127542. * @param extension defines the extension to load
  127543. * @returns a plugin or null if none works
  127544. */
  127545. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127546. /**
  127547. * Gets a boolean indicating that the given extension can be loaded
  127548. * @param extension defines the extension to load
  127549. * @returns true if the extension is supported
  127550. */
  127551. static IsPluginForExtensionAvailable(extension: string): boolean;
  127552. /**
  127553. * Adds a new plugin to the list of registered plugins
  127554. * @param plugin defines the plugin to add
  127555. */
  127556. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127557. /**
  127558. * Import meshes into a scene
  127559. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127560. * @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)
  127561. * @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)
  127562. * @param scene the instance of BABYLON.Scene to append to
  127563. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127564. * @param onProgress a callback with a progress event for each file being loaded
  127565. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127566. * @param pluginExtension the extension used to determine the plugin
  127567. * @returns The loaded plugin
  127568. */
  127569. 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: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127570. /**
  127571. * Import meshes into a scene
  127572. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127573. * @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)
  127574. * @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)
  127575. * @param scene the instance of BABYLON.Scene to append to
  127576. * @param onProgress a callback with a progress event for each file being loaded
  127577. * @param pluginExtension the extension used to determine the plugin
  127578. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127579. */
  127580. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127581. meshes: AbstractMesh[];
  127582. particleSystems: IParticleSystem[];
  127583. skeletons: Skeleton[];
  127584. animationGroups: AnimationGroup[];
  127585. }>;
  127586. /**
  127587. * Load a scene
  127588. * @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)
  127589. * @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)
  127590. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127591. * @param onSuccess a callback with the scene when import succeeds
  127592. * @param onProgress a callback with a progress event for each file being loaded
  127593. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127594. * @param pluginExtension the extension used to determine the plugin
  127595. * @returns The loaded plugin
  127596. */
  127597. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127598. /**
  127599. * Load a scene
  127600. * @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)
  127601. * @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)
  127602. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127603. * @param onProgress a callback with a progress event for each file being loaded
  127604. * @param pluginExtension the extension used to determine the plugin
  127605. * @returns The loaded scene
  127606. */
  127607. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127608. /**
  127609. * Append a scene
  127610. * @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)
  127611. * @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)
  127612. * @param scene is the instance of BABYLON.Scene to append to
  127613. * @param onSuccess a callback with the scene when import succeeds
  127614. * @param onProgress a callback with a progress event for each file being loaded
  127615. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127616. * @param pluginExtension the extension used to determine the plugin
  127617. * @returns The loaded plugin
  127618. */
  127619. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127620. /**
  127621. * Append a scene
  127622. * @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)
  127623. * @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)
  127624. * @param scene is the instance of BABYLON.Scene to append to
  127625. * @param onProgress a callback with a progress event for each file being loaded
  127626. * @param pluginExtension the extension used to determine the plugin
  127627. * @returns The given scene
  127628. */
  127629. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127630. /**
  127631. * Load a scene into an asset container
  127632. * @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)
  127633. * @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)
  127634. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127635. * @param onSuccess a callback with the scene when import succeeds
  127636. * @param onProgress a callback with a progress event for each file being loaded
  127637. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127638. * @param pluginExtension the extension used to determine the plugin
  127639. * @returns The loaded plugin
  127640. */
  127641. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127642. /**
  127643. * Load a scene into an asset container
  127644. * @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)
  127645. * @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)
  127646. * @param scene is the instance of Scene to append to
  127647. * @param onProgress a callback with a progress event for each file being loaded
  127648. * @param pluginExtension the extension used to determine the plugin
  127649. * @returns The loaded asset container
  127650. */
  127651. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127652. /**
  127653. * Import animations from a file into a scene
  127654. * @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)
  127655. * @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)
  127656. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127657. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127658. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127659. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127660. * @param onSuccess a callback with the scene when import succeeds
  127661. * @param onProgress a callback with a progress event for each file being loaded
  127662. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127663. * @param pluginExtension the extension used to determine the plugin
  127664. */
  127665. static ImportAnimations(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): void;
  127666. /**
  127667. * Import animations from a file into a scene
  127668. * @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)
  127669. * @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)
  127670. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127671. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127672. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127673. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127674. * @param onSuccess a callback with the scene when import succeeds
  127675. * @param onProgress a callback with a progress event for each file being loaded
  127676. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127677. * @param pluginExtension the extension used to determine the plugin
  127678. * @returns the updated scene with imported animations
  127679. */
  127680. static ImportAnimationsAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127681. }
  127682. }
  127683. declare module BABYLON {
  127684. /**
  127685. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127686. */
  127687. export type MotionControllerHandedness = "none" | "left" | "right";
  127688. /**
  127689. * The type of components available in motion controllers.
  127690. * This is not the name of the component.
  127691. */
  127692. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127693. /**
  127694. * The state of a controller component
  127695. */
  127696. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127697. /**
  127698. * The schema of motion controller layout.
  127699. * No object will be initialized using this interface
  127700. * This is used just to define the profile.
  127701. */
  127702. export interface IMotionControllerLayout {
  127703. /**
  127704. * Path to load the assets. Usually relative to the base path
  127705. */
  127706. assetPath: string;
  127707. /**
  127708. * Available components (unsorted)
  127709. */
  127710. components: {
  127711. /**
  127712. * A map of component Ids
  127713. */
  127714. [componentId: string]: {
  127715. /**
  127716. * The type of input the component outputs
  127717. */
  127718. type: MotionControllerComponentType;
  127719. /**
  127720. * The indices of this component in the gamepad object
  127721. */
  127722. gamepadIndices: {
  127723. /**
  127724. * Index of button
  127725. */
  127726. button?: number;
  127727. /**
  127728. * If available, index of x-axis
  127729. */
  127730. xAxis?: number;
  127731. /**
  127732. * If available, index of y-axis
  127733. */
  127734. yAxis?: number;
  127735. };
  127736. /**
  127737. * The mesh's root node name
  127738. */
  127739. rootNodeName: string;
  127740. /**
  127741. * Animation definitions for this model
  127742. */
  127743. visualResponses: {
  127744. [stateKey: string]: {
  127745. /**
  127746. * What property will be animated
  127747. */
  127748. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127749. /**
  127750. * What states influence this visual response
  127751. */
  127752. states: MotionControllerComponentStateType[];
  127753. /**
  127754. * Type of animation - movement or visibility
  127755. */
  127756. valueNodeProperty: "transform" | "visibility";
  127757. /**
  127758. * Base node name to move. Its position will be calculated according to the min and max nodes
  127759. */
  127760. valueNodeName?: string;
  127761. /**
  127762. * Minimum movement node
  127763. */
  127764. minNodeName?: string;
  127765. /**
  127766. * Max movement node
  127767. */
  127768. maxNodeName?: string;
  127769. };
  127770. };
  127771. /**
  127772. * If touch enabled, what is the name of node to display user feedback
  127773. */
  127774. touchPointNodeName?: string;
  127775. };
  127776. };
  127777. /**
  127778. * Is it xr standard mapping or not
  127779. */
  127780. gamepadMapping: "" | "xr-standard";
  127781. /**
  127782. * Base root node of this entire model
  127783. */
  127784. rootNodeName: string;
  127785. /**
  127786. * Defines the main button component id
  127787. */
  127788. selectComponentId: string;
  127789. }
  127790. /**
  127791. * A definition for the layout map in the input profile
  127792. */
  127793. export interface IMotionControllerLayoutMap {
  127794. /**
  127795. * Layouts with handedness type as a key
  127796. */
  127797. [handedness: string]: IMotionControllerLayout;
  127798. }
  127799. /**
  127800. * The XR Input profile schema
  127801. * Profiles can be found here:
  127802. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127803. */
  127804. export interface IMotionControllerProfile {
  127805. /**
  127806. * fallback profiles for this profileId
  127807. */
  127808. fallbackProfileIds: string[];
  127809. /**
  127810. * The layout map, with handedness as key
  127811. */
  127812. layouts: IMotionControllerLayoutMap;
  127813. /**
  127814. * The id of this profile
  127815. * correlates to the profile(s) in the xrInput.profiles array
  127816. */
  127817. profileId: string;
  127818. }
  127819. /**
  127820. * A helper-interface for the 3 meshes needed for controller button animation
  127821. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127822. */
  127823. export interface IMotionControllerButtonMeshMap {
  127824. /**
  127825. * the mesh that defines the pressed value mesh position.
  127826. * This is used to find the max-position of this button
  127827. */
  127828. pressedMesh: AbstractMesh;
  127829. /**
  127830. * the mesh that defines the unpressed value mesh position.
  127831. * This is used to find the min (or initial) position of this button
  127832. */
  127833. unpressedMesh: AbstractMesh;
  127834. /**
  127835. * The mesh that will be changed when value changes
  127836. */
  127837. valueMesh: AbstractMesh;
  127838. }
  127839. /**
  127840. * A helper-interface for the 3 meshes needed for controller axis animation.
  127841. * This will be expanded when touchpad animations are fully supported
  127842. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127843. */
  127844. export interface IMotionControllerMeshMap {
  127845. /**
  127846. * the mesh that defines the maximum value mesh position.
  127847. */
  127848. maxMesh?: AbstractMesh;
  127849. /**
  127850. * the mesh that defines the minimum value mesh position.
  127851. */
  127852. minMesh?: AbstractMesh;
  127853. /**
  127854. * The mesh that will be changed when axis value changes
  127855. */
  127856. valueMesh?: AbstractMesh;
  127857. }
  127858. /**
  127859. * The elements needed for change-detection of the gamepad objects in motion controllers
  127860. */
  127861. export interface IMinimalMotionControllerObject {
  127862. /**
  127863. * Available axes of this controller
  127864. */
  127865. axes: number[];
  127866. /**
  127867. * An array of available buttons
  127868. */
  127869. buttons: Array<{
  127870. /**
  127871. * Value of the button/trigger
  127872. */
  127873. value: number;
  127874. /**
  127875. * If the button/trigger is currently touched
  127876. */
  127877. touched: boolean;
  127878. /**
  127879. * If the button/trigger is currently pressed
  127880. */
  127881. pressed: boolean;
  127882. }>;
  127883. /**
  127884. * EXPERIMENTAL haptic support.
  127885. */
  127886. hapticActuators?: Array<{
  127887. pulse: (value: number, duration: number) => Promise<boolean>;
  127888. }>;
  127889. }
  127890. /**
  127891. * An Abstract Motion controller
  127892. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127893. * Each component has an observable to check for changes in value and state
  127894. */
  127895. export abstract class WebXRAbstractMotionController implements IDisposable {
  127896. protected scene: Scene;
  127897. protected layout: IMotionControllerLayout;
  127898. /**
  127899. * The gamepad object correlating to this controller
  127900. */
  127901. gamepadObject: IMinimalMotionControllerObject;
  127902. /**
  127903. * handedness (left/right/none) of this controller
  127904. */
  127905. handedness: MotionControllerHandedness;
  127906. private _initComponent;
  127907. private _modelReady;
  127908. /**
  127909. * A map of components (WebXRControllerComponent) in this motion controller
  127910. * Components have a ComponentType and can also have both button and axis definitions
  127911. */
  127912. readonly components: {
  127913. [id: string]: WebXRControllerComponent;
  127914. };
  127915. /**
  127916. * Disable the model's animation. Can be set at any time.
  127917. */
  127918. disableAnimation: boolean;
  127919. /**
  127920. * Observers registered here will be triggered when the model of this controller is done loading
  127921. */
  127922. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127923. /**
  127924. * The profile id of this motion controller
  127925. */
  127926. abstract profileId: string;
  127927. /**
  127928. * The root mesh of the model. It is null if the model was not yet initialized
  127929. */
  127930. rootMesh: Nullable<AbstractMesh>;
  127931. /**
  127932. * constructs a new abstract motion controller
  127933. * @param scene the scene to which the model of the controller will be added
  127934. * @param layout The profile layout to load
  127935. * @param gamepadObject The gamepad object correlating to this controller
  127936. * @param handedness handedness (left/right/none) of this controller
  127937. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127938. */
  127939. constructor(scene: Scene, layout: IMotionControllerLayout,
  127940. /**
  127941. * The gamepad object correlating to this controller
  127942. */
  127943. gamepadObject: IMinimalMotionControllerObject,
  127944. /**
  127945. * handedness (left/right/none) of this controller
  127946. */
  127947. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127948. /**
  127949. * Dispose this controller, the model mesh and all its components
  127950. */
  127951. dispose(): void;
  127952. /**
  127953. * Returns all components of specific type
  127954. * @param type the type to search for
  127955. * @return an array of components with this type
  127956. */
  127957. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127958. /**
  127959. * get a component based an its component id as defined in layout.components
  127960. * @param id the id of the component
  127961. * @returns the component correlates to the id or undefined if not found
  127962. */
  127963. getComponent(id: string): WebXRControllerComponent;
  127964. /**
  127965. * Get the list of components available in this motion controller
  127966. * @returns an array of strings correlating to available components
  127967. */
  127968. getComponentIds(): string[];
  127969. /**
  127970. * Get the first component of specific type
  127971. * @param type type of component to find
  127972. * @return a controller component or null if not found
  127973. */
  127974. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127975. /**
  127976. * Get the main (Select) component of this controller as defined in the layout
  127977. * @returns the main component of this controller
  127978. */
  127979. getMainComponent(): WebXRControllerComponent;
  127980. /**
  127981. * Loads the model correlating to this controller
  127982. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127983. * @returns A promise fulfilled with the result of the model loading
  127984. */
  127985. loadModel(): Promise<boolean>;
  127986. /**
  127987. * Update this model using the current XRFrame
  127988. * @param xrFrame the current xr frame to use and update the model
  127989. */
  127990. updateFromXRFrame(xrFrame: XRFrame): void;
  127991. /**
  127992. * Backwards compatibility due to a deeply-integrated typo
  127993. */
  127994. get handness(): XREye;
  127995. /**
  127996. * Pulse (vibrate) this controller
  127997. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127998. * Consecutive calls to this function will cancel the last pulse call
  127999. *
  128000. * @param value the strength of the pulse in 0.0...1.0 range
  128001. * @param duration Duration of the pulse in milliseconds
  128002. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  128003. * @returns a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
  128004. */
  128005. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  128006. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128007. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128008. /**
  128009. * Moves the axis on the controller mesh based on its current state
  128010. * @param axis the index of the axis
  128011. * @param axisValue the value of the axis which determines the meshes new position
  128012. * @hidden
  128013. */
  128014. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  128015. /**
  128016. * Update the model itself with the current frame data
  128017. * @param xrFrame the frame to use for updating the model mesh
  128018. */
  128019. protected updateModel(xrFrame: XRFrame): void;
  128020. /**
  128021. * Get the filename and path for this controller's model
  128022. * @returns a map of filename and path
  128023. */
  128024. protected abstract _getFilenameAndPath(): {
  128025. filename: string;
  128026. path: string;
  128027. };
  128028. /**
  128029. * This function is called before the mesh is loaded. It checks for loading constraints.
  128030. * For example, this function can check if the GLB loader is available
  128031. * If this function returns false, the generic controller will be loaded instead
  128032. * @returns Is the client ready to load the mesh
  128033. */
  128034. protected abstract _getModelLoadingConstraints(): boolean;
  128035. /**
  128036. * This function will be called after the model was successfully loaded and can be used
  128037. * for mesh transformations before it is available for the user
  128038. * @param meshes the loaded meshes
  128039. */
  128040. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  128041. /**
  128042. * Set the root mesh for this controller. Important for the WebXR controller class
  128043. * @param meshes the loaded meshes
  128044. */
  128045. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  128046. /**
  128047. * A function executed each frame that updates the mesh (if needed)
  128048. * @param xrFrame the current xrFrame
  128049. */
  128050. protected abstract _updateModel(xrFrame: XRFrame): void;
  128051. private _getGenericFilenameAndPath;
  128052. private _getGenericParentMesh;
  128053. }
  128054. }
  128055. declare module BABYLON {
  128056. /**
  128057. * A generic trigger-only motion controller for WebXR
  128058. */
  128059. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  128060. /**
  128061. * Static version of the profile id of this controller
  128062. */
  128063. static ProfileId: string;
  128064. profileId: string;
  128065. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  128066. protected _getFilenameAndPath(): {
  128067. filename: string;
  128068. path: string;
  128069. };
  128070. protected _getModelLoadingConstraints(): boolean;
  128071. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  128072. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128073. protected _updateModel(): void;
  128074. }
  128075. }
  128076. declare module BABYLON {
  128077. /**
  128078. * Class containing static functions to help procedurally build meshes
  128079. */
  128080. export class SphereBuilder {
  128081. /**
  128082. * Creates a sphere mesh
  128083. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  128084. * * 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`)
  128085. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  128086. * * 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
  128087. * * 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)
  128088. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  128089. * * 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
  128090. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128091. * @param name defines the name of the mesh
  128092. * @param options defines the options used to create the mesh
  128093. * @param scene defines the hosting scene
  128094. * @returns the sphere mesh
  128095. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128096. */
  128097. static CreateSphere(name: string, options: {
  128098. segments?: number;
  128099. diameter?: number;
  128100. diameterX?: number;
  128101. diameterY?: number;
  128102. diameterZ?: number;
  128103. arc?: number;
  128104. slice?: number;
  128105. sideOrientation?: number;
  128106. frontUVs?: Vector4;
  128107. backUVs?: Vector4;
  128108. updatable?: boolean;
  128109. }, scene?: Nullable<Scene>): Mesh;
  128110. }
  128111. }
  128112. declare module BABYLON {
  128113. /**
  128114. * A profiled motion controller has its profile loaded from an online repository.
  128115. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128116. */
  128117. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128118. private _repositoryUrl;
  128119. private _buttonMeshMapping;
  128120. private _touchDots;
  128121. /**
  128122. * The profile ID of this controller. Will be populated when the controller initializes.
  128123. */
  128124. profileId: string;
  128125. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128126. dispose(): void;
  128127. protected _getFilenameAndPath(): {
  128128. filename: string;
  128129. path: string;
  128130. };
  128131. protected _getModelLoadingConstraints(): boolean;
  128132. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128133. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128134. protected _updateModel(_xrFrame: XRFrame): void;
  128135. }
  128136. }
  128137. declare module BABYLON {
  128138. /**
  128139. * A construction function type to create a new controller based on an xrInput object
  128140. */
  128141. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128142. /**
  128143. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128144. *
  128145. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128146. * it should be replaced with auto-loaded controllers.
  128147. *
  128148. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128149. */
  128150. export class WebXRMotionControllerManager {
  128151. private static _AvailableControllers;
  128152. private static _Fallbacks;
  128153. private static _ProfileLoadingPromises;
  128154. private static _ProfilesList;
  128155. /**
  128156. * The base URL of the online controller repository. Can be changed at any time.
  128157. */
  128158. static BaseRepositoryUrl: string;
  128159. /**
  128160. * Which repository gets priority - local or online
  128161. */
  128162. static PrioritizeOnlineRepository: boolean;
  128163. /**
  128164. * Use the online repository, or use only locally-defined controllers
  128165. */
  128166. static UseOnlineRepository: boolean;
  128167. /**
  128168. * Clear the cache used for profile loading and reload when requested again
  128169. */
  128170. static ClearProfilesCache(): void;
  128171. /**
  128172. * Register the default fallbacks.
  128173. * This function is called automatically when this file is imported.
  128174. */
  128175. static DefaultFallbacks(): void;
  128176. /**
  128177. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128178. * @param profileId the profile to which a fallback needs to be found
  128179. * @return an array with corresponding fallback profiles
  128180. */
  128181. static FindFallbackWithProfileId(profileId: string): string[];
  128182. /**
  128183. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128184. * The order of search:
  128185. *
  128186. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128187. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128188. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128189. * 4) return the generic trigger controller if none were found
  128190. *
  128191. * @param xrInput the xrInput to which a new controller is initialized
  128192. * @param scene the scene to which the model will be added
  128193. * @param forceProfile force a certain profile for this controller
  128194. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128195. */
  128196. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128197. /**
  128198. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128199. *
  128200. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128201. *
  128202. * @param type the profile type to register
  128203. * @param constructFunction the function to be called when loading this profile
  128204. */
  128205. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128206. /**
  128207. * Register a fallback to a specific profile.
  128208. * @param profileId the profileId that will receive the fallbacks
  128209. * @param fallbacks A list of fallback profiles
  128210. */
  128211. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128212. /**
  128213. * Will update the list of profiles available in the repository
  128214. * @return a promise that resolves to a map of profiles available online
  128215. */
  128216. static UpdateProfilesList(): Promise<{
  128217. [profile: string]: string;
  128218. }>;
  128219. private static _LoadProfileFromRepository;
  128220. private static _LoadProfilesFromAvailableControllers;
  128221. }
  128222. }
  128223. declare module BABYLON {
  128224. /**
  128225. * Configuration options for the WebXR controller creation
  128226. */
  128227. export interface IWebXRControllerOptions {
  128228. /**
  128229. * Should the controller mesh be animated when a user interacts with it
  128230. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128231. */
  128232. disableMotionControllerAnimation?: boolean;
  128233. /**
  128234. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128235. */
  128236. doNotLoadControllerMesh?: boolean;
  128237. /**
  128238. * Force a specific controller type for this controller.
  128239. * This can be used when creating your own profile or when testing different controllers
  128240. */
  128241. forceControllerProfile?: string;
  128242. /**
  128243. * Defines a rendering group ID for meshes that will be loaded.
  128244. * This is for the default controllers only.
  128245. */
  128246. renderingGroupId?: number;
  128247. }
  128248. /**
  128249. * Represents an XR controller
  128250. */
  128251. export class WebXRInputSource {
  128252. private _scene;
  128253. /** The underlying input source for the controller */
  128254. inputSource: XRInputSource;
  128255. private _options;
  128256. private _tmpVector;
  128257. private _uniqueId;
  128258. private _disposed;
  128259. /**
  128260. * 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
  128261. */
  128262. grip?: AbstractMesh;
  128263. /**
  128264. * If available, this is the gamepad object related to this controller.
  128265. * Using this object it is possible to get click events and trackpad changes of the
  128266. * webxr controller that is currently being used.
  128267. */
  128268. motionController?: WebXRAbstractMotionController;
  128269. /**
  128270. * Event that fires when the controller is removed/disposed.
  128271. * The object provided as event data is this controller, after associated assets were disposed.
  128272. * uniqueId is still available.
  128273. */
  128274. onDisposeObservable: Observable<WebXRInputSource>;
  128275. /**
  128276. * Will be triggered when the mesh associated with the motion controller is done loading.
  128277. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128278. * A shortened version of controller -> motion controller -> on mesh loaded.
  128279. */
  128280. onMeshLoadedObservable: Observable<AbstractMesh>;
  128281. /**
  128282. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128283. */
  128284. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128285. /**
  128286. * Pointer which can be used to select objects or attach a visible laser to
  128287. */
  128288. pointer: AbstractMesh;
  128289. /**
  128290. * Creates the input source object
  128291. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128292. * @param _scene the scene which the controller should be associated to
  128293. * @param inputSource the underlying input source for the controller
  128294. * @param _options options for this controller creation
  128295. */
  128296. constructor(_scene: Scene,
  128297. /** The underlying input source for the controller */
  128298. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128299. /**
  128300. * Get this controllers unique id
  128301. */
  128302. get uniqueId(): string;
  128303. /**
  128304. * Disposes of the object
  128305. */
  128306. dispose(): void;
  128307. /**
  128308. * Gets a world space ray coming from the pointer or grip
  128309. * @param result the resulting ray
  128310. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128311. */
  128312. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128313. /**
  128314. * Updates the controller pose based on the given XRFrame
  128315. * @param xrFrame xr frame to update the pose with
  128316. * @param referenceSpace reference space to use
  128317. */
  128318. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128319. }
  128320. }
  128321. declare module BABYLON {
  128322. /**
  128323. * The schema for initialization options of the XR Input class
  128324. */
  128325. export interface IWebXRInputOptions {
  128326. /**
  128327. * If set to true no model will be automatically loaded
  128328. */
  128329. doNotLoadControllerMeshes?: boolean;
  128330. /**
  128331. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128332. * If not found, the xr input profile data will be used.
  128333. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128334. */
  128335. forceInputProfile?: string;
  128336. /**
  128337. * Do not send a request to the controller repository to load the profile.
  128338. *
  128339. * Instead, use the controllers available in babylon itself.
  128340. */
  128341. disableOnlineControllerRepository?: boolean;
  128342. /**
  128343. * A custom URL for the controllers repository
  128344. */
  128345. customControllersRepositoryURL?: string;
  128346. /**
  128347. * Should the controller model's components not move according to the user input
  128348. */
  128349. disableControllerAnimation?: boolean;
  128350. /**
  128351. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128352. */
  128353. controllerOptions?: IWebXRControllerOptions;
  128354. }
  128355. /**
  128356. * XR input used to track XR inputs such as controllers/rays
  128357. */
  128358. export class WebXRInput implements IDisposable {
  128359. /**
  128360. * the xr session manager for this session
  128361. */
  128362. xrSessionManager: WebXRSessionManager;
  128363. /**
  128364. * the WebXR camera for this session. Mainly used for teleportation
  128365. */
  128366. xrCamera: WebXRCamera;
  128367. private readonly options;
  128368. /**
  128369. * XR controllers being tracked
  128370. */
  128371. controllers: Array<WebXRInputSource>;
  128372. private _frameObserver;
  128373. private _sessionEndedObserver;
  128374. private _sessionInitObserver;
  128375. /**
  128376. * Event when a controller has been connected/added
  128377. */
  128378. onControllerAddedObservable: Observable<WebXRInputSource>;
  128379. /**
  128380. * Event when a controller has been removed/disconnected
  128381. */
  128382. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128383. /**
  128384. * Initializes the WebXRInput
  128385. * @param xrSessionManager the xr session manager for this session
  128386. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128387. * @param options = initialization options for this xr input
  128388. */
  128389. constructor(
  128390. /**
  128391. * the xr session manager for this session
  128392. */
  128393. xrSessionManager: WebXRSessionManager,
  128394. /**
  128395. * the WebXR camera for this session. Mainly used for teleportation
  128396. */
  128397. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128398. private _onInputSourcesChange;
  128399. private _addAndRemoveControllers;
  128400. /**
  128401. * Disposes of the object
  128402. */
  128403. dispose(): void;
  128404. }
  128405. }
  128406. declare module BABYLON {
  128407. /**
  128408. * This is the base class for all WebXR features.
  128409. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128410. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128411. */
  128412. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128413. protected _xrSessionManager: WebXRSessionManager;
  128414. private _attached;
  128415. private _removeOnDetach;
  128416. /**
  128417. * Should auto-attach be disabled?
  128418. */
  128419. disableAutoAttach: boolean;
  128420. /**
  128421. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128422. */
  128423. xrNativeFeatureName: string;
  128424. /**
  128425. * Construct a new (abstract) WebXR feature
  128426. * @param _xrSessionManager the xr session manager for this feature
  128427. */
  128428. constructor(_xrSessionManager: WebXRSessionManager);
  128429. /**
  128430. * Is this feature attached
  128431. */
  128432. get attached(): boolean;
  128433. /**
  128434. * attach this feature
  128435. *
  128436. * @param force should attachment be forced (even when already attached)
  128437. * @returns true if successful, false is failed or already attached
  128438. */
  128439. attach(force?: boolean): boolean;
  128440. /**
  128441. * detach this feature.
  128442. *
  128443. * @returns true if successful, false if failed or already detached
  128444. */
  128445. detach(): boolean;
  128446. /**
  128447. * Dispose this feature and all of the resources attached
  128448. */
  128449. dispose(): void;
  128450. /**
  128451. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128452. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128453. *
  128454. * @returns whether or not the feature is compatible in this environment
  128455. */
  128456. isCompatible(): boolean;
  128457. /**
  128458. * This is used to register callbacks that will automatically be removed when detach is called.
  128459. * @param observable the observable to which the observer will be attached
  128460. * @param callback the callback to register
  128461. */
  128462. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128463. /**
  128464. * Code in this function will be executed on each xrFrame received from the browser.
  128465. * This function will not execute after the feature is detached.
  128466. * @param _xrFrame the current frame
  128467. */
  128468. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128469. }
  128470. }
  128471. declare module BABYLON {
  128472. /**
  128473. * Renders a layer on top of an existing scene
  128474. */
  128475. export class UtilityLayerRenderer implements IDisposable {
  128476. /** the original scene that will be rendered on top of */
  128477. originalScene: Scene;
  128478. private _pointerCaptures;
  128479. private _lastPointerEvents;
  128480. private static _DefaultUtilityLayer;
  128481. private static _DefaultKeepDepthUtilityLayer;
  128482. private _sharedGizmoLight;
  128483. private _renderCamera;
  128484. /**
  128485. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128486. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128487. * @returns the camera that is used when rendering the utility layer
  128488. */
  128489. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128490. /**
  128491. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128492. * @param cam the camera that should be used when rendering the utility layer
  128493. */
  128494. setRenderCamera(cam: Nullable<Camera>): void;
  128495. /**
  128496. * @hidden
  128497. * Light which used by gizmos to get light shading
  128498. */
  128499. _getSharedGizmoLight(): HemisphericLight;
  128500. /**
  128501. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128502. */
  128503. pickUtilitySceneFirst: boolean;
  128504. /**
  128505. * 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)
  128506. */
  128507. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128508. /**
  128509. * 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)
  128510. */
  128511. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128512. /**
  128513. * The scene that is rendered on top of the original scene
  128514. */
  128515. utilityLayerScene: Scene;
  128516. /**
  128517. * If the utility layer should automatically be rendered on top of existing scene
  128518. */
  128519. shouldRender: boolean;
  128520. /**
  128521. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128522. */
  128523. onlyCheckPointerDownEvents: boolean;
  128524. /**
  128525. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128526. */
  128527. processAllEvents: boolean;
  128528. /**
  128529. * Observable raised when the pointer move from the utility layer scene to the main scene
  128530. */
  128531. onPointerOutObservable: Observable<number>;
  128532. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128533. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128534. private _afterRenderObserver;
  128535. private _sceneDisposeObserver;
  128536. private _originalPointerObserver;
  128537. /**
  128538. * Instantiates a UtilityLayerRenderer
  128539. * @param originalScene the original scene that will be rendered on top of
  128540. * @param handleEvents boolean indicating if the utility layer should handle events
  128541. */
  128542. constructor(
  128543. /** the original scene that will be rendered on top of */
  128544. originalScene: Scene, handleEvents?: boolean);
  128545. private _notifyObservers;
  128546. /**
  128547. * Renders the utility layers scene on top of the original scene
  128548. */
  128549. render(): void;
  128550. /**
  128551. * Disposes of the renderer
  128552. */
  128553. dispose(): void;
  128554. private _updateCamera;
  128555. }
  128556. }
  128557. declare module BABYLON {
  128558. /**
  128559. * Options interface for the pointer selection module
  128560. */
  128561. export interface IWebXRControllerPointerSelectionOptions {
  128562. /**
  128563. * if provided, this scene will be used to render meshes.
  128564. */
  128565. customUtilityLayerScene?: Scene;
  128566. /**
  128567. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  128568. * If not disabled, the last picked point will be used to execute a pointer up event
  128569. * If disabled, pointer up event will be triggered right after the pointer down event.
  128570. * Used in screen and gaze target ray mode only
  128571. */
  128572. disablePointerUpOnTouchOut: boolean;
  128573. /**
  128574. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128575. */
  128576. forceGazeMode: boolean;
  128577. /**
  128578. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  128579. * to start a new countdown to the pointer down event.
  128580. * Defaults to 1.
  128581. */
  128582. gazeModePointerMovedFactor?: number;
  128583. /**
  128584. * Different button type to use instead of the main component
  128585. */
  128586. overrideButtonId?: string;
  128587. /**
  128588. * use this rendering group id for the meshes (optional)
  128589. */
  128590. renderingGroupId?: number;
  128591. /**
  128592. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128593. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128594. * 3000 means 3 seconds between pointing at something and selecting it
  128595. */
  128596. timeToSelect?: number;
  128597. /**
  128598. * Should meshes created here be added to a utility layer or the main scene
  128599. */
  128600. useUtilityLayer?: boolean;
  128601. /**
  128602. * Optional WebXR camera to be used for gaze selection
  128603. */
  128604. gazeCamera?: WebXRCamera;
  128605. /**
  128606. * the xr input to use with this pointer selection
  128607. */
  128608. xrInput: WebXRInput;
  128609. }
  128610. /**
  128611. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128612. */
  128613. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128614. private readonly _options;
  128615. private static _idCounter;
  128616. private _attachController;
  128617. private _controllers;
  128618. private _scene;
  128619. private _tmpVectorForPickCompare;
  128620. /**
  128621. * The module's name
  128622. */
  128623. static readonly Name: string;
  128624. /**
  128625. * The (Babylon) version of this module.
  128626. * This is an integer representing the implementation version.
  128627. * This number does not correspond to the WebXR specs version
  128628. */
  128629. static readonly Version: number;
  128630. /**
  128631. * Disable lighting on the laser pointer (so it will always be visible)
  128632. */
  128633. disablePointerLighting: boolean;
  128634. /**
  128635. * Disable lighting on the selection mesh (so it will always be visible)
  128636. */
  128637. disableSelectionMeshLighting: boolean;
  128638. /**
  128639. * Should the laser pointer be displayed
  128640. */
  128641. displayLaserPointer: boolean;
  128642. /**
  128643. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128644. */
  128645. displaySelectionMesh: boolean;
  128646. /**
  128647. * This color will be set to the laser pointer when selection is triggered
  128648. */
  128649. laserPointerPickedColor: Color3;
  128650. /**
  128651. * Default color of the laser pointer
  128652. */
  128653. laserPointerDefaultColor: Color3;
  128654. /**
  128655. * default color of the selection ring
  128656. */
  128657. selectionMeshDefaultColor: Color3;
  128658. /**
  128659. * This color will be applied to the selection ring when selection is triggered
  128660. */
  128661. selectionMeshPickedColor: Color3;
  128662. /**
  128663. * Optional filter to be used for ray selection. This predicate shares behavior with
  128664. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128665. */
  128666. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128667. /**
  128668. * constructs a new background remover module
  128669. * @param _xrSessionManager the session manager for this module
  128670. * @param _options read-only options to be used in this module
  128671. */
  128672. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128673. /**
  128674. * attach this feature
  128675. * Will usually be called by the features manager
  128676. *
  128677. * @returns true if successful.
  128678. */
  128679. attach(): boolean;
  128680. /**
  128681. * detach this feature.
  128682. * Will usually be called by the features manager
  128683. *
  128684. * @returns true if successful.
  128685. */
  128686. detach(): boolean;
  128687. /**
  128688. * Will get the mesh under a specific pointer.
  128689. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128690. * @param controllerId the controllerId to check
  128691. * @returns The mesh under pointer or null if no mesh is under the pointer
  128692. */
  128693. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128694. /**
  128695. * Get the xr controller that correlates to the pointer id in the pointer event
  128696. *
  128697. * @param id the pointer id to search for
  128698. * @returns the controller that correlates to this id or null if not found
  128699. */
  128700. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128701. protected _onXRFrame(_xrFrame: XRFrame): void;
  128702. private _attachGazeMode;
  128703. private _attachScreenRayMode;
  128704. private _attachTrackedPointerRayMode;
  128705. private _convertNormalToDirectionOfRay;
  128706. private _detachController;
  128707. private _generateNewMeshPair;
  128708. private _pickingMoved;
  128709. private _updatePointerDistance;
  128710. /** @hidden */
  128711. get lasterPointerDefaultColor(): Color3;
  128712. }
  128713. }
  128714. declare module BABYLON {
  128715. /**
  128716. * Button which can be used to enter a different mode of XR
  128717. */
  128718. export class WebXREnterExitUIButton {
  128719. /** button element */
  128720. element: HTMLElement;
  128721. /** XR initialization options for the button */
  128722. sessionMode: XRSessionMode;
  128723. /** Reference space type */
  128724. referenceSpaceType: XRReferenceSpaceType;
  128725. /**
  128726. * Creates a WebXREnterExitUIButton
  128727. * @param element button element
  128728. * @param sessionMode XR initialization session mode
  128729. * @param referenceSpaceType the type of reference space to be used
  128730. */
  128731. constructor(
  128732. /** button element */
  128733. element: HTMLElement,
  128734. /** XR initialization options for the button */
  128735. sessionMode: XRSessionMode,
  128736. /** Reference space type */
  128737. referenceSpaceType: XRReferenceSpaceType);
  128738. /**
  128739. * Extendable function which can be used to update the button's visuals when the state changes
  128740. * @param activeButton the current active button in the UI
  128741. */
  128742. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128743. }
  128744. /**
  128745. * Options to create the webXR UI
  128746. */
  128747. export class WebXREnterExitUIOptions {
  128748. /**
  128749. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128750. */
  128751. customButtons?: Array<WebXREnterExitUIButton>;
  128752. /**
  128753. * A reference space type to use when creating the default button.
  128754. * Default is local-floor
  128755. */
  128756. referenceSpaceType?: XRReferenceSpaceType;
  128757. /**
  128758. * Context to enter xr with
  128759. */
  128760. renderTarget?: Nullable<WebXRRenderTarget>;
  128761. /**
  128762. * A session mode to use when creating the default button.
  128763. * Default is immersive-vr
  128764. */
  128765. sessionMode?: XRSessionMode;
  128766. /**
  128767. * A list of optional features to init the session with
  128768. */
  128769. optionalFeatures?: string[];
  128770. /**
  128771. * A list of optional features to init the session with
  128772. */
  128773. requiredFeatures?: string[];
  128774. }
  128775. /**
  128776. * UI to allow the user to enter/exit XR mode
  128777. */
  128778. export class WebXREnterExitUI implements IDisposable {
  128779. private scene;
  128780. /** version of the options passed to this UI */
  128781. options: WebXREnterExitUIOptions;
  128782. private _activeButton;
  128783. private _buttons;
  128784. /**
  128785. * The HTML Div Element to which buttons are added.
  128786. */
  128787. readonly overlay: HTMLDivElement;
  128788. /**
  128789. * Fired every time the active button is changed.
  128790. *
  128791. * When xr is entered via a button that launches xr that button will be the callback parameter
  128792. *
  128793. * When exiting xr the callback parameter will be null)
  128794. */
  128795. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128796. /**
  128797. *
  128798. * @param scene babylon scene object to use
  128799. * @param options (read-only) version of the options passed to this UI
  128800. */
  128801. private constructor();
  128802. /**
  128803. * Creates UI to allow the user to enter/exit XR mode
  128804. * @param scene the scene to add the ui to
  128805. * @param helper the xr experience helper to enter/exit xr with
  128806. * @param options options to configure the UI
  128807. * @returns the created ui
  128808. */
  128809. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128810. /**
  128811. * Disposes of the XR UI component
  128812. */
  128813. dispose(): void;
  128814. private _updateButtons;
  128815. }
  128816. }
  128817. declare module BABYLON {
  128818. /**
  128819. * Class containing static functions to help procedurally build meshes
  128820. */
  128821. export class LinesBuilder {
  128822. /**
  128823. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128824. * * 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
  128825. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128826. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128827. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128828. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128829. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128830. * * 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
  128831. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128832. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128833. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128834. * @param name defines the name of the new line system
  128835. * @param options defines the options used to create the line system
  128836. * @param scene defines the hosting scene
  128837. * @returns a new line system mesh
  128838. */
  128839. static CreateLineSystem(name: string, options: {
  128840. lines: Vector3[][];
  128841. updatable?: boolean;
  128842. instance?: Nullable<LinesMesh>;
  128843. colors?: Nullable<Color4[][]>;
  128844. useVertexAlpha?: boolean;
  128845. }, scene: Nullable<Scene>): LinesMesh;
  128846. /**
  128847. * Creates a line mesh
  128848. * 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
  128849. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128850. * * The parameter `points` is an array successive Vector3
  128851. * * 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
  128852. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128853. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128854. * * When updating an instance, remember that only point positions can change, not the number of points
  128855. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128856. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128857. * @param name defines the name of the new line system
  128858. * @param options defines the options used to create the line system
  128859. * @param scene defines the hosting scene
  128860. * @returns a new line mesh
  128861. */
  128862. static CreateLines(name: string, options: {
  128863. points: Vector3[];
  128864. updatable?: boolean;
  128865. instance?: Nullable<LinesMesh>;
  128866. colors?: Color4[];
  128867. useVertexAlpha?: boolean;
  128868. }, scene?: Nullable<Scene>): LinesMesh;
  128869. /**
  128870. * Creates a dashed line mesh
  128871. * * 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
  128872. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128873. * * The parameter `points` is an array successive Vector3
  128874. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128875. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128876. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128877. * * 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
  128878. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128879. * * When updating an instance, remember that only point positions can change, not the number of points
  128880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128881. * @param name defines the name of the mesh
  128882. * @param options defines the options used to create the mesh
  128883. * @param scene defines the hosting scene
  128884. * @returns the dashed line mesh
  128885. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128886. */
  128887. static CreateDashedLines(name: string, options: {
  128888. points: Vector3[];
  128889. dashSize?: number;
  128890. gapSize?: number;
  128891. dashNb?: number;
  128892. updatable?: boolean;
  128893. instance?: LinesMesh;
  128894. useVertexAlpha?: boolean;
  128895. }, scene?: Nullable<Scene>): LinesMesh;
  128896. }
  128897. }
  128898. declare module BABYLON {
  128899. /**
  128900. * Construction options for a timer
  128901. */
  128902. export interface ITimerOptions<T> {
  128903. /**
  128904. * Time-to-end
  128905. */
  128906. timeout: number;
  128907. /**
  128908. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128909. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128910. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128911. */
  128912. contextObservable: Observable<T>;
  128913. /**
  128914. * Optional parameters when adding an observer to the observable
  128915. */
  128916. observableParameters?: {
  128917. mask?: number;
  128918. insertFirst?: boolean;
  128919. scope?: any;
  128920. };
  128921. /**
  128922. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128923. */
  128924. breakCondition?: (data?: ITimerData<T>) => boolean;
  128925. /**
  128926. * Will be triggered when the time condition has met
  128927. */
  128928. onEnded?: (data: ITimerData<any>) => void;
  128929. /**
  128930. * Will be triggered when the break condition has met (prematurely ended)
  128931. */
  128932. onAborted?: (data: ITimerData<any>) => void;
  128933. /**
  128934. * Optional function to execute on each tick (or count)
  128935. */
  128936. onTick?: (data: ITimerData<any>) => void;
  128937. }
  128938. /**
  128939. * An interface defining the data sent by the timer
  128940. */
  128941. export interface ITimerData<T> {
  128942. /**
  128943. * When did it start
  128944. */
  128945. startTime: number;
  128946. /**
  128947. * Time now
  128948. */
  128949. currentTime: number;
  128950. /**
  128951. * Time passed since started
  128952. */
  128953. deltaTime: number;
  128954. /**
  128955. * How much is completed, in [0.0...1.0].
  128956. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128957. */
  128958. completeRate: number;
  128959. /**
  128960. * What the registered observable sent in the last count
  128961. */
  128962. payload: T;
  128963. }
  128964. /**
  128965. * The current state of the timer
  128966. */
  128967. export enum TimerState {
  128968. /**
  128969. * Timer initialized, not yet started
  128970. */
  128971. INIT = 0,
  128972. /**
  128973. * Timer started and counting
  128974. */
  128975. STARTED = 1,
  128976. /**
  128977. * Timer ended (whether aborted or time reached)
  128978. */
  128979. ENDED = 2
  128980. }
  128981. /**
  128982. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128983. *
  128984. * @param options options with which to initialize this timer
  128985. */
  128986. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128987. /**
  128988. * An advanced implementation of a timer class
  128989. */
  128990. export class AdvancedTimer<T = any> implements IDisposable {
  128991. /**
  128992. * Will notify each time the timer calculates the remaining time
  128993. */
  128994. onEachCountObservable: Observable<ITimerData<T>>;
  128995. /**
  128996. * Will trigger when the timer was aborted due to the break condition
  128997. */
  128998. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128999. /**
  129000. * Will trigger when the timer ended successfully
  129001. */
  129002. onTimerEndedObservable: Observable<ITimerData<T>>;
  129003. /**
  129004. * Will trigger when the timer state has changed
  129005. */
  129006. onStateChangedObservable: Observable<TimerState>;
  129007. private _observer;
  129008. private _contextObservable;
  129009. private _observableParameters;
  129010. private _startTime;
  129011. private _timer;
  129012. private _state;
  129013. private _breakCondition;
  129014. private _timeToEnd;
  129015. private _breakOnNextTick;
  129016. /**
  129017. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  129018. * @param options construction options for this advanced timer
  129019. */
  129020. constructor(options: ITimerOptions<T>);
  129021. /**
  129022. * set a breaking condition for this timer. Default is to never break during count
  129023. * @param predicate the new break condition. Returns true to break, false otherwise
  129024. */
  129025. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  129026. /**
  129027. * Reset ALL associated observables in this advanced timer
  129028. */
  129029. clearObservables(): void;
  129030. /**
  129031. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  129032. *
  129033. * @param timeToEnd how much time to measure until timer ended
  129034. */
  129035. start(timeToEnd?: number): void;
  129036. /**
  129037. * Will force a stop on the next tick.
  129038. */
  129039. stop(): void;
  129040. /**
  129041. * Dispose this timer, clearing all resources
  129042. */
  129043. dispose(): void;
  129044. private _setState;
  129045. private _tick;
  129046. private _stop;
  129047. }
  129048. }
  129049. declare module BABYLON {
  129050. /**
  129051. * The options container for the teleportation module
  129052. */
  129053. export interface IWebXRTeleportationOptions {
  129054. /**
  129055. * if provided, this scene will be used to render meshes.
  129056. */
  129057. customUtilityLayerScene?: Scene;
  129058. /**
  129059. * Values to configure the default target mesh
  129060. */
  129061. defaultTargetMeshOptions?: {
  129062. /**
  129063. * Fill color of the teleportation area
  129064. */
  129065. teleportationFillColor?: string;
  129066. /**
  129067. * Border color for the teleportation area
  129068. */
  129069. teleportationBorderColor?: string;
  129070. /**
  129071. * Disable the mesh's animation sequence
  129072. */
  129073. disableAnimation?: boolean;
  129074. /**
  129075. * Disable lighting on the material or the ring and arrow
  129076. */
  129077. disableLighting?: boolean;
  129078. /**
  129079. * Override the default material of the torus and arrow
  129080. */
  129081. torusArrowMaterial?: Material;
  129082. };
  129083. /**
  129084. * A list of meshes to use as floor meshes.
  129085. * Meshes can be added and removed after initializing the feature using the
  129086. * addFloorMesh and removeFloorMesh functions
  129087. * If empty, rotation will still work
  129088. */
  129089. floorMeshes?: AbstractMesh[];
  129090. /**
  129091. * use this rendering group id for the meshes (optional)
  129092. */
  129093. renderingGroupId?: number;
  129094. /**
  129095. * Should teleportation move only to snap points
  129096. */
  129097. snapPointsOnly?: boolean;
  129098. /**
  129099. * An array of points to which the teleportation will snap to.
  129100. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129101. */
  129102. snapPositions?: Vector3[];
  129103. /**
  129104. * How close should the teleportation ray be in order to snap to position.
  129105. * Default to 0.8 units (meters)
  129106. */
  129107. snapToPositionRadius?: number;
  129108. /**
  129109. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129110. * If you want to support rotation, make sure your mesh has a direction indicator.
  129111. *
  129112. * When left untouched, the default mesh will be initialized.
  129113. */
  129114. teleportationTargetMesh?: AbstractMesh;
  129115. /**
  129116. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129117. */
  129118. timeToTeleport?: number;
  129119. /**
  129120. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129121. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129122. */
  129123. useMainComponentOnly?: boolean;
  129124. /**
  129125. * Should meshes created here be added to a utility layer or the main scene
  129126. */
  129127. useUtilityLayer?: boolean;
  129128. /**
  129129. * Babylon XR Input class for controller
  129130. */
  129131. xrInput: WebXRInput;
  129132. /**
  129133. * Meshes that the teleportation ray cannot go through
  129134. */
  129135. pickBlockerMeshes?: AbstractMesh[];
  129136. }
  129137. /**
  129138. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129139. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129140. * the input of the attached controllers.
  129141. */
  129142. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129143. private _options;
  129144. private _controllers;
  129145. private _currentTeleportationControllerId;
  129146. private _floorMeshes;
  129147. private _quadraticBezierCurve;
  129148. private _selectionFeature;
  129149. private _snapToPositions;
  129150. private _snappedToPoint;
  129151. private _teleportationRingMaterial?;
  129152. private _tmpRay;
  129153. private _tmpVector;
  129154. private _tmpQuaternion;
  129155. /**
  129156. * The module's name
  129157. */
  129158. static readonly Name: string;
  129159. /**
  129160. * The (Babylon) version of this module.
  129161. * This is an integer representing the implementation version.
  129162. * This number does not correspond to the webxr specs version
  129163. */
  129164. static readonly Version: number;
  129165. /**
  129166. * Is movement backwards enabled
  129167. */
  129168. backwardsMovementEnabled: boolean;
  129169. /**
  129170. * Distance to travel when moving backwards
  129171. */
  129172. backwardsTeleportationDistance: number;
  129173. /**
  129174. * The distance from the user to the inspection point in the direction of the controller
  129175. * A higher number will allow the user to move further
  129176. * defaults to 5 (meters, in xr units)
  129177. */
  129178. parabolicCheckRadius: number;
  129179. /**
  129180. * Should the module support parabolic ray on top of direct ray
  129181. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129182. * Very helpful when moving between floors / different heights
  129183. */
  129184. parabolicRayEnabled: boolean;
  129185. /**
  129186. * How much rotation should be applied when rotating right and left
  129187. */
  129188. rotationAngle: number;
  129189. /**
  129190. * Is rotation enabled when moving forward?
  129191. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129192. */
  129193. rotationEnabled: boolean;
  129194. /**
  129195. * constructs a new anchor system
  129196. * @param _xrSessionManager an instance of WebXRSessionManager
  129197. * @param _options configuration object for this feature
  129198. */
  129199. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129200. /**
  129201. * Get the snapPointsOnly flag
  129202. */
  129203. get snapPointsOnly(): boolean;
  129204. /**
  129205. * Sets the snapPointsOnly flag
  129206. * @param snapToPoints should teleportation be exclusively to snap points
  129207. */
  129208. set snapPointsOnly(snapToPoints: boolean);
  129209. /**
  129210. * Add a new mesh to the floor meshes array
  129211. * @param mesh the mesh to use as floor mesh
  129212. */
  129213. addFloorMesh(mesh: AbstractMesh): void;
  129214. /**
  129215. * Add a new snap-to point to fix teleportation to this position
  129216. * @param newSnapPoint The new Snap-To point
  129217. */
  129218. addSnapPoint(newSnapPoint: Vector3): void;
  129219. attach(): boolean;
  129220. detach(): boolean;
  129221. dispose(): void;
  129222. /**
  129223. * Remove a mesh from the floor meshes array
  129224. * @param mesh the mesh to remove
  129225. */
  129226. removeFloorMesh(mesh: AbstractMesh): void;
  129227. /**
  129228. * Remove a mesh from the floor meshes array using its name
  129229. * @param name the mesh name to remove
  129230. */
  129231. removeFloorMeshByName(name: string): void;
  129232. /**
  129233. * This function will iterate through the array, searching for this point or equal to it. It will then remove it from the snap-to array
  129234. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129235. * @returns was the point found and removed or not
  129236. */
  129237. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129238. /**
  129239. * This function sets a selection feature that will be disabled when
  129240. * the forward ray is shown and will be reattached when hidden.
  129241. * This is used to remove the selection rays when moving.
  129242. * @param selectionFeature the feature to disable when forward movement is enabled
  129243. */
  129244. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129245. protected _onXRFrame(_xrFrame: XRFrame): void;
  129246. private _attachController;
  129247. private _createDefaultTargetMesh;
  129248. private _detachController;
  129249. private _findClosestSnapPointWithRadius;
  129250. private _setTargetMeshPosition;
  129251. private _setTargetMeshVisibility;
  129252. private _showParabolicPath;
  129253. private _teleportForward;
  129254. }
  129255. }
  129256. declare module BABYLON {
  129257. /**
  129258. * Options for the default xr helper
  129259. */
  129260. export class WebXRDefaultExperienceOptions {
  129261. /**
  129262. * Enable or disable default UI to enter XR
  129263. */
  129264. disableDefaultUI?: boolean;
  129265. /**
  129266. * Should teleportation not initialize. defaults to false.
  129267. */
  129268. disableTeleportation?: boolean;
  129269. /**
  129270. * Floor meshes that will be used for teleport
  129271. */
  129272. floorMeshes?: Array<AbstractMesh>;
  129273. /**
  129274. * If set to true, the first frame will not be used to reset position
  129275. * The first frame is mainly used when copying transformation from the old camera
  129276. * Mainly used in AR
  129277. */
  129278. ignoreNativeCameraTransformation?: boolean;
  129279. /**
  129280. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129281. */
  129282. inputOptions?: IWebXRInputOptions;
  129283. /**
  129284. * optional configuration for the output canvas
  129285. */
  129286. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129287. /**
  129288. * optional UI options. This can be used among other to change session mode and reference space type
  129289. */
  129290. uiOptions?: WebXREnterExitUIOptions;
  129291. /**
  129292. * When loading teleportation and pointer select, use stable versions instead of latest.
  129293. */
  129294. useStablePlugins?: boolean;
  129295. /**
  129296. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129297. */
  129298. renderingGroupId?: number;
  129299. /**
  129300. * A list of optional features to init the session with
  129301. * If set to true, all features we support will be added
  129302. */
  129303. optionalFeatures?: boolean | string[];
  129304. }
  129305. /**
  129306. * Default experience which provides a similar setup to the previous webVRExperience
  129307. */
  129308. export class WebXRDefaultExperience {
  129309. /**
  129310. * Base experience
  129311. */
  129312. baseExperience: WebXRExperienceHelper;
  129313. /**
  129314. * Enables ui for entering/exiting xr
  129315. */
  129316. enterExitUI: WebXREnterExitUI;
  129317. /**
  129318. * Input experience extension
  129319. */
  129320. input: WebXRInput;
  129321. /**
  129322. * Enables laser pointer and selection
  129323. */
  129324. pointerSelection: WebXRControllerPointerSelection;
  129325. /**
  129326. * Default target xr should render to
  129327. */
  129328. renderTarget: WebXRRenderTarget;
  129329. /**
  129330. * Enables teleportation
  129331. */
  129332. teleportation: WebXRMotionControllerTeleportation;
  129333. private constructor();
  129334. /**
  129335. * Creates the default xr experience
  129336. * @param scene scene
  129337. * @param options options for basic configuration
  129338. * @returns resulting WebXRDefaultExperience
  129339. */
  129340. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129341. /**
  129342. * DIsposes of the experience helper
  129343. */
  129344. dispose(): void;
  129345. }
  129346. }
  129347. declare module BABYLON {
  129348. /**
  129349. * Options to modify the vr teleportation behavior.
  129350. */
  129351. export interface VRTeleportationOptions {
  129352. /**
  129353. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129354. */
  129355. floorMeshName?: string;
  129356. /**
  129357. * A list of meshes to be used as the teleportation floor. (default: empty)
  129358. */
  129359. floorMeshes?: Mesh[];
  129360. /**
  129361. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129362. */
  129363. teleportationMode?: number;
  129364. /**
  129365. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129366. */
  129367. teleportationTime?: number;
  129368. /**
  129369. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129370. */
  129371. teleportationSpeed?: number;
  129372. /**
  129373. * The easing function used in the animation or null for Linear. (default CircleEase)
  129374. */
  129375. easingFunction?: EasingFunction;
  129376. }
  129377. /**
  129378. * Options to modify the vr experience helper's behavior.
  129379. */
  129380. export interface VRExperienceHelperOptions extends WebVROptions {
  129381. /**
  129382. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129383. */
  129384. createDeviceOrientationCamera?: boolean;
  129385. /**
  129386. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129387. */
  129388. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129389. /**
  129390. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129391. */
  129392. laserToggle?: boolean;
  129393. /**
  129394. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129395. */
  129396. floorMeshes?: Mesh[];
  129397. /**
  129398. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129399. */
  129400. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129401. /**
  129402. * Defines if WebXR should be used instead of WebVR (if available)
  129403. */
  129404. useXR?: boolean;
  129405. }
  129406. /**
  129407. * Event containing information after VR has been entered
  129408. */
  129409. export class OnAfterEnteringVRObservableEvent {
  129410. /**
  129411. * If entering vr was successful
  129412. */
  129413. success: boolean;
  129414. }
  129415. /**
  129416. * Helps to quickly add VR support to an existing scene.
  129417. * See https://doc.babylonjs.com/how_to/webvr_helper
  129418. */
  129419. export class VRExperienceHelper {
  129420. /** Options to modify the vr experience helper's behavior. */
  129421. webVROptions: VRExperienceHelperOptions;
  129422. private _scene;
  129423. private _position;
  129424. private _btnVR;
  129425. private _btnVRDisplayed;
  129426. private _webVRsupported;
  129427. private _webVRready;
  129428. private _webVRrequesting;
  129429. private _webVRpresenting;
  129430. private _hasEnteredVR;
  129431. private _fullscreenVRpresenting;
  129432. private _inputElement;
  129433. private _webVRCamera;
  129434. private _vrDeviceOrientationCamera;
  129435. private _deviceOrientationCamera;
  129436. private _existingCamera;
  129437. private _onKeyDown;
  129438. private _onVrDisplayPresentChange;
  129439. private _onVRDisplayChanged;
  129440. private _onVRRequestPresentStart;
  129441. private _onVRRequestPresentComplete;
  129442. /**
  129443. * 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)
  129444. */
  129445. enableGazeEvenWhenNoPointerLock: boolean;
  129446. /**
  129447. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129448. */
  129449. exitVROnDoubleTap: boolean;
  129450. /**
  129451. * Observable raised right before entering VR.
  129452. */
  129453. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129454. /**
  129455. * Observable raised when entering VR has completed.
  129456. */
  129457. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129458. /**
  129459. * Observable raised when exiting VR.
  129460. */
  129461. onExitingVRObservable: Observable<VRExperienceHelper>;
  129462. /**
  129463. * Observable raised when controller mesh is loaded.
  129464. */
  129465. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129466. /** Return this.onEnteringVRObservable
  129467. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129468. */
  129469. get onEnteringVR(): Observable<VRExperienceHelper>;
  129470. /** Return this.onExitingVRObservable
  129471. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129472. */
  129473. get onExitingVR(): Observable<VRExperienceHelper>;
  129474. /** Return this.onControllerMeshLoadedObservable
  129475. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129476. */
  129477. get onControllerMeshLoaded(): Observable<WebVRController>;
  129478. private _rayLength;
  129479. private _useCustomVRButton;
  129480. private _teleportationRequested;
  129481. private _teleportActive;
  129482. private _floorMeshName;
  129483. private _floorMeshesCollection;
  129484. private _teleportationMode;
  129485. private _teleportationTime;
  129486. private _teleportationSpeed;
  129487. private _teleportationEasing;
  129488. private _rotationAllowed;
  129489. private _teleportBackwardsVector;
  129490. private _teleportationTarget;
  129491. private _isDefaultTeleportationTarget;
  129492. private _postProcessMove;
  129493. private _teleportationFillColor;
  129494. private _teleportationBorderColor;
  129495. private _rotationAngle;
  129496. private _haloCenter;
  129497. private _cameraGazer;
  129498. private _padSensibilityUp;
  129499. private _padSensibilityDown;
  129500. private _leftController;
  129501. private _rightController;
  129502. private _gazeColor;
  129503. private _laserColor;
  129504. private _pickedLaserColor;
  129505. private _pickedGazeColor;
  129506. /**
  129507. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129508. */
  129509. onNewMeshSelected: Observable<AbstractMesh>;
  129510. /**
  129511. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129512. * This observable will provide the mesh and the controller used to select the mesh
  129513. */
  129514. onMeshSelectedWithController: Observable<{
  129515. mesh: AbstractMesh;
  129516. controller: WebVRController;
  129517. }>;
  129518. /**
  129519. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129520. */
  129521. onNewMeshPicked: Observable<PickingInfo>;
  129522. private _circleEase;
  129523. /**
  129524. * Observable raised before camera teleportation
  129525. */
  129526. onBeforeCameraTeleport: Observable<Vector3>;
  129527. /**
  129528. * Observable raised after camera teleportation
  129529. */
  129530. onAfterCameraTeleport: Observable<Vector3>;
  129531. /**
  129532. * Observable raised when current selected mesh gets unselected
  129533. */
  129534. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129535. private _raySelectionPredicate;
  129536. /**
  129537. * To be optionaly changed by user to define custom ray selection
  129538. */
  129539. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129540. /**
  129541. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129542. */
  129543. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129544. /**
  129545. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129546. */
  129547. teleportationEnabled: boolean;
  129548. private _defaultHeight;
  129549. private _teleportationInitialized;
  129550. private _interactionsEnabled;
  129551. private _interactionsRequested;
  129552. private _displayGaze;
  129553. private _displayLaserPointer;
  129554. /**
  129555. * The mesh used to display where the user is going to teleport.
  129556. */
  129557. get teleportationTarget(): Mesh;
  129558. /**
  129559. * Sets the mesh to be used to display where the user is going to teleport.
  129560. */
  129561. set teleportationTarget(value: Mesh);
  129562. /**
  129563. * 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
  129564. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129565. * See https://doc.babylonjs.com/resources/baking_transformations
  129566. */
  129567. get gazeTrackerMesh(): Mesh;
  129568. set gazeTrackerMesh(value: Mesh);
  129569. /**
  129570. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129571. */
  129572. updateGazeTrackerScale: boolean;
  129573. /**
  129574. * If the gaze trackers color should be updated when selecting meshes
  129575. */
  129576. updateGazeTrackerColor: boolean;
  129577. /**
  129578. * If the controller laser color should be updated when selecting meshes
  129579. */
  129580. updateControllerLaserColor: boolean;
  129581. /**
  129582. * The gaze tracking mesh corresponding to the left controller
  129583. */
  129584. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129585. /**
  129586. * The gaze tracking mesh corresponding to the right controller
  129587. */
  129588. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129589. /**
  129590. * If the ray of the gaze should be displayed.
  129591. */
  129592. get displayGaze(): boolean;
  129593. /**
  129594. * Sets if the ray of the gaze should be displayed.
  129595. */
  129596. set displayGaze(value: boolean);
  129597. /**
  129598. * If the ray of the LaserPointer should be displayed.
  129599. */
  129600. get displayLaserPointer(): boolean;
  129601. /**
  129602. * Sets if the ray of the LaserPointer should be displayed.
  129603. */
  129604. set displayLaserPointer(value: boolean);
  129605. /**
  129606. * The deviceOrientationCamera used as the camera when not in VR.
  129607. */
  129608. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129609. /**
  129610. * Based on the current WebVR support, returns the current VR camera used.
  129611. */
  129612. get currentVRCamera(): Nullable<Camera>;
  129613. /**
  129614. * The webVRCamera which is used when in VR.
  129615. */
  129616. get webVRCamera(): WebVRFreeCamera;
  129617. /**
  129618. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129619. */
  129620. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129621. /**
  129622. * The html button that is used to trigger entering into VR.
  129623. */
  129624. get vrButton(): Nullable<HTMLButtonElement>;
  129625. private get _teleportationRequestInitiated();
  129626. /**
  129627. * Defines whether or not Pointer lock should be requested when switching to
  129628. * full screen.
  129629. */
  129630. requestPointerLockOnFullScreen: boolean;
  129631. /**
  129632. * If asking to force XR, this will be populated with the default xr experience
  129633. */
  129634. xr: WebXRDefaultExperience;
  129635. /**
  129636. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129637. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129638. */
  129639. xrTestDone: boolean;
  129640. /**
  129641. * Instantiates a VRExperienceHelper.
  129642. * Helps to quickly add VR support to an existing scene.
  129643. * @param scene The scene the VRExperienceHelper belongs to.
  129644. * @param webVROptions Options to modify the vr experience helper's behavior.
  129645. */
  129646. constructor(scene: Scene,
  129647. /** Options to modify the vr experience helper's behavior. */
  129648. webVROptions?: VRExperienceHelperOptions);
  129649. private completeVRInit;
  129650. private _onDefaultMeshLoaded;
  129651. private _onResize;
  129652. private _onFullscreenChange;
  129653. /**
  129654. * Gets a value indicating if we are currently in VR mode.
  129655. */
  129656. get isInVRMode(): boolean;
  129657. private onVrDisplayPresentChange;
  129658. private onVRDisplayChanged;
  129659. private moveButtonToBottomRight;
  129660. private displayVRButton;
  129661. private updateButtonVisibility;
  129662. private _cachedAngularSensibility;
  129663. /**
  129664. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129665. * Otherwise, will use the fullscreen API.
  129666. */
  129667. enterVR(): void;
  129668. /**
  129669. * Attempt to exit VR, or fullscreen.
  129670. */
  129671. exitVR(): void;
  129672. /**
  129673. * The position of the vr experience helper.
  129674. */
  129675. get position(): Vector3;
  129676. /**
  129677. * Sets the position of the vr experience helper.
  129678. */
  129679. set position(value: Vector3);
  129680. /**
  129681. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129682. */
  129683. enableInteractions(): void;
  129684. private get _noControllerIsActive();
  129685. private beforeRender;
  129686. private _isTeleportationFloor;
  129687. /**
  129688. * Adds a floor mesh to be used for teleportation.
  129689. * @param floorMesh the mesh to be used for teleportation.
  129690. */
  129691. addFloorMesh(floorMesh: Mesh): void;
  129692. /**
  129693. * Removes a floor mesh from being used for teleportation.
  129694. * @param floorMesh the mesh to be removed.
  129695. */
  129696. removeFloorMesh(floorMesh: Mesh): void;
  129697. /**
  129698. * Enables interactions and teleportation using the VR controllers and gaze.
  129699. * @param vrTeleportationOptions options to modify teleportation behavior.
  129700. */
  129701. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129702. private _onNewGamepadConnected;
  129703. private _tryEnableInteractionOnController;
  129704. private _onNewGamepadDisconnected;
  129705. private _enableInteractionOnController;
  129706. private _checkTeleportWithRay;
  129707. private _checkRotate;
  129708. private _checkTeleportBackwards;
  129709. private _enableTeleportationOnController;
  129710. private _createTeleportationCircles;
  129711. private _displayTeleportationTarget;
  129712. private _hideTeleportationTarget;
  129713. private _rotateCamera;
  129714. private _moveTeleportationSelectorTo;
  129715. private _workingVector;
  129716. private _workingQuaternion;
  129717. private _workingMatrix;
  129718. /**
  129719. * Time Constant Teleportation Mode
  129720. */
  129721. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129722. /**
  129723. * Speed Constant Teleportation Mode
  129724. */
  129725. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129726. /**
  129727. * Teleports the users feet to the desired location
  129728. * @param location The location where the user's feet should be placed
  129729. */
  129730. teleportCamera(location: Vector3): void;
  129731. private _convertNormalToDirectionOfRay;
  129732. private _castRayAndSelectObject;
  129733. private _notifySelectedMeshUnselected;
  129734. /**
  129735. * Permanently set new colors for the laser pointer
  129736. * @param color the new laser color
  129737. * @param pickedColor the new laser color when picked mesh detected
  129738. */
  129739. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129740. /**
  129741. * Set lighting enabled / disabled on the laser pointer of both controllers
  129742. * @param enabled should the lighting be enabled on the laser pointer
  129743. */
  129744. setLaserLightingState(enabled?: boolean): void;
  129745. /**
  129746. * Permanently set new colors for the gaze pointer
  129747. * @param color the new gaze color
  129748. * @param pickedColor the new gaze color when picked mesh detected
  129749. */
  129750. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129751. /**
  129752. * Sets the color of the laser ray from the vr controllers.
  129753. * @param color new color for the ray.
  129754. */
  129755. changeLaserColor(color: Color3): void;
  129756. /**
  129757. * Sets the color of the ray from the vr headsets gaze.
  129758. * @param color new color for the ray.
  129759. */
  129760. changeGazeColor(color: Color3): void;
  129761. /**
  129762. * Exits VR and disposes of the vr experience helper
  129763. */
  129764. dispose(): void;
  129765. /**
  129766. * Gets the name of the VRExperienceHelper class
  129767. * @returns "VRExperienceHelper"
  129768. */
  129769. getClassName(): string;
  129770. }
  129771. }
  129772. declare module BABYLON {
  129773. /**
  129774. * Contains an array of blocks representing the octree
  129775. */
  129776. export interface IOctreeContainer<T> {
  129777. /**
  129778. * Blocks within the octree
  129779. */
  129780. blocks: Array<OctreeBlock<T>>;
  129781. }
  129782. /**
  129783. * Class used to store a cell in an octree
  129784. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129785. */
  129786. export class OctreeBlock<T> {
  129787. /**
  129788. * Gets the content of the current block
  129789. */
  129790. entries: T[];
  129791. /**
  129792. * Gets the list of block children
  129793. */
  129794. blocks: Array<OctreeBlock<T>>;
  129795. private _depth;
  129796. private _maxDepth;
  129797. private _capacity;
  129798. private _minPoint;
  129799. private _maxPoint;
  129800. private _boundingVectors;
  129801. private _creationFunc;
  129802. /**
  129803. * Creates a new block
  129804. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129805. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129806. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129807. * @param depth defines the current depth of this block in the octree
  129808. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129809. * @param creationFunc defines a callback to call when an element is added to the block
  129810. */
  129811. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129812. /**
  129813. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129814. */
  129815. get capacity(): number;
  129816. /**
  129817. * Gets the minimum vector (in world space) of the block's bounding box
  129818. */
  129819. get minPoint(): Vector3;
  129820. /**
  129821. * Gets the maximum vector (in world space) of the block's bounding box
  129822. */
  129823. get maxPoint(): Vector3;
  129824. /**
  129825. * Add a new element to this block
  129826. * @param entry defines the element to add
  129827. */
  129828. addEntry(entry: T): void;
  129829. /**
  129830. * Remove an element from this block
  129831. * @param entry defines the element to remove
  129832. */
  129833. removeEntry(entry: T): void;
  129834. /**
  129835. * Add an array of elements to this block
  129836. * @param entries defines the array of elements to add
  129837. */
  129838. addEntries(entries: T[]): void;
  129839. /**
  129840. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129841. * @param frustumPlanes defines the frustum planes to test
  129842. * @param selection defines the array to store current content if selection is positive
  129843. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129844. */
  129845. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129846. /**
  129847. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129848. * @param sphereCenter defines the bounding sphere center
  129849. * @param sphereRadius defines the bounding sphere radius
  129850. * @param selection defines the array to store current content if selection is positive
  129851. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129852. */
  129853. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129854. /**
  129855. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129856. * @param ray defines the ray to test with
  129857. * @param selection defines the array to store current content if selection is positive
  129858. */
  129859. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129860. /**
  129861. * Subdivide the content into child blocks (this block will then be empty)
  129862. */
  129863. createInnerBlocks(): void;
  129864. /**
  129865. * @hidden
  129866. */
  129867. 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;
  129868. }
  129869. }
  129870. declare module BABYLON {
  129871. /**
  129872. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129873. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129874. */
  129875. export class Octree<T> {
  129876. /** 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.) */
  129877. maxDepth: number;
  129878. /**
  129879. * Blocks within the octree containing objects
  129880. */
  129881. blocks: Array<OctreeBlock<T>>;
  129882. /**
  129883. * Content stored in the octree
  129884. */
  129885. dynamicContent: T[];
  129886. private _maxBlockCapacity;
  129887. private _selectionContent;
  129888. private _creationFunc;
  129889. /**
  129890. * Creates a octree
  129891. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129892. * @param creationFunc function to be used to instatiate the octree
  129893. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129894. * @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.)
  129895. */
  129896. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129897. /** 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.) */
  129898. maxDepth?: number);
  129899. /**
  129900. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129901. * @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);
  129902. * @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);
  129903. * @param entries meshes to be added to the octree blocks
  129904. */
  129905. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129906. /**
  129907. * Adds a mesh to the octree
  129908. * @param entry Mesh to add to the octree
  129909. */
  129910. addMesh(entry: T): void;
  129911. /**
  129912. * Remove an element from the octree
  129913. * @param entry defines the element to remove
  129914. */
  129915. removeMesh(entry: T): void;
  129916. /**
  129917. * Selects an array of meshes within the frustum
  129918. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129919. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129920. * @returns array of meshes within the frustum
  129921. */
  129922. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129923. /**
  129924. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129925. * @param sphereCenter defines the bounding sphere center
  129926. * @param sphereRadius defines the bounding sphere radius
  129927. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129928. * @returns an array of objects that intersect the sphere
  129929. */
  129930. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129931. /**
  129932. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129933. * @param ray defines the ray to test with
  129934. * @returns array of intersected objects
  129935. */
  129936. intersectsRay(ray: Ray): SmartArray<T>;
  129937. /**
  129938. * Adds a mesh into the octree block if it intersects the block
  129939. */
  129940. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129941. /**
  129942. * Adds a submesh into the octree block if it intersects the block
  129943. */
  129944. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129945. }
  129946. }
  129947. declare module BABYLON {
  129948. interface Scene {
  129949. /**
  129950. * @hidden
  129951. * Backing Filed
  129952. */
  129953. _selectionOctree: Octree<AbstractMesh>;
  129954. /**
  129955. * Gets the octree used to boost mesh selection (picking)
  129956. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129957. */
  129958. selectionOctree: Octree<AbstractMesh>;
  129959. /**
  129960. * Creates or updates the octree used to boost selection (picking)
  129961. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129962. * @param maxCapacity defines the maximum capacity per leaf
  129963. * @param maxDepth defines the maximum depth of the octree
  129964. * @returns an octree of AbstractMesh
  129965. */
  129966. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129967. }
  129968. interface AbstractMesh {
  129969. /**
  129970. * @hidden
  129971. * Backing Field
  129972. */
  129973. _submeshesOctree: Octree<SubMesh>;
  129974. /**
  129975. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129976. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129977. * @param maxCapacity defines the maximum size of each block (64 by default)
  129978. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129979. * @returns the new octree
  129980. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129981. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129982. */
  129983. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129984. }
  129985. /**
  129986. * Defines the octree scene component responsible to manage any octrees
  129987. * in a given scene.
  129988. */
  129989. export class OctreeSceneComponent {
  129990. /**
  129991. * The component name help to identify the component in the list of scene components.
  129992. */
  129993. readonly name: string;
  129994. /**
  129995. * The scene the component belongs to.
  129996. */
  129997. scene: Scene;
  129998. /**
  129999. * Indicates if the meshes have been checked to make sure they are isEnabled()
  130000. */
  130001. readonly checksIsEnabled: boolean;
  130002. /**
  130003. * Creates a new instance of the component for the given scene
  130004. * @param scene Defines the scene to register the component in
  130005. */
  130006. constructor(scene: Scene);
  130007. /**
  130008. * Registers the component in a given scene
  130009. */
  130010. register(): void;
  130011. /**
  130012. * Return the list of active meshes
  130013. * @returns the list of active meshes
  130014. */
  130015. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  130016. /**
  130017. * Return the list of active sub meshes
  130018. * @param mesh The mesh to get the candidates sub meshes from
  130019. * @returns the list of active sub meshes
  130020. */
  130021. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  130022. private _tempRay;
  130023. /**
  130024. * Return the list of sub meshes intersecting with a given local ray
  130025. * @param mesh defines the mesh to find the submesh for
  130026. * @param localRay defines the ray in local space
  130027. * @returns the list of intersecting sub meshes
  130028. */
  130029. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  130030. /**
  130031. * Return the list of sub meshes colliding with a collider
  130032. * @param mesh defines the mesh to find the submesh for
  130033. * @param collider defines the collider to evaluate the collision against
  130034. * @returns the list of colliding sub meshes
  130035. */
  130036. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  130037. /**
  130038. * Rebuilds the elements related to this component in case of
  130039. * context lost for instance.
  130040. */
  130041. rebuild(): void;
  130042. /**
  130043. * Disposes the component and the associated ressources.
  130044. */
  130045. dispose(): void;
  130046. }
  130047. }
  130048. declare module BABYLON {
  130049. /**
  130050. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  130051. */
  130052. export class Gizmo implements IDisposable {
  130053. /** The utility layer the gizmo will be added to */
  130054. gizmoLayer: UtilityLayerRenderer;
  130055. /**
  130056. * The root mesh of the gizmo
  130057. */
  130058. _rootMesh: Mesh;
  130059. private _attachedMesh;
  130060. private _attachedNode;
  130061. /**
  130062. * Ratio for the scale of the gizmo (Default: 1)
  130063. */
  130064. protected _scaleRatio: number;
  130065. /**
  130066. * Ratio for the scale of the gizmo (Default: 1)
  130067. */
  130068. set scaleRatio(value: number);
  130069. get scaleRatio(): number;
  130070. /**
  130071. * If a custom mesh has been set (Default: false)
  130072. */
  130073. protected _customMeshSet: boolean;
  130074. /**
  130075. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  130076. * * When set, interactions will be enabled
  130077. */
  130078. get attachedMesh(): Nullable<AbstractMesh>;
  130079. set attachedMesh(value: Nullable<AbstractMesh>);
  130080. /**
  130081. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  130082. * * When set, interactions will be enabled
  130083. */
  130084. get attachedNode(): Nullable<Node>;
  130085. set attachedNode(value: Nullable<Node>);
  130086. /**
  130087. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130088. * @param mesh The mesh to replace the default mesh of the gizmo
  130089. */
  130090. setCustomMesh(mesh: Mesh): void;
  130091. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  130092. /**
  130093. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  130094. */
  130095. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130096. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130097. /**
  130098. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130099. */
  130100. updateGizmoPositionToMatchAttachedMesh: boolean;
  130101. /**
  130102. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130103. */
  130104. updateScale: boolean;
  130105. protected _interactionsEnabled: boolean;
  130106. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130107. private _beforeRenderObserver;
  130108. private _tempQuaternion;
  130109. private _tempVector;
  130110. private _tempVector2;
  130111. private _tempMatrix1;
  130112. private _tempMatrix2;
  130113. private _rightHandtoLeftHandMatrix;
  130114. /**
  130115. * Creates a gizmo
  130116. * @param gizmoLayer The utility layer the gizmo will be added to
  130117. */
  130118. constructor(
  130119. /** The utility layer the gizmo will be added to */
  130120. gizmoLayer?: UtilityLayerRenderer);
  130121. /**
  130122. * Updates the gizmo to match the attached mesh's position/rotation
  130123. */
  130124. protected _update(): void;
  130125. /**
  130126. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130127. * @param value Node, TransformNode or mesh
  130128. */
  130129. protected _matrixChanged(): void;
  130130. /**
  130131. * Disposes of the gizmo
  130132. */
  130133. dispose(): void;
  130134. }
  130135. }
  130136. declare module BABYLON {
  130137. /**
  130138. * Single plane drag gizmo
  130139. */
  130140. export class PlaneDragGizmo extends Gizmo {
  130141. /**
  130142. * Drag behavior responsible for the gizmos dragging interactions
  130143. */
  130144. dragBehavior: PointerDragBehavior;
  130145. private _pointerObserver;
  130146. /**
  130147. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130148. */
  130149. snapDistance: number;
  130150. /**
  130151. * Event that fires each time the gizmo snaps to a new location.
  130152. * * snapDistance is the the change in distance
  130153. */
  130154. onSnapObservable: Observable<{
  130155. snapDistance: number;
  130156. }>;
  130157. private _plane;
  130158. private _coloredMaterial;
  130159. private _hoverMaterial;
  130160. private _isEnabled;
  130161. private _parent;
  130162. /** @hidden */
  130163. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130164. /** @hidden */
  130165. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130166. /**
  130167. * Creates a PlaneDragGizmo
  130168. * @param gizmoLayer The utility layer the gizmo will be added to
  130169. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130170. * @param color The color of the gizmo
  130171. */
  130172. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130173. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130174. /**
  130175. * If the gizmo is enabled
  130176. */
  130177. set isEnabled(value: boolean);
  130178. get isEnabled(): boolean;
  130179. /**
  130180. * Disposes of the gizmo
  130181. */
  130182. dispose(): void;
  130183. }
  130184. }
  130185. declare module BABYLON {
  130186. /**
  130187. * Gizmo that enables dragging a mesh along 3 axis
  130188. */
  130189. export class PositionGizmo extends Gizmo {
  130190. /**
  130191. * Internal gizmo used for interactions on the x axis
  130192. */
  130193. xGizmo: AxisDragGizmo;
  130194. /**
  130195. * Internal gizmo used for interactions on the y axis
  130196. */
  130197. yGizmo: AxisDragGizmo;
  130198. /**
  130199. * Internal gizmo used for interactions on the z axis
  130200. */
  130201. zGizmo: AxisDragGizmo;
  130202. /**
  130203. * Internal gizmo used for interactions on the yz plane
  130204. */
  130205. xPlaneGizmo: PlaneDragGizmo;
  130206. /**
  130207. * Internal gizmo used for interactions on the xz plane
  130208. */
  130209. yPlaneGizmo: PlaneDragGizmo;
  130210. /**
  130211. * Internal gizmo used for interactions on the xy plane
  130212. */
  130213. zPlaneGizmo: PlaneDragGizmo;
  130214. /**
  130215. * private variables
  130216. */
  130217. private _meshAttached;
  130218. private _nodeAttached;
  130219. private _snapDistance;
  130220. /** Fires an event when any of it's sub gizmos are dragged */
  130221. onDragStartObservable: Observable<unknown>;
  130222. /** Fires an event when any of it's sub gizmos are released from dragging */
  130223. onDragEndObservable: Observable<unknown>;
  130224. /**
  130225. * If set to true, planar drag is enabled
  130226. */
  130227. private _planarGizmoEnabled;
  130228. get attachedMesh(): Nullable<AbstractMesh>;
  130229. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130230. get attachedNode(): Nullable<Node>;
  130231. set attachedNode(node: Nullable<Node>);
  130232. /**
  130233. * Creates a PositionGizmo
  130234. * @param gizmoLayer The utility layer the gizmo will be added to
  130235. @param thickness display gizmo axis thickness
  130236. */
  130237. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130238. /**
  130239. * If the planar drag gizmo is enabled
  130240. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130241. */
  130242. set planarGizmoEnabled(value: boolean);
  130243. get planarGizmoEnabled(): boolean;
  130244. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130245. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130246. /**
  130247. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130248. */
  130249. set snapDistance(value: number);
  130250. get snapDistance(): number;
  130251. /**
  130252. * Ratio for the scale of the gizmo (Default: 1)
  130253. */
  130254. set scaleRatio(value: number);
  130255. get scaleRatio(): number;
  130256. /**
  130257. * Disposes of the gizmo
  130258. */
  130259. dispose(): void;
  130260. /**
  130261. * CustomMeshes are not supported by this gizmo
  130262. * @param mesh The mesh to replace the default mesh of the gizmo
  130263. */
  130264. setCustomMesh(mesh: Mesh): void;
  130265. }
  130266. }
  130267. declare module BABYLON {
  130268. /**
  130269. * Single axis drag gizmo
  130270. */
  130271. export class AxisDragGizmo extends Gizmo {
  130272. /**
  130273. * Drag behavior responsible for the gizmos dragging interactions
  130274. */
  130275. dragBehavior: PointerDragBehavior;
  130276. private _pointerObserver;
  130277. /**
  130278. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130279. */
  130280. snapDistance: number;
  130281. /**
  130282. * Event that fires each time the gizmo snaps to a new location.
  130283. * * snapDistance is the the change in distance
  130284. */
  130285. onSnapObservable: Observable<{
  130286. snapDistance: number;
  130287. }>;
  130288. private _isEnabled;
  130289. private _parent;
  130290. private _arrow;
  130291. private _coloredMaterial;
  130292. private _hoverMaterial;
  130293. /** @hidden */
  130294. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130295. /** @hidden */
  130296. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130297. /**
  130298. * Creates an AxisDragGizmo
  130299. * @param gizmoLayer The utility layer the gizmo will be added to
  130300. * @param dragAxis The axis which the gizmo will be able to drag on
  130301. * @param color The color of the gizmo
  130302. * @param thickness display gizmo axis thickness
  130303. */
  130304. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130305. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130306. /**
  130307. * If the gizmo is enabled
  130308. */
  130309. set isEnabled(value: boolean);
  130310. get isEnabled(): boolean;
  130311. /**
  130312. * Disposes of the gizmo
  130313. */
  130314. dispose(): void;
  130315. }
  130316. }
  130317. declare module BABYLON.Debug {
  130318. /**
  130319. * The Axes viewer will show 3 axes in a specific point in space
  130320. */
  130321. export class AxesViewer {
  130322. private _xAxis;
  130323. private _yAxis;
  130324. private _zAxis;
  130325. private _scaleLinesFactor;
  130326. private _instanced;
  130327. /**
  130328. * Gets the hosting scene
  130329. */
  130330. scene: Nullable<Scene>;
  130331. /**
  130332. * Gets or sets a number used to scale line length
  130333. */
  130334. scaleLines: number;
  130335. /** Gets the node hierarchy used to render x-axis */
  130336. get xAxis(): TransformNode;
  130337. /** Gets the node hierarchy used to render y-axis */
  130338. get yAxis(): TransformNode;
  130339. /** Gets the node hierarchy used to render z-axis */
  130340. get zAxis(): TransformNode;
  130341. /**
  130342. * Creates a new AxesViewer
  130343. * @param scene defines the hosting scene
  130344. * @param scaleLines defines a number used to scale line length (1 by default)
  130345. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130346. * @param xAxis defines the node hierarchy used to render the x-axis
  130347. * @param yAxis defines the node hierarchy used to render the y-axis
  130348. * @param zAxis defines the node hierarchy used to render the z-axis
  130349. */
  130350. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130351. /**
  130352. * Force the viewer to update
  130353. * @param position defines the position of the viewer
  130354. * @param xaxis defines the x axis of the viewer
  130355. * @param yaxis defines the y axis of the viewer
  130356. * @param zaxis defines the z axis of the viewer
  130357. */
  130358. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130359. /**
  130360. * Creates an instance of this axes viewer.
  130361. * @returns a new axes viewer with instanced meshes
  130362. */
  130363. createInstance(): AxesViewer;
  130364. /** Releases resources */
  130365. dispose(): void;
  130366. private static _SetRenderingGroupId;
  130367. }
  130368. }
  130369. declare module BABYLON.Debug {
  130370. /**
  130371. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130372. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130373. */
  130374. export class BoneAxesViewer extends AxesViewer {
  130375. /**
  130376. * Gets or sets the target mesh where to display the axes viewer
  130377. */
  130378. mesh: Nullable<Mesh>;
  130379. /**
  130380. * Gets or sets the target bone where to display the axes viewer
  130381. */
  130382. bone: Nullable<Bone>;
  130383. /** Gets current position */
  130384. pos: Vector3;
  130385. /** Gets direction of X axis */
  130386. xaxis: Vector3;
  130387. /** Gets direction of Y axis */
  130388. yaxis: Vector3;
  130389. /** Gets direction of Z axis */
  130390. zaxis: Vector3;
  130391. /**
  130392. * Creates a new BoneAxesViewer
  130393. * @param scene defines the hosting scene
  130394. * @param bone defines the target bone
  130395. * @param mesh defines the target mesh
  130396. * @param scaleLines defines a scaling factor for line length (1 by default)
  130397. */
  130398. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130399. /**
  130400. * Force the viewer to update
  130401. */
  130402. update(): void;
  130403. /** Releases resources */
  130404. dispose(): void;
  130405. }
  130406. }
  130407. declare module BABYLON {
  130408. /**
  130409. * Interface used to define scene explorer extensibility option
  130410. */
  130411. export interface IExplorerExtensibilityOption {
  130412. /**
  130413. * Define the option label
  130414. */
  130415. label: string;
  130416. /**
  130417. * Defines the action to execute on click
  130418. */
  130419. action: (entity: any) => void;
  130420. }
  130421. /**
  130422. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130423. */
  130424. export interface IExplorerExtensibilityGroup {
  130425. /**
  130426. * Defines a predicate to test if a given type mut be extended
  130427. */
  130428. predicate: (entity: any) => boolean;
  130429. /**
  130430. * Gets the list of options added to a type
  130431. */
  130432. entries: IExplorerExtensibilityOption[];
  130433. }
  130434. /**
  130435. * Interface used to define the options to use to create the Inspector
  130436. */
  130437. export interface IInspectorOptions {
  130438. /**
  130439. * Display in overlay mode (default: false)
  130440. */
  130441. overlay?: boolean;
  130442. /**
  130443. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130444. */
  130445. globalRoot?: HTMLElement;
  130446. /**
  130447. * Display the Scene explorer
  130448. */
  130449. showExplorer?: boolean;
  130450. /**
  130451. * Display the property inspector
  130452. */
  130453. showInspector?: boolean;
  130454. /**
  130455. * Display in embed mode (both panes on the right)
  130456. */
  130457. embedMode?: boolean;
  130458. /**
  130459. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130460. */
  130461. handleResize?: boolean;
  130462. /**
  130463. * Allow the panes to popup (default: true)
  130464. */
  130465. enablePopup?: boolean;
  130466. /**
  130467. * Allow the panes to be closed by users (default: true)
  130468. */
  130469. enableClose?: boolean;
  130470. /**
  130471. * Optional list of extensibility entries
  130472. */
  130473. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130474. /**
  130475. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130476. */
  130477. inspectorURL?: string;
  130478. /**
  130479. * Optional initial tab (default to DebugLayerTab.Properties)
  130480. */
  130481. initialTab?: DebugLayerTab;
  130482. }
  130483. interface Scene {
  130484. /**
  130485. * @hidden
  130486. * Backing field
  130487. */
  130488. _debugLayer: DebugLayer;
  130489. /**
  130490. * Gets the debug layer (aka Inspector) associated with the scene
  130491. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130492. */
  130493. debugLayer: DebugLayer;
  130494. }
  130495. /**
  130496. * Enum of inspector action tab
  130497. */
  130498. export enum DebugLayerTab {
  130499. /**
  130500. * Properties tag (default)
  130501. */
  130502. Properties = 0,
  130503. /**
  130504. * Debug tab
  130505. */
  130506. Debug = 1,
  130507. /**
  130508. * Statistics tab
  130509. */
  130510. Statistics = 2,
  130511. /**
  130512. * Tools tab
  130513. */
  130514. Tools = 3,
  130515. /**
  130516. * Settings tab
  130517. */
  130518. Settings = 4
  130519. }
  130520. /**
  130521. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130522. * what is happening in your scene
  130523. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130524. */
  130525. export class DebugLayer {
  130526. /**
  130527. * Define the url to get the inspector script from.
  130528. * By default it uses the babylonjs CDN.
  130529. * @ignoreNaming
  130530. */
  130531. static InspectorURL: string;
  130532. private _scene;
  130533. private BJSINSPECTOR;
  130534. private _onPropertyChangedObservable?;
  130535. /**
  130536. * Observable triggered when a property is changed through the inspector.
  130537. */
  130538. get onPropertyChangedObservable(): any;
  130539. /**
  130540. * Instantiates a new debug layer.
  130541. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130542. * what is happening in your scene
  130543. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130544. * @param scene Defines the scene to inspect
  130545. */
  130546. constructor(scene: Scene);
  130547. /** Creates the inspector window. */
  130548. private _createInspector;
  130549. /**
  130550. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130551. * @param entity defines the entity to select
  130552. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130553. */
  130554. select(entity: any, lineContainerTitles?: string | string[]): void;
  130555. /** Get the inspector from bundle or global */
  130556. private _getGlobalInspector;
  130557. /**
  130558. * Get if the inspector is visible or not.
  130559. * @returns true if visible otherwise, false
  130560. */
  130561. isVisible(): boolean;
  130562. /**
  130563. * Hide the inspector and close its window.
  130564. */
  130565. hide(): void;
  130566. /**
  130567. * Update the scene in the inspector
  130568. */
  130569. setAsActiveScene(): void;
  130570. /**
  130571. * Launch the debugLayer.
  130572. * @param config Define the configuration of the inspector
  130573. * @return a promise fulfilled when the debug layer is visible
  130574. */
  130575. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130576. }
  130577. }
  130578. declare module BABYLON {
  130579. /**
  130580. * Class containing static functions to help procedurally build meshes
  130581. */
  130582. export class BoxBuilder {
  130583. /**
  130584. * Creates a box mesh
  130585. * * The parameter `size` sets the size (float) of each box side (default 1)
  130586. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130587. * * 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)
  130588. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130589. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130590. * * 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
  130591. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130592. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130593. * @param name defines the name of the mesh
  130594. * @param options defines the options used to create the mesh
  130595. * @param scene defines the hosting scene
  130596. * @returns the box mesh
  130597. */
  130598. static CreateBox(name: string, options: {
  130599. size?: number;
  130600. width?: number;
  130601. height?: number;
  130602. depth?: number;
  130603. faceUV?: Vector4[];
  130604. faceColors?: Color4[];
  130605. sideOrientation?: number;
  130606. frontUVs?: Vector4;
  130607. backUVs?: Vector4;
  130608. wrap?: boolean;
  130609. topBaseAt?: number;
  130610. bottomBaseAt?: number;
  130611. updatable?: boolean;
  130612. }, scene?: Nullable<Scene>): Mesh;
  130613. }
  130614. }
  130615. declare module BABYLON.Debug {
  130616. /**
  130617. * Used to show the physics impostor around the specific mesh
  130618. */
  130619. export class PhysicsViewer {
  130620. /** @hidden */
  130621. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130622. /** @hidden */
  130623. protected _meshes: Array<Nullable<AbstractMesh>>;
  130624. /** @hidden */
  130625. protected _scene: Nullable<Scene>;
  130626. /** @hidden */
  130627. protected _numMeshes: number;
  130628. /** @hidden */
  130629. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130630. private _renderFunction;
  130631. private _utilityLayer;
  130632. private _debugBoxMesh;
  130633. private _debugSphereMesh;
  130634. private _debugCylinderMesh;
  130635. private _debugMaterial;
  130636. private _debugMeshMeshes;
  130637. /**
  130638. * Creates a new PhysicsViewer
  130639. * @param scene defines the hosting scene
  130640. */
  130641. constructor(scene: Scene);
  130642. /** @hidden */
  130643. protected _updateDebugMeshes(): void;
  130644. /**
  130645. * Renders a specified physic impostor
  130646. * @param impostor defines the impostor to render
  130647. * @param targetMesh defines the mesh represented by the impostor
  130648. * @returns the new debug mesh used to render the impostor
  130649. */
  130650. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130651. /**
  130652. * Hides a specified physic impostor
  130653. * @param impostor defines the impostor to hide
  130654. */
  130655. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130656. private _getDebugMaterial;
  130657. private _getDebugBoxMesh;
  130658. private _getDebugSphereMesh;
  130659. private _getDebugCylinderMesh;
  130660. private _getDebugMeshMesh;
  130661. private _getDebugMesh;
  130662. /** Releases all resources */
  130663. dispose(): void;
  130664. }
  130665. }
  130666. declare module BABYLON {
  130667. /**
  130668. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130669. * in order to better appreciate the issue one might have.
  130670. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130671. */
  130672. export class RayHelper {
  130673. /**
  130674. * Defines the ray we are currently tryin to visualize.
  130675. */
  130676. ray: Nullable<Ray>;
  130677. private _renderPoints;
  130678. private _renderLine;
  130679. private _renderFunction;
  130680. private _scene;
  130681. private _onAfterRenderObserver;
  130682. private _onAfterStepObserver;
  130683. private _attachedToMesh;
  130684. private _meshSpaceDirection;
  130685. private _meshSpaceOrigin;
  130686. /**
  130687. * Helper function to create a colored helper in a scene in one line.
  130688. * @param ray Defines the ray we are currently tryin to visualize
  130689. * @param scene Defines the scene the ray is used in
  130690. * @param color Defines the color we want to see the ray in
  130691. * @returns The newly created ray helper.
  130692. */
  130693. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130694. /**
  130695. * Instantiate a new ray helper.
  130696. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130697. * in order to better appreciate the issue one might have.
  130698. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130699. * @param ray Defines the ray we are currently tryin to visualize
  130700. */
  130701. constructor(ray: Ray);
  130702. /**
  130703. * Shows the ray we are willing to debug.
  130704. * @param scene Defines the scene the ray needs to be rendered in
  130705. * @param color Defines the color the ray needs to be rendered in
  130706. */
  130707. show(scene: Scene, color?: Color3): void;
  130708. /**
  130709. * Hides the ray we are debugging.
  130710. */
  130711. hide(): void;
  130712. private _render;
  130713. /**
  130714. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130715. * @param mesh Defines the mesh we want the helper attached to
  130716. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130717. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130718. * @param length Defines the length of the ray
  130719. */
  130720. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130721. /**
  130722. * Detach the ray helper from the mesh it has previously been attached to.
  130723. */
  130724. detachFromMesh(): void;
  130725. private _updateToMesh;
  130726. /**
  130727. * Dispose the helper and release its associated resources.
  130728. */
  130729. dispose(): void;
  130730. }
  130731. }
  130732. declare module BABYLON {
  130733. /**
  130734. * Defines the options associated with the creation of a SkeletonViewer.
  130735. */
  130736. export interface ISkeletonViewerOptions {
  130737. /** Should the system pause animations before building the Viewer? */
  130738. pauseAnimations: boolean;
  130739. /** Should the system return the skeleton to rest before building? */
  130740. returnToRest: boolean;
  130741. /** public Display Mode of the Viewer */
  130742. displayMode: number;
  130743. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130744. displayOptions: ISkeletonViewerDisplayOptions;
  130745. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130746. computeBonesUsingShaders: boolean;
  130747. /** Flag ignore non weighted bones */
  130748. useAllBones: boolean;
  130749. }
  130750. /**
  130751. * Defines how to display the various bone meshes for the viewer.
  130752. */
  130753. export interface ISkeletonViewerDisplayOptions {
  130754. /** How far down to start tapering the bone spurs */
  130755. midStep?: number;
  130756. /** How big is the midStep? */
  130757. midStepFactor?: number;
  130758. /** Base for the Sphere Size */
  130759. sphereBaseSize?: number;
  130760. /** The ratio of the sphere to the longest bone in units */
  130761. sphereScaleUnit?: number;
  130762. /** Ratio for the Sphere Size */
  130763. sphereFactor?: number;
  130764. }
  130765. /**
  130766. * Defines the constructor options for the BoneWeight Shader.
  130767. */
  130768. export interface IBoneWeightShaderOptions {
  130769. /** Skeleton to Map */
  130770. skeleton: Skeleton;
  130771. /** Colors for Uninfluenced bones */
  130772. colorBase?: Color3;
  130773. /** Colors for 0.0-0.25 Weight bones */
  130774. colorZero?: Color3;
  130775. /** Color for 0.25-0.5 Weight Influence */
  130776. colorQuarter?: Color3;
  130777. /** Color for 0.5-0.75 Weight Influence */
  130778. colorHalf?: Color3;
  130779. /** Color for 0.75-1 Weight Influence */
  130780. colorFull?: Color3;
  130781. /** Color for Zero Weight Influence */
  130782. targetBoneIndex?: number;
  130783. }
  130784. /**
  130785. * Simple structure of the gradient steps for the Color Map.
  130786. */
  130787. export interface ISkeletonMapShaderColorMapKnot {
  130788. /** Color of the Knot */
  130789. color: Color3;
  130790. /** Location of the Knot */
  130791. location: number;
  130792. }
  130793. /**
  130794. * Defines the constructor options for the SkeletonMap Shader.
  130795. */
  130796. export interface ISkeletonMapShaderOptions {
  130797. /** Skeleton to Map */
  130798. skeleton: Skeleton;
  130799. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  130800. colorMap?: ISkeletonMapShaderColorMapKnot[];
  130801. }
  130802. }
  130803. declare module BABYLON {
  130804. /**
  130805. * Class containing static functions to help procedurally build meshes
  130806. */
  130807. export class RibbonBuilder {
  130808. /**
  130809. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130810. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130811. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130812. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130813. * * 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
  130814. * * 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
  130815. * * 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
  130816. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130817. * * 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
  130818. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130819. * * 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
  130820. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130821. * * 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
  130822. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130823. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130824. * @param name defines the name of the mesh
  130825. * @param options defines the options used to create the mesh
  130826. * @param scene defines the hosting scene
  130827. * @returns the ribbon mesh
  130828. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130829. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130830. */
  130831. static CreateRibbon(name: string, options: {
  130832. pathArray: Vector3[][];
  130833. closeArray?: boolean;
  130834. closePath?: boolean;
  130835. offset?: number;
  130836. updatable?: boolean;
  130837. sideOrientation?: number;
  130838. frontUVs?: Vector4;
  130839. backUVs?: Vector4;
  130840. instance?: Mesh;
  130841. invertUV?: boolean;
  130842. uvs?: Vector2[];
  130843. colors?: Color4[];
  130844. }, scene?: Nullable<Scene>): Mesh;
  130845. }
  130846. }
  130847. declare module BABYLON {
  130848. /**
  130849. * Class containing static functions to help procedurally build meshes
  130850. */
  130851. export class ShapeBuilder {
  130852. /**
  130853. * 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.
  130854. * * 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.
  130855. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130856. * * 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.
  130857. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130858. * * 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
  130859. * * 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
  130860. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130861. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130862. * * 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
  130863. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130864. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130865. * @param name defines the name of the mesh
  130866. * @param options defines the options used to create the mesh
  130867. * @param scene defines the hosting scene
  130868. * @returns the extruded shape mesh
  130869. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130870. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130871. */
  130872. static ExtrudeShape(name: string, options: {
  130873. shape: Vector3[];
  130874. path: Vector3[];
  130875. scale?: number;
  130876. rotation?: number;
  130877. cap?: number;
  130878. updatable?: boolean;
  130879. sideOrientation?: number;
  130880. frontUVs?: Vector4;
  130881. backUVs?: Vector4;
  130882. instance?: Mesh;
  130883. invertUV?: boolean;
  130884. }, scene?: Nullable<Scene>): Mesh;
  130885. /**
  130886. * Creates an custom extruded shape mesh.
  130887. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130888. * * 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.
  130889. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130890. * * 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
  130891. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130892. * * 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
  130893. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130894. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130895. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130896. * * 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
  130897. * * 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
  130898. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130899. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130900. * * 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
  130901. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130902. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130903. * @param name defines the name of the mesh
  130904. * @param options defines the options used to create the mesh
  130905. * @param scene defines the hosting scene
  130906. * @returns the custom extruded shape mesh
  130907. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130908. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130909. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130910. */
  130911. static ExtrudeShapeCustom(name: string, options: {
  130912. shape: Vector3[];
  130913. path: Vector3[];
  130914. scaleFunction?: any;
  130915. rotationFunction?: any;
  130916. ribbonCloseArray?: boolean;
  130917. ribbonClosePath?: boolean;
  130918. cap?: number;
  130919. updatable?: boolean;
  130920. sideOrientation?: number;
  130921. frontUVs?: Vector4;
  130922. backUVs?: Vector4;
  130923. instance?: Mesh;
  130924. invertUV?: boolean;
  130925. }, scene?: Nullable<Scene>): Mesh;
  130926. private static _ExtrudeShapeGeneric;
  130927. }
  130928. }
  130929. declare module BABYLON.Debug {
  130930. /**
  130931. * Class used to render a debug view of a given skeleton
  130932. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130933. */
  130934. export class SkeletonViewer {
  130935. /** defines the skeleton to render */
  130936. skeleton: Skeleton;
  130937. /** defines the mesh attached to the skeleton */
  130938. mesh: AbstractMesh;
  130939. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130940. autoUpdateBonesMatrices: boolean;
  130941. /** defines the rendering group id to use with the viewer */
  130942. renderingGroupId: number;
  130943. /** is the options for the viewer */
  130944. options: Partial<ISkeletonViewerOptions>;
  130945. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130946. static readonly DISPLAY_LINES: number;
  130947. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130948. static readonly DISPLAY_SPHERES: number;
  130949. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130950. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130951. /** public static method to create a BoneWeight Shader
  130952. * @param options The constructor options
  130953. * @param scene The scene that the shader is scoped to
  130954. * @returns The created ShaderMaterial
  130955. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  130956. */
  130957. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  130958. /** public static method to create a BoneWeight Shader
  130959. * @param options The constructor options
  130960. * @param scene The scene that the shader is scoped to
  130961. * @returns The created ShaderMaterial
  130962. */
  130963. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  130964. /** private static method to create a BoneWeight Shader
  130965. * @param size The size of the buffer to create (usually the bone count)
  130966. * @param colorMap The gradient data to generate
  130967. * @param scene The scene that the shader is scoped to
  130968. * @returns an Array of floats from the color gradient values
  130969. */
  130970. private static _CreateBoneMapColorBuffer;
  130971. /** If SkeletonViewer scene scope. */
  130972. private _scene;
  130973. /** Gets or sets the color used to render the skeleton */
  130974. color: Color3;
  130975. /** Array of the points of the skeleton fo the line view. */
  130976. private _debugLines;
  130977. /** The SkeletonViewers Mesh. */
  130978. private _debugMesh;
  130979. /** If SkeletonViewer is enabled. */
  130980. private _isEnabled;
  130981. /** If SkeletonViewer is ready. */
  130982. private _ready;
  130983. /** SkeletonViewer render observable. */
  130984. private _obs;
  130985. /** The Utility Layer to render the gizmos in. */
  130986. private _utilityLayer;
  130987. private _boneIndices;
  130988. /** Gets the Scene. */
  130989. get scene(): Scene;
  130990. /** Gets the utilityLayer. */
  130991. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130992. /** Checks Ready Status. */
  130993. get isReady(): Boolean;
  130994. /** Sets Ready Status. */
  130995. set ready(value: boolean);
  130996. /** Gets the debugMesh */
  130997. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130998. /** Sets the debugMesh */
  130999. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  131000. /** Gets the material */
  131001. get material(): StandardMaterial;
  131002. /** Sets the material */
  131003. set material(value: StandardMaterial);
  131004. /** Gets the material */
  131005. get displayMode(): number;
  131006. /** Sets the material */
  131007. set displayMode(value: number);
  131008. /**
  131009. * Creates a new SkeletonViewer
  131010. * @param skeleton defines the skeleton to render
  131011. * @param mesh defines the mesh attached to the skeleton
  131012. * @param scene defines the hosting scene
  131013. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  131014. * @param renderingGroupId defines the rendering group id to use with the viewer
  131015. * @param options All of the extra constructor options for the SkeletonViewer
  131016. */
  131017. constructor(
  131018. /** defines the skeleton to render */
  131019. skeleton: Skeleton,
  131020. /** defines the mesh attached to the skeleton */
  131021. mesh: AbstractMesh,
  131022. /** The Scene scope*/
  131023. scene: Scene,
  131024. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131025. autoUpdateBonesMatrices?: boolean,
  131026. /** defines the rendering group id to use with the viewer */
  131027. renderingGroupId?: number,
  131028. /** is the options for the viewer */
  131029. options?: Partial<ISkeletonViewerOptions>);
  131030. /** The Dynamic bindings for the update functions */
  131031. private _bindObs;
  131032. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  131033. update(): void;
  131034. /** Gets or sets a boolean indicating if the viewer is enabled */
  131035. set isEnabled(value: boolean);
  131036. get isEnabled(): boolean;
  131037. private _getBonePosition;
  131038. private _getLinesForBonesWithLength;
  131039. private _getLinesForBonesNoLength;
  131040. /** function to revert the mesh and scene back to the initial state. */
  131041. private _revert;
  131042. /** function to build and bind sphere joint points and spur bone representations. */
  131043. private _buildSpheresAndSpurs;
  131044. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  131045. private _displayLinesUpdate;
  131046. /** Changes the displayMode of the skeleton viewer
  131047. * @param mode The displayMode numerical value
  131048. */
  131049. changeDisplayMode(mode: number): void;
  131050. /** Changes the displayMode of the skeleton viewer
  131051. * @param option String of the option name
  131052. * @param value The numerical option value
  131053. */
  131054. changeDisplayOptions(option: string, value: number): void;
  131055. /** Release associated resources */
  131056. dispose(): void;
  131057. }
  131058. }
  131059. declare module BABYLON {
  131060. /**
  131061. * Enum for Device Types
  131062. */
  131063. export enum DeviceType {
  131064. /** Generic */
  131065. Generic = 0,
  131066. /** Keyboard */
  131067. Keyboard = 1,
  131068. /** Mouse */
  131069. Mouse = 2,
  131070. /** Touch Pointers */
  131071. Touch = 3,
  131072. /** PS4 Dual Shock */
  131073. DualShock = 4,
  131074. /** Xbox */
  131075. Xbox = 5,
  131076. /** Switch Controller */
  131077. Switch = 6
  131078. }
  131079. /**
  131080. * Enum for All Pointers (Touch/Mouse)
  131081. */
  131082. export enum PointerInput {
  131083. /** Horizontal Axis */
  131084. Horizontal = 0,
  131085. /** Vertical Axis */
  131086. Vertical = 1,
  131087. /** Left Click or Touch */
  131088. LeftClick = 2,
  131089. /** Middle Click */
  131090. MiddleClick = 3,
  131091. /** Right Click */
  131092. RightClick = 4,
  131093. /** Browser Back */
  131094. BrowserBack = 5,
  131095. /** Browser Forward */
  131096. BrowserForward = 6
  131097. }
  131098. /**
  131099. * Enum for Dual Shock Gamepad
  131100. */
  131101. export enum DualShockInput {
  131102. /** Cross */
  131103. Cross = 0,
  131104. /** Circle */
  131105. Circle = 1,
  131106. /** Square */
  131107. Square = 2,
  131108. /** Triangle */
  131109. Triangle = 3,
  131110. /** L1 */
  131111. L1 = 4,
  131112. /** R1 */
  131113. R1 = 5,
  131114. /** L2 */
  131115. L2 = 6,
  131116. /** R2 */
  131117. R2 = 7,
  131118. /** Share */
  131119. Share = 8,
  131120. /** Options */
  131121. Options = 9,
  131122. /** L3 */
  131123. L3 = 10,
  131124. /** R3 */
  131125. R3 = 11,
  131126. /** DPadUp */
  131127. DPadUp = 12,
  131128. /** DPadDown */
  131129. DPadDown = 13,
  131130. /** DPadLeft */
  131131. DPadLeft = 14,
  131132. /** DRight */
  131133. DPadRight = 15,
  131134. /** Home */
  131135. Home = 16,
  131136. /** TouchPad */
  131137. TouchPad = 17,
  131138. /** LStickXAxis */
  131139. LStickXAxis = 18,
  131140. /** LStickYAxis */
  131141. LStickYAxis = 19,
  131142. /** RStickXAxis */
  131143. RStickXAxis = 20,
  131144. /** RStickYAxis */
  131145. RStickYAxis = 21
  131146. }
  131147. /**
  131148. * Enum for Xbox Gamepad
  131149. */
  131150. export enum XboxInput {
  131151. /** A */
  131152. A = 0,
  131153. /** B */
  131154. B = 1,
  131155. /** X */
  131156. X = 2,
  131157. /** Y */
  131158. Y = 3,
  131159. /** LB */
  131160. LB = 4,
  131161. /** RB */
  131162. RB = 5,
  131163. /** LT */
  131164. LT = 6,
  131165. /** RT */
  131166. RT = 7,
  131167. /** Back */
  131168. Back = 8,
  131169. /** Start */
  131170. Start = 9,
  131171. /** LS */
  131172. LS = 10,
  131173. /** RS */
  131174. RS = 11,
  131175. /** DPadUp */
  131176. DPadUp = 12,
  131177. /** DPadDown */
  131178. DPadDown = 13,
  131179. /** DPadLeft */
  131180. DPadLeft = 14,
  131181. /** DRight */
  131182. DPadRight = 15,
  131183. /** Home */
  131184. Home = 16,
  131185. /** LStickXAxis */
  131186. LStickXAxis = 17,
  131187. /** LStickYAxis */
  131188. LStickYAxis = 18,
  131189. /** RStickXAxis */
  131190. RStickXAxis = 19,
  131191. /** RStickYAxis */
  131192. RStickYAxis = 20
  131193. }
  131194. /**
  131195. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131196. */
  131197. export enum SwitchInput {
  131198. /** B */
  131199. B = 0,
  131200. /** A */
  131201. A = 1,
  131202. /** Y */
  131203. Y = 2,
  131204. /** X */
  131205. X = 3,
  131206. /** L */
  131207. L = 4,
  131208. /** R */
  131209. R = 5,
  131210. /** ZL */
  131211. ZL = 6,
  131212. /** ZR */
  131213. ZR = 7,
  131214. /** Minus */
  131215. Minus = 8,
  131216. /** Plus */
  131217. Plus = 9,
  131218. /** LS */
  131219. LS = 10,
  131220. /** RS */
  131221. RS = 11,
  131222. /** DPadUp */
  131223. DPadUp = 12,
  131224. /** DPadDown */
  131225. DPadDown = 13,
  131226. /** DPadLeft */
  131227. DPadLeft = 14,
  131228. /** DRight */
  131229. DPadRight = 15,
  131230. /** Home */
  131231. Home = 16,
  131232. /** Capture */
  131233. Capture = 17,
  131234. /** LStickXAxis */
  131235. LStickXAxis = 18,
  131236. /** LStickYAxis */
  131237. LStickYAxis = 19,
  131238. /** RStickXAxis */
  131239. RStickXAxis = 20,
  131240. /** RStickYAxis */
  131241. RStickYAxis = 21
  131242. }
  131243. }
  131244. declare module BABYLON {
  131245. /**
  131246. * This class will take all inputs from Keyboard, Pointer, and
  131247. * any Gamepads and provide a polling system that all devices
  131248. * will use. This class assumes that there will only be one
  131249. * pointer device and one keyboard.
  131250. */
  131251. export class DeviceInputSystem implements IDisposable {
  131252. /**
  131253. * Callback to be triggered when a device is connected
  131254. */
  131255. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131256. /**
  131257. * Callback to be triggered when a device is disconnected
  131258. */
  131259. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131260. /**
  131261. * Callback to be triggered when event driven input is updated
  131262. */
  131263. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131264. private _inputs;
  131265. private _gamepads;
  131266. private _keyboardActive;
  131267. private _pointerActive;
  131268. private _elementToAttachTo;
  131269. private _keyboardDownEvent;
  131270. private _keyboardUpEvent;
  131271. private _pointerMoveEvent;
  131272. private _pointerDownEvent;
  131273. private _pointerUpEvent;
  131274. private _gamepadConnectedEvent;
  131275. private _gamepadDisconnectedEvent;
  131276. private static _MAX_KEYCODES;
  131277. private static _MAX_POINTER_INPUTS;
  131278. private constructor();
  131279. /**
  131280. * Creates a new DeviceInputSystem instance
  131281. * @param engine Engine to pull input element from
  131282. * @returns The new instance
  131283. */
  131284. static Create(engine: Engine): DeviceInputSystem;
  131285. /**
  131286. * Checks for current device input value, given an id and input index
  131287. * @param deviceName Id of connected device
  131288. * @param inputIndex Index of device input
  131289. * @returns Current value of input
  131290. */
  131291. /**
  131292. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131293. * @param deviceType Enum specifiying device type
  131294. * @param deviceSlot "Slot" or index that device is referenced in
  131295. * @param inputIndex Id of input to be checked
  131296. * @returns Current value of input
  131297. */
  131298. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131299. /**
  131300. * Dispose of all the eventlisteners
  131301. */
  131302. dispose(): void;
  131303. /**
  131304. * Add device and inputs to device array
  131305. * @param deviceType Enum specifiying device type
  131306. * @param deviceSlot "Slot" or index that device is referenced in
  131307. * @param numberOfInputs Number of input entries to create for given device
  131308. */
  131309. private _registerDevice;
  131310. /**
  131311. * Given a specific device name, remove that device from the device map
  131312. * @param deviceType Enum specifiying device type
  131313. * @param deviceSlot "Slot" or index that device is referenced in
  131314. */
  131315. private _unregisterDevice;
  131316. /**
  131317. * Handle all actions that come from keyboard interaction
  131318. */
  131319. private _handleKeyActions;
  131320. /**
  131321. * Handle all actions that come from pointer interaction
  131322. */
  131323. private _handlePointerActions;
  131324. /**
  131325. * Handle all actions that come from gamepad interaction
  131326. */
  131327. private _handleGamepadActions;
  131328. /**
  131329. * Update all non-event based devices with each frame
  131330. * @param deviceType Enum specifiying device type
  131331. * @param deviceSlot "Slot" or index that device is referenced in
  131332. * @param inputIndex Id of input to be checked
  131333. */
  131334. private _updateDevice;
  131335. /**
  131336. * Gets DeviceType from the device name
  131337. * @param deviceName Name of Device from DeviceInputSystem
  131338. * @returns DeviceType enum value
  131339. */
  131340. private _getGamepadDeviceType;
  131341. }
  131342. }
  131343. declare module BABYLON {
  131344. /**
  131345. * Type to handle enforcement of inputs
  131346. */
  131347. export type DeviceInput<T extends DeviceType> = T extends DeviceType.Keyboard | DeviceType.Generic ? number : T extends DeviceType.Mouse | DeviceType.Touch ? PointerInput : T extends DeviceType.DualShock ? DualShockInput : T extends DeviceType.Xbox ? XboxInput : T extends DeviceType.Switch ? SwitchInput : never;
  131348. }
  131349. declare module BABYLON {
  131350. /**
  131351. * Class that handles all input for a specific device
  131352. */
  131353. export class DeviceSource<T extends DeviceType> {
  131354. /** Type of device */
  131355. readonly deviceType: DeviceType;
  131356. /** "Slot" or index that device is referenced in */
  131357. readonly deviceSlot: number;
  131358. /**
  131359. * Observable to handle device input changes per device
  131360. */
  131361. readonly onInputChangedObservable: Observable<{
  131362. inputIndex: DeviceInput<T>;
  131363. previousState: Nullable<number>;
  131364. currentState: Nullable<number>;
  131365. }>;
  131366. private readonly _deviceInputSystem;
  131367. /**
  131368. * Default Constructor
  131369. * @param deviceInputSystem Reference to DeviceInputSystem
  131370. * @param deviceType Type of device
  131371. * @param deviceSlot "Slot" or index that device is referenced in
  131372. */
  131373. constructor(deviceInputSystem: DeviceInputSystem,
  131374. /** Type of device */
  131375. deviceType: DeviceType,
  131376. /** "Slot" or index that device is referenced in */
  131377. deviceSlot?: number);
  131378. /**
  131379. * Get input for specific input
  131380. * @param inputIndex index of specific input on device
  131381. * @returns Input value from DeviceInputSystem
  131382. */
  131383. getInput(inputIndex: DeviceInput<T>): number;
  131384. }
  131385. /**
  131386. * Class to keep track of devices
  131387. */
  131388. export class DeviceSourceManager implements IDisposable {
  131389. /**
  131390. * Observable to be triggered when before a device is connected
  131391. */
  131392. readonly onBeforeDeviceConnectedObservable: Observable<{
  131393. deviceType: DeviceType;
  131394. deviceSlot: number;
  131395. }>;
  131396. /**
  131397. * Observable to be triggered when before a device is disconnected
  131398. */
  131399. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131400. deviceType: DeviceType;
  131401. deviceSlot: number;
  131402. }>;
  131403. /**
  131404. * Observable to be triggered when after a device is connected
  131405. */
  131406. readonly onAfterDeviceConnectedObservable: Observable<{
  131407. deviceType: DeviceType;
  131408. deviceSlot: number;
  131409. }>;
  131410. /**
  131411. * Observable to be triggered when after a device is disconnected
  131412. */
  131413. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131414. deviceType: DeviceType;
  131415. deviceSlot: number;
  131416. }>;
  131417. private readonly _devices;
  131418. private readonly _firstDevice;
  131419. private readonly _deviceInputSystem;
  131420. /**
  131421. * Default Constructor
  131422. * @param engine engine to pull input element from
  131423. */
  131424. constructor(engine: Engine);
  131425. /**
  131426. * Gets a DeviceSource, given a type and slot
  131427. * @param deviceType Enum specifying device type
  131428. * @param deviceSlot "Slot" or index that device is referenced in
  131429. * @returns DeviceSource object
  131430. */
  131431. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131432. /**
  131433. * Gets an array of DeviceSource objects for a given device type
  131434. * @param deviceType Enum specifying device type
  131435. * @returns Array of DeviceSource objects
  131436. */
  131437. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131438. /**
  131439. * Dispose of DeviceInputSystem and other parts
  131440. */
  131441. dispose(): void;
  131442. /**
  131443. * Function to add device name to device list
  131444. * @param deviceType Enum specifying device type
  131445. * @param deviceSlot "Slot" or index that device is referenced in
  131446. */
  131447. private _addDevice;
  131448. /**
  131449. * Function to remove device name to device list
  131450. * @param deviceType Enum specifying device type
  131451. * @param deviceSlot "Slot" or index that device is referenced in
  131452. */
  131453. private _removeDevice;
  131454. /**
  131455. * Updates array storing first connected device of each type
  131456. * @param type Type of Device
  131457. */
  131458. private _updateFirstDevices;
  131459. }
  131460. }
  131461. declare module BABYLON {
  131462. /**
  131463. * Options to create the null engine
  131464. */
  131465. export class NullEngineOptions {
  131466. /**
  131467. * Render width (Default: 512)
  131468. */
  131469. renderWidth: number;
  131470. /**
  131471. * Render height (Default: 256)
  131472. */
  131473. renderHeight: number;
  131474. /**
  131475. * Texture size (Default: 512)
  131476. */
  131477. textureSize: number;
  131478. /**
  131479. * If delta time between frames should be constant
  131480. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131481. */
  131482. deterministicLockstep: boolean;
  131483. /**
  131484. * Maximum about of steps between frames (Default: 4)
  131485. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131486. */
  131487. lockstepMaxSteps: number;
  131488. /**
  131489. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131490. */
  131491. useHighPrecisionMatrix?: boolean;
  131492. }
  131493. /**
  131494. * The null engine class provides support for headless version of babylon.js.
  131495. * This can be used in server side scenario or for testing purposes
  131496. */
  131497. export class NullEngine extends Engine {
  131498. private _options;
  131499. /**
  131500. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131501. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131502. * @returns true if engine is in deterministic lock step mode
  131503. */
  131504. isDeterministicLockStep(): boolean;
  131505. /**
  131506. * Gets the max steps when engine is running in deterministic lock step
  131507. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131508. * @returns the max steps
  131509. */
  131510. getLockstepMaxSteps(): number;
  131511. /**
  131512. * Gets the current hardware scaling level.
  131513. * By default the hardware scaling level is computed from the window device ratio.
  131514. * 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.
  131515. * @returns a number indicating the current hardware scaling level
  131516. */
  131517. getHardwareScalingLevel(): number;
  131518. constructor(options?: NullEngineOptions);
  131519. /**
  131520. * Creates a vertex buffer
  131521. * @param vertices the data for the vertex buffer
  131522. * @returns the new WebGL static buffer
  131523. */
  131524. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131525. /**
  131526. * Creates a new index buffer
  131527. * @param indices defines the content of the index buffer
  131528. * @param updatable defines if the index buffer must be updatable
  131529. * @returns a new webGL buffer
  131530. */
  131531. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131532. /**
  131533. * Clear the current render buffer or the current render target (if any is set up)
  131534. * @param color defines the color to use
  131535. * @param backBuffer defines if the back buffer must be cleared
  131536. * @param depth defines if the depth buffer must be cleared
  131537. * @param stencil defines if the stencil buffer must be cleared
  131538. */
  131539. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131540. /**
  131541. * Gets the current render width
  131542. * @param useScreen defines if screen size must be used (or the current render target if any)
  131543. * @returns a number defining the current render width
  131544. */
  131545. getRenderWidth(useScreen?: boolean): number;
  131546. /**
  131547. * Gets the current render height
  131548. * @param useScreen defines if screen size must be used (or the current render target if any)
  131549. * @returns a number defining the current render height
  131550. */
  131551. getRenderHeight(useScreen?: boolean): number;
  131552. /**
  131553. * Set the WebGL's viewport
  131554. * @param viewport defines the viewport element to be used
  131555. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131556. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131557. */
  131558. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131559. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131560. /**
  131561. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131562. * @param pipelineContext defines the pipeline context to use
  131563. * @param uniformsNames defines the list of uniform names
  131564. * @returns an array of webGL uniform locations
  131565. */
  131566. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131567. /**
  131568. * Gets the lsit of active attributes for a given webGL program
  131569. * @param pipelineContext defines the pipeline context to use
  131570. * @param attributesNames defines the list of attribute names to get
  131571. * @returns an array of indices indicating the offset of each attribute
  131572. */
  131573. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131574. /**
  131575. * Binds an effect to the webGL context
  131576. * @param effect defines the effect to bind
  131577. */
  131578. bindSamplers(effect: Effect): void;
  131579. /**
  131580. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131581. * @param effect defines the effect to activate
  131582. */
  131583. enableEffect(effect: Effect): void;
  131584. /**
  131585. * Set various states to the webGL context
  131586. * @param culling defines backface culling state
  131587. * @param zOffset defines the value to apply to zOffset (0 by default)
  131588. * @param force defines if states must be applied even if cache is up to date
  131589. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131590. */
  131591. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131592. /**
  131593. * Set the value of an uniform to an array of int32
  131594. * @param uniform defines the webGL uniform location where to store the value
  131595. * @param array defines the array of int32 to store
  131596. */
  131597. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131598. /**
  131599. * Set the value of an uniform to an array of int32 (stored as vec2)
  131600. * @param uniform defines the webGL uniform location where to store the value
  131601. * @param array defines the array of int32 to store
  131602. */
  131603. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131604. /**
  131605. * Set the value of an uniform to an array of int32 (stored as vec3)
  131606. * @param uniform defines the webGL uniform location where to store the value
  131607. * @param array defines the array of int32 to store
  131608. */
  131609. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131610. /**
  131611. * Set the value of an uniform to an array of int32 (stored as vec4)
  131612. * @param uniform defines the webGL uniform location where to store the value
  131613. * @param array defines the array of int32 to store
  131614. */
  131615. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131616. /**
  131617. * Set the value of an uniform to an array of float32
  131618. * @param uniform defines the webGL uniform location where to store the value
  131619. * @param array defines the array of float32 to store
  131620. */
  131621. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131622. /**
  131623. * Set the value of an uniform to an array of float32 (stored as vec2)
  131624. * @param uniform defines the webGL uniform location where to store the value
  131625. * @param array defines the array of float32 to store
  131626. */
  131627. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131628. /**
  131629. * Set the value of an uniform to an array of float32 (stored as vec3)
  131630. * @param uniform defines the webGL uniform location where to store the value
  131631. * @param array defines the array of float32 to store
  131632. */
  131633. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131634. /**
  131635. * Set the value of an uniform to an array of float32 (stored as vec4)
  131636. * @param uniform defines the webGL uniform location where to store the value
  131637. * @param array defines the array of float32 to store
  131638. */
  131639. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131640. /**
  131641. * Set the value of an uniform to an array of number
  131642. * @param uniform defines the webGL uniform location where to store the value
  131643. * @param array defines the array of number to store
  131644. */
  131645. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131646. /**
  131647. * Set the value of an uniform to an array of number (stored as vec2)
  131648. * @param uniform defines the webGL uniform location where to store the value
  131649. * @param array defines the array of number to store
  131650. */
  131651. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131652. /**
  131653. * Set the value of an uniform to an array of number (stored as vec3)
  131654. * @param uniform defines the webGL uniform location where to store the value
  131655. * @param array defines the array of number to store
  131656. */
  131657. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131658. /**
  131659. * Set the value of an uniform to an array of number (stored as vec4)
  131660. * @param uniform defines the webGL uniform location where to store the value
  131661. * @param array defines the array of number to store
  131662. */
  131663. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131664. /**
  131665. * Set the value of an uniform to an array of float32 (stored as matrices)
  131666. * @param uniform defines the webGL uniform location where to store the value
  131667. * @param matrices defines the array of float32 to store
  131668. */
  131669. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131670. /**
  131671. * Set the value of an uniform to a matrix (3x3)
  131672. * @param uniform defines the webGL uniform location where to store the value
  131673. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131674. */
  131675. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131676. /**
  131677. * Set the value of an uniform to a matrix (2x2)
  131678. * @param uniform defines the webGL uniform location where to store the value
  131679. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131680. */
  131681. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131682. /**
  131683. * Set the value of an uniform to a number (float)
  131684. * @param uniform defines the webGL uniform location where to store the value
  131685. * @param value defines the float number to store
  131686. */
  131687. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131688. /**
  131689. * Set the value of an uniform to a vec2
  131690. * @param uniform defines the webGL uniform location where to store the value
  131691. * @param x defines the 1st component of the value
  131692. * @param y defines the 2nd component of the value
  131693. */
  131694. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131695. /**
  131696. * Set the value of an uniform to a vec3
  131697. * @param uniform defines the webGL uniform location where to store the value
  131698. * @param x defines the 1st component of the value
  131699. * @param y defines the 2nd component of the value
  131700. * @param z defines the 3rd component of the value
  131701. */
  131702. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131703. /**
  131704. * Set the value of an uniform to a boolean
  131705. * @param uniform defines the webGL uniform location where to store the value
  131706. * @param bool defines the boolean to store
  131707. */
  131708. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131709. /**
  131710. * Set the value of an uniform to a vec4
  131711. * @param uniform defines the webGL uniform location where to store the value
  131712. * @param x defines the 1st component of the value
  131713. * @param y defines the 2nd component of the value
  131714. * @param z defines the 3rd component of the value
  131715. * @param w defines the 4th component of the value
  131716. */
  131717. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131718. /**
  131719. * Sets the current alpha mode
  131720. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131721. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131722. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131723. */
  131724. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131725. /**
  131726. * Bind webGl buffers directly to the webGL context
  131727. * @param vertexBuffers defines the vertex buffer to bind
  131728. * @param indexBuffer defines the index buffer to bind
  131729. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131730. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131731. * @param effect defines the effect associated with the vertex buffer
  131732. */
  131733. bindBuffers(vertexBuffers: {
  131734. [key: string]: VertexBuffer;
  131735. }, indexBuffer: DataBuffer, effect: Effect): void;
  131736. /**
  131737. * Force the entire cache to be cleared
  131738. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131739. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131740. */
  131741. wipeCaches(bruteForce?: boolean): void;
  131742. /**
  131743. * Send a draw order
  131744. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131745. * @param indexStart defines the starting index
  131746. * @param indexCount defines the number of index to draw
  131747. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131748. */
  131749. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131750. /**
  131751. * Draw a list of indexed primitives
  131752. * @param fillMode defines the primitive to use
  131753. * @param indexStart defines the starting index
  131754. * @param indexCount defines the number of index to draw
  131755. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131756. */
  131757. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131758. /**
  131759. * Draw a list of unindexed primitives
  131760. * @param fillMode defines the primitive to use
  131761. * @param verticesStart defines the index of first vertex to draw
  131762. * @param verticesCount defines the count of vertices to draw
  131763. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131764. */
  131765. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131766. /** @hidden */
  131767. _createTexture(): WebGLTexture;
  131768. /** @hidden */
  131769. _releaseTexture(texture: InternalTexture): void;
  131770. /**
  131771. * Usually called from Texture.ts.
  131772. * Passed information to create a WebGLTexture
  131773. * @param urlArg defines a value which contains one of the following:
  131774. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131775. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131776. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131777. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131778. * @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)
  131779. * @param scene needed for loading to the correct scene
  131780. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131781. * @param onLoad optional callback to be called upon successful completion
  131782. * @param onError optional callback to be called upon failure
  131783. * @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
  131784. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131785. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131786. * @param forcedExtension defines the extension to use to pick the right loader
  131787. * @param mimeType defines an optional mime type
  131788. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131789. */
  131790. 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>, mimeType?: string): InternalTexture;
  131791. /**
  131792. * Creates a new render target texture
  131793. * @param size defines the size of the texture
  131794. * @param options defines the options used to create the texture
  131795. * @returns a new render target texture stored in an InternalTexture
  131796. */
  131797. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131798. /**
  131799. * Update the sampling mode of a given texture
  131800. * @param samplingMode defines the required sampling mode
  131801. * @param texture defines the texture to update
  131802. */
  131803. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131804. /**
  131805. * Binds the frame buffer to the specified texture.
  131806. * @param texture The texture to render to or null for the default canvas
  131807. * @param faceIndex The face of the texture to render to in case of cube texture
  131808. * @param requiredWidth The width of the target to render to
  131809. * @param requiredHeight The height of the target to render to
  131810. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131811. * @param lodLevel defines le lod level to bind to the frame buffer
  131812. */
  131813. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131814. /**
  131815. * Unbind the current render target texture from the webGL context
  131816. * @param texture defines the render target texture to unbind
  131817. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131818. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131819. */
  131820. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131821. /**
  131822. * Creates a dynamic vertex buffer
  131823. * @param vertices the data for the dynamic vertex buffer
  131824. * @returns the new WebGL dynamic buffer
  131825. */
  131826. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131827. /**
  131828. * Update the content of a dynamic texture
  131829. * @param texture defines the texture to update
  131830. * @param canvas defines the canvas containing the source
  131831. * @param invertY defines if data must be stored with Y axis inverted
  131832. * @param premulAlpha defines if alpha is stored as premultiplied
  131833. * @param format defines the format of the data
  131834. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131835. */
  131836. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131837. /**
  131838. * Gets a boolean indicating if all created effects are ready
  131839. * @returns true if all effects are ready
  131840. */
  131841. areAllEffectsReady(): boolean;
  131842. /**
  131843. * @hidden
  131844. * Get the current error code of the webGL context
  131845. * @returns the error code
  131846. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131847. */
  131848. getError(): number;
  131849. /** @hidden */
  131850. _getUnpackAlignement(): number;
  131851. /** @hidden */
  131852. _unpackFlipY(value: boolean): void;
  131853. /**
  131854. * Update a dynamic index buffer
  131855. * @param indexBuffer defines the target index buffer
  131856. * @param indices defines the data to update
  131857. * @param offset defines the offset in the target index buffer where update should start
  131858. */
  131859. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131860. /**
  131861. * Updates a dynamic vertex buffer.
  131862. * @param vertexBuffer the vertex buffer to update
  131863. * @param vertices the data used to update the vertex buffer
  131864. * @param byteOffset the byte offset of the data (optional)
  131865. * @param byteLength the byte length of the data (optional)
  131866. */
  131867. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131868. /** @hidden */
  131869. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131870. /** @hidden */
  131871. _bindTexture(channel: number, texture: InternalTexture): void;
  131872. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131873. /**
  131874. * 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
  131875. */
  131876. releaseEffects(): void;
  131877. displayLoadingUI(): void;
  131878. hideLoadingUI(): void;
  131879. /** @hidden */
  131880. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131881. /** @hidden */
  131882. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131883. /** @hidden */
  131884. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131885. /** @hidden */
  131886. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131887. }
  131888. }
  131889. declare module BABYLON {
  131890. /**
  131891. * @hidden
  131892. **/
  131893. export class _TimeToken {
  131894. _startTimeQuery: Nullable<WebGLQuery>;
  131895. _endTimeQuery: Nullable<WebGLQuery>;
  131896. _timeElapsedQuery: Nullable<WebGLQuery>;
  131897. _timeElapsedQueryEnded: boolean;
  131898. }
  131899. }
  131900. declare module BABYLON {
  131901. /** @hidden */
  131902. export class _OcclusionDataStorage {
  131903. /** @hidden */
  131904. occlusionInternalRetryCounter: number;
  131905. /** @hidden */
  131906. isOcclusionQueryInProgress: boolean;
  131907. /** @hidden */
  131908. isOccluded: boolean;
  131909. /** @hidden */
  131910. occlusionRetryCount: number;
  131911. /** @hidden */
  131912. occlusionType: number;
  131913. /** @hidden */
  131914. occlusionQueryAlgorithmType: number;
  131915. }
  131916. interface Engine {
  131917. /**
  131918. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131919. * @return the new query
  131920. */
  131921. createQuery(): WebGLQuery;
  131922. /**
  131923. * Delete and release a webGL query
  131924. * @param query defines the query to delete
  131925. * @return the current engine
  131926. */
  131927. deleteQuery(query: WebGLQuery): Engine;
  131928. /**
  131929. * Check if a given query has resolved and got its value
  131930. * @param query defines the query to check
  131931. * @returns true if the query got its value
  131932. */
  131933. isQueryResultAvailable(query: WebGLQuery): boolean;
  131934. /**
  131935. * Gets the value of a given query
  131936. * @param query defines the query to check
  131937. * @returns the value of the query
  131938. */
  131939. getQueryResult(query: WebGLQuery): number;
  131940. /**
  131941. * Initiates an occlusion query
  131942. * @param algorithmType defines the algorithm to use
  131943. * @param query defines the query to use
  131944. * @returns the current engine
  131945. * @see https://doc.babylonjs.com/features/occlusionquery
  131946. */
  131947. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131948. /**
  131949. * Ends an occlusion query
  131950. * @see https://doc.babylonjs.com/features/occlusionquery
  131951. * @param algorithmType defines the algorithm to use
  131952. * @returns the current engine
  131953. */
  131954. endOcclusionQuery(algorithmType: number): Engine;
  131955. /**
  131956. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131957. * Please note that only one query can be issued at a time
  131958. * @returns a time token used to track the time span
  131959. */
  131960. startTimeQuery(): Nullable<_TimeToken>;
  131961. /**
  131962. * Ends a time query
  131963. * @param token defines the token used to measure the time span
  131964. * @returns the time spent (in ns)
  131965. */
  131966. endTimeQuery(token: _TimeToken): int;
  131967. /** @hidden */
  131968. _currentNonTimestampToken: Nullable<_TimeToken>;
  131969. /** @hidden */
  131970. _createTimeQuery(): WebGLQuery;
  131971. /** @hidden */
  131972. _deleteTimeQuery(query: WebGLQuery): void;
  131973. /** @hidden */
  131974. _getGlAlgorithmType(algorithmType: number): number;
  131975. /** @hidden */
  131976. _getTimeQueryResult(query: WebGLQuery): any;
  131977. /** @hidden */
  131978. _getTimeQueryAvailability(query: WebGLQuery): any;
  131979. }
  131980. interface AbstractMesh {
  131981. /**
  131982. * Backing filed
  131983. * @hidden
  131984. */
  131985. __occlusionDataStorage: _OcclusionDataStorage;
  131986. /**
  131987. * Access property
  131988. * @hidden
  131989. */
  131990. _occlusionDataStorage: _OcclusionDataStorage;
  131991. /**
  131992. * 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.
  131993. * The default value is -1 which means don't break the query and wait till the result
  131994. * @see https://doc.babylonjs.com/features/occlusionquery
  131995. */
  131996. occlusionRetryCount: number;
  131997. /**
  131998. * 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:
  131999. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  132000. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  132001. * * 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.
  132002. * @see https://doc.babylonjs.com/features/occlusionquery
  132003. */
  132004. occlusionType: number;
  132005. /**
  132006. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  132007. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  132008. * * 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.
  132009. * @see https://doc.babylonjs.com/features/occlusionquery
  132010. */
  132011. occlusionQueryAlgorithmType: number;
  132012. /**
  132013. * 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
  132014. * @see https://doc.babylonjs.com/features/occlusionquery
  132015. */
  132016. isOccluded: boolean;
  132017. /**
  132018. * Flag to check the progress status of the query
  132019. * @see https://doc.babylonjs.com/features/occlusionquery
  132020. */
  132021. isOcclusionQueryInProgress: boolean;
  132022. }
  132023. }
  132024. declare module BABYLON {
  132025. /** @hidden */
  132026. export var _forceTransformFeedbackToBundle: boolean;
  132027. interface Engine {
  132028. /**
  132029. * Creates a webGL transform feedback object
  132030. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  132031. * @returns the webGL transform feedback object
  132032. */
  132033. createTransformFeedback(): WebGLTransformFeedback;
  132034. /**
  132035. * Delete a webGL transform feedback object
  132036. * @param value defines the webGL transform feedback object to delete
  132037. */
  132038. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  132039. /**
  132040. * Bind a webGL transform feedback object to the webgl context
  132041. * @param value defines the webGL transform feedback object to bind
  132042. */
  132043. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  132044. /**
  132045. * Begins a transform feedback operation
  132046. * @param usePoints defines if points or triangles must be used
  132047. */
  132048. beginTransformFeedback(usePoints: boolean): void;
  132049. /**
  132050. * Ends a transform feedback operation
  132051. */
  132052. endTransformFeedback(): void;
  132053. /**
  132054. * Specify the varyings to use with transform feedback
  132055. * @param program defines the associated webGL program
  132056. * @param value defines the list of strings representing the varying names
  132057. */
  132058. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  132059. /**
  132060. * Bind a webGL buffer for a transform feedback operation
  132061. * @param value defines the webGL buffer to bind
  132062. */
  132063. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  132064. }
  132065. }
  132066. declare module BABYLON {
  132067. /**
  132068. * Class used to define an additional view for the engine
  132069. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132070. */
  132071. export class EngineView {
  132072. /** Defines the canvas where to render the view */
  132073. target: HTMLCanvasElement;
  132074. /** Defines an optional camera used to render the view (will use active camera else) */
  132075. camera?: Camera;
  132076. }
  132077. interface Engine {
  132078. /**
  132079. * Gets or sets the HTML element to use for attaching events
  132080. */
  132081. inputElement: Nullable<HTMLElement>;
  132082. /**
  132083. * Gets the current engine view
  132084. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132085. */
  132086. activeView: Nullable<EngineView>;
  132087. /** Gets or sets the list of views */
  132088. views: EngineView[];
  132089. /**
  132090. * Register a new child canvas
  132091. * @param canvas defines the canvas to register
  132092. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  132093. * @returns the associated view
  132094. */
  132095. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  132096. /**
  132097. * Remove a registered child canvas
  132098. * @param canvas defines the canvas to remove
  132099. * @returns the current engine
  132100. */
  132101. unRegisterView(canvas: HTMLCanvasElement): Engine;
  132102. }
  132103. }
  132104. declare module BABYLON {
  132105. interface Engine {
  132106. /** @hidden */
  132107. _excludedCompressedTextures: string[];
  132108. /** @hidden */
  132109. _textureFormatInUse: string;
  132110. /**
  132111. * Gets the list of texture formats supported
  132112. */
  132113. readonly texturesSupported: Array<string>;
  132114. /**
  132115. * Gets the texture format in use
  132116. */
  132117. readonly textureFormatInUse: Nullable<string>;
  132118. /**
  132119. * Set the compressed texture extensions or file names to skip.
  132120. *
  132121. * @param skippedFiles defines the list of those texture files you want to skip
  132122. * Example: [".dds", ".env", "myfile.png"]
  132123. */
  132124. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  132125. /**
  132126. * Set the compressed texture format to use, based on the formats you have, and the formats
  132127. * supported by the hardware / browser.
  132128. *
  132129. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  132130. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  132131. * to API arguments needed to compressed textures. This puts the burden on the container
  132132. * generator to house the arcane code for determining these for current & future formats.
  132133. *
  132134. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  132135. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  132136. *
  132137. * Note: The result of this call is not taken into account when a texture is base64.
  132138. *
  132139. * @param formatsAvailable defines the list of those format families you have created
  132140. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  132141. *
  132142. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  132143. * @returns The extension selected.
  132144. */
  132145. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  132146. }
  132147. }
  132148. declare module BABYLON {
  132149. /**
  132150. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  132151. */
  132152. export interface CubeMapInfo {
  132153. /**
  132154. * The pixel array for the front face.
  132155. * This is stored in format, left to right, up to down format.
  132156. */
  132157. front: Nullable<ArrayBufferView>;
  132158. /**
  132159. * The pixel array for the back face.
  132160. * This is stored in format, left to right, up to down format.
  132161. */
  132162. back: Nullable<ArrayBufferView>;
  132163. /**
  132164. * The pixel array for the left face.
  132165. * This is stored in format, left to right, up to down format.
  132166. */
  132167. left: Nullable<ArrayBufferView>;
  132168. /**
  132169. * The pixel array for the right face.
  132170. * This is stored in format, left to right, up to down format.
  132171. */
  132172. right: Nullable<ArrayBufferView>;
  132173. /**
  132174. * The pixel array for the up face.
  132175. * This is stored in format, left to right, up to down format.
  132176. */
  132177. up: Nullable<ArrayBufferView>;
  132178. /**
  132179. * The pixel array for the down face.
  132180. * This is stored in format, left to right, up to down format.
  132181. */
  132182. down: Nullable<ArrayBufferView>;
  132183. /**
  132184. * The size of the cubemap stored.
  132185. *
  132186. * Each faces will be size * size pixels.
  132187. */
  132188. size: number;
  132189. /**
  132190. * The format of the texture.
  132191. *
  132192. * RGBA, RGB.
  132193. */
  132194. format: number;
  132195. /**
  132196. * The type of the texture data.
  132197. *
  132198. * UNSIGNED_INT, FLOAT.
  132199. */
  132200. type: number;
  132201. /**
  132202. * Specifies whether the texture is in gamma space.
  132203. */
  132204. gammaSpace: boolean;
  132205. }
  132206. /**
  132207. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132208. */
  132209. export class PanoramaToCubeMapTools {
  132210. private static FACE_LEFT;
  132211. private static FACE_RIGHT;
  132212. private static FACE_FRONT;
  132213. private static FACE_BACK;
  132214. private static FACE_DOWN;
  132215. private static FACE_UP;
  132216. /**
  132217. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132218. *
  132219. * @param float32Array The source data.
  132220. * @param inputWidth The width of the input panorama.
  132221. * @param inputHeight The height of the input panorama.
  132222. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132223. * @return The cubemap data
  132224. */
  132225. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132226. private static CreateCubemapTexture;
  132227. private static CalcProjectionSpherical;
  132228. }
  132229. }
  132230. declare module BABYLON {
  132231. /**
  132232. * Helper class dealing with the extraction of spherical polynomial dataArray
  132233. * from a cube map.
  132234. */
  132235. export class CubeMapToSphericalPolynomialTools {
  132236. private static FileFaces;
  132237. /**
  132238. * Converts a texture to the according Spherical Polynomial data.
  132239. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132240. *
  132241. * @param texture The texture to extract the information from.
  132242. * @return The Spherical Polynomial data.
  132243. */
  132244. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132245. /**
  132246. * Converts a cubemap to the according Spherical Polynomial data.
  132247. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132248. *
  132249. * @param cubeInfo The Cube map to extract the information from.
  132250. * @return The Spherical Polynomial data.
  132251. */
  132252. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132253. }
  132254. }
  132255. declare module BABYLON {
  132256. interface BaseTexture {
  132257. /**
  132258. * Get the polynomial representation of the texture data.
  132259. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132260. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132261. */
  132262. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132263. }
  132264. }
  132265. declare module BABYLON {
  132266. /** @hidden */
  132267. export var rgbdEncodePixelShader: {
  132268. name: string;
  132269. shader: string;
  132270. };
  132271. }
  132272. declare module BABYLON {
  132273. /** @hidden */
  132274. export var rgbdDecodePixelShader: {
  132275. name: string;
  132276. shader: string;
  132277. };
  132278. }
  132279. declare module BABYLON {
  132280. /**
  132281. * Raw texture data and descriptor sufficient for WebGL texture upload
  132282. */
  132283. export interface EnvironmentTextureInfo {
  132284. /**
  132285. * Version of the environment map
  132286. */
  132287. version: number;
  132288. /**
  132289. * Width of image
  132290. */
  132291. width: number;
  132292. /**
  132293. * Irradiance information stored in the file.
  132294. */
  132295. irradiance: any;
  132296. /**
  132297. * Specular information stored in the file.
  132298. */
  132299. specular: any;
  132300. }
  132301. /**
  132302. * Defines One Image in the file. It requires only the position in the file
  132303. * as well as the length.
  132304. */
  132305. interface BufferImageData {
  132306. /**
  132307. * Length of the image data.
  132308. */
  132309. length: number;
  132310. /**
  132311. * Position of the data from the null terminator delimiting the end of the JSON.
  132312. */
  132313. position: number;
  132314. }
  132315. /**
  132316. * Defines the specular data enclosed in the file.
  132317. * This corresponds to the version 1 of the data.
  132318. */
  132319. export interface EnvironmentTextureSpecularInfoV1 {
  132320. /**
  132321. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132322. */
  132323. specularDataPosition?: number;
  132324. /**
  132325. * This contains all the images data needed to reconstruct the cubemap.
  132326. */
  132327. mipmaps: Array<BufferImageData>;
  132328. /**
  132329. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132330. */
  132331. lodGenerationScale: number;
  132332. }
  132333. /**
  132334. * Sets of helpers addressing the serialization and deserialization of environment texture
  132335. * stored in a BabylonJS env file.
  132336. * Those files are usually stored as .env files.
  132337. */
  132338. export class EnvironmentTextureTools {
  132339. /**
  132340. * Magic number identifying the env file.
  132341. */
  132342. private static _MagicBytes;
  132343. /**
  132344. * Gets the environment info from an env file.
  132345. * @param data The array buffer containing the .env bytes.
  132346. * @returns the environment file info (the json header) if successfully parsed.
  132347. */
  132348. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132349. /**
  132350. * Creates an environment texture from a loaded cube texture.
  132351. * @param texture defines the cube texture to convert in env file
  132352. * @return a promise containing the environment data if succesfull.
  132353. */
  132354. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132355. /**
  132356. * Creates a JSON representation of the spherical data.
  132357. * @param texture defines the texture containing the polynomials
  132358. * @return the JSON representation of the spherical info
  132359. */
  132360. private static _CreateEnvTextureIrradiance;
  132361. /**
  132362. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132363. * @param data the image data
  132364. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132365. * @return the views described by info providing access to the underlying buffer
  132366. */
  132367. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132368. /**
  132369. * Uploads the texture info contained in the env file to the GPU.
  132370. * @param texture defines the internal texture to upload to
  132371. * @param data defines the data to load
  132372. * @param info defines the texture info retrieved through the GetEnvInfo method
  132373. * @returns a promise
  132374. */
  132375. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132376. private static _OnImageReadyAsync;
  132377. /**
  132378. * Uploads the levels of image data to the GPU.
  132379. * @param texture defines the internal texture to upload to
  132380. * @param imageData defines the array buffer views of image data [mipmap][face]
  132381. * @returns a promise
  132382. */
  132383. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132384. /**
  132385. * Uploads spherical polynomials information to the texture.
  132386. * @param texture defines the texture we are trying to upload the information to
  132387. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132388. */
  132389. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132390. /** @hidden */
  132391. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132392. }
  132393. }
  132394. declare module BABYLON {
  132395. /**
  132396. * Class used to inline functions in shader code
  132397. */
  132398. export class ShaderCodeInliner {
  132399. private static readonly _RegexpFindFunctionNameAndType;
  132400. private _sourceCode;
  132401. private _functionDescr;
  132402. private _numMaxIterations;
  132403. /** Gets or sets the token used to mark the functions to inline */
  132404. inlineToken: string;
  132405. /** Gets or sets the debug mode */
  132406. debug: boolean;
  132407. /** Gets the code after the inlining process */
  132408. get code(): string;
  132409. /**
  132410. * Initializes the inliner
  132411. * @param sourceCode shader code source to inline
  132412. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132413. */
  132414. constructor(sourceCode: string, numMaxIterations?: number);
  132415. /**
  132416. * Start the processing of the shader code
  132417. */
  132418. processCode(): void;
  132419. private _collectFunctions;
  132420. private _processInlining;
  132421. private _extractBetweenMarkers;
  132422. private _skipWhitespaces;
  132423. private _removeComments;
  132424. private _replaceFunctionCallsByCode;
  132425. private _findBackward;
  132426. private _escapeRegExp;
  132427. private _replaceNames;
  132428. }
  132429. }
  132430. declare module BABYLON {
  132431. /**
  132432. * Container for accessors for natively-stored mesh data buffers.
  132433. */
  132434. class NativeDataBuffer extends DataBuffer {
  132435. /**
  132436. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132437. */
  132438. nativeIndexBuffer?: any;
  132439. /**
  132440. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132441. */
  132442. nativeVertexBuffer?: any;
  132443. }
  132444. /** @hidden */
  132445. class NativeTexture extends InternalTexture {
  132446. getInternalTexture(): InternalTexture;
  132447. getViewCount(): number;
  132448. }
  132449. /** @hidden */
  132450. export class NativeEngine extends Engine {
  132451. private readonly _native;
  132452. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132453. private readonly INVALID_HANDLE;
  132454. private _boundBuffersVertexArray;
  132455. getHardwareScalingLevel(): number;
  132456. constructor();
  132457. dispose(): void;
  132458. /**
  132459. * Can be used to override the current requestAnimationFrame requester.
  132460. * @hidden
  132461. */
  132462. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132463. /**
  132464. * Override default engine behavior.
  132465. * @param color
  132466. * @param backBuffer
  132467. * @param depth
  132468. * @param stencil
  132469. */
  132470. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132471. /**
  132472. * Gets host document
  132473. * @returns the host document object
  132474. */
  132475. getHostDocument(): Nullable<Document>;
  132476. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132477. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132478. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132479. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132480. [key: string]: VertexBuffer;
  132481. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132482. bindBuffers(vertexBuffers: {
  132483. [key: string]: VertexBuffer;
  132484. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132485. recordVertexArrayObject(vertexBuffers: {
  132486. [key: string]: VertexBuffer;
  132487. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132488. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132489. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132490. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132491. /**
  132492. * Draw a list of indexed primitives
  132493. * @param fillMode defines the primitive to use
  132494. * @param indexStart defines the starting index
  132495. * @param indexCount defines the number of index to draw
  132496. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132497. */
  132498. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132499. /**
  132500. * Draw a list of unindexed primitives
  132501. * @param fillMode defines the primitive to use
  132502. * @param verticesStart defines the index of first vertex to draw
  132503. * @param verticesCount defines the count of vertices to draw
  132504. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132505. */
  132506. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132507. createPipelineContext(): IPipelineContext;
  132508. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132509. /** @hidden */
  132510. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132511. /** @hidden */
  132512. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132513. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132514. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132515. protected _setProgram(program: WebGLProgram): void;
  132516. _releaseEffect(effect: Effect): void;
  132517. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132518. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132519. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132520. bindSamplers(effect: Effect): void;
  132521. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132522. getRenderWidth(useScreen?: boolean): number;
  132523. getRenderHeight(useScreen?: boolean): number;
  132524. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132525. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132526. /**
  132527. * Set the z offset to apply to current rendering
  132528. * @param value defines the offset to apply
  132529. */
  132530. setZOffset(value: number): void;
  132531. /**
  132532. * Gets the current value of the zOffset
  132533. * @returns the current zOffset state
  132534. */
  132535. getZOffset(): number;
  132536. /**
  132537. * Enable or disable depth buffering
  132538. * @param enable defines the state to set
  132539. */
  132540. setDepthBuffer(enable: boolean): void;
  132541. /**
  132542. * Gets a boolean indicating if depth writing is enabled
  132543. * @returns the current depth writing state
  132544. */
  132545. getDepthWrite(): boolean;
  132546. /**
  132547. * Enable or disable depth writing
  132548. * @param enable defines the state to set
  132549. */
  132550. setDepthWrite(enable: boolean): void;
  132551. /**
  132552. * Enable or disable color writing
  132553. * @param enable defines the state to set
  132554. */
  132555. setColorWrite(enable: boolean): void;
  132556. /**
  132557. * Gets a boolean indicating if color writing is enabled
  132558. * @returns the current color writing state
  132559. */
  132560. getColorWrite(): boolean;
  132561. /**
  132562. * Sets alpha constants used by some alpha blending modes
  132563. * @param r defines the red component
  132564. * @param g defines the green component
  132565. * @param b defines the blue component
  132566. * @param a defines the alpha component
  132567. */
  132568. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132569. /**
  132570. * Sets the current alpha mode
  132571. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132572. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132573. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132574. */
  132575. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132576. /**
  132577. * Gets the current alpha mode
  132578. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132579. * @returns the current alpha mode
  132580. */
  132581. getAlphaMode(): number;
  132582. setInt(uniform: WebGLUniformLocation, int: number): void;
  132583. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132584. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132585. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132586. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132587. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132588. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132589. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132590. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132591. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132592. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132593. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132594. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132595. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132596. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132597. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132598. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132599. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132600. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132601. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132602. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132603. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132604. wipeCaches(bruteForce?: boolean): void;
  132605. _createTexture(): WebGLTexture;
  132606. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132607. /**
  132608. * Usually called from Texture.ts.
  132609. * Passed information to create a WebGLTexture
  132610. * @param url defines a value which contains one of the following:
  132611. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132612. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132613. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132614. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132615. * @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)
  132616. * @param scene needed for loading to the correct scene
  132617. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132618. * @param onLoad optional callback to be called upon successful completion
  132619. * @param onError optional callback to be called upon failure
  132620. * @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
  132621. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132622. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132623. * @param forcedExtension defines the extension to use to pick the right loader
  132624. * @param mimeType defines an optional mime type
  132625. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132626. */
  132627. createTexture(url: 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>, mimeType?: string): InternalTexture;
  132628. /**
  132629. * Creates a cube texture
  132630. * @param rootUrl defines the url where the files to load is located
  132631. * @param scene defines the current scene
  132632. * @param files defines the list of files to load (1 per face)
  132633. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132634. * @param onLoad defines an optional callback raised when the texture is loaded
  132635. * @param onError defines an optional callback raised if there is an issue to load the texture
  132636. * @param format defines the format of the data
  132637. * @param forcedExtension defines the extension to use to pick the right loader
  132638. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132639. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132640. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132641. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132642. * @returns the cube texture as an InternalTexture
  132643. */
  132644. 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;
  132645. private _getSamplingFilter;
  132646. private static _GetNativeTextureFormat;
  132647. createRenderTargetTexture(size: number | {
  132648. width: number;
  132649. height: number;
  132650. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132651. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132652. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132653. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132654. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132655. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132656. /**
  132657. * Updates a dynamic vertex buffer.
  132658. * @param vertexBuffer the vertex buffer to update
  132659. * @param data the data used to update the vertex buffer
  132660. * @param byteOffset the byte offset of the data (optional)
  132661. * @param byteLength the byte length of the data (optional)
  132662. */
  132663. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132664. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132665. private _updateAnisotropicLevel;
  132666. private _getAddressMode;
  132667. /** @hidden */
  132668. _bindTexture(channel: number, texture: InternalTexture): void;
  132669. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132670. releaseEffects(): void;
  132671. /** @hidden */
  132672. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132673. /** @hidden */
  132674. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132675. /** @hidden */
  132676. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132677. /** @hidden */
  132678. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132679. }
  132680. }
  132681. declare module BABYLON {
  132682. /**
  132683. * Gather the list of clipboard event types as constants.
  132684. */
  132685. export class ClipboardEventTypes {
  132686. /**
  132687. * The clipboard event is fired when a copy command is active (pressed).
  132688. */
  132689. static readonly COPY: number;
  132690. /**
  132691. * The clipboard event is fired when a cut command is active (pressed).
  132692. */
  132693. static readonly CUT: number;
  132694. /**
  132695. * The clipboard event is fired when a paste command is active (pressed).
  132696. */
  132697. static readonly PASTE: number;
  132698. }
  132699. /**
  132700. * This class is used to store clipboard related info for the onClipboardObservable event.
  132701. */
  132702. export class ClipboardInfo {
  132703. /**
  132704. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132705. */
  132706. type: number;
  132707. /**
  132708. * Defines the related dom event
  132709. */
  132710. event: ClipboardEvent;
  132711. /**
  132712. *Creates an instance of ClipboardInfo.
  132713. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132714. * @param event Defines the related dom event
  132715. */
  132716. constructor(
  132717. /**
  132718. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132719. */
  132720. type: number,
  132721. /**
  132722. * Defines the related dom event
  132723. */
  132724. event: ClipboardEvent);
  132725. /**
  132726. * Get the clipboard event's type from the keycode.
  132727. * @param keyCode Defines the keyCode for the current keyboard event.
  132728. * @return {number}
  132729. */
  132730. static GetTypeFromCharacter(keyCode: number): number;
  132731. }
  132732. }
  132733. declare module BABYLON {
  132734. /**
  132735. * Google Daydream controller
  132736. */
  132737. export class DaydreamController extends WebVRController {
  132738. /**
  132739. * Base Url for the controller model.
  132740. */
  132741. static MODEL_BASE_URL: string;
  132742. /**
  132743. * File name for the controller model.
  132744. */
  132745. static MODEL_FILENAME: string;
  132746. /**
  132747. * Gamepad Id prefix used to identify Daydream Controller.
  132748. */
  132749. static readonly GAMEPAD_ID_PREFIX: string;
  132750. /**
  132751. * Creates a new DaydreamController from a gamepad
  132752. * @param vrGamepad the gamepad that the controller should be created from
  132753. */
  132754. constructor(vrGamepad: any);
  132755. /**
  132756. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132757. * @param scene scene in which to add meshes
  132758. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132759. */
  132760. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132761. /**
  132762. * Called once for each button that changed state since the last frame
  132763. * @param buttonIdx Which button index changed
  132764. * @param state New state of the button
  132765. * @param changes Which properties on the state changed since last frame
  132766. */
  132767. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132768. }
  132769. }
  132770. declare module BABYLON {
  132771. /**
  132772. * Gear VR Controller
  132773. */
  132774. export class GearVRController extends WebVRController {
  132775. /**
  132776. * Base Url for the controller model.
  132777. */
  132778. static MODEL_BASE_URL: string;
  132779. /**
  132780. * File name for the controller model.
  132781. */
  132782. static MODEL_FILENAME: string;
  132783. /**
  132784. * Gamepad Id prefix used to identify this controller.
  132785. */
  132786. static readonly GAMEPAD_ID_PREFIX: string;
  132787. private readonly _buttonIndexToObservableNameMap;
  132788. /**
  132789. * Creates a new GearVRController from a gamepad
  132790. * @param vrGamepad the gamepad that the controller should be created from
  132791. */
  132792. constructor(vrGamepad: any);
  132793. /**
  132794. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132795. * @param scene scene in which to add meshes
  132796. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132797. */
  132798. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132799. /**
  132800. * Called once for each button that changed state since the last frame
  132801. * @param buttonIdx Which button index changed
  132802. * @param state New state of the button
  132803. * @param changes Which properties on the state changed since last frame
  132804. */
  132805. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132806. }
  132807. }
  132808. declare module BABYLON {
  132809. /**
  132810. * Generic Controller
  132811. */
  132812. export class GenericController extends WebVRController {
  132813. /**
  132814. * Base Url for the controller model.
  132815. */
  132816. static readonly MODEL_BASE_URL: string;
  132817. /**
  132818. * File name for the controller model.
  132819. */
  132820. static readonly MODEL_FILENAME: string;
  132821. /**
  132822. * Creates a new GenericController from a gamepad
  132823. * @param vrGamepad the gamepad that the controller should be created from
  132824. */
  132825. constructor(vrGamepad: any);
  132826. /**
  132827. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132828. * @param scene scene in which to add meshes
  132829. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132830. */
  132831. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132832. /**
  132833. * Called once for each button that changed state since the last frame
  132834. * @param buttonIdx Which button index changed
  132835. * @param state New state of the button
  132836. * @param changes Which properties on the state changed since last frame
  132837. */
  132838. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132839. }
  132840. }
  132841. declare module BABYLON {
  132842. /**
  132843. * Oculus Touch Controller
  132844. */
  132845. export class OculusTouchController extends WebVRController {
  132846. /**
  132847. * Base Url for the controller model.
  132848. */
  132849. static MODEL_BASE_URL: string;
  132850. /**
  132851. * File name for the left controller model.
  132852. */
  132853. static MODEL_LEFT_FILENAME: string;
  132854. /**
  132855. * File name for the right controller model.
  132856. */
  132857. static MODEL_RIGHT_FILENAME: string;
  132858. /**
  132859. * Base Url for the Quest controller model.
  132860. */
  132861. static QUEST_MODEL_BASE_URL: string;
  132862. /**
  132863. * @hidden
  132864. * If the controllers are running on a device that needs the updated Quest controller models
  132865. */
  132866. static _IsQuest: boolean;
  132867. /**
  132868. * Fired when the secondary trigger on this controller is modified
  132869. */
  132870. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132871. /**
  132872. * Fired when the thumb rest on this controller is modified
  132873. */
  132874. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132875. /**
  132876. * Creates a new OculusTouchController from a gamepad
  132877. * @param vrGamepad the gamepad that the controller should be created from
  132878. */
  132879. constructor(vrGamepad: any);
  132880. /**
  132881. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132882. * @param scene scene in which to add meshes
  132883. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132884. */
  132885. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132886. /**
  132887. * Fired when the A button on this controller is modified
  132888. */
  132889. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132890. /**
  132891. * Fired when the B button on this controller is modified
  132892. */
  132893. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132894. /**
  132895. * Fired when the X button on this controller is modified
  132896. */
  132897. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132898. /**
  132899. * Fired when the Y button on this controller is modified
  132900. */
  132901. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132902. /**
  132903. * Called once for each button that changed state since the last frame
  132904. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132905. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132906. * 2) secondary trigger (same)
  132907. * 3) A (right) X (left), touch, pressed = value
  132908. * 4) B / Y
  132909. * 5) thumb rest
  132910. * @param buttonIdx Which button index changed
  132911. * @param state New state of the button
  132912. * @param changes Which properties on the state changed since last frame
  132913. */
  132914. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132915. }
  132916. }
  132917. declare module BABYLON {
  132918. /**
  132919. * Vive Controller
  132920. */
  132921. export class ViveController extends WebVRController {
  132922. /**
  132923. * Base Url for the controller model.
  132924. */
  132925. static MODEL_BASE_URL: string;
  132926. /**
  132927. * File name for the controller model.
  132928. */
  132929. static MODEL_FILENAME: string;
  132930. /**
  132931. * Creates a new ViveController from a gamepad
  132932. * @param vrGamepad the gamepad that the controller should be created from
  132933. */
  132934. constructor(vrGamepad: any);
  132935. /**
  132936. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132937. * @param scene scene in which to add meshes
  132938. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132939. */
  132940. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132941. /**
  132942. * Fired when the left button on this controller is modified
  132943. */
  132944. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132945. /**
  132946. * Fired when the right button on this controller is modified
  132947. */
  132948. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132949. /**
  132950. * Fired when the menu button on this controller is modified
  132951. */
  132952. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132953. /**
  132954. * Called once for each button that changed state since the last frame
  132955. * Vive mapping:
  132956. * 0: touchpad
  132957. * 1: trigger
  132958. * 2: left AND right buttons
  132959. * 3: menu button
  132960. * @param buttonIdx Which button index changed
  132961. * @param state New state of the button
  132962. * @param changes Which properties on the state changed since last frame
  132963. */
  132964. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132965. }
  132966. }
  132967. declare module BABYLON {
  132968. /**
  132969. * Defines the WindowsMotionController object that the state of the windows motion controller
  132970. */
  132971. export class WindowsMotionController extends WebVRController {
  132972. /**
  132973. * The base url used to load the left and right controller models
  132974. */
  132975. static MODEL_BASE_URL: string;
  132976. /**
  132977. * The name of the left controller model file
  132978. */
  132979. static MODEL_LEFT_FILENAME: string;
  132980. /**
  132981. * The name of the right controller model file
  132982. */
  132983. static MODEL_RIGHT_FILENAME: string;
  132984. /**
  132985. * The controller name prefix for this controller type
  132986. */
  132987. static readonly GAMEPAD_ID_PREFIX: string;
  132988. /**
  132989. * The controller id pattern for this controller type
  132990. */
  132991. private static readonly GAMEPAD_ID_PATTERN;
  132992. private _loadedMeshInfo;
  132993. protected readonly _mapping: {
  132994. buttons: string[];
  132995. buttonMeshNames: {
  132996. trigger: string;
  132997. menu: string;
  132998. grip: string;
  132999. thumbstick: string;
  133000. trackpad: string;
  133001. };
  133002. buttonObservableNames: {
  133003. trigger: string;
  133004. menu: string;
  133005. grip: string;
  133006. thumbstick: string;
  133007. trackpad: string;
  133008. };
  133009. axisMeshNames: string[];
  133010. pointingPoseMeshName: string;
  133011. };
  133012. /**
  133013. * Fired when the trackpad on this controller is clicked
  133014. */
  133015. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133016. /**
  133017. * Fired when the trackpad on this controller is modified
  133018. */
  133019. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133020. /**
  133021. * The current x and y values of this controller's trackpad
  133022. */
  133023. trackpad: StickValues;
  133024. /**
  133025. * Creates a new WindowsMotionController from a gamepad
  133026. * @param vrGamepad the gamepad that the controller should be created from
  133027. */
  133028. constructor(vrGamepad: any);
  133029. /**
  133030. * Fired when the trigger on this controller is modified
  133031. */
  133032. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133033. /**
  133034. * Fired when the menu button on this controller is modified
  133035. */
  133036. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133037. /**
  133038. * Fired when the grip button on this controller is modified
  133039. */
  133040. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133041. /**
  133042. * Fired when the thumbstick button on this controller is modified
  133043. */
  133044. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133045. /**
  133046. * Fired when the touchpad button on this controller is modified
  133047. */
  133048. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133049. /**
  133050. * Fired when the touchpad values on this controller are modified
  133051. */
  133052. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  133053. protected _updateTrackpad(): void;
  133054. /**
  133055. * Called once per frame by the engine.
  133056. */
  133057. update(): void;
  133058. /**
  133059. * Called once for each button that changed state since the last frame
  133060. * @param buttonIdx Which button index changed
  133061. * @param state New state of the button
  133062. * @param changes Which properties on the state changed since last frame
  133063. */
  133064. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133065. /**
  133066. * Moves the buttons on the controller mesh based on their current state
  133067. * @param buttonName the name of the button to move
  133068. * @param buttonValue the value of the button which determines the buttons new position
  133069. */
  133070. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  133071. /**
  133072. * Moves the axis on the controller mesh based on its current state
  133073. * @param axis the index of the axis
  133074. * @param axisValue the value of the axis which determines the meshes new position
  133075. * @hidden
  133076. */
  133077. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  133078. /**
  133079. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133080. * @param scene scene in which to add meshes
  133081. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133082. */
  133083. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  133084. /**
  133085. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  133086. * can be transformed by button presses and axes values, based on this._mapping.
  133087. *
  133088. * @param scene scene in which the meshes exist
  133089. * @param meshes list of meshes that make up the controller model to process
  133090. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  133091. */
  133092. private processModel;
  133093. private createMeshInfo;
  133094. /**
  133095. * Gets the ray of the controller in the direction the controller is pointing
  133096. * @param length the length the resulting ray should be
  133097. * @returns a ray in the direction the controller is pointing
  133098. */
  133099. getForwardRay(length?: number): Ray;
  133100. /**
  133101. * Disposes of the controller
  133102. */
  133103. dispose(): void;
  133104. }
  133105. /**
  133106. * This class represents a new windows motion controller in XR.
  133107. */
  133108. export class XRWindowsMotionController extends WindowsMotionController {
  133109. /**
  133110. * Changing the original WIndowsMotionController mapping to fir the new mapping
  133111. */
  133112. protected readonly _mapping: {
  133113. buttons: string[];
  133114. buttonMeshNames: {
  133115. trigger: string;
  133116. menu: string;
  133117. grip: string;
  133118. thumbstick: string;
  133119. trackpad: string;
  133120. };
  133121. buttonObservableNames: {
  133122. trigger: string;
  133123. menu: string;
  133124. grip: string;
  133125. thumbstick: string;
  133126. trackpad: string;
  133127. };
  133128. axisMeshNames: string[];
  133129. pointingPoseMeshName: string;
  133130. };
  133131. /**
  133132. * Construct a new XR-Based windows motion controller
  133133. *
  133134. * @param gamepadInfo the gamepad object from the browser
  133135. */
  133136. constructor(gamepadInfo: any);
  133137. /**
  133138. * holds the thumbstick values (X,Y)
  133139. */
  133140. thumbstickValues: StickValues;
  133141. /**
  133142. * Fired when the thumbstick on this controller is clicked
  133143. */
  133144. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  133145. /**
  133146. * Fired when the thumbstick on this controller is modified
  133147. */
  133148. onThumbstickValuesChangedObservable: Observable<StickValues>;
  133149. /**
  133150. * Fired when the touchpad button on this controller is modified
  133151. */
  133152. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133153. /**
  133154. * Fired when the touchpad values on this controller are modified
  133155. */
  133156. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133157. /**
  133158. * Fired when the thumbstick button on this controller is modified
  133159. * here to prevent breaking changes
  133160. */
  133161. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133162. /**
  133163. * updating the thumbstick(!) and not the trackpad.
  133164. * This is named this way due to the difference between WebVR and XR and to avoid
  133165. * changing the parent class.
  133166. */
  133167. protected _updateTrackpad(): void;
  133168. /**
  133169. * Disposes the class with joy
  133170. */
  133171. dispose(): void;
  133172. }
  133173. }
  133174. declare module BABYLON {
  133175. /**
  133176. * Class containing static functions to help procedurally build meshes
  133177. */
  133178. export class PolyhedronBuilder {
  133179. /**
  133180. * Creates a polyhedron mesh
  133181. * * 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
  133182. * * The parameter `size` (positive float, default 1) sets the polygon size
  133183. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133184. * * 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`
  133185. * * 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
  133186. * * 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)`)
  133187. * * 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
  133188. * * 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
  133189. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133190. * * 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
  133191. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133192. * @param name defines the name of the mesh
  133193. * @param options defines the options used to create the mesh
  133194. * @param scene defines the hosting scene
  133195. * @returns the polyhedron mesh
  133196. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133197. */
  133198. static CreatePolyhedron(name: string, options: {
  133199. type?: number;
  133200. size?: number;
  133201. sizeX?: number;
  133202. sizeY?: number;
  133203. sizeZ?: number;
  133204. custom?: any;
  133205. faceUV?: Vector4[];
  133206. faceColors?: Color4[];
  133207. flat?: boolean;
  133208. updatable?: boolean;
  133209. sideOrientation?: number;
  133210. frontUVs?: Vector4;
  133211. backUVs?: Vector4;
  133212. }, scene?: Nullable<Scene>): Mesh;
  133213. }
  133214. }
  133215. declare module BABYLON {
  133216. /**
  133217. * Gizmo that enables scaling a mesh along 3 axis
  133218. */
  133219. export class ScaleGizmo extends Gizmo {
  133220. /**
  133221. * Internal gizmo used for interactions on the x axis
  133222. */
  133223. xGizmo: AxisScaleGizmo;
  133224. /**
  133225. * Internal gizmo used for interactions on the y axis
  133226. */
  133227. yGizmo: AxisScaleGizmo;
  133228. /**
  133229. * Internal gizmo used for interactions on the z axis
  133230. */
  133231. zGizmo: AxisScaleGizmo;
  133232. /**
  133233. * Internal gizmo used to scale all axis equally
  133234. */
  133235. uniformScaleGizmo: AxisScaleGizmo;
  133236. private _meshAttached;
  133237. private _nodeAttached;
  133238. private _snapDistance;
  133239. private _uniformScalingMesh;
  133240. private _octahedron;
  133241. private _sensitivity;
  133242. /** Fires an event when any of it's sub gizmos are dragged */
  133243. onDragStartObservable: Observable<unknown>;
  133244. /** Fires an event when any of it's sub gizmos are released from dragging */
  133245. onDragEndObservable: Observable<unknown>;
  133246. get attachedMesh(): Nullable<AbstractMesh>;
  133247. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133248. get attachedNode(): Nullable<Node>;
  133249. set attachedNode(node: Nullable<Node>);
  133250. /**
  133251. * Creates a ScaleGizmo
  133252. * @param gizmoLayer The utility layer the gizmo will be added to
  133253. * @param thickness display gizmo axis thickness
  133254. */
  133255. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133256. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133257. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133258. /**
  133259. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133260. */
  133261. set snapDistance(value: number);
  133262. get snapDistance(): number;
  133263. /**
  133264. * Ratio for the scale of the gizmo (Default: 1)
  133265. */
  133266. set scaleRatio(value: number);
  133267. get scaleRatio(): number;
  133268. /**
  133269. * Sensitivity factor for dragging (Default: 1)
  133270. */
  133271. set sensitivity(value: number);
  133272. get sensitivity(): number;
  133273. /**
  133274. * Disposes of the gizmo
  133275. */
  133276. dispose(): void;
  133277. }
  133278. }
  133279. declare module BABYLON {
  133280. /**
  133281. * Single axis scale gizmo
  133282. */
  133283. export class AxisScaleGizmo extends Gizmo {
  133284. /**
  133285. * Drag behavior responsible for the gizmos dragging interactions
  133286. */
  133287. dragBehavior: PointerDragBehavior;
  133288. private _pointerObserver;
  133289. /**
  133290. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133291. */
  133292. snapDistance: number;
  133293. /**
  133294. * Event that fires each time the gizmo snaps to a new location.
  133295. * * snapDistance is the the change in distance
  133296. */
  133297. onSnapObservable: Observable<{
  133298. snapDistance: number;
  133299. }>;
  133300. /**
  133301. * If the scaling operation should be done on all axis (default: false)
  133302. */
  133303. uniformScaling: boolean;
  133304. /**
  133305. * Custom sensitivity value for the drag strength
  133306. */
  133307. sensitivity: number;
  133308. private _isEnabled;
  133309. private _parent;
  133310. private _arrow;
  133311. private _coloredMaterial;
  133312. private _hoverMaterial;
  133313. /**
  133314. * Creates an AxisScaleGizmo
  133315. * @param gizmoLayer The utility layer the gizmo will be added to
  133316. * @param dragAxis The axis which the gizmo will be able to scale on
  133317. * @param color The color of the gizmo
  133318. * @param thickness display gizmo axis thickness
  133319. */
  133320. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133321. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133322. /**
  133323. * If the gizmo is enabled
  133324. */
  133325. set isEnabled(value: boolean);
  133326. get isEnabled(): boolean;
  133327. /**
  133328. * Disposes of the gizmo
  133329. */
  133330. dispose(): void;
  133331. /**
  133332. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133333. * @param mesh The mesh to replace the default mesh of the gizmo
  133334. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133335. */
  133336. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133337. }
  133338. }
  133339. declare module BABYLON {
  133340. /**
  133341. * Bounding box gizmo
  133342. */
  133343. export class BoundingBoxGizmo extends Gizmo {
  133344. private _lineBoundingBox;
  133345. private _rotateSpheresParent;
  133346. private _scaleBoxesParent;
  133347. private _boundingDimensions;
  133348. private _renderObserver;
  133349. private _pointerObserver;
  133350. private _scaleDragSpeed;
  133351. private _tmpQuaternion;
  133352. private _tmpVector;
  133353. private _tmpRotationMatrix;
  133354. /**
  133355. * 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)
  133356. */
  133357. ignoreChildren: boolean;
  133358. /**
  133359. * 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)
  133360. */
  133361. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133362. /**
  133363. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133364. */
  133365. rotationSphereSize: number;
  133366. /**
  133367. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133368. */
  133369. scaleBoxSize: number;
  133370. /**
  133371. * 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)
  133372. */
  133373. fixedDragMeshScreenSize: boolean;
  133374. /**
  133375. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133376. */
  133377. fixedDragMeshScreenSizeDistanceFactor: number;
  133378. /**
  133379. * Fired when a rotation sphere or scale box is dragged
  133380. */
  133381. onDragStartObservable: Observable<{}>;
  133382. /**
  133383. * Fired when a scale box is dragged
  133384. */
  133385. onScaleBoxDragObservable: Observable<{}>;
  133386. /**
  133387. * Fired when a scale box drag is ended
  133388. */
  133389. onScaleBoxDragEndObservable: Observable<{}>;
  133390. /**
  133391. * Fired when a rotation sphere is dragged
  133392. */
  133393. onRotationSphereDragObservable: Observable<{}>;
  133394. /**
  133395. * Fired when a rotation sphere drag is ended
  133396. */
  133397. onRotationSphereDragEndObservable: Observable<{}>;
  133398. /**
  133399. * Relative bounding box pivot used when scaling the attached node. 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)
  133400. */
  133401. scalePivot: Nullable<Vector3>;
  133402. /**
  133403. * Mesh used as a pivot to rotate the attached node
  133404. */
  133405. private _anchorMesh;
  133406. private _existingMeshScale;
  133407. private _dragMesh;
  133408. private pointerDragBehavior;
  133409. private coloredMaterial;
  133410. private hoverColoredMaterial;
  133411. /**
  133412. * Sets the color of the bounding box gizmo
  133413. * @param color the color to set
  133414. */
  133415. setColor(color: Color3): void;
  133416. /**
  133417. * Creates an BoundingBoxGizmo
  133418. * @param gizmoLayer The utility layer the gizmo will be added to
  133419. * @param color The color of the gizmo
  133420. */
  133421. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133422. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133423. private _selectNode;
  133424. /**
  133425. * Updates the bounding box information for the Gizmo
  133426. */
  133427. updateBoundingBox(): void;
  133428. private _updateRotationSpheres;
  133429. private _updateScaleBoxes;
  133430. /**
  133431. * Enables rotation on the specified axis and disables rotation on the others
  133432. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133433. */
  133434. setEnabledRotationAxis(axis: string): void;
  133435. /**
  133436. * Enables/disables scaling
  133437. * @param enable if scaling should be enabled
  133438. * @param homogeneousScaling defines if scaling should only be homogeneous
  133439. */
  133440. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133441. private _updateDummy;
  133442. /**
  133443. * Enables a pointer drag behavior on the bounding box of the gizmo
  133444. */
  133445. enableDragBehavior(): void;
  133446. /**
  133447. * Disposes of the gizmo
  133448. */
  133449. dispose(): void;
  133450. /**
  133451. * 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)
  133452. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133453. * @returns the bounding box mesh with the passed in mesh as a child
  133454. */
  133455. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133456. /**
  133457. * CustomMeshes are not supported by this gizmo
  133458. * @param mesh The mesh to replace the default mesh of the gizmo
  133459. */
  133460. setCustomMesh(mesh: Mesh): void;
  133461. }
  133462. }
  133463. declare module BABYLON {
  133464. /**
  133465. * Single plane rotation gizmo
  133466. */
  133467. export class PlaneRotationGizmo extends Gizmo {
  133468. /**
  133469. * Drag behavior responsible for the gizmos dragging interactions
  133470. */
  133471. dragBehavior: PointerDragBehavior;
  133472. private _pointerObserver;
  133473. /**
  133474. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133475. */
  133476. snapDistance: number;
  133477. /**
  133478. * Event that fires each time the gizmo snaps to a new location.
  133479. * * snapDistance is the the change in distance
  133480. */
  133481. onSnapObservable: Observable<{
  133482. snapDistance: number;
  133483. }>;
  133484. private _isEnabled;
  133485. private _parent;
  133486. /**
  133487. * Creates a PlaneRotationGizmo
  133488. * @param gizmoLayer The utility layer the gizmo will be added to
  133489. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133490. * @param color The color of the gizmo
  133491. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133492. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133493. * @param thickness display gizmo axis thickness
  133494. */
  133495. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133496. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133497. /**
  133498. * If the gizmo is enabled
  133499. */
  133500. set isEnabled(value: boolean);
  133501. get isEnabled(): boolean;
  133502. /**
  133503. * Disposes of the gizmo
  133504. */
  133505. dispose(): void;
  133506. }
  133507. }
  133508. declare module BABYLON {
  133509. /**
  133510. * Gizmo that enables rotating a mesh along 3 axis
  133511. */
  133512. export class RotationGizmo extends Gizmo {
  133513. /**
  133514. * Internal gizmo used for interactions on the x axis
  133515. */
  133516. xGizmo: PlaneRotationGizmo;
  133517. /**
  133518. * Internal gizmo used for interactions on the y axis
  133519. */
  133520. yGizmo: PlaneRotationGizmo;
  133521. /**
  133522. * Internal gizmo used for interactions on the z axis
  133523. */
  133524. zGizmo: PlaneRotationGizmo;
  133525. /** Fires an event when any of it's sub gizmos are dragged */
  133526. onDragStartObservable: Observable<unknown>;
  133527. /** Fires an event when any of it's sub gizmos are released from dragging */
  133528. onDragEndObservable: Observable<unknown>;
  133529. private _meshAttached;
  133530. private _nodeAttached;
  133531. get attachedMesh(): Nullable<AbstractMesh>;
  133532. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133533. get attachedNode(): Nullable<Node>;
  133534. set attachedNode(node: Nullable<Node>);
  133535. /**
  133536. * Creates a RotationGizmo
  133537. * @param gizmoLayer The utility layer the gizmo will be added to
  133538. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133539. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133540. * @param thickness display gizmo axis thickness
  133541. */
  133542. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133543. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133544. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133545. /**
  133546. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133547. */
  133548. set snapDistance(value: number);
  133549. get snapDistance(): number;
  133550. /**
  133551. * Ratio for the scale of the gizmo (Default: 1)
  133552. */
  133553. set scaleRatio(value: number);
  133554. get scaleRatio(): number;
  133555. /**
  133556. * Disposes of the gizmo
  133557. */
  133558. dispose(): void;
  133559. /**
  133560. * CustomMeshes are not supported by this gizmo
  133561. * @param mesh The mesh to replace the default mesh of the gizmo
  133562. */
  133563. setCustomMesh(mesh: Mesh): void;
  133564. }
  133565. }
  133566. declare module BABYLON {
  133567. /**
  133568. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133569. */
  133570. export class GizmoManager implements IDisposable {
  133571. private scene;
  133572. /**
  133573. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133574. */
  133575. gizmos: {
  133576. positionGizmo: Nullable<PositionGizmo>;
  133577. rotationGizmo: Nullable<RotationGizmo>;
  133578. scaleGizmo: Nullable<ScaleGizmo>;
  133579. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133580. };
  133581. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133582. clearGizmoOnEmptyPointerEvent: boolean;
  133583. /** Fires an event when the manager is attached to a mesh */
  133584. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133585. /** Fires an event when the manager is attached to a node */
  133586. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133587. private _gizmosEnabled;
  133588. private _pointerObserver;
  133589. private _attachedMesh;
  133590. private _attachedNode;
  133591. private _boundingBoxColor;
  133592. private _defaultUtilityLayer;
  133593. private _defaultKeepDepthUtilityLayer;
  133594. private _thickness;
  133595. /**
  133596. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133597. */
  133598. boundingBoxDragBehavior: SixDofDragBehavior;
  133599. /**
  133600. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133601. */
  133602. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133603. /**
  133604. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133605. */
  133606. attachableNodes: Nullable<Array<Node>>;
  133607. /**
  133608. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133609. */
  133610. usePointerToAttachGizmos: boolean;
  133611. /**
  133612. * Utility layer that the bounding box gizmo belongs to
  133613. */
  133614. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133615. /**
  133616. * Utility layer that all gizmos besides bounding box belong to
  133617. */
  133618. get utilityLayer(): UtilityLayerRenderer;
  133619. /**
  133620. * Instatiates a gizmo manager
  133621. * @param scene the scene to overlay the gizmos on top of
  133622. * @param thickness display gizmo axis thickness
  133623. */
  133624. constructor(scene: Scene, thickness?: number);
  133625. /**
  133626. * Attaches a set of gizmos to the specified mesh
  133627. * @param mesh The mesh the gizmo's should be attached to
  133628. */
  133629. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133630. /**
  133631. * Attaches a set of gizmos to the specified node
  133632. * @param node The node the gizmo's should be attached to
  133633. */
  133634. attachToNode(node: Nullable<Node>): void;
  133635. /**
  133636. * If the position gizmo is enabled
  133637. */
  133638. set positionGizmoEnabled(value: boolean);
  133639. get positionGizmoEnabled(): boolean;
  133640. /**
  133641. * If the rotation gizmo is enabled
  133642. */
  133643. set rotationGizmoEnabled(value: boolean);
  133644. get rotationGizmoEnabled(): boolean;
  133645. /**
  133646. * If the scale gizmo is enabled
  133647. */
  133648. set scaleGizmoEnabled(value: boolean);
  133649. get scaleGizmoEnabled(): boolean;
  133650. /**
  133651. * If the boundingBox gizmo is enabled
  133652. */
  133653. set boundingBoxGizmoEnabled(value: boolean);
  133654. get boundingBoxGizmoEnabled(): boolean;
  133655. /**
  133656. * Disposes of the gizmo manager
  133657. */
  133658. dispose(): void;
  133659. }
  133660. }
  133661. declare module BABYLON {
  133662. /**
  133663. * A directional light is defined by a direction (what a surprise!).
  133664. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133665. * 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.
  133666. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133667. */
  133668. export class DirectionalLight extends ShadowLight {
  133669. private _shadowFrustumSize;
  133670. /**
  133671. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133672. */
  133673. get shadowFrustumSize(): number;
  133674. /**
  133675. * Specifies a fix frustum size for the shadow generation.
  133676. */
  133677. set shadowFrustumSize(value: number);
  133678. private _shadowOrthoScale;
  133679. /**
  133680. * Gets the shadow projection scale against the optimal computed one.
  133681. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133682. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133683. */
  133684. get shadowOrthoScale(): number;
  133685. /**
  133686. * Sets the shadow projection scale against the optimal computed one.
  133687. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133688. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133689. */
  133690. set shadowOrthoScale(value: number);
  133691. /**
  133692. * Automatically compute the projection matrix to best fit (including all the casters)
  133693. * on each frame.
  133694. */
  133695. autoUpdateExtends: boolean;
  133696. /**
  133697. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133698. * on each frame. autoUpdateExtends must be set to true for this to work
  133699. */
  133700. autoCalcShadowZBounds: boolean;
  133701. private _orthoLeft;
  133702. private _orthoRight;
  133703. private _orthoTop;
  133704. private _orthoBottom;
  133705. /**
  133706. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133707. * The directional light is emitted from everywhere in the given direction.
  133708. * It can cast shadows.
  133709. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133710. * @param name The friendly name of the light
  133711. * @param direction The direction of the light
  133712. * @param scene The scene the light belongs to
  133713. */
  133714. constructor(name: string, direction: Vector3, scene: Scene);
  133715. /**
  133716. * Returns the string "DirectionalLight".
  133717. * @return The class name
  133718. */
  133719. getClassName(): string;
  133720. /**
  133721. * Returns the integer 1.
  133722. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133723. */
  133724. getTypeID(): number;
  133725. /**
  133726. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133727. * Returns the DirectionalLight Shadow projection matrix.
  133728. */
  133729. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133730. /**
  133731. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133732. * Returns the DirectionalLight Shadow projection matrix.
  133733. */
  133734. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133735. /**
  133736. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133737. * Returns the DirectionalLight Shadow projection matrix.
  133738. */
  133739. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133740. protected _buildUniformLayout(): void;
  133741. /**
  133742. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133743. * @param effect The effect to update
  133744. * @param lightIndex The index of the light in the effect to update
  133745. * @returns The directional light
  133746. */
  133747. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133748. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133749. /**
  133750. * Gets the minZ used for shadow according to both the scene and the light.
  133751. *
  133752. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133753. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133754. * @param activeCamera The camera we are returning the min for
  133755. * @returns the depth min z
  133756. */
  133757. getDepthMinZ(activeCamera: Camera): number;
  133758. /**
  133759. * Gets the maxZ used for shadow according to both the scene and the light.
  133760. *
  133761. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133762. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133763. * @param activeCamera The camera we are returning the max for
  133764. * @returns the depth max z
  133765. */
  133766. getDepthMaxZ(activeCamera: Camera): number;
  133767. /**
  133768. * Prepares the list of defines specific to the light type.
  133769. * @param defines the list of defines
  133770. * @param lightIndex defines the index of the light for the effect
  133771. */
  133772. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133773. }
  133774. }
  133775. declare module BABYLON {
  133776. /**
  133777. * Class containing static functions to help procedurally build meshes
  133778. */
  133779. export class HemisphereBuilder {
  133780. /**
  133781. * Creates a hemisphere mesh
  133782. * @param name defines the name of the mesh
  133783. * @param options defines the options used to create the mesh
  133784. * @param scene defines the hosting scene
  133785. * @returns the hemisphere mesh
  133786. */
  133787. static CreateHemisphere(name: string, options: {
  133788. segments?: number;
  133789. diameter?: number;
  133790. sideOrientation?: number;
  133791. }, scene: any): Mesh;
  133792. }
  133793. }
  133794. declare module BABYLON {
  133795. /**
  133796. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133797. * These values define a cone of light starting from the position, emitting toward the direction.
  133798. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133799. * and the exponent defines the speed of the decay of the light with distance (reach).
  133800. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133801. */
  133802. export class SpotLight extends ShadowLight {
  133803. private _angle;
  133804. private _innerAngle;
  133805. private _cosHalfAngle;
  133806. private _lightAngleScale;
  133807. private _lightAngleOffset;
  133808. /**
  133809. * Gets the cone angle of the spot light in Radians.
  133810. */
  133811. get angle(): number;
  133812. /**
  133813. * Sets the cone angle of the spot light in Radians.
  133814. */
  133815. set angle(value: number);
  133816. /**
  133817. * Only used in gltf falloff mode, this defines the angle where
  133818. * the directional falloff will start before cutting at angle which could be seen
  133819. * as outer angle.
  133820. */
  133821. get innerAngle(): number;
  133822. /**
  133823. * Only used in gltf falloff mode, this defines the angle where
  133824. * the directional falloff will start before cutting at angle which could be seen
  133825. * as outer angle.
  133826. */
  133827. set innerAngle(value: number);
  133828. private _shadowAngleScale;
  133829. /**
  133830. * Allows scaling the angle of the light for shadow generation only.
  133831. */
  133832. get shadowAngleScale(): number;
  133833. /**
  133834. * Allows scaling the angle of the light for shadow generation only.
  133835. */
  133836. set shadowAngleScale(value: number);
  133837. /**
  133838. * The light decay speed with the distance from the emission spot.
  133839. */
  133840. exponent: number;
  133841. private _projectionTextureMatrix;
  133842. /**
  133843. * Allows reading the projecton texture
  133844. */
  133845. get projectionTextureMatrix(): Matrix;
  133846. protected _projectionTextureLightNear: number;
  133847. /**
  133848. * Gets the near clip of the Spotlight for texture projection.
  133849. */
  133850. get projectionTextureLightNear(): number;
  133851. /**
  133852. * Sets the near clip of the Spotlight for texture projection.
  133853. */
  133854. set projectionTextureLightNear(value: number);
  133855. protected _projectionTextureLightFar: number;
  133856. /**
  133857. * Gets the far clip of the Spotlight for texture projection.
  133858. */
  133859. get projectionTextureLightFar(): number;
  133860. /**
  133861. * Sets the far clip of the Spotlight for texture projection.
  133862. */
  133863. set projectionTextureLightFar(value: number);
  133864. protected _projectionTextureUpDirection: Vector3;
  133865. /**
  133866. * Gets the Up vector of the Spotlight for texture projection.
  133867. */
  133868. get projectionTextureUpDirection(): Vector3;
  133869. /**
  133870. * Sets the Up vector of the Spotlight for texture projection.
  133871. */
  133872. set projectionTextureUpDirection(value: Vector3);
  133873. private _projectionTexture;
  133874. /**
  133875. * Gets the projection texture of the light.
  133876. */
  133877. get projectionTexture(): Nullable<BaseTexture>;
  133878. /**
  133879. * Sets the projection texture of the light.
  133880. */
  133881. set projectionTexture(value: Nullable<BaseTexture>);
  133882. private _projectionTextureViewLightDirty;
  133883. private _projectionTextureProjectionLightDirty;
  133884. private _projectionTextureDirty;
  133885. private _projectionTextureViewTargetVector;
  133886. private _projectionTextureViewLightMatrix;
  133887. private _projectionTextureProjectionLightMatrix;
  133888. private _projectionTextureScalingMatrix;
  133889. /**
  133890. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133891. * It can cast shadows.
  133892. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133893. * @param name The light friendly name
  133894. * @param position The position of the spot light in the scene
  133895. * @param direction The direction of the light in the scene
  133896. * @param angle The cone angle of the light in Radians
  133897. * @param exponent The light decay speed with the distance from the emission spot
  133898. * @param scene The scene the lights belongs to
  133899. */
  133900. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133901. /**
  133902. * Returns the string "SpotLight".
  133903. * @returns the class name
  133904. */
  133905. getClassName(): string;
  133906. /**
  133907. * Returns the integer 2.
  133908. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133909. */
  133910. getTypeID(): number;
  133911. /**
  133912. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133913. */
  133914. protected _setDirection(value: Vector3): void;
  133915. /**
  133916. * Overrides the position setter to recompute the projection texture view light Matrix.
  133917. */
  133918. protected _setPosition(value: Vector3): void;
  133919. /**
  133920. * 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.
  133921. * Returns the SpotLight.
  133922. */
  133923. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133924. protected _computeProjectionTextureViewLightMatrix(): void;
  133925. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133926. /**
  133927. * Main function for light texture projection matrix computing.
  133928. */
  133929. protected _computeProjectionTextureMatrix(): void;
  133930. protected _buildUniformLayout(): void;
  133931. private _computeAngleValues;
  133932. /**
  133933. * Sets the passed Effect "effect" with the Light textures.
  133934. * @param effect The effect to update
  133935. * @param lightIndex The index of the light in the effect to update
  133936. * @returns The light
  133937. */
  133938. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133939. /**
  133940. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133941. * @param effect The effect to update
  133942. * @param lightIndex The index of the light in the effect to update
  133943. * @returns The spot light
  133944. */
  133945. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133946. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133947. /**
  133948. * Disposes the light and the associated resources.
  133949. */
  133950. dispose(): void;
  133951. /**
  133952. * Prepares the list of defines specific to the light type.
  133953. * @param defines the list of defines
  133954. * @param lightIndex defines the index of the light for the effect
  133955. */
  133956. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133957. }
  133958. }
  133959. declare module BABYLON {
  133960. /**
  133961. * Gizmo that enables viewing a light
  133962. */
  133963. export class LightGizmo extends Gizmo {
  133964. private _lightMesh;
  133965. private _material;
  133966. private _cachedPosition;
  133967. private _cachedForward;
  133968. private _attachedMeshParent;
  133969. private _pointerObserver;
  133970. /**
  133971. * Event that fires each time the gizmo is clicked
  133972. */
  133973. onClickedObservable: Observable<Light>;
  133974. /**
  133975. * Creates a LightGizmo
  133976. * @param gizmoLayer The utility layer the gizmo will be added to
  133977. */
  133978. constructor(gizmoLayer?: UtilityLayerRenderer);
  133979. private _light;
  133980. /**
  133981. * The light that the gizmo is attached to
  133982. */
  133983. set light(light: Nullable<Light>);
  133984. get light(): Nullable<Light>;
  133985. /**
  133986. * Gets the material used to render the light gizmo
  133987. */
  133988. get material(): StandardMaterial;
  133989. /**
  133990. * @hidden
  133991. * Updates the gizmo to match the attached mesh's position/rotation
  133992. */
  133993. protected _update(): void;
  133994. private static _Scale;
  133995. /**
  133996. * Creates the lines for a light mesh
  133997. */
  133998. private static _CreateLightLines;
  133999. /**
  134000. * Disposes of the light gizmo
  134001. */
  134002. dispose(): void;
  134003. private static _CreateHemisphericLightMesh;
  134004. private static _CreatePointLightMesh;
  134005. private static _CreateSpotLightMesh;
  134006. private static _CreateDirectionalLightMesh;
  134007. }
  134008. }
  134009. declare module BABYLON {
  134010. /**
  134011. * Gizmo that enables viewing a camera
  134012. */
  134013. export class CameraGizmo extends Gizmo {
  134014. private _cameraMesh;
  134015. private _cameraLinesMesh;
  134016. private _material;
  134017. private _pointerObserver;
  134018. /**
  134019. * Event that fires each time the gizmo is clicked
  134020. */
  134021. onClickedObservable: Observable<Camera>;
  134022. /**
  134023. * Creates a CameraGizmo
  134024. * @param gizmoLayer The utility layer the gizmo will be added to
  134025. */
  134026. constructor(gizmoLayer?: UtilityLayerRenderer);
  134027. private _camera;
  134028. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  134029. get displayFrustum(): boolean;
  134030. set displayFrustum(value: boolean);
  134031. /**
  134032. * The camera that the gizmo is attached to
  134033. */
  134034. set camera(camera: Nullable<Camera>);
  134035. get camera(): Nullable<Camera>;
  134036. /**
  134037. * Gets the material used to render the camera gizmo
  134038. */
  134039. get material(): StandardMaterial;
  134040. /**
  134041. * @hidden
  134042. * Updates the gizmo to match the attached mesh's position/rotation
  134043. */
  134044. protected _update(): void;
  134045. private static _Scale;
  134046. private _invProjection;
  134047. /**
  134048. * Disposes of the camera gizmo
  134049. */
  134050. dispose(): void;
  134051. private static _CreateCameraMesh;
  134052. private static _CreateCameraFrustum;
  134053. }
  134054. }
  134055. declare module BABYLON {
  134056. /** @hidden */
  134057. export var backgroundFragmentDeclaration: {
  134058. name: string;
  134059. shader: string;
  134060. };
  134061. }
  134062. declare module BABYLON {
  134063. /** @hidden */
  134064. export var backgroundUboDeclaration: {
  134065. name: string;
  134066. shader: string;
  134067. };
  134068. }
  134069. declare module BABYLON {
  134070. /** @hidden */
  134071. export var backgroundPixelShader: {
  134072. name: string;
  134073. shader: string;
  134074. };
  134075. }
  134076. declare module BABYLON {
  134077. /** @hidden */
  134078. export var backgroundVertexDeclaration: {
  134079. name: string;
  134080. shader: string;
  134081. };
  134082. }
  134083. declare module BABYLON {
  134084. /** @hidden */
  134085. export var backgroundVertexShader: {
  134086. name: string;
  134087. shader: string;
  134088. };
  134089. }
  134090. declare module BABYLON {
  134091. /**
  134092. * Background material used to create an efficient environement around your scene.
  134093. */
  134094. export class BackgroundMaterial extends PushMaterial {
  134095. /**
  134096. * Standard reflectance value at parallel view angle.
  134097. */
  134098. static StandardReflectance0: number;
  134099. /**
  134100. * Standard reflectance value at grazing angle.
  134101. */
  134102. static StandardReflectance90: number;
  134103. protected _primaryColor: Color3;
  134104. /**
  134105. * Key light Color (multiply against the environement texture)
  134106. */
  134107. primaryColor: Color3;
  134108. protected __perceptualColor: Nullable<Color3>;
  134109. /**
  134110. * Experimental Internal Use Only.
  134111. *
  134112. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  134113. * This acts as a helper to set the primary color to a more "human friendly" value.
  134114. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  134115. * output color as close as possible from the chosen value.
  134116. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  134117. * part of lighting setup.)
  134118. */
  134119. get _perceptualColor(): Nullable<Color3>;
  134120. set _perceptualColor(value: Nullable<Color3>);
  134121. protected _primaryColorShadowLevel: float;
  134122. /**
  134123. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  134124. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  134125. */
  134126. get primaryColorShadowLevel(): float;
  134127. set primaryColorShadowLevel(value: float);
  134128. protected _primaryColorHighlightLevel: float;
  134129. /**
  134130. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  134131. * The primary color is used at the level chosen to define what the white area would look.
  134132. */
  134133. get primaryColorHighlightLevel(): float;
  134134. set primaryColorHighlightLevel(value: float);
  134135. protected _reflectionTexture: Nullable<BaseTexture>;
  134136. /**
  134137. * Reflection Texture used in the material.
  134138. * Should be author in a specific way for the best result (refer to the documentation).
  134139. */
  134140. reflectionTexture: Nullable<BaseTexture>;
  134141. protected _reflectionBlur: float;
  134142. /**
  134143. * Reflection Texture level of blur.
  134144. *
  134145. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  134146. * texture twice.
  134147. */
  134148. reflectionBlur: float;
  134149. protected _diffuseTexture: Nullable<BaseTexture>;
  134150. /**
  134151. * Diffuse Texture used in the material.
  134152. * Should be author in a specific way for the best result (refer to the documentation).
  134153. */
  134154. diffuseTexture: Nullable<BaseTexture>;
  134155. protected _shadowLights: Nullable<IShadowLight[]>;
  134156. /**
  134157. * Specify the list of lights casting shadow on the material.
  134158. * All scene shadow lights will be included if null.
  134159. */
  134160. shadowLights: Nullable<IShadowLight[]>;
  134161. protected _shadowLevel: float;
  134162. /**
  134163. * Helps adjusting the shadow to a softer level if required.
  134164. * 0 means black shadows and 1 means no shadows.
  134165. */
  134166. shadowLevel: float;
  134167. protected _sceneCenter: Vector3;
  134168. /**
  134169. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134170. * It is usually zero but might be interesting to modify according to your setup.
  134171. */
  134172. sceneCenter: Vector3;
  134173. protected _opacityFresnel: boolean;
  134174. /**
  134175. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134176. * This helps ensuring a nice transition when the camera goes under the ground.
  134177. */
  134178. opacityFresnel: boolean;
  134179. protected _reflectionFresnel: boolean;
  134180. /**
  134181. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134182. * This helps adding a mirror texture on the ground.
  134183. */
  134184. reflectionFresnel: boolean;
  134185. protected _reflectionFalloffDistance: number;
  134186. /**
  134187. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134188. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134189. */
  134190. reflectionFalloffDistance: number;
  134191. protected _reflectionAmount: number;
  134192. /**
  134193. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134194. */
  134195. reflectionAmount: number;
  134196. protected _reflectionReflectance0: number;
  134197. /**
  134198. * This specifies the weight of the reflection at grazing angle.
  134199. */
  134200. reflectionReflectance0: number;
  134201. protected _reflectionReflectance90: number;
  134202. /**
  134203. * This specifies the weight of the reflection at a perpendicular point of view.
  134204. */
  134205. reflectionReflectance90: number;
  134206. /**
  134207. * Sets the reflection reflectance fresnel values according to the default standard
  134208. * empirically know to work well :-)
  134209. */
  134210. set reflectionStandardFresnelWeight(value: number);
  134211. protected _useRGBColor: boolean;
  134212. /**
  134213. * Helps to directly use the maps channels instead of their level.
  134214. */
  134215. useRGBColor: boolean;
  134216. protected _enableNoise: boolean;
  134217. /**
  134218. * This helps reducing the banding effect that could occur on the background.
  134219. */
  134220. enableNoise: boolean;
  134221. /**
  134222. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134223. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134224. * Recommended to be keep at 1.0 except for special cases.
  134225. */
  134226. get fovMultiplier(): number;
  134227. set fovMultiplier(value: number);
  134228. private _fovMultiplier;
  134229. /**
  134230. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134231. */
  134232. useEquirectangularFOV: boolean;
  134233. private _maxSimultaneousLights;
  134234. /**
  134235. * Number of Simultaneous lights allowed on the material.
  134236. */
  134237. maxSimultaneousLights: int;
  134238. private _shadowOnly;
  134239. /**
  134240. * Make the material only render shadows
  134241. */
  134242. shadowOnly: boolean;
  134243. /**
  134244. * Default configuration related to image processing available in the Background Material.
  134245. */
  134246. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134247. /**
  134248. * Keep track of the image processing observer to allow dispose and replace.
  134249. */
  134250. private _imageProcessingObserver;
  134251. /**
  134252. * Attaches a new image processing configuration to the PBR Material.
  134253. * @param configuration (if null the scene configuration will be use)
  134254. */
  134255. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134256. /**
  134257. * Gets the image processing configuration used either in this material.
  134258. */
  134259. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134260. /**
  134261. * Sets the Default image processing configuration used either in the this material.
  134262. *
  134263. * If sets to null, the scene one is in use.
  134264. */
  134265. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134266. /**
  134267. * Gets wether the color curves effect is enabled.
  134268. */
  134269. get cameraColorCurvesEnabled(): boolean;
  134270. /**
  134271. * Sets wether the color curves effect is enabled.
  134272. */
  134273. set cameraColorCurvesEnabled(value: boolean);
  134274. /**
  134275. * Gets wether the color grading effect is enabled.
  134276. */
  134277. get cameraColorGradingEnabled(): boolean;
  134278. /**
  134279. * Gets wether the color grading effect is enabled.
  134280. */
  134281. set cameraColorGradingEnabled(value: boolean);
  134282. /**
  134283. * Gets wether tonemapping is enabled or not.
  134284. */
  134285. get cameraToneMappingEnabled(): boolean;
  134286. /**
  134287. * Sets wether tonemapping is enabled or not
  134288. */
  134289. set cameraToneMappingEnabled(value: boolean);
  134290. /**
  134291. * The camera exposure used on this material.
  134292. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134293. * This corresponds to a photographic exposure.
  134294. */
  134295. get cameraExposure(): float;
  134296. /**
  134297. * The camera exposure used on this material.
  134298. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134299. * This corresponds to a photographic exposure.
  134300. */
  134301. set cameraExposure(value: float);
  134302. /**
  134303. * Gets The camera contrast used on this material.
  134304. */
  134305. get cameraContrast(): float;
  134306. /**
  134307. * Sets The camera contrast used on this material.
  134308. */
  134309. set cameraContrast(value: float);
  134310. /**
  134311. * Gets the Color Grading 2D Lookup Texture.
  134312. */
  134313. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134314. /**
  134315. * Sets the Color Grading 2D Lookup Texture.
  134316. */
  134317. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134318. /**
  134319. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134320. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134321. * 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;
  134322. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134323. */
  134324. get cameraColorCurves(): Nullable<ColorCurves>;
  134325. /**
  134326. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134327. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134328. * 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;
  134329. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134330. */
  134331. set cameraColorCurves(value: Nullable<ColorCurves>);
  134332. /**
  134333. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134334. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134335. */
  134336. switchToBGR: boolean;
  134337. private _renderTargets;
  134338. private _reflectionControls;
  134339. private _white;
  134340. private _primaryShadowColor;
  134341. private _primaryHighlightColor;
  134342. /**
  134343. * Instantiates a Background Material in the given scene
  134344. * @param name The friendly name of the material
  134345. * @param scene The scene to add the material to
  134346. */
  134347. constructor(name: string, scene: Scene);
  134348. /**
  134349. * Gets a boolean indicating that current material needs to register RTT
  134350. */
  134351. get hasRenderTargetTextures(): boolean;
  134352. /**
  134353. * The entire material has been created in order to prevent overdraw.
  134354. * @returns false
  134355. */
  134356. needAlphaTesting(): boolean;
  134357. /**
  134358. * The entire material has been created in order to prevent overdraw.
  134359. * @returns true if blending is enable
  134360. */
  134361. needAlphaBlending(): boolean;
  134362. /**
  134363. * Checks wether the material is ready to be rendered for a given mesh.
  134364. * @param mesh The mesh to render
  134365. * @param subMesh The submesh to check against
  134366. * @param useInstances Specify wether or not the material is used with instances
  134367. * @returns true if all the dependencies are ready (Textures, Effects...)
  134368. */
  134369. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134370. /**
  134371. * Compute the primary color according to the chosen perceptual color.
  134372. */
  134373. private _computePrimaryColorFromPerceptualColor;
  134374. /**
  134375. * Compute the highlights and shadow colors according to their chosen levels.
  134376. */
  134377. private _computePrimaryColors;
  134378. /**
  134379. * Build the uniform buffer used in the material.
  134380. */
  134381. buildUniformLayout(): void;
  134382. /**
  134383. * Unbind the material.
  134384. */
  134385. unbind(): void;
  134386. /**
  134387. * Bind only the world matrix to the material.
  134388. * @param world The world matrix to bind.
  134389. */
  134390. bindOnlyWorldMatrix(world: Matrix): void;
  134391. /**
  134392. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134393. * @param world The world matrix to bind.
  134394. * @param subMesh The submesh to bind for.
  134395. */
  134396. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134397. /**
  134398. * Checks to see if a texture is used in the material.
  134399. * @param texture - Base texture to use.
  134400. * @returns - Boolean specifying if a texture is used in the material.
  134401. */
  134402. hasTexture(texture: BaseTexture): boolean;
  134403. /**
  134404. * Dispose the material.
  134405. * @param forceDisposeEffect Force disposal of the associated effect.
  134406. * @param forceDisposeTextures Force disposal of the associated textures.
  134407. */
  134408. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134409. /**
  134410. * Clones the material.
  134411. * @param name The cloned name.
  134412. * @returns The cloned material.
  134413. */
  134414. clone(name: string): BackgroundMaterial;
  134415. /**
  134416. * Serializes the current material to its JSON representation.
  134417. * @returns The JSON representation.
  134418. */
  134419. serialize(): any;
  134420. /**
  134421. * Gets the class name of the material
  134422. * @returns "BackgroundMaterial"
  134423. */
  134424. getClassName(): string;
  134425. /**
  134426. * Parse a JSON input to create back a background material.
  134427. * @param source The JSON data to parse
  134428. * @param scene The scene to create the parsed material in
  134429. * @param rootUrl The root url of the assets the material depends upon
  134430. * @returns the instantiated BackgroundMaterial.
  134431. */
  134432. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134433. }
  134434. }
  134435. declare module BABYLON {
  134436. /**
  134437. * Represents the different options available during the creation of
  134438. * a Environment helper.
  134439. *
  134440. * This can control the default ground, skybox and image processing setup of your scene.
  134441. */
  134442. export interface IEnvironmentHelperOptions {
  134443. /**
  134444. * Specifies whether or not to create a ground.
  134445. * True by default.
  134446. */
  134447. createGround: boolean;
  134448. /**
  134449. * Specifies the ground size.
  134450. * 15 by default.
  134451. */
  134452. groundSize: number;
  134453. /**
  134454. * The texture used on the ground for the main color.
  134455. * Comes from the BabylonJS CDN by default.
  134456. *
  134457. * Remarks: Can be either a texture or a url.
  134458. */
  134459. groundTexture: string | BaseTexture;
  134460. /**
  134461. * The color mixed in the ground texture by default.
  134462. * BabylonJS clearColor by default.
  134463. */
  134464. groundColor: Color3;
  134465. /**
  134466. * Specifies the ground opacity.
  134467. * 1 by default.
  134468. */
  134469. groundOpacity: number;
  134470. /**
  134471. * Enables the ground to receive shadows.
  134472. * True by default.
  134473. */
  134474. enableGroundShadow: boolean;
  134475. /**
  134476. * Helps preventing the shadow to be fully black on the ground.
  134477. * 0.5 by default.
  134478. */
  134479. groundShadowLevel: number;
  134480. /**
  134481. * Creates a mirror texture attach to the ground.
  134482. * false by default.
  134483. */
  134484. enableGroundMirror: boolean;
  134485. /**
  134486. * Specifies the ground mirror size ratio.
  134487. * 0.3 by default as the default kernel is 64.
  134488. */
  134489. groundMirrorSizeRatio: number;
  134490. /**
  134491. * Specifies the ground mirror blur kernel size.
  134492. * 64 by default.
  134493. */
  134494. groundMirrorBlurKernel: number;
  134495. /**
  134496. * Specifies the ground mirror visibility amount.
  134497. * 1 by default
  134498. */
  134499. groundMirrorAmount: number;
  134500. /**
  134501. * Specifies the ground mirror reflectance weight.
  134502. * This uses the standard weight of the background material to setup the fresnel effect
  134503. * of the mirror.
  134504. * 1 by default.
  134505. */
  134506. groundMirrorFresnelWeight: number;
  134507. /**
  134508. * Specifies the ground mirror Falloff distance.
  134509. * This can helps reducing the size of the reflection.
  134510. * 0 by Default.
  134511. */
  134512. groundMirrorFallOffDistance: number;
  134513. /**
  134514. * Specifies the ground mirror texture type.
  134515. * Unsigned Int by Default.
  134516. */
  134517. groundMirrorTextureType: number;
  134518. /**
  134519. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134520. * the shown objects.
  134521. */
  134522. groundYBias: number;
  134523. /**
  134524. * Specifies whether or not to create a skybox.
  134525. * True by default.
  134526. */
  134527. createSkybox: boolean;
  134528. /**
  134529. * Specifies the skybox size.
  134530. * 20 by default.
  134531. */
  134532. skyboxSize: number;
  134533. /**
  134534. * The texture used on the skybox for the main color.
  134535. * Comes from the BabylonJS CDN by default.
  134536. *
  134537. * Remarks: Can be either a texture or a url.
  134538. */
  134539. skyboxTexture: string | BaseTexture;
  134540. /**
  134541. * The color mixed in the skybox texture by default.
  134542. * BabylonJS clearColor by default.
  134543. */
  134544. skyboxColor: Color3;
  134545. /**
  134546. * The background rotation around the Y axis of the scene.
  134547. * This helps aligning the key lights of your scene with the background.
  134548. * 0 by default.
  134549. */
  134550. backgroundYRotation: number;
  134551. /**
  134552. * Compute automatically the size of the elements to best fit with the scene.
  134553. */
  134554. sizeAuto: boolean;
  134555. /**
  134556. * Default position of the rootMesh if autoSize is not true.
  134557. */
  134558. rootPosition: Vector3;
  134559. /**
  134560. * Sets up the image processing in the scene.
  134561. * true by default.
  134562. */
  134563. setupImageProcessing: boolean;
  134564. /**
  134565. * The texture used as your environment texture in the scene.
  134566. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134567. *
  134568. * Remarks: Can be either a texture or a url.
  134569. */
  134570. environmentTexture: string | BaseTexture;
  134571. /**
  134572. * The value of the exposure to apply to the scene.
  134573. * 0.6 by default if setupImageProcessing is true.
  134574. */
  134575. cameraExposure: number;
  134576. /**
  134577. * The value of the contrast to apply to the scene.
  134578. * 1.6 by default if setupImageProcessing is true.
  134579. */
  134580. cameraContrast: number;
  134581. /**
  134582. * Specifies whether or not tonemapping should be enabled in the scene.
  134583. * true by default if setupImageProcessing is true.
  134584. */
  134585. toneMappingEnabled: boolean;
  134586. }
  134587. /**
  134588. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134589. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134590. * It also helps with the default setup of your imageProcessing configuration.
  134591. */
  134592. export class EnvironmentHelper {
  134593. /**
  134594. * Default ground texture URL.
  134595. */
  134596. private static _groundTextureCDNUrl;
  134597. /**
  134598. * Default skybox texture URL.
  134599. */
  134600. private static _skyboxTextureCDNUrl;
  134601. /**
  134602. * Default environment texture URL.
  134603. */
  134604. private static _environmentTextureCDNUrl;
  134605. /**
  134606. * Creates the default options for the helper.
  134607. */
  134608. private static _getDefaultOptions;
  134609. private _rootMesh;
  134610. /**
  134611. * Gets the root mesh created by the helper.
  134612. */
  134613. get rootMesh(): Mesh;
  134614. private _skybox;
  134615. /**
  134616. * Gets the skybox created by the helper.
  134617. */
  134618. get skybox(): Nullable<Mesh>;
  134619. private _skyboxTexture;
  134620. /**
  134621. * Gets the skybox texture created by the helper.
  134622. */
  134623. get skyboxTexture(): Nullable<BaseTexture>;
  134624. private _skyboxMaterial;
  134625. /**
  134626. * Gets the skybox material created by the helper.
  134627. */
  134628. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134629. private _ground;
  134630. /**
  134631. * Gets the ground mesh created by the helper.
  134632. */
  134633. get ground(): Nullable<Mesh>;
  134634. private _groundTexture;
  134635. /**
  134636. * Gets the ground texture created by the helper.
  134637. */
  134638. get groundTexture(): Nullable<BaseTexture>;
  134639. private _groundMirror;
  134640. /**
  134641. * Gets the ground mirror created by the helper.
  134642. */
  134643. get groundMirror(): Nullable<MirrorTexture>;
  134644. /**
  134645. * Gets the ground mirror render list to helps pushing the meshes
  134646. * you wish in the ground reflection.
  134647. */
  134648. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134649. private _groundMaterial;
  134650. /**
  134651. * Gets the ground material created by the helper.
  134652. */
  134653. get groundMaterial(): Nullable<BackgroundMaterial>;
  134654. /**
  134655. * Stores the creation options.
  134656. */
  134657. private readonly _scene;
  134658. private _options;
  134659. /**
  134660. * This observable will be notified with any error during the creation of the environment,
  134661. * mainly texture creation errors.
  134662. */
  134663. onErrorObservable: Observable<{
  134664. message?: string;
  134665. exception?: any;
  134666. }>;
  134667. /**
  134668. * constructor
  134669. * @param options Defines the options we want to customize the helper
  134670. * @param scene The scene to add the material to
  134671. */
  134672. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134673. /**
  134674. * Updates the background according to the new options
  134675. * @param options
  134676. */
  134677. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134678. /**
  134679. * Sets the primary color of all the available elements.
  134680. * @param color the main color to affect to the ground and the background
  134681. */
  134682. setMainColor(color: Color3): void;
  134683. /**
  134684. * Setup the image processing according to the specified options.
  134685. */
  134686. private _setupImageProcessing;
  134687. /**
  134688. * Setup the environment texture according to the specified options.
  134689. */
  134690. private _setupEnvironmentTexture;
  134691. /**
  134692. * Setup the background according to the specified options.
  134693. */
  134694. private _setupBackground;
  134695. /**
  134696. * Get the scene sizes according to the setup.
  134697. */
  134698. private _getSceneSize;
  134699. /**
  134700. * Setup the ground according to the specified options.
  134701. */
  134702. private _setupGround;
  134703. /**
  134704. * Setup the ground material according to the specified options.
  134705. */
  134706. private _setupGroundMaterial;
  134707. /**
  134708. * Setup the ground diffuse texture according to the specified options.
  134709. */
  134710. private _setupGroundDiffuseTexture;
  134711. /**
  134712. * Setup the ground mirror texture according to the specified options.
  134713. */
  134714. private _setupGroundMirrorTexture;
  134715. /**
  134716. * Setup the ground to receive the mirror texture.
  134717. */
  134718. private _setupMirrorInGroundMaterial;
  134719. /**
  134720. * Setup the skybox according to the specified options.
  134721. */
  134722. private _setupSkybox;
  134723. /**
  134724. * Setup the skybox material according to the specified options.
  134725. */
  134726. private _setupSkyboxMaterial;
  134727. /**
  134728. * Setup the skybox reflection texture according to the specified options.
  134729. */
  134730. private _setupSkyboxReflectionTexture;
  134731. private _errorHandler;
  134732. /**
  134733. * Dispose all the elements created by the Helper.
  134734. */
  134735. dispose(): void;
  134736. }
  134737. }
  134738. declare module BABYLON {
  134739. /**
  134740. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134741. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134742. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134743. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134744. */
  134745. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134746. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134747. /**
  134748. * Define the source as a Monoscopic panoramic 360/180.
  134749. */
  134750. static readonly MODE_MONOSCOPIC: number;
  134751. /**
  134752. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134753. */
  134754. static readonly MODE_TOPBOTTOM: number;
  134755. /**
  134756. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134757. */
  134758. static readonly MODE_SIDEBYSIDE: number;
  134759. private _halfDome;
  134760. protected _useDirectMapping: boolean;
  134761. /**
  134762. * The texture being displayed on the sphere
  134763. */
  134764. protected _texture: T;
  134765. /**
  134766. * Gets the texture being displayed on the sphere
  134767. */
  134768. get texture(): T;
  134769. /**
  134770. * Sets the texture being displayed on the sphere
  134771. */
  134772. set texture(newTexture: T);
  134773. /**
  134774. * The skybox material
  134775. */
  134776. protected _material: BackgroundMaterial;
  134777. /**
  134778. * The surface used for the dome
  134779. */
  134780. protected _mesh: Mesh;
  134781. /**
  134782. * Gets the mesh used for the dome.
  134783. */
  134784. get mesh(): Mesh;
  134785. /**
  134786. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134787. */
  134788. private _halfDomeMask;
  134789. /**
  134790. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134791. * Also see the options.resolution property.
  134792. */
  134793. get fovMultiplier(): number;
  134794. set fovMultiplier(value: number);
  134795. protected _textureMode: number;
  134796. /**
  134797. * Gets or set the current texture mode for the texture. It can be:
  134798. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134799. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134800. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134801. */
  134802. get textureMode(): number;
  134803. /**
  134804. * Sets the current texture mode for the texture. It can be:
  134805. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134806. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134807. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134808. */
  134809. set textureMode(value: number);
  134810. /**
  134811. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134812. */
  134813. get halfDome(): boolean;
  134814. /**
  134815. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134816. */
  134817. set halfDome(enabled: boolean);
  134818. /**
  134819. * Oberserver used in Stereoscopic VR Mode.
  134820. */
  134821. private _onBeforeCameraRenderObserver;
  134822. /**
  134823. * Observable raised when an error occured while loading the 360 image
  134824. */
  134825. onLoadErrorObservable: Observable<string>;
  134826. /**
  134827. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134828. * @param name Element's name, child elements will append suffixes for their own names.
  134829. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134830. * @param options An object containing optional or exposed sub element properties
  134831. */
  134832. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134833. resolution?: number;
  134834. clickToPlay?: boolean;
  134835. autoPlay?: boolean;
  134836. loop?: boolean;
  134837. size?: number;
  134838. poster?: string;
  134839. faceForward?: boolean;
  134840. useDirectMapping?: boolean;
  134841. halfDomeMode?: boolean;
  134842. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134843. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134844. protected _changeTextureMode(value: number): void;
  134845. /**
  134846. * Releases resources associated with this node.
  134847. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134848. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134849. */
  134850. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134851. }
  134852. }
  134853. declare module BABYLON {
  134854. /**
  134855. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134856. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134857. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134858. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134859. */
  134860. export class PhotoDome extends TextureDome<Texture> {
  134861. /**
  134862. * Define the image as a Monoscopic panoramic 360 image.
  134863. */
  134864. static readonly MODE_MONOSCOPIC: number;
  134865. /**
  134866. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134867. */
  134868. static readonly MODE_TOPBOTTOM: number;
  134869. /**
  134870. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134871. */
  134872. static readonly MODE_SIDEBYSIDE: number;
  134873. /**
  134874. * Gets or sets the texture being displayed on the sphere
  134875. */
  134876. get photoTexture(): Texture;
  134877. /**
  134878. * sets the texture being displayed on the sphere
  134879. */
  134880. set photoTexture(value: Texture);
  134881. /**
  134882. * Gets the current video mode for the video. It can be:
  134883. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134884. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134885. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134886. */
  134887. get imageMode(): number;
  134888. /**
  134889. * Sets the current video mode for the video. It can be:
  134890. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134891. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134892. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134893. */
  134894. set imageMode(value: number);
  134895. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134896. }
  134897. }
  134898. declare module BABYLON {
  134899. /**
  134900. * Class used to host RGBD texture specific utilities
  134901. */
  134902. export class RGBDTextureTools {
  134903. /**
  134904. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134905. * @param texture the texture to expand.
  134906. */
  134907. static ExpandRGBDTexture(texture: Texture): void;
  134908. }
  134909. }
  134910. declare module BABYLON {
  134911. /**
  134912. * Class used to host texture specific utilities
  134913. */
  134914. export class BRDFTextureTools {
  134915. /**
  134916. * Prevents texture cache collision
  134917. */
  134918. private static _instanceNumber;
  134919. /**
  134920. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134921. * @param scene defines the hosting scene
  134922. * @returns the environment BRDF texture
  134923. */
  134924. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134925. private static _environmentBRDFBase64Texture;
  134926. }
  134927. }
  134928. declare module BABYLON {
  134929. /**
  134930. * @hidden
  134931. */
  134932. export interface IMaterialClearCoatDefines {
  134933. CLEARCOAT: boolean;
  134934. CLEARCOAT_DEFAULTIOR: boolean;
  134935. CLEARCOAT_TEXTURE: boolean;
  134936. CLEARCOAT_TEXTUREDIRECTUV: number;
  134937. CLEARCOAT_BUMP: boolean;
  134938. CLEARCOAT_BUMPDIRECTUV: number;
  134939. CLEARCOAT_TINT: boolean;
  134940. CLEARCOAT_TINT_TEXTURE: boolean;
  134941. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134942. /** @hidden */
  134943. _areTexturesDirty: boolean;
  134944. }
  134945. /**
  134946. * Define the code related to the clear coat parameters of the pbr material.
  134947. */
  134948. export class PBRClearCoatConfiguration {
  134949. /**
  134950. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134951. * The default fits with a polyurethane material.
  134952. */
  134953. private static readonly _DefaultIndexOfRefraction;
  134954. private _isEnabled;
  134955. /**
  134956. * Defines if the clear coat is enabled in the material.
  134957. */
  134958. isEnabled: boolean;
  134959. /**
  134960. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134961. */
  134962. intensity: number;
  134963. /**
  134964. * Defines the clear coat layer roughness.
  134965. */
  134966. roughness: number;
  134967. private _indexOfRefraction;
  134968. /**
  134969. * Defines the index of refraction of the clear coat.
  134970. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134971. * The default fits with a polyurethane material.
  134972. * Changing the default value is more performance intensive.
  134973. */
  134974. indexOfRefraction: number;
  134975. private _texture;
  134976. /**
  134977. * Stores the clear coat values in a texture.
  134978. */
  134979. texture: Nullable<BaseTexture>;
  134980. private _bumpTexture;
  134981. /**
  134982. * Define the clear coat specific bump texture.
  134983. */
  134984. bumpTexture: Nullable<BaseTexture>;
  134985. private _isTintEnabled;
  134986. /**
  134987. * Defines if the clear coat tint is enabled in the material.
  134988. */
  134989. isTintEnabled: boolean;
  134990. /**
  134991. * Defines the clear coat tint of the material.
  134992. * This is only use if tint is enabled
  134993. */
  134994. tintColor: Color3;
  134995. /**
  134996. * Defines the distance at which the tint color should be found in the
  134997. * clear coat media.
  134998. * This is only use if tint is enabled
  134999. */
  135000. tintColorAtDistance: number;
  135001. /**
  135002. * Defines the clear coat layer thickness.
  135003. * This is only use if tint is enabled
  135004. */
  135005. tintThickness: number;
  135006. private _tintTexture;
  135007. /**
  135008. * Stores the clear tint values in a texture.
  135009. * rgb is tint
  135010. * a is a thickness factor
  135011. */
  135012. tintTexture: Nullable<BaseTexture>;
  135013. /** @hidden */
  135014. private _internalMarkAllSubMeshesAsTexturesDirty;
  135015. /** @hidden */
  135016. _markAllSubMeshesAsTexturesDirty(): void;
  135017. /**
  135018. * Instantiate a new istance of clear coat configuration.
  135019. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135020. */
  135021. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135022. /**
  135023. * Gets wehter the submesh is ready to be used or not.
  135024. * @param defines the list of "defines" to update.
  135025. * @param scene defines the scene the material belongs to.
  135026. * @param engine defines the engine the material belongs to.
  135027. * @param disableBumpMap defines wether the material disables bump or not.
  135028. * @returns - boolean indicating that the submesh is ready or not.
  135029. */
  135030. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  135031. /**
  135032. * Checks to see if a texture is used in the material.
  135033. * @param defines the list of "defines" to update.
  135034. * @param scene defines the scene to the material belongs to.
  135035. */
  135036. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  135037. /**
  135038. * Binds the material data.
  135039. * @param uniformBuffer defines the Uniform buffer to fill in.
  135040. * @param scene defines the scene the material belongs to.
  135041. * @param engine defines the engine the material belongs to.
  135042. * @param disableBumpMap defines wether the material disables bump or not.
  135043. * @param isFrozen defines wether the material is frozen or not.
  135044. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135045. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135046. */
  135047. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  135048. /**
  135049. * Checks to see if a texture is used in the material.
  135050. * @param texture - Base texture to use.
  135051. * @returns - Boolean specifying if a texture is used in the material.
  135052. */
  135053. hasTexture(texture: BaseTexture): boolean;
  135054. /**
  135055. * Returns an array of the actively used textures.
  135056. * @param activeTextures Array of BaseTextures
  135057. */
  135058. getActiveTextures(activeTextures: BaseTexture[]): void;
  135059. /**
  135060. * Returns the animatable textures.
  135061. * @param animatables Array of animatable textures.
  135062. */
  135063. getAnimatables(animatables: IAnimatable[]): void;
  135064. /**
  135065. * Disposes the resources of the material.
  135066. * @param forceDisposeTextures - Forces the disposal of all textures.
  135067. */
  135068. dispose(forceDisposeTextures?: boolean): void;
  135069. /**
  135070. * Get the current class name of the texture useful for serialization or dynamic coding.
  135071. * @returns "PBRClearCoatConfiguration"
  135072. */
  135073. getClassName(): string;
  135074. /**
  135075. * Add fallbacks to the effect fallbacks list.
  135076. * @param defines defines the Base texture to use.
  135077. * @param fallbacks defines the current fallback list.
  135078. * @param currentRank defines the current fallback rank.
  135079. * @returns the new fallback rank.
  135080. */
  135081. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135082. /**
  135083. * Add the required uniforms to the current list.
  135084. * @param uniforms defines the current uniform list.
  135085. */
  135086. static AddUniforms(uniforms: string[]): void;
  135087. /**
  135088. * Add the required samplers to the current list.
  135089. * @param samplers defines the current sampler list.
  135090. */
  135091. static AddSamplers(samplers: string[]): void;
  135092. /**
  135093. * Add the required uniforms to the current buffer.
  135094. * @param uniformBuffer defines the current uniform buffer.
  135095. */
  135096. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135097. /**
  135098. * Makes a duplicate of the current configuration into another one.
  135099. * @param clearCoatConfiguration define the config where to copy the info
  135100. */
  135101. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  135102. /**
  135103. * Serializes this clear coat configuration.
  135104. * @returns - An object with the serialized config.
  135105. */
  135106. serialize(): any;
  135107. /**
  135108. * Parses a anisotropy Configuration from a serialized object.
  135109. * @param source - Serialized object.
  135110. * @param scene Defines the scene we are parsing for
  135111. * @param rootUrl Defines the rootUrl to load from
  135112. */
  135113. parse(source: any, scene: Scene, rootUrl: string): void;
  135114. }
  135115. }
  135116. declare module BABYLON {
  135117. /**
  135118. * @hidden
  135119. */
  135120. export interface IMaterialAnisotropicDefines {
  135121. ANISOTROPIC: boolean;
  135122. ANISOTROPIC_TEXTURE: boolean;
  135123. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135124. MAINUV1: boolean;
  135125. _areTexturesDirty: boolean;
  135126. _needUVs: boolean;
  135127. }
  135128. /**
  135129. * Define the code related to the anisotropic parameters of the pbr material.
  135130. */
  135131. export class PBRAnisotropicConfiguration {
  135132. private _isEnabled;
  135133. /**
  135134. * Defines if the anisotropy is enabled in the material.
  135135. */
  135136. isEnabled: boolean;
  135137. /**
  135138. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  135139. */
  135140. intensity: number;
  135141. /**
  135142. * Defines if the effect is along the tangents, bitangents or in between.
  135143. * By default, the effect is "strectching" the highlights along the tangents.
  135144. */
  135145. direction: Vector2;
  135146. private _texture;
  135147. /**
  135148. * Stores the anisotropy values in a texture.
  135149. * rg is direction (like normal from -1 to 1)
  135150. * b is a intensity
  135151. */
  135152. texture: Nullable<BaseTexture>;
  135153. /** @hidden */
  135154. private _internalMarkAllSubMeshesAsTexturesDirty;
  135155. /** @hidden */
  135156. _markAllSubMeshesAsTexturesDirty(): void;
  135157. /**
  135158. * Instantiate a new istance of anisotropy configuration.
  135159. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135160. */
  135161. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135162. /**
  135163. * Specifies that the submesh is ready to be used.
  135164. * @param defines the list of "defines" to update.
  135165. * @param scene defines the scene the material belongs to.
  135166. * @returns - boolean indicating that the submesh is ready or not.
  135167. */
  135168. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135169. /**
  135170. * Checks to see if a texture is used in the material.
  135171. * @param defines the list of "defines" to update.
  135172. * @param mesh the mesh we are preparing the defines for.
  135173. * @param scene defines the scene the material belongs to.
  135174. */
  135175. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135176. /**
  135177. * Binds the material data.
  135178. * @param uniformBuffer defines the Uniform buffer to fill in.
  135179. * @param scene defines the scene the material belongs to.
  135180. * @param isFrozen defines wether the material is frozen or not.
  135181. */
  135182. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135183. /**
  135184. * Checks to see if a texture is used in the material.
  135185. * @param texture - Base texture to use.
  135186. * @returns - Boolean specifying if a texture is used in the material.
  135187. */
  135188. hasTexture(texture: BaseTexture): boolean;
  135189. /**
  135190. * Returns an array of the actively used textures.
  135191. * @param activeTextures Array of BaseTextures
  135192. */
  135193. getActiveTextures(activeTextures: BaseTexture[]): void;
  135194. /**
  135195. * Returns the animatable textures.
  135196. * @param animatables Array of animatable textures.
  135197. */
  135198. getAnimatables(animatables: IAnimatable[]): void;
  135199. /**
  135200. * Disposes the resources of the material.
  135201. * @param forceDisposeTextures - Forces the disposal of all textures.
  135202. */
  135203. dispose(forceDisposeTextures?: boolean): void;
  135204. /**
  135205. * Get the current class name of the texture useful for serialization or dynamic coding.
  135206. * @returns "PBRAnisotropicConfiguration"
  135207. */
  135208. getClassName(): string;
  135209. /**
  135210. * Add fallbacks to the effect fallbacks list.
  135211. * @param defines defines the Base texture to use.
  135212. * @param fallbacks defines the current fallback list.
  135213. * @param currentRank defines the current fallback rank.
  135214. * @returns the new fallback rank.
  135215. */
  135216. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135217. /**
  135218. * Add the required uniforms to the current list.
  135219. * @param uniforms defines the current uniform list.
  135220. */
  135221. static AddUniforms(uniforms: string[]): void;
  135222. /**
  135223. * Add the required uniforms to the current buffer.
  135224. * @param uniformBuffer defines the current uniform buffer.
  135225. */
  135226. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135227. /**
  135228. * Add the required samplers to the current list.
  135229. * @param samplers defines the current sampler list.
  135230. */
  135231. static AddSamplers(samplers: string[]): void;
  135232. /**
  135233. * Makes a duplicate of the current configuration into another one.
  135234. * @param anisotropicConfiguration define the config where to copy the info
  135235. */
  135236. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135237. /**
  135238. * Serializes this anisotropy configuration.
  135239. * @returns - An object with the serialized config.
  135240. */
  135241. serialize(): any;
  135242. /**
  135243. * Parses a anisotropy Configuration from a serialized object.
  135244. * @param source - Serialized object.
  135245. * @param scene Defines the scene we are parsing for
  135246. * @param rootUrl Defines the rootUrl to load from
  135247. */
  135248. parse(source: any, scene: Scene, rootUrl: string): void;
  135249. }
  135250. }
  135251. declare module BABYLON {
  135252. /**
  135253. * @hidden
  135254. */
  135255. export interface IMaterialBRDFDefines {
  135256. BRDF_V_HEIGHT_CORRELATED: boolean;
  135257. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135258. SPHERICAL_HARMONICS: boolean;
  135259. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135260. /** @hidden */
  135261. _areMiscDirty: boolean;
  135262. }
  135263. /**
  135264. * Define the code related to the BRDF parameters of the pbr material.
  135265. */
  135266. export class PBRBRDFConfiguration {
  135267. /**
  135268. * Default value used for the energy conservation.
  135269. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135270. */
  135271. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135272. /**
  135273. * Default value used for the Smith Visibility Height Correlated mode.
  135274. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135275. */
  135276. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135277. /**
  135278. * Default value used for the IBL diffuse part.
  135279. * This can help switching back to the polynomials mode globally which is a tiny bit
  135280. * less GPU intensive at the drawback of a lower quality.
  135281. */
  135282. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135283. /**
  135284. * Default value used for activating energy conservation for the specular workflow.
  135285. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135286. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135287. */
  135288. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135289. private _useEnergyConservation;
  135290. /**
  135291. * Defines if the material uses energy conservation.
  135292. */
  135293. useEnergyConservation: boolean;
  135294. private _useSmithVisibilityHeightCorrelated;
  135295. /**
  135296. * LEGACY Mode set to false
  135297. * Defines if the material uses height smith correlated visibility term.
  135298. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135299. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135300. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135301. * Not relying on height correlated will also disable energy conservation.
  135302. */
  135303. useSmithVisibilityHeightCorrelated: boolean;
  135304. private _useSphericalHarmonics;
  135305. /**
  135306. * LEGACY Mode set to false
  135307. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135308. * diffuse part of the IBL.
  135309. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135310. * to the ground truth.
  135311. */
  135312. useSphericalHarmonics: boolean;
  135313. private _useSpecularGlossinessInputEnergyConservation;
  135314. /**
  135315. * Defines if the material uses energy conservation, when the specular workflow is active.
  135316. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135317. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135318. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135319. */
  135320. useSpecularGlossinessInputEnergyConservation: boolean;
  135321. /** @hidden */
  135322. private _internalMarkAllSubMeshesAsMiscDirty;
  135323. /** @hidden */
  135324. _markAllSubMeshesAsMiscDirty(): void;
  135325. /**
  135326. * Instantiate a new istance of clear coat configuration.
  135327. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135328. */
  135329. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135330. /**
  135331. * Checks to see if a texture is used in the material.
  135332. * @param defines the list of "defines" to update.
  135333. */
  135334. prepareDefines(defines: IMaterialBRDFDefines): void;
  135335. /**
  135336. * Get the current class name of the texture useful for serialization or dynamic coding.
  135337. * @returns "PBRClearCoatConfiguration"
  135338. */
  135339. getClassName(): string;
  135340. /**
  135341. * Makes a duplicate of the current configuration into another one.
  135342. * @param brdfConfiguration define the config where to copy the info
  135343. */
  135344. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135345. /**
  135346. * Serializes this BRDF configuration.
  135347. * @returns - An object with the serialized config.
  135348. */
  135349. serialize(): any;
  135350. /**
  135351. * Parses a anisotropy Configuration from a serialized object.
  135352. * @param source - Serialized object.
  135353. * @param scene Defines the scene we are parsing for
  135354. * @param rootUrl Defines the rootUrl to load from
  135355. */
  135356. parse(source: any, scene: Scene, rootUrl: string): void;
  135357. }
  135358. }
  135359. declare module BABYLON {
  135360. /**
  135361. * @hidden
  135362. */
  135363. export interface IMaterialSheenDefines {
  135364. SHEEN: boolean;
  135365. SHEEN_TEXTURE: boolean;
  135366. SHEEN_TEXTUREDIRECTUV: number;
  135367. SHEEN_LINKWITHALBEDO: boolean;
  135368. SHEEN_ROUGHNESS: boolean;
  135369. SHEEN_ALBEDOSCALING: boolean;
  135370. /** @hidden */
  135371. _areTexturesDirty: boolean;
  135372. }
  135373. /**
  135374. * Define the code related to the Sheen parameters of the pbr material.
  135375. */
  135376. export class PBRSheenConfiguration {
  135377. private _isEnabled;
  135378. /**
  135379. * Defines if the material uses sheen.
  135380. */
  135381. isEnabled: boolean;
  135382. private _linkSheenWithAlbedo;
  135383. /**
  135384. * Defines if the sheen is linked to the sheen color.
  135385. */
  135386. linkSheenWithAlbedo: boolean;
  135387. /**
  135388. * Defines the sheen intensity.
  135389. */
  135390. intensity: number;
  135391. /**
  135392. * Defines the sheen color.
  135393. */
  135394. color: Color3;
  135395. private _texture;
  135396. /**
  135397. * Stores the sheen tint values in a texture.
  135398. * rgb is tint
  135399. * a is a intensity or roughness if roughness has been defined
  135400. */
  135401. texture: Nullable<BaseTexture>;
  135402. private _roughness;
  135403. /**
  135404. * Defines the sheen roughness.
  135405. * It is not taken into account if linkSheenWithAlbedo is true.
  135406. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135407. */
  135408. roughness: Nullable<number>;
  135409. private _albedoScaling;
  135410. /**
  135411. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135412. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135413. * making it easier to setup and tweak the effect
  135414. */
  135415. albedoScaling: boolean;
  135416. /** @hidden */
  135417. private _internalMarkAllSubMeshesAsTexturesDirty;
  135418. /** @hidden */
  135419. _markAllSubMeshesAsTexturesDirty(): void;
  135420. /**
  135421. * Instantiate a new istance of clear coat configuration.
  135422. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135423. */
  135424. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135425. /**
  135426. * Specifies that the submesh is ready to be used.
  135427. * @param defines the list of "defines" to update.
  135428. * @param scene defines the scene the material belongs to.
  135429. * @returns - boolean indicating that the submesh is ready or not.
  135430. */
  135431. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135432. /**
  135433. * Checks to see if a texture is used in the material.
  135434. * @param defines the list of "defines" to update.
  135435. * @param scene defines the scene the material belongs to.
  135436. */
  135437. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135438. /**
  135439. * Binds the material data.
  135440. * @param uniformBuffer defines the Uniform buffer to fill in.
  135441. * @param scene defines the scene the material belongs to.
  135442. * @param isFrozen defines wether the material is frozen or not.
  135443. */
  135444. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135445. /**
  135446. * Checks to see if a texture is used in the material.
  135447. * @param texture - Base texture to use.
  135448. * @returns - Boolean specifying if a texture is used in the material.
  135449. */
  135450. hasTexture(texture: BaseTexture): boolean;
  135451. /**
  135452. * Returns an array of the actively used textures.
  135453. * @param activeTextures Array of BaseTextures
  135454. */
  135455. getActiveTextures(activeTextures: BaseTexture[]): void;
  135456. /**
  135457. * Returns the animatable textures.
  135458. * @param animatables Array of animatable textures.
  135459. */
  135460. getAnimatables(animatables: IAnimatable[]): void;
  135461. /**
  135462. * Disposes the resources of the material.
  135463. * @param forceDisposeTextures - Forces the disposal of all textures.
  135464. */
  135465. dispose(forceDisposeTextures?: boolean): void;
  135466. /**
  135467. * Get the current class name of the texture useful for serialization or dynamic coding.
  135468. * @returns "PBRSheenConfiguration"
  135469. */
  135470. getClassName(): string;
  135471. /**
  135472. * Add fallbacks to the effect fallbacks list.
  135473. * @param defines defines the Base texture to use.
  135474. * @param fallbacks defines the current fallback list.
  135475. * @param currentRank defines the current fallback rank.
  135476. * @returns the new fallback rank.
  135477. */
  135478. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135479. /**
  135480. * Add the required uniforms to the current list.
  135481. * @param uniforms defines the current uniform list.
  135482. */
  135483. static AddUniforms(uniforms: string[]): void;
  135484. /**
  135485. * Add the required uniforms to the current buffer.
  135486. * @param uniformBuffer defines the current uniform buffer.
  135487. */
  135488. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135489. /**
  135490. * Add the required samplers to the current list.
  135491. * @param samplers defines the current sampler list.
  135492. */
  135493. static AddSamplers(samplers: string[]): void;
  135494. /**
  135495. * Makes a duplicate of the current configuration into another one.
  135496. * @param sheenConfiguration define the config where to copy the info
  135497. */
  135498. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135499. /**
  135500. * Serializes this BRDF configuration.
  135501. * @returns - An object with the serialized config.
  135502. */
  135503. serialize(): any;
  135504. /**
  135505. * Parses a anisotropy Configuration from a serialized object.
  135506. * @param source - Serialized object.
  135507. * @param scene Defines the scene we are parsing for
  135508. * @param rootUrl Defines the rootUrl to load from
  135509. */
  135510. parse(source: any, scene: Scene, rootUrl: string): void;
  135511. }
  135512. }
  135513. declare module BABYLON {
  135514. /**
  135515. * @hidden
  135516. */
  135517. export interface IMaterialSubSurfaceDefines {
  135518. SUBSURFACE: boolean;
  135519. SS_REFRACTION: boolean;
  135520. SS_TRANSLUCENCY: boolean;
  135521. SS_SCATTERING: boolean;
  135522. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135523. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135524. SS_REFRACTIONMAP_3D: boolean;
  135525. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135526. SS_LODINREFRACTIONALPHA: boolean;
  135527. SS_GAMMAREFRACTION: boolean;
  135528. SS_RGBDREFRACTION: boolean;
  135529. SS_LINEARSPECULARREFRACTION: boolean;
  135530. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135531. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135532. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135533. /** @hidden */
  135534. _areTexturesDirty: boolean;
  135535. }
  135536. /**
  135537. * Define the code related to the sub surface parameters of the pbr material.
  135538. */
  135539. export class PBRSubSurfaceConfiguration {
  135540. private _isRefractionEnabled;
  135541. /**
  135542. * Defines if the refraction is enabled in the material.
  135543. */
  135544. isRefractionEnabled: boolean;
  135545. private _isTranslucencyEnabled;
  135546. /**
  135547. * Defines if the translucency is enabled in the material.
  135548. */
  135549. isTranslucencyEnabled: boolean;
  135550. private _isScatteringEnabled;
  135551. /**
  135552. * Defines if the sub surface scattering is enabled in the material.
  135553. */
  135554. isScatteringEnabled: boolean;
  135555. private _scatteringDiffusionProfileIndex;
  135556. /**
  135557. * Diffusion profile for subsurface scattering.
  135558. * Useful for better scattering in the skins or foliages.
  135559. */
  135560. get scatteringDiffusionProfile(): Nullable<Color3>;
  135561. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135562. /**
  135563. * Defines the refraction intensity of the material.
  135564. * The refraction when enabled replaces the Diffuse part of the material.
  135565. * The intensity helps transitionning between diffuse and refraction.
  135566. */
  135567. refractionIntensity: number;
  135568. /**
  135569. * Defines the translucency intensity of the material.
  135570. * When translucency has been enabled, this defines how much of the "translucency"
  135571. * is addded to the diffuse part of the material.
  135572. */
  135573. translucencyIntensity: number;
  135574. /**
  135575. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135576. */
  135577. useAlbedoToTintRefraction: boolean;
  135578. private _thicknessTexture;
  135579. /**
  135580. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135581. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135582. * 0 would mean minimumThickness
  135583. * 1 would mean maximumThickness
  135584. * The other channels might be use as a mask to vary the different effects intensity.
  135585. */
  135586. thicknessTexture: Nullable<BaseTexture>;
  135587. private _refractionTexture;
  135588. /**
  135589. * Defines the texture to use for refraction.
  135590. */
  135591. refractionTexture: Nullable<BaseTexture>;
  135592. private _indexOfRefraction;
  135593. /**
  135594. * Index of refraction of the material base layer.
  135595. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135596. *
  135597. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135598. *
  135599. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135600. */
  135601. indexOfRefraction: number;
  135602. private _volumeIndexOfRefraction;
  135603. /**
  135604. * Index of refraction of the material's volume.
  135605. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135606. *
  135607. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135608. * the volume will use the same IOR as the surface.
  135609. */
  135610. get volumeIndexOfRefraction(): number;
  135611. set volumeIndexOfRefraction(value: number);
  135612. private _invertRefractionY;
  135613. /**
  135614. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135615. */
  135616. invertRefractionY: boolean;
  135617. private _linkRefractionWithTransparency;
  135618. /**
  135619. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135620. * Materials half opaque for instance using refraction could benefit from this control.
  135621. */
  135622. linkRefractionWithTransparency: boolean;
  135623. /**
  135624. * Defines the minimum thickness stored in the thickness map.
  135625. * If no thickness map is defined, this value will be used to simulate thickness.
  135626. */
  135627. minimumThickness: number;
  135628. /**
  135629. * Defines the maximum thickness stored in the thickness map.
  135630. */
  135631. maximumThickness: number;
  135632. /**
  135633. * Defines the volume tint of the material.
  135634. * This is used for both translucency and scattering.
  135635. */
  135636. tintColor: Color3;
  135637. /**
  135638. * Defines the distance at which the tint color should be found in the media.
  135639. * This is used for refraction only.
  135640. */
  135641. tintColorAtDistance: number;
  135642. /**
  135643. * Defines how far each channel transmit through the media.
  135644. * It is defined as a color to simplify it selection.
  135645. */
  135646. diffusionDistance: Color3;
  135647. private _useMaskFromThicknessTexture;
  135648. /**
  135649. * Stores the intensity of the different subsurface effects in the thickness texture.
  135650. * * the green channel is the translucency intensity.
  135651. * * the blue channel is the scattering intensity.
  135652. * * the alpha channel is the refraction intensity.
  135653. */
  135654. useMaskFromThicknessTexture: boolean;
  135655. private _scene;
  135656. /** @hidden */
  135657. private _internalMarkAllSubMeshesAsTexturesDirty;
  135658. private _internalMarkScenePrePassDirty;
  135659. /** @hidden */
  135660. _markAllSubMeshesAsTexturesDirty(): void;
  135661. /** @hidden */
  135662. _markScenePrePassDirty(): void;
  135663. /**
  135664. * Instantiate a new istance of sub surface configuration.
  135665. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135666. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135667. * @param scene The scene
  135668. */
  135669. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135670. /**
  135671. * Gets wehter the submesh is ready to be used or not.
  135672. * @param defines the list of "defines" to update.
  135673. * @param scene defines the scene the material belongs to.
  135674. * @returns - boolean indicating that the submesh is ready or not.
  135675. */
  135676. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135677. /**
  135678. * Checks to see if a texture is used in the material.
  135679. * @param defines the list of "defines" to update.
  135680. * @param scene defines the scene to the material belongs to.
  135681. */
  135682. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135683. /**
  135684. * Binds the material data.
  135685. * @param uniformBuffer defines the Uniform buffer to fill in.
  135686. * @param scene defines the scene the material belongs to.
  135687. * @param engine defines the engine the material belongs to.
  135688. * @param isFrozen defines whether the material is frozen or not.
  135689. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135690. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135691. */
  135692. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135693. /**
  135694. * Unbinds the material from the mesh.
  135695. * @param activeEffect defines the effect that should be unbound from.
  135696. * @returns true if unbound, otherwise false
  135697. */
  135698. unbind(activeEffect: Effect): boolean;
  135699. /**
  135700. * Returns the texture used for refraction or null if none is used.
  135701. * @param scene defines the scene the material belongs to.
  135702. * @returns - Refraction texture if present. If no refraction texture and refraction
  135703. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135704. */
  135705. private _getRefractionTexture;
  135706. /**
  135707. * Returns true if alpha blending should be disabled.
  135708. */
  135709. get disableAlphaBlending(): boolean;
  135710. /**
  135711. * Fills the list of render target textures.
  135712. * @param renderTargets the list of render targets to update
  135713. */
  135714. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135715. /**
  135716. * Checks to see if a texture is used in the material.
  135717. * @param texture - Base texture to use.
  135718. * @returns - Boolean specifying if a texture is used in the material.
  135719. */
  135720. hasTexture(texture: BaseTexture): boolean;
  135721. /**
  135722. * Gets a boolean indicating that current material needs to register RTT
  135723. * @returns true if this uses a render target otherwise false.
  135724. */
  135725. hasRenderTargetTextures(): boolean;
  135726. /**
  135727. * Returns an array of the actively used textures.
  135728. * @param activeTextures Array of BaseTextures
  135729. */
  135730. getActiveTextures(activeTextures: BaseTexture[]): void;
  135731. /**
  135732. * Returns the animatable textures.
  135733. * @param animatables Array of animatable textures.
  135734. */
  135735. getAnimatables(animatables: IAnimatable[]): void;
  135736. /**
  135737. * Disposes the resources of the material.
  135738. * @param forceDisposeTextures - Forces the disposal of all textures.
  135739. */
  135740. dispose(forceDisposeTextures?: boolean): void;
  135741. /**
  135742. * Get the current class name of the texture useful for serialization or dynamic coding.
  135743. * @returns "PBRSubSurfaceConfiguration"
  135744. */
  135745. getClassName(): string;
  135746. /**
  135747. * Add fallbacks to the effect fallbacks list.
  135748. * @param defines defines the Base texture to use.
  135749. * @param fallbacks defines the current fallback list.
  135750. * @param currentRank defines the current fallback rank.
  135751. * @returns the new fallback rank.
  135752. */
  135753. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135754. /**
  135755. * Add the required uniforms to the current list.
  135756. * @param uniforms defines the current uniform list.
  135757. */
  135758. static AddUniforms(uniforms: string[]): void;
  135759. /**
  135760. * Add the required samplers to the current list.
  135761. * @param samplers defines the current sampler list.
  135762. */
  135763. static AddSamplers(samplers: string[]): void;
  135764. /**
  135765. * Add the required uniforms to the current buffer.
  135766. * @param uniformBuffer defines the current uniform buffer.
  135767. */
  135768. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135769. /**
  135770. * Makes a duplicate of the current configuration into another one.
  135771. * @param configuration define the config where to copy the info
  135772. */
  135773. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135774. /**
  135775. * Serializes this Sub Surface configuration.
  135776. * @returns - An object with the serialized config.
  135777. */
  135778. serialize(): any;
  135779. /**
  135780. * Parses a anisotropy Configuration from a serialized object.
  135781. * @param source - Serialized object.
  135782. * @param scene Defines the scene we are parsing for
  135783. * @param rootUrl Defines the rootUrl to load from
  135784. */
  135785. parse(source: any, scene: Scene, rootUrl: string): void;
  135786. }
  135787. }
  135788. declare module BABYLON {
  135789. /** @hidden */
  135790. export var pbrFragmentDeclaration: {
  135791. name: string;
  135792. shader: string;
  135793. };
  135794. }
  135795. declare module BABYLON {
  135796. /** @hidden */
  135797. export var pbrUboDeclaration: {
  135798. name: string;
  135799. shader: string;
  135800. };
  135801. }
  135802. declare module BABYLON {
  135803. /** @hidden */
  135804. export var pbrFragmentExtraDeclaration: {
  135805. name: string;
  135806. shader: string;
  135807. };
  135808. }
  135809. declare module BABYLON {
  135810. /** @hidden */
  135811. export var pbrFragmentSamplersDeclaration: {
  135812. name: string;
  135813. shader: string;
  135814. };
  135815. }
  135816. declare module BABYLON {
  135817. /** @hidden */
  135818. export var importanceSampling: {
  135819. name: string;
  135820. shader: string;
  135821. };
  135822. }
  135823. declare module BABYLON {
  135824. /** @hidden */
  135825. export var pbrHelperFunctions: {
  135826. name: string;
  135827. shader: string;
  135828. };
  135829. }
  135830. declare module BABYLON {
  135831. /** @hidden */
  135832. export var harmonicsFunctions: {
  135833. name: string;
  135834. shader: string;
  135835. };
  135836. }
  135837. declare module BABYLON {
  135838. /** @hidden */
  135839. export var pbrDirectLightingSetupFunctions: {
  135840. name: string;
  135841. shader: string;
  135842. };
  135843. }
  135844. declare module BABYLON {
  135845. /** @hidden */
  135846. export var pbrDirectLightingFalloffFunctions: {
  135847. name: string;
  135848. shader: string;
  135849. };
  135850. }
  135851. declare module BABYLON {
  135852. /** @hidden */
  135853. export var pbrBRDFFunctions: {
  135854. name: string;
  135855. shader: string;
  135856. };
  135857. }
  135858. declare module BABYLON {
  135859. /** @hidden */
  135860. export var hdrFilteringFunctions: {
  135861. name: string;
  135862. shader: string;
  135863. };
  135864. }
  135865. declare module BABYLON {
  135866. /** @hidden */
  135867. export var pbrDirectLightingFunctions: {
  135868. name: string;
  135869. shader: string;
  135870. };
  135871. }
  135872. declare module BABYLON {
  135873. /** @hidden */
  135874. export var pbrIBLFunctions: {
  135875. name: string;
  135876. shader: string;
  135877. };
  135878. }
  135879. declare module BABYLON {
  135880. /** @hidden */
  135881. export var pbrBlockAlbedoOpacity: {
  135882. name: string;
  135883. shader: string;
  135884. };
  135885. }
  135886. declare module BABYLON {
  135887. /** @hidden */
  135888. export var pbrBlockReflectivity: {
  135889. name: string;
  135890. shader: string;
  135891. };
  135892. }
  135893. declare module BABYLON {
  135894. /** @hidden */
  135895. export var pbrBlockAmbientOcclusion: {
  135896. name: string;
  135897. shader: string;
  135898. };
  135899. }
  135900. declare module BABYLON {
  135901. /** @hidden */
  135902. export var pbrBlockAlphaFresnel: {
  135903. name: string;
  135904. shader: string;
  135905. };
  135906. }
  135907. declare module BABYLON {
  135908. /** @hidden */
  135909. export var pbrBlockAnisotropic: {
  135910. name: string;
  135911. shader: string;
  135912. };
  135913. }
  135914. declare module BABYLON {
  135915. /** @hidden */
  135916. export var pbrBlockReflection: {
  135917. name: string;
  135918. shader: string;
  135919. };
  135920. }
  135921. declare module BABYLON {
  135922. /** @hidden */
  135923. export var pbrBlockSheen: {
  135924. name: string;
  135925. shader: string;
  135926. };
  135927. }
  135928. declare module BABYLON {
  135929. /** @hidden */
  135930. export var pbrBlockClearcoat: {
  135931. name: string;
  135932. shader: string;
  135933. };
  135934. }
  135935. declare module BABYLON {
  135936. /** @hidden */
  135937. export var pbrBlockSubSurface: {
  135938. name: string;
  135939. shader: string;
  135940. };
  135941. }
  135942. declare module BABYLON {
  135943. /** @hidden */
  135944. export var pbrBlockNormalGeometric: {
  135945. name: string;
  135946. shader: string;
  135947. };
  135948. }
  135949. declare module BABYLON {
  135950. /** @hidden */
  135951. export var pbrBlockNormalFinal: {
  135952. name: string;
  135953. shader: string;
  135954. };
  135955. }
  135956. declare module BABYLON {
  135957. /** @hidden */
  135958. export var pbrBlockLightmapInit: {
  135959. name: string;
  135960. shader: string;
  135961. };
  135962. }
  135963. declare module BABYLON {
  135964. /** @hidden */
  135965. export var pbrBlockGeometryInfo: {
  135966. name: string;
  135967. shader: string;
  135968. };
  135969. }
  135970. declare module BABYLON {
  135971. /** @hidden */
  135972. export var pbrBlockReflectance0: {
  135973. name: string;
  135974. shader: string;
  135975. };
  135976. }
  135977. declare module BABYLON {
  135978. /** @hidden */
  135979. export var pbrBlockReflectance: {
  135980. name: string;
  135981. shader: string;
  135982. };
  135983. }
  135984. declare module BABYLON {
  135985. /** @hidden */
  135986. export var pbrBlockDirectLighting: {
  135987. name: string;
  135988. shader: string;
  135989. };
  135990. }
  135991. declare module BABYLON {
  135992. /** @hidden */
  135993. export var pbrBlockFinalLitComponents: {
  135994. name: string;
  135995. shader: string;
  135996. };
  135997. }
  135998. declare module BABYLON {
  135999. /** @hidden */
  136000. export var pbrBlockFinalUnlitComponents: {
  136001. name: string;
  136002. shader: string;
  136003. };
  136004. }
  136005. declare module BABYLON {
  136006. /** @hidden */
  136007. export var pbrBlockFinalColorComposition: {
  136008. name: string;
  136009. shader: string;
  136010. };
  136011. }
  136012. declare module BABYLON {
  136013. /** @hidden */
  136014. export var pbrBlockImageProcessing: {
  136015. name: string;
  136016. shader: string;
  136017. };
  136018. }
  136019. declare module BABYLON {
  136020. /** @hidden */
  136021. export var pbrDebug: {
  136022. name: string;
  136023. shader: string;
  136024. };
  136025. }
  136026. declare module BABYLON {
  136027. /** @hidden */
  136028. export var pbrPixelShader: {
  136029. name: string;
  136030. shader: string;
  136031. };
  136032. }
  136033. declare module BABYLON {
  136034. /** @hidden */
  136035. export var pbrVertexDeclaration: {
  136036. name: string;
  136037. shader: string;
  136038. };
  136039. }
  136040. declare module BABYLON {
  136041. /** @hidden */
  136042. export var pbrVertexShader: {
  136043. name: string;
  136044. shader: string;
  136045. };
  136046. }
  136047. declare module BABYLON {
  136048. /**
  136049. * Manages the defines for the PBR Material.
  136050. * @hidden
  136051. */
  136052. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  136053. PBR: boolean;
  136054. NUM_SAMPLES: string;
  136055. REALTIME_FILTERING: boolean;
  136056. MAINUV1: boolean;
  136057. MAINUV2: boolean;
  136058. UV1: boolean;
  136059. UV2: boolean;
  136060. ALBEDO: boolean;
  136061. GAMMAALBEDO: boolean;
  136062. ALBEDODIRECTUV: number;
  136063. VERTEXCOLOR: boolean;
  136064. DETAIL: boolean;
  136065. DETAILDIRECTUV: number;
  136066. DETAIL_NORMALBLENDMETHOD: number;
  136067. AMBIENT: boolean;
  136068. AMBIENTDIRECTUV: number;
  136069. AMBIENTINGRAYSCALE: boolean;
  136070. OPACITY: boolean;
  136071. VERTEXALPHA: boolean;
  136072. OPACITYDIRECTUV: number;
  136073. OPACITYRGB: boolean;
  136074. ALPHATEST: boolean;
  136075. DEPTHPREPASS: boolean;
  136076. ALPHABLEND: boolean;
  136077. ALPHAFROMALBEDO: boolean;
  136078. ALPHATESTVALUE: string;
  136079. SPECULAROVERALPHA: boolean;
  136080. RADIANCEOVERALPHA: boolean;
  136081. ALPHAFRESNEL: boolean;
  136082. LINEARALPHAFRESNEL: boolean;
  136083. PREMULTIPLYALPHA: boolean;
  136084. EMISSIVE: boolean;
  136085. EMISSIVEDIRECTUV: number;
  136086. REFLECTIVITY: boolean;
  136087. REFLECTIVITYDIRECTUV: number;
  136088. SPECULARTERM: boolean;
  136089. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  136090. MICROSURFACEAUTOMATIC: boolean;
  136091. LODBASEDMICROSFURACE: boolean;
  136092. MICROSURFACEMAP: boolean;
  136093. MICROSURFACEMAPDIRECTUV: number;
  136094. METALLICWORKFLOW: boolean;
  136095. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  136096. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  136097. METALLNESSSTOREINMETALMAPBLUE: boolean;
  136098. AOSTOREINMETALMAPRED: boolean;
  136099. METALLIC_REFLECTANCE: boolean;
  136100. METALLIC_REFLECTANCEDIRECTUV: number;
  136101. ENVIRONMENTBRDF: boolean;
  136102. ENVIRONMENTBRDF_RGBD: boolean;
  136103. NORMAL: boolean;
  136104. TANGENT: boolean;
  136105. BUMP: boolean;
  136106. BUMPDIRECTUV: number;
  136107. OBJECTSPACE_NORMALMAP: boolean;
  136108. PARALLAX: boolean;
  136109. PARALLAXOCCLUSION: boolean;
  136110. NORMALXYSCALE: boolean;
  136111. LIGHTMAP: boolean;
  136112. LIGHTMAPDIRECTUV: number;
  136113. USELIGHTMAPASSHADOWMAP: boolean;
  136114. GAMMALIGHTMAP: boolean;
  136115. RGBDLIGHTMAP: boolean;
  136116. REFLECTION: boolean;
  136117. REFLECTIONMAP_3D: boolean;
  136118. REFLECTIONMAP_SPHERICAL: boolean;
  136119. REFLECTIONMAP_PLANAR: boolean;
  136120. REFLECTIONMAP_CUBIC: boolean;
  136121. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  136122. REFLECTIONMAP_PROJECTION: boolean;
  136123. REFLECTIONMAP_SKYBOX: boolean;
  136124. REFLECTIONMAP_EXPLICIT: boolean;
  136125. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  136126. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  136127. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  136128. INVERTCUBICMAP: boolean;
  136129. USESPHERICALFROMREFLECTIONMAP: boolean;
  136130. USEIRRADIANCEMAP: boolean;
  136131. SPHERICAL_HARMONICS: boolean;
  136132. USESPHERICALINVERTEX: boolean;
  136133. REFLECTIONMAP_OPPOSITEZ: boolean;
  136134. LODINREFLECTIONALPHA: boolean;
  136135. GAMMAREFLECTION: boolean;
  136136. RGBDREFLECTION: boolean;
  136137. LINEARSPECULARREFLECTION: boolean;
  136138. RADIANCEOCCLUSION: boolean;
  136139. HORIZONOCCLUSION: boolean;
  136140. INSTANCES: boolean;
  136141. THIN_INSTANCES: boolean;
  136142. PREPASS: boolean;
  136143. SCENE_MRT_COUNT: number;
  136144. NUM_BONE_INFLUENCERS: number;
  136145. BonesPerMesh: number;
  136146. BONETEXTURE: boolean;
  136147. NONUNIFORMSCALING: boolean;
  136148. MORPHTARGETS: boolean;
  136149. MORPHTARGETS_NORMAL: boolean;
  136150. MORPHTARGETS_TANGENT: boolean;
  136151. MORPHTARGETS_UV: boolean;
  136152. NUM_MORPH_INFLUENCERS: number;
  136153. IMAGEPROCESSING: boolean;
  136154. VIGNETTE: boolean;
  136155. VIGNETTEBLENDMODEMULTIPLY: boolean;
  136156. VIGNETTEBLENDMODEOPAQUE: boolean;
  136157. TONEMAPPING: boolean;
  136158. TONEMAPPING_ACES: boolean;
  136159. CONTRAST: boolean;
  136160. COLORCURVES: boolean;
  136161. COLORGRADING: boolean;
  136162. COLORGRADING3D: boolean;
  136163. SAMPLER3DGREENDEPTH: boolean;
  136164. SAMPLER3DBGRMAP: boolean;
  136165. IMAGEPROCESSINGPOSTPROCESS: boolean;
  136166. EXPOSURE: boolean;
  136167. MULTIVIEW: boolean;
  136168. USEPHYSICALLIGHTFALLOFF: boolean;
  136169. USEGLTFLIGHTFALLOFF: boolean;
  136170. TWOSIDEDLIGHTING: boolean;
  136171. SHADOWFLOAT: boolean;
  136172. CLIPPLANE: boolean;
  136173. CLIPPLANE2: boolean;
  136174. CLIPPLANE3: boolean;
  136175. CLIPPLANE4: boolean;
  136176. CLIPPLANE5: boolean;
  136177. CLIPPLANE6: boolean;
  136178. POINTSIZE: boolean;
  136179. FOG: boolean;
  136180. LOGARITHMICDEPTH: boolean;
  136181. FORCENORMALFORWARD: boolean;
  136182. SPECULARAA: boolean;
  136183. CLEARCOAT: boolean;
  136184. CLEARCOAT_DEFAULTIOR: boolean;
  136185. CLEARCOAT_TEXTURE: boolean;
  136186. CLEARCOAT_TEXTUREDIRECTUV: number;
  136187. CLEARCOAT_BUMP: boolean;
  136188. CLEARCOAT_BUMPDIRECTUV: number;
  136189. CLEARCOAT_TINT: boolean;
  136190. CLEARCOAT_TINT_TEXTURE: boolean;
  136191. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136192. ANISOTROPIC: boolean;
  136193. ANISOTROPIC_TEXTURE: boolean;
  136194. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136195. BRDF_V_HEIGHT_CORRELATED: boolean;
  136196. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136197. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136198. SHEEN: boolean;
  136199. SHEEN_TEXTURE: boolean;
  136200. SHEEN_TEXTUREDIRECTUV: number;
  136201. SHEEN_LINKWITHALBEDO: boolean;
  136202. SHEEN_ROUGHNESS: boolean;
  136203. SHEEN_ALBEDOSCALING: boolean;
  136204. SUBSURFACE: boolean;
  136205. SS_REFRACTION: boolean;
  136206. SS_TRANSLUCENCY: boolean;
  136207. SS_SCATTERING: boolean;
  136208. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136209. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136210. SS_REFRACTIONMAP_3D: boolean;
  136211. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136212. SS_LODINREFRACTIONALPHA: boolean;
  136213. SS_GAMMAREFRACTION: boolean;
  136214. SS_RGBDREFRACTION: boolean;
  136215. SS_LINEARSPECULARREFRACTION: boolean;
  136216. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136217. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136218. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136219. UNLIT: boolean;
  136220. DEBUGMODE: number;
  136221. /**
  136222. * Initializes the PBR Material defines.
  136223. */
  136224. constructor();
  136225. /**
  136226. * Resets the PBR Material defines.
  136227. */
  136228. reset(): void;
  136229. }
  136230. /**
  136231. * The Physically based material base class of BJS.
  136232. *
  136233. * This offers the main features of a standard PBR material.
  136234. * For more information, please refer to the documentation :
  136235. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136236. */
  136237. export abstract class PBRBaseMaterial extends PushMaterial {
  136238. /**
  136239. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136240. */
  136241. static readonly PBRMATERIAL_OPAQUE: number;
  136242. /**
  136243. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136244. */
  136245. static readonly PBRMATERIAL_ALPHATEST: number;
  136246. /**
  136247. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136248. */
  136249. static readonly PBRMATERIAL_ALPHABLEND: number;
  136250. /**
  136251. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136252. * They are also discarded below the alpha cutoff threshold to improve performances.
  136253. */
  136254. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136255. /**
  136256. * Defines the default value of how much AO map is occluding the analytical lights
  136257. * (point spot...).
  136258. */
  136259. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136260. /**
  136261. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136262. */
  136263. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136264. /**
  136265. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136266. * to enhance interoperability with other engines.
  136267. */
  136268. static readonly LIGHTFALLOFF_GLTF: number;
  136269. /**
  136270. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136271. * to enhance interoperability with other materials.
  136272. */
  136273. static readonly LIGHTFALLOFF_STANDARD: number;
  136274. /**
  136275. * Intensity of the direct lights e.g. the four lights available in your scene.
  136276. * This impacts both the direct diffuse and specular highlights.
  136277. */
  136278. protected _directIntensity: number;
  136279. /**
  136280. * Intensity of the emissive part of the material.
  136281. * This helps controlling the emissive effect without modifying the emissive color.
  136282. */
  136283. protected _emissiveIntensity: number;
  136284. /**
  136285. * Intensity of the environment e.g. how much the environment will light the object
  136286. * either through harmonics for rough material or through the refelction for shiny ones.
  136287. */
  136288. protected _environmentIntensity: number;
  136289. /**
  136290. * This is a special control allowing the reduction of the specular highlights coming from the
  136291. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136292. */
  136293. protected _specularIntensity: number;
  136294. /**
  136295. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136296. */
  136297. private _lightingInfos;
  136298. /**
  136299. * Debug Control allowing disabling the bump map on this material.
  136300. */
  136301. protected _disableBumpMap: boolean;
  136302. /**
  136303. * AKA Diffuse Texture in standard nomenclature.
  136304. */
  136305. protected _albedoTexture: Nullable<BaseTexture>;
  136306. /**
  136307. * AKA Occlusion Texture in other nomenclature.
  136308. */
  136309. protected _ambientTexture: Nullable<BaseTexture>;
  136310. /**
  136311. * AKA Occlusion Texture Intensity in other nomenclature.
  136312. */
  136313. protected _ambientTextureStrength: number;
  136314. /**
  136315. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136316. * 1 means it completely occludes it
  136317. * 0 mean it has no impact
  136318. */
  136319. protected _ambientTextureImpactOnAnalyticalLights: number;
  136320. /**
  136321. * Stores the alpha values in a texture.
  136322. */
  136323. protected _opacityTexture: Nullable<BaseTexture>;
  136324. /**
  136325. * Stores the reflection values in a texture.
  136326. */
  136327. protected _reflectionTexture: Nullable<BaseTexture>;
  136328. /**
  136329. * Stores the emissive values in a texture.
  136330. */
  136331. protected _emissiveTexture: Nullable<BaseTexture>;
  136332. /**
  136333. * AKA Specular texture in other nomenclature.
  136334. */
  136335. protected _reflectivityTexture: Nullable<BaseTexture>;
  136336. /**
  136337. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136338. */
  136339. protected _metallicTexture: Nullable<BaseTexture>;
  136340. /**
  136341. * Specifies the metallic scalar of the metallic/roughness workflow.
  136342. * Can also be used to scale the metalness values of the metallic texture.
  136343. */
  136344. protected _metallic: Nullable<number>;
  136345. /**
  136346. * Specifies the roughness scalar of the metallic/roughness workflow.
  136347. * Can also be used to scale the roughness values of the metallic texture.
  136348. */
  136349. protected _roughness: Nullable<number>;
  136350. /**
  136351. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136352. * By default the indexOfrefraction is used to compute F0;
  136353. *
  136354. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136355. *
  136356. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136357. * F90 = metallicReflectanceColor;
  136358. */
  136359. protected _metallicF0Factor: number;
  136360. /**
  136361. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136362. * By default the F90 is always 1;
  136363. *
  136364. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136365. *
  136366. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136367. * F90 = metallicReflectanceColor;
  136368. */
  136369. protected _metallicReflectanceColor: Color3;
  136370. /**
  136371. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136372. * This is multiply against the scalar values defined in the material.
  136373. */
  136374. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136375. /**
  136376. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136377. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136378. */
  136379. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136380. /**
  136381. * Stores surface normal data used to displace a mesh in a texture.
  136382. */
  136383. protected _bumpTexture: Nullable<BaseTexture>;
  136384. /**
  136385. * Stores the pre-calculated light information of a mesh in a texture.
  136386. */
  136387. protected _lightmapTexture: Nullable<BaseTexture>;
  136388. /**
  136389. * The color of a material in ambient lighting.
  136390. */
  136391. protected _ambientColor: Color3;
  136392. /**
  136393. * AKA Diffuse Color in other nomenclature.
  136394. */
  136395. protected _albedoColor: Color3;
  136396. /**
  136397. * AKA Specular Color in other nomenclature.
  136398. */
  136399. protected _reflectivityColor: Color3;
  136400. /**
  136401. * The color applied when light is reflected from a material.
  136402. */
  136403. protected _reflectionColor: Color3;
  136404. /**
  136405. * The color applied when light is emitted from a material.
  136406. */
  136407. protected _emissiveColor: Color3;
  136408. /**
  136409. * AKA Glossiness in other nomenclature.
  136410. */
  136411. protected _microSurface: number;
  136412. /**
  136413. * Specifies that the material will use the light map as a show map.
  136414. */
  136415. protected _useLightmapAsShadowmap: boolean;
  136416. /**
  136417. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136418. * makes the reflect vector face the model (under horizon).
  136419. */
  136420. protected _useHorizonOcclusion: boolean;
  136421. /**
  136422. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136423. * too much the area relying on ambient texture to define their ambient occlusion.
  136424. */
  136425. protected _useRadianceOcclusion: boolean;
  136426. /**
  136427. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136428. */
  136429. protected _useAlphaFromAlbedoTexture: boolean;
  136430. /**
  136431. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136432. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136433. */
  136434. protected _useSpecularOverAlpha: boolean;
  136435. /**
  136436. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136437. */
  136438. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136439. /**
  136440. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136441. */
  136442. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136443. /**
  136444. * Specifies if the metallic texture contains the roughness information in its green channel.
  136445. */
  136446. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136447. /**
  136448. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136449. */
  136450. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136451. /**
  136452. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136453. */
  136454. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136455. /**
  136456. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136457. */
  136458. protected _useAmbientInGrayScale: boolean;
  136459. /**
  136460. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136461. * The material will try to infer what glossiness each pixel should be.
  136462. */
  136463. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136464. /**
  136465. * Defines the falloff type used in this material.
  136466. * It by default is Physical.
  136467. */
  136468. protected _lightFalloff: number;
  136469. /**
  136470. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136471. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136472. */
  136473. protected _useRadianceOverAlpha: boolean;
  136474. /**
  136475. * Allows using an object space normal map (instead of tangent space).
  136476. */
  136477. protected _useObjectSpaceNormalMap: boolean;
  136478. /**
  136479. * Allows using the bump map in parallax mode.
  136480. */
  136481. protected _useParallax: boolean;
  136482. /**
  136483. * Allows using the bump map in parallax occlusion mode.
  136484. */
  136485. protected _useParallaxOcclusion: boolean;
  136486. /**
  136487. * Controls the scale bias of the parallax mode.
  136488. */
  136489. protected _parallaxScaleBias: number;
  136490. /**
  136491. * If sets to true, disables all the lights affecting the material.
  136492. */
  136493. protected _disableLighting: boolean;
  136494. /**
  136495. * Number of Simultaneous lights allowed on the material.
  136496. */
  136497. protected _maxSimultaneousLights: number;
  136498. /**
  136499. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136500. */
  136501. protected _invertNormalMapX: boolean;
  136502. /**
  136503. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136504. */
  136505. protected _invertNormalMapY: boolean;
  136506. /**
  136507. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136508. */
  136509. protected _twoSidedLighting: boolean;
  136510. /**
  136511. * Defines the alpha limits in alpha test mode.
  136512. */
  136513. protected _alphaCutOff: number;
  136514. /**
  136515. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136516. */
  136517. protected _forceAlphaTest: boolean;
  136518. /**
  136519. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136520. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136521. */
  136522. protected _useAlphaFresnel: boolean;
  136523. /**
  136524. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136525. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136526. */
  136527. protected _useLinearAlphaFresnel: boolean;
  136528. /**
  136529. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136530. * from cos thetav and roughness:
  136531. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136532. */
  136533. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136534. /**
  136535. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136536. */
  136537. protected _forceIrradianceInFragment: boolean;
  136538. private _realTimeFiltering;
  136539. /**
  136540. * Enables realtime filtering on the texture.
  136541. */
  136542. get realTimeFiltering(): boolean;
  136543. set realTimeFiltering(b: boolean);
  136544. private _realTimeFilteringQuality;
  136545. /**
  136546. * Quality switch for realtime filtering
  136547. */
  136548. get realTimeFilteringQuality(): number;
  136549. set realTimeFilteringQuality(n: number);
  136550. /**
  136551. * Can this material render to several textures at once
  136552. */
  136553. get canRenderToMRT(): boolean;
  136554. /**
  136555. * Force normal to face away from face.
  136556. */
  136557. protected _forceNormalForward: boolean;
  136558. /**
  136559. * Enables specular anti aliasing in the PBR shader.
  136560. * It will both interacts on the Geometry for analytical and IBL lighting.
  136561. * It also prefilter the roughness map based on the bump values.
  136562. */
  136563. protected _enableSpecularAntiAliasing: boolean;
  136564. /**
  136565. * Default configuration related to image processing available in the PBR Material.
  136566. */
  136567. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136568. /**
  136569. * Keep track of the image processing observer to allow dispose and replace.
  136570. */
  136571. private _imageProcessingObserver;
  136572. /**
  136573. * Attaches a new image processing configuration to the PBR Material.
  136574. * @param configuration
  136575. */
  136576. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136577. /**
  136578. * Stores the available render targets.
  136579. */
  136580. private _renderTargets;
  136581. /**
  136582. * Sets the global ambient color for the material used in lighting calculations.
  136583. */
  136584. private _globalAmbientColor;
  136585. /**
  136586. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136587. */
  136588. private _useLogarithmicDepth;
  136589. /**
  136590. * If set to true, no lighting calculations will be applied.
  136591. */
  136592. private _unlit;
  136593. private _debugMode;
  136594. /**
  136595. * @hidden
  136596. * This is reserved for the inspector.
  136597. * Defines the material debug mode.
  136598. * It helps seeing only some components of the material while troubleshooting.
  136599. */
  136600. debugMode: number;
  136601. /**
  136602. * @hidden
  136603. * This is reserved for the inspector.
  136604. * Specify from where on screen the debug mode should start.
  136605. * The value goes from -1 (full screen) to 1 (not visible)
  136606. * It helps with side by side comparison against the final render
  136607. * This defaults to -1
  136608. */
  136609. private debugLimit;
  136610. /**
  136611. * @hidden
  136612. * This is reserved for the inspector.
  136613. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136614. * You can use the factor to better multiply the final value.
  136615. */
  136616. private debugFactor;
  136617. /**
  136618. * Defines the clear coat layer parameters for the material.
  136619. */
  136620. readonly clearCoat: PBRClearCoatConfiguration;
  136621. /**
  136622. * Defines the anisotropic parameters for the material.
  136623. */
  136624. readonly anisotropy: PBRAnisotropicConfiguration;
  136625. /**
  136626. * Defines the BRDF parameters for the material.
  136627. */
  136628. readonly brdf: PBRBRDFConfiguration;
  136629. /**
  136630. * Defines the Sheen parameters for the material.
  136631. */
  136632. readonly sheen: PBRSheenConfiguration;
  136633. /**
  136634. * Defines the SubSurface parameters for the material.
  136635. */
  136636. readonly subSurface: PBRSubSurfaceConfiguration;
  136637. /**
  136638. * Defines the detail map parameters for the material.
  136639. */
  136640. readonly detailMap: DetailMapConfiguration;
  136641. protected _rebuildInParallel: boolean;
  136642. /**
  136643. * Instantiates a new PBRMaterial instance.
  136644. *
  136645. * @param name The material name
  136646. * @param scene The scene the material will be use in.
  136647. */
  136648. constructor(name: string, scene: Scene);
  136649. /**
  136650. * Gets a boolean indicating that current material needs to register RTT
  136651. */
  136652. get hasRenderTargetTextures(): boolean;
  136653. /**
  136654. * Gets the name of the material class.
  136655. */
  136656. getClassName(): string;
  136657. /**
  136658. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136659. */
  136660. get useLogarithmicDepth(): boolean;
  136661. /**
  136662. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136663. */
  136664. set useLogarithmicDepth(value: boolean);
  136665. /**
  136666. * Returns true if alpha blending should be disabled.
  136667. */
  136668. protected get _disableAlphaBlending(): boolean;
  136669. /**
  136670. * Specifies whether or not this material should be rendered in alpha blend mode.
  136671. */
  136672. needAlphaBlending(): boolean;
  136673. /**
  136674. * Specifies whether or not this material should be rendered in alpha test mode.
  136675. */
  136676. needAlphaTesting(): boolean;
  136677. /**
  136678. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136679. */
  136680. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136681. /**
  136682. * Gets the texture used for the alpha test.
  136683. */
  136684. getAlphaTestTexture(): Nullable<BaseTexture>;
  136685. /**
  136686. * Specifies that the submesh is ready to be used.
  136687. * @param mesh - BJS mesh.
  136688. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136689. * @param useInstances - Specifies that instances should be used.
  136690. * @returns - boolean indicating that the submesh is ready or not.
  136691. */
  136692. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136693. /**
  136694. * Specifies if the material uses metallic roughness workflow.
  136695. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136696. */
  136697. isMetallicWorkflow(): boolean;
  136698. private _prepareEffect;
  136699. private _prepareDefines;
  136700. /**
  136701. * Force shader compilation
  136702. */
  136703. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136704. /**
  136705. * Initializes the uniform buffer layout for the shader.
  136706. */
  136707. buildUniformLayout(): void;
  136708. /**
  136709. * Unbinds the material from the mesh
  136710. */
  136711. unbind(): void;
  136712. /**
  136713. * Binds the submesh data.
  136714. * @param world - The world matrix.
  136715. * @param mesh - The BJS mesh.
  136716. * @param subMesh - A submesh of the BJS mesh.
  136717. */
  136718. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136719. /**
  136720. * Returns the animatable textures.
  136721. * @returns - Array of animatable textures.
  136722. */
  136723. getAnimatables(): IAnimatable[];
  136724. /**
  136725. * Returns the texture used for reflections.
  136726. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136727. */
  136728. private _getReflectionTexture;
  136729. /**
  136730. * Returns an array of the actively used textures.
  136731. * @returns - Array of BaseTextures
  136732. */
  136733. getActiveTextures(): BaseTexture[];
  136734. /**
  136735. * Checks to see if a texture is used in the material.
  136736. * @param texture - Base texture to use.
  136737. * @returns - Boolean specifying if a texture is used in the material.
  136738. */
  136739. hasTexture(texture: BaseTexture): boolean;
  136740. /**
  136741. * Sets the required values to the prepass renderer.
  136742. * @param prePassRenderer defines the prepass renderer to setup
  136743. */
  136744. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136745. /**
  136746. * Disposes the resources of the material.
  136747. * @param forceDisposeEffect - Forces the disposal of effects.
  136748. * @param forceDisposeTextures - Forces the disposal of all textures.
  136749. */
  136750. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136751. }
  136752. }
  136753. declare module BABYLON {
  136754. /**
  136755. * The Physically based material of BJS.
  136756. *
  136757. * This offers the main features of a standard PBR material.
  136758. * For more information, please refer to the documentation :
  136759. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136760. */
  136761. export class PBRMaterial extends PBRBaseMaterial {
  136762. /**
  136763. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136764. */
  136765. static readonly PBRMATERIAL_OPAQUE: number;
  136766. /**
  136767. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136768. */
  136769. static readonly PBRMATERIAL_ALPHATEST: number;
  136770. /**
  136771. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136772. */
  136773. static readonly PBRMATERIAL_ALPHABLEND: number;
  136774. /**
  136775. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136776. * They are also discarded below the alpha cutoff threshold to improve performances.
  136777. */
  136778. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136779. /**
  136780. * Defines the default value of how much AO map is occluding the analytical lights
  136781. * (point spot...).
  136782. */
  136783. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136784. /**
  136785. * Intensity of the direct lights e.g. the four lights available in your scene.
  136786. * This impacts both the direct diffuse and specular highlights.
  136787. */
  136788. directIntensity: number;
  136789. /**
  136790. * Intensity of the emissive part of the material.
  136791. * This helps controlling the emissive effect without modifying the emissive color.
  136792. */
  136793. emissiveIntensity: number;
  136794. /**
  136795. * Intensity of the environment e.g. how much the environment will light the object
  136796. * either through harmonics for rough material or through the refelction for shiny ones.
  136797. */
  136798. environmentIntensity: number;
  136799. /**
  136800. * This is a special control allowing the reduction of the specular highlights coming from the
  136801. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136802. */
  136803. specularIntensity: number;
  136804. /**
  136805. * Debug Control allowing disabling the bump map on this material.
  136806. */
  136807. disableBumpMap: boolean;
  136808. /**
  136809. * AKA Diffuse Texture in standard nomenclature.
  136810. */
  136811. albedoTexture: BaseTexture;
  136812. /**
  136813. * AKA Occlusion Texture in other nomenclature.
  136814. */
  136815. ambientTexture: BaseTexture;
  136816. /**
  136817. * AKA Occlusion Texture Intensity in other nomenclature.
  136818. */
  136819. ambientTextureStrength: number;
  136820. /**
  136821. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136822. * 1 means it completely occludes it
  136823. * 0 mean it has no impact
  136824. */
  136825. ambientTextureImpactOnAnalyticalLights: number;
  136826. /**
  136827. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136828. */
  136829. opacityTexture: BaseTexture;
  136830. /**
  136831. * Stores the reflection values in a texture.
  136832. */
  136833. reflectionTexture: Nullable<BaseTexture>;
  136834. /**
  136835. * Stores the emissive values in a texture.
  136836. */
  136837. emissiveTexture: BaseTexture;
  136838. /**
  136839. * AKA Specular texture in other nomenclature.
  136840. */
  136841. reflectivityTexture: BaseTexture;
  136842. /**
  136843. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136844. */
  136845. metallicTexture: BaseTexture;
  136846. /**
  136847. * Specifies the metallic scalar of the metallic/roughness workflow.
  136848. * Can also be used to scale the metalness values of the metallic texture.
  136849. */
  136850. metallic: Nullable<number>;
  136851. /**
  136852. * Specifies the roughness scalar of the metallic/roughness workflow.
  136853. * Can also be used to scale the roughness values of the metallic texture.
  136854. */
  136855. roughness: Nullable<number>;
  136856. /**
  136857. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136858. * By default the indexOfrefraction is used to compute F0;
  136859. *
  136860. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136861. *
  136862. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136863. * F90 = metallicReflectanceColor;
  136864. */
  136865. metallicF0Factor: number;
  136866. /**
  136867. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136868. * By default the F90 is always 1;
  136869. *
  136870. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136871. *
  136872. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136873. * F90 = metallicReflectanceColor;
  136874. */
  136875. metallicReflectanceColor: Color3;
  136876. /**
  136877. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136878. * This is multiply against the scalar values defined in the material.
  136879. */
  136880. metallicReflectanceTexture: Nullable<BaseTexture>;
  136881. /**
  136882. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136883. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136884. */
  136885. microSurfaceTexture: BaseTexture;
  136886. /**
  136887. * Stores surface normal data used to displace a mesh in a texture.
  136888. */
  136889. bumpTexture: BaseTexture;
  136890. /**
  136891. * Stores the pre-calculated light information of a mesh in a texture.
  136892. */
  136893. lightmapTexture: BaseTexture;
  136894. /**
  136895. * Stores the refracted light information in a texture.
  136896. */
  136897. get refractionTexture(): Nullable<BaseTexture>;
  136898. set refractionTexture(value: Nullable<BaseTexture>);
  136899. /**
  136900. * The color of a material in ambient lighting.
  136901. */
  136902. ambientColor: Color3;
  136903. /**
  136904. * AKA Diffuse Color in other nomenclature.
  136905. */
  136906. albedoColor: Color3;
  136907. /**
  136908. * AKA Specular Color in other nomenclature.
  136909. */
  136910. reflectivityColor: Color3;
  136911. /**
  136912. * The color reflected from the material.
  136913. */
  136914. reflectionColor: Color3;
  136915. /**
  136916. * The color emitted from the material.
  136917. */
  136918. emissiveColor: Color3;
  136919. /**
  136920. * AKA Glossiness in other nomenclature.
  136921. */
  136922. microSurface: number;
  136923. /**
  136924. * Index of refraction of the material base layer.
  136925. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136926. *
  136927. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136928. *
  136929. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136930. */
  136931. get indexOfRefraction(): number;
  136932. set indexOfRefraction(value: number);
  136933. /**
  136934. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136935. */
  136936. get invertRefractionY(): boolean;
  136937. set invertRefractionY(value: boolean);
  136938. /**
  136939. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136940. * Materials half opaque for instance using refraction could benefit from this control.
  136941. */
  136942. get linkRefractionWithTransparency(): boolean;
  136943. set linkRefractionWithTransparency(value: boolean);
  136944. /**
  136945. * If true, the light map contains occlusion information instead of lighting info.
  136946. */
  136947. useLightmapAsShadowmap: boolean;
  136948. /**
  136949. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136950. */
  136951. useAlphaFromAlbedoTexture: boolean;
  136952. /**
  136953. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136954. */
  136955. forceAlphaTest: boolean;
  136956. /**
  136957. * Defines the alpha limits in alpha test mode.
  136958. */
  136959. alphaCutOff: number;
  136960. /**
  136961. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136962. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136963. */
  136964. useSpecularOverAlpha: boolean;
  136965. /**
  136966. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136967. */
  136968. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136969. /**
  136970. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136971. */
  136972. useRoughnessFromMetallicTextureAlpha: boolean;
  136973. /**
  136974. * Specifies if the metallic texture contains the roughness information in its green channel.
  136975. */
  136976. useRoughnessFromMetallicTextureGreen: boolean;
  136977. /**
  136978. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136979. */
  136980. useMetallnessFromMetallicTextureBlue: boolean;
  136981. /**
  136982. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136983. */
  136984. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136985. /**
  136986. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136987. */
  136988. useAmbientInGrayScale: boolean;
  136989. /**
  136990. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136991. * The material will try to infer what glossiness each pixel should be.
  136992. */
  136993. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136994. /**
  136995. * BJS is using an harcoded light falloff based on a manually sets up range.
  136996. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136997. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136998. */
  136999. get usePhysicalLightFalloff(): boolean;
  137000. /**
  137001. * BJS is using an harcoded light falloff based on a manually sets up range.
  137002. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137003. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137004. */
  137005. set usePhysicalLightFalloff(value: boolean);
  137006. /**
  137007. * In order to support the falloff compatibility with gltf, a special mode has been added
  137008. * to reproduce the gltf light falloff.
  137009. */
  137010. get useGLTFLightFalloff(): boolean;
  137011. /**
  137012. * In order to support the falloff compatibility with gltf, a special mode has been added
  137013. * to reproduce the gltf light falloff.
  137014. */
  137015. set useGLTFLightFalloff(value: boolean);
  137016. /**
  137017. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137018. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137019. */
  137020. useRadianceOverAlpha: boolean;
  137021. /**
  137022. * Allows using an object space normal map (instead of tangent space).
  137023. */
  137024. useObjectSpaceNormalMap: boolean;
  137025. /**
  137026. * Allows using the bump map in parallax mode.
  137027. */
  137028. useParallax: boolean;
  137029. /**
  137030. * Allows using the bump map in parallax occlusion mode.
  137031. */
  137032. useParallaxOcclusion: boolean;
  137033. /**
  137034. * Controls the scale bias of the parallax mode.
  137035. */
  137036. parallaxScaleBias: number;
  137037. /**
  137038. * If sets to true, disables all the lights affecting the material.
  137039. */
  137040. disableLighting: boolean;
  137041. /**
  137042. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137043. */
  137044. forceIrradianceInFragment: boolean;
  137045. /**
  137046. * Number of Simultaneous lights allowed on the material.
  137047. */
  137048. maxSimultaneousLights: number;
  137049. /**
  137050. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  137051. */
  137052. invertNormalMapX: boolean;
  137053. /**
  137054. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  137055. */
  137056. invertNormalMapY: boolean;
  137057. /**
  137058. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137059. */
  137060. twoSidedLighting: boolean;
  137061. /**
  137062. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137063. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137064. */
  137065. useAlphaFresnel: boolean;
  137066. /**
  137067. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137068. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137069. */
  137070. useLinearAlphaFresnel: boolean;
  137071. /**
  137072. * Let user defines the brdf lookup texture used for IBL.
  137073. * A default 8bit version is embedded but you could point at :
  137074. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  137075. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  137076. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  137077. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  137078. */
  137079. environmentBRDFTexture: Nullable<BaseTexture>;
  137080. /**
  137081. * Force normal to face away from face.
  137082. */
  137083. forceNormalForward: boolean;
  137084. /**
  137085. * Enables specular anti aliasing in the PBR shader.
  137086. * It will both interacts on the Geometry for analytical and IBL lighting.
  137087. * It also prefilter the roughness map based on the bump values.
  137088. */
  137089. enableSpecularAntiAliasing: boolean;
  137090. /**
  137091. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137092. * makes the reflect vector face the model (under horizon).
  137093. */
  137094. useHorizonOcclusion: boolean;
  137095. /**
  137096. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137097. * too much the area relying on ambient texture to define their ambient occlusion.
  137098. */
  137099. useRadianceOcclusion: boolean;
  137100. /**
  137101. * If set to true, no lighting calculations will be applied.
  137102. */
  137103. unlit: boolean;
  137104. /**
  137105. * Gets the image processing configuration used either in this material.
  137106. */
  137107. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  137108. /**
  137109. * Sets the Default image processing configuration used either in the this material.
  137110. *
  137111. * If sets to null, the scene one is in use.
  137112. */
  137113. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  137114. /**
  137115. * Gets wether the color curves effect is enabled.
  137116. */
  137117. get cameraColorCurvesEnabled(): boolean;
  137118. /**
  137119. * Sets wether the color curves effect is enabled.
  137120. */
  137121. set cameraColorCurvesEnabled(value: boolean);
  137122. /**
  137123. * Gets wether the color grading effect is enabled.
  137124. */
  137125. get cameraColorGradingEnabled(): boolean;
  137126. /**
  137127. * Gets wether the color grading effect is enabled.
  137128. */
  137129. set cameraColorGradingEnabled(value: boolean);
  137130. /**
  137131. * Gets wether tonemapping is enabled or not.
  137132. */
  137133. get cameraToneMappingEnabled(): boolean;
  137134. /**
  137135. * Sets wether tonemapping is enabled or not
  137136. */
  137137. set cameraToneMappingEnabled(value: boolean);
  137138. /**
  137139. * The camera exposure used on this material.
  137140. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137141. * This corresponds to a photographic exposure.
  137142. */
  137143. get cameraExposure(): number;
  137144. /**
  137145. * The camera exposure used on this material.
  137146. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137147. * This corresponds to a photographic exposure.
  137148. */
  137149. set cameraExposure(value: number);
  137150. /**
  137151. * Gets The camera contrast used on this material.
  137152. */
  137153. get cameraContrast(): number;
  137154. /**
  137155. * Sets The camera contrast used on this material.
  137156. */
  137157. set cameraContrast(value: number);
  137158. /**
  137159. * Gets the Color Grading 2D Lookup Texture.
  137160. */
  137161. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  137162. /**
  137163. * Sets the Color Grading 2D Lookup Texture.
  137164. */
  137165. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  137166. /**
  137167. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137168. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137169. * 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;
  137170. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137171. */
  137172. get cameraColorCurves(): Nullable<ColorCurves>;
  137173. /**
  137174. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137175. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137176. * 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;
  137177. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137178. */
  137179. set cameraColorCurves(value: Nullable<ColorCurves>);
  137180. /**
  137181. * Instantiates a new PBRMaterial instance.
  137182. *
  137183. * @param name The material name
  137184. * @param scene The scene the material will be use in.
  137185. */
  137186. constructor(name: string, scene: Scene);
  137187. /**
  137188. * Returns the name of this material class.
  137189. */
  137190. getClassName(): string;
  137191. /**
  137192. * Makes a duplicate of the current material.
  137193. * @param name - name to use for the new material.
  137194. */
  137195. clone(name: string): PBRMaterial;
  137196. /**
  137197. * Serializes this PBR Material.
  137198. * @returns - An object with the serialized material.
  137199. */
  137200. serialize(): any;
  137201. /**
  137202. * Parses a PBR Material from a serialized object.
  137203. * @param source - Serialized object.
  137204. * @param scene - BJS scene instance.
  137205. * @param rootUrl - url for the scene object
  137206. * @returns - PBRMaterial
  137207. */
  137208. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137209. }
  137210. }
  137211. declare module BABYLON {
  137212. /**
  137213. * Direct draw surface info
  137214. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137215. */
  137216. export interface DDSInfo {
  137217. /**
  137218. * Width of the texture
  137219. */
  137220. width: number;
  137221. /**
  137222. * Width of the texture
  137223. */
  137224. height: number;
  137225. /**
  137226. * Number of Mipmaps for the texture
  137227. * @see https://en.wikipedia.org/wiki/Mipmap
  137228. */
  137229. mipmapCount: number;
  137230. /**
  137231. * If the textures format is a known fourCC format
  137232. * @see https://www.fourcc.org/
  137233. */
  137234. isFourCC: boolean;
  137235. /**
  137236. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137237. */
  137238. isRGB: boolean;
  137239. /**
  137240. * If the texture is a lumincance format
  137241. */
  137242. isLuminance: boolean;
  137243. /**
  137244. * If this is a cube texture
  137245. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137246. */
  137247. isCube: boolean;
  137248. /**
  137249. * If the texture is a compressed format eg. FOURCC_DXT1
  137250. */
  137251. isCompressed: boolean;
  137252. /**
  137253. * The dxgiFormat of the texture
  137254. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137255. */
  137256. dxgiFormat: number;
  137257. /**
  137258. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137259. */
  137260. textureType: number;
  137261. /**
  137262. * Sphericle polynomial created for the dds texture
  137263. */
  137264. sphericalPolynomial?: SphericalPolynomial;
  137265. }
  137266. /**
  137267. * Class used to provide DDS decompression tools
  137268. */
  137269. export class DDSTools {
  137270. /**
  137271. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137272. */
  137273. static StoreLODInAlphaChannel: boolean;
  137274. /**
  137275. * Gets DDS information from an array buffer
  137276. * @param data defines the array buffer view to read data from
  137277. * @returns the DDS information
  137278. */
  137279. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137280. private static _FloatView;
  137281. private static _Int32View;
  137282. private static _ToHalfFloat;
  137283. private static _FromHalfFloat;
  137284. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137285. private static _GetHalfFloatRGBAArrayBuffer;
  137286. private static _GetFloatRGBAArrayBuffer;
  137287. private static _GetFloatAsUIntRGBAArrayBuffer;
  137288. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137289. private static _GetRGBAArrayBuffer;
  137290. private static _ExtractLongWordOrder;
  137291. private static _GetRGBArrayBuffer;
  137292. private static _GetLuminanceArrayBuffer;
  137293. /**
  137294. * Uploads DDS Levels to a Babylon Texture
  137295. * @hidden
  137296. */
  137297. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137298. }
  137299. interface ThinEngine {
  137300. /**
  137301. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137302. * @param rootUrl defines the url where the file to load is located
  137303. * @param scene defines the current scene
  137304. * @param lodScale defines scale to apply to the mip map selection
  137305. * @param lodOffset defines offset to apply to the mip map selection
  137306. * @param onLoad defines an optional callback raised when the texture is loaded
  137307. * @param onError defines an optional callback raised if there is an issue to load the texture
  137308. * @param format defines the format of the data
  137309. * @param forcedExtension defines the extension to use to pick the right loader
  137310. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137311. * @returns the cube texture as an InternalTexture
  137312. */
  137313. 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;
  137314. }
  137315. }
  137316. declare module BABYLON {
  137317. /**
  137318. * Implementation of the DDS Texture Loader.
  137319. * @hidden
  137320. */
  137321. export class _DDSTextureLoader implements IInternalTextureLoader {
  137322. /**
  137323. * Defines wether the loader supports cascade loading the different faces.
  137324. */
  137325. readonly supportCascades: boolean;
  137326. /**
  137327. * This returns if the loader support the current file information.
  137328. * @param extension defines the file extension of the file being loaded
  137329. * @returns true if the loader can load the specified file
  137330. */
  137331. canLoad(extension: string): boolean;
  137332. /**
  137333. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137334. * @param data contains the texture data
  137335. * @param texture defines the BabylonJS internal texture
  137336. * @param createPolynomials will be true if polynomials have been requested
  137337. * @param onLoad defines the callback to trigger once the texture is ready
  137338. * @param onError defines the callback to trigger in case of error
  137339. */
  137340. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137341. /**
  137342. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137343. * @param data contains the texture data
  137344. * @param texture defines the BabylonJS internal texture
  137345. * @param callback defines the method to call once ready to upload
  137346. */
  137347. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137348. }
  137349. }
  137350. declare module BABYLON {
  137351. /**
  137352. * Implementation of the ENV Texture Loader.
  137353. * @hidden
  137354. */
  137355. export class _ENVTextureLoader implements IInternalTextureLoader {
  137356. /**
  137357. * Defines wether the loader supports cascade loading the different faces.
  137358. */
  137359. readonly supportCascades: boolean;
  137360. /**
  137361. * This returns if the loader support the current file information.
  137362. * @param extension defines the file extension of the file being loaded
  137363. * @returns true if the loader can load the specified file
  137364. */
  137365. canLoad(extension: string): boolean;
  137366. /**
  137367. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137368. * @param data contains the texture data
  137369. * @param texture defines the BabylonJS internal texture
  137370. * @param createPolynomials will be true if polynomials have been requested
  137371. * @param onLoad defines the callback to trigger once the texture is ready
  137372. * @param onError defines the callback to trigger in case of error
  137373. */
  137374. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137375. /**
  137376. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137377. * @param data contains the texture data
  137378. * @param texture defines the BabylonJS internal texture
  137379. * @param callback defines the method to call once ready to upload
  137380. */
  137381. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137382. }
  137383. }
  137384. declare module BABYLON {
  137385. /**
  137386. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137387. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137388. */
  137389. export class KhronosTextureContainer {
  137390. /** contents of the KTX container file */
  137391. data: ArrayBufferView;
  137392. private static HEADER_LEN;
  137393. private static COMPRESSED_2D;
  137394. private static COMPRESSED_3D;
  137395. private static TEX_2D;
  137396. private static TEX_3D;
  137397. /**
  137398. * Gets the openGL type
  137399. */
  137400. glType: number;
  137401. /**
  137402. * Gets the openGL type size
  137403. */
  137404. glTypeSize: number;
  137405. /**
  137406. * Gets the openGL format
  137407. */
  137408. glFormat: number;
  137409. /**
  137410. * Gets the openGL internal format
  137411. */
  137412. glInternalFormat: number;
  137413. /**
  137414. * Gets the base internal format
  137415. */
  137416. glBaseInternalFormat: number;
  137417. /**
  137418. * Gets image width in pixel
  137419. */
  137420. pixelWidth: number;
  137421. /**
  137422. * Gets image height in pixel
  137423. */
  137424. pixelHeight: number;
  137425. /**
  137426. * Gets image depth in pixels
  137427. */
  137428. pixelDepth: number;
  137429. /**
  137430. * Gets the number of array elements
  137431. */
  137432. numberOfArrayElements: number;
  137433. /**
  137434. * Gets the number of faces
  137435. */
  137436. numberOfFaces: number;
  137437. /**
  137438. * Gets the number of mipmap levels
  137439. */
  137440. numberOfMipmapLevels: number;
  137441. /**
  137442. * Gets the bytes of key value data
  137443. */
  137444. bytesOfKeyValueData: number;
  137445. /**
  137446. * Gets the load type
  137447. */
  137448. loadType: number;
  137449. /**
  137450. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137451. */
  137452. isInvalid: boolean;
  137453. /**
  137454. * Creates a new KhronosTextureContainer
  137455. * @param data contents of the KTX container file
  137456. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137457. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137458. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137459. */
  137460. constructor(
  137461. /** contents of the KTX container file */
  137462. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137463. /**
  137464. * Uploads KTX content to a Babylon Texture.
  137465. * It is assumed that the texture has already been created & is currently bound
  137466. * @hidden
  137467. */
  137468. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137469. private _upload2DCompressedLevels;
  137470. /**
  137471. * Checks if the given data starts with a KTX file identifier.
  137472. * @param data the data to check
  137473. * @returns true if the data is a KTX file or false otherwise
  137474. */
  137475. static IsValid(data: ArrayBufferView): boolean;
  137476. }
  137477. }
  137478. declare module BABYLON {
  137479. /**
  137480. * Class for loading KTX2 files
  137481. * !!! Experimental Extension Subject to Changes !!!
  137482. * @hidden
  137483. */
  137484. export class KhronosTextureContainer2 {
  137485. private static _ModulePromise;
  137486. private static _TranscodeFormat;
  137487. constructor(engine: ThinEngine);
  137488. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137489. private _determineTranscodeFormat;
  137490. /**
  137491. * Checks if the given data starts with a KTX2 file identifier.
  137492. * @param data the data to check
  137493. * @returns true if the data is a KTX2 file or false otherwise
  137494. */
  137495. static IsValid(data: ArrayBufferView): boolean;
  137496. }
  137497. }
  137498. declare module BABYLON {
  137499. /**
  137500. * Implementation of the KTX Texture Loader.
  137501. * @hidden
  137502. */
  137503. export class _KTXTextureLoader implements IInternalTextureLoader {
  137504. /**
  137505. * Defines wether the loader supports cascade loading the different faces.
  137506. */
  137507. readonly supportCascades: boolean;
  137508. /**
  137509. * This returns if the loader support the current file information.
  137510. * @param extension defines the file extension of the file being loaded
  137511. * @param mimeType defines the optional mime type of the file being loaded
  137512. * @returns true if the loader can load the specified file
  137513. */
  137514. canLoad(extension: string, mimeType?: string): boolean;
  137515. /**
  137516. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137517. * @param data contains the texture data
  137518. * @param texture defines the BabylonJS internal texture
  137519. * @param createPolynomials will be true if polynomials have been requested
  137520. * @param onLoad defines the callback to trigger once the texture is ready
  137521. * @param onError defines the callback to trigger in case of error
  137522. */
  137523. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137524. /**
  137525. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137526. * @param data contains the texture data
  137527. * @param texture defines the BabylonJS internal texture
  137528. * @param callback defines the method to call once ready to upload
  137529. */
  137530. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137531. }
  137532. }
  137533. declare module BABYLON {
  137534. /** @hidden */
  137535. export var _forceSceneHelpersToBundle: boolean;
  137536. interface Scene {
  137537. /**
  137538. * Creates a default light for the scene.
  137539. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137540. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137541. */
  137542. createDefaultLight(replace?: boolean): void;
  137543. /**
  137544. * Creates a default camera for the scene.
  137545. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137546. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137547. * @param replace has default false, when true replaces the active camera in the scene
  137548. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137549. */
  137550. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137551. /**
  137552. * Creates a default camera and a default light.
  137553. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137554. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137555. * @param replace has the default false, when true replaces the active camera/light in the scene
  137556. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137557. */
  137558. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137559. /**
  137560. * Creates a new sky box
  137561. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137562. * @param environmentTexture defines the texture to use as environment texture
  137563. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137564. * @param scale defines the overall scale of the skybox
  137565. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137566. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137567. * @returns a new mesh holding the sky box
  137568. */
  137569. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137570. /**
  137571. * Creates a new environment
  137572. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137573. * @param options defines the options you can use to configure the environment
  137574. * @returns the new EnvironmentHelper
  137575. */
  137576. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137577. /**
  137578. * Creates a new VREXperienceHelper
  137579. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137580. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137581. * @returns a new VREXperienceHelper
  137582. */
  137583. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137584. /**
  137585. * Creates a new WebXRDefaultExperience
  137586. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137587. * @param options experience options
  137588. * @returns a promise for a new WebXRDefaultExperience
  137589. */
  137590. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137591. }
  137592. }
  137593. declare module BABYLON {
  137594. /**
  137595. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137596. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137597. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137598. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137599. */
  137600. export class VideoDome extends TextureDome<VideoTexture> {
  137601. /**
  137602. * Define the video source as a Monoscopic panoramic 360 video.
  137603. */
  137604. static readonly MODE_MONOSCOPIC: number;
  137605. /**
  137606. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137607. */
  137608. static readonly MODE_TOPBOTTOM: number;
  137609. /**
  137610. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137611. */
  137612. static readonly MODE_SIDEBYSIDE: number;
  137613. /**
  137614. * Get the video texture associated with this video dome
  137615. */
  137616. get videoTexture(): VideoTexture;
  137617. /**
  137618. * Get the video mode of this dome
  137619. */
  137620. get videoMode(): number;
  137621. /**
  137622. * Set the video mode of this dome.
  137623. * @see textureMode
  137624. */
  137625. set videoMode(value: number);
  137626. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137627. }
  137628. }
  137629. declare module BABYLON {
  137630. /**
  137631. * This class can be used to get instrumentation data from a Babylon engine
  137632. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137633. */
  137634. export class EngineInstrumentation implements IDisposable {
  137635. /**
  137636. * Define the instrumented engine.
  137637. */
  137638. engine: Engine;
  137639. private _captureGPUFrameTime;
  137640. private _gpuFrameTimeToken;
  137641. private _gpuFrameTime;
  137642. private _captureShaderCompilationTime;
  137643. private _shaderCompilationTime;
  137644. private _onBeginFrameObserver;
  137645. private _onEndFrameObserver;
  137646. private _onBeforeShaderCompilationObserver;
  137647. private _onAfterShaderCompilationObserver;
  137648. /**
  137649. * Gets the perf counter used for GPU frame time
  137650. */
  137651. get gpuFrameTimeCounter(): PerfCounter;
  137652. /**
  137653. * Gets the GPU frame time capture status
  137654. */
  137655. get captureGPUFrameTime(): boolean;
  137656. /**
  137657. * Enable or disable the GPU frame time capture
  137658. */
  137659. set captureGPUFrameTime(value: boolean);
  137660. /**
  137661. * Gets the perf counter used for shader compilation time
  137662. */
  137663. get shaderCompilationTimeCounter(): PerfCounter;
  137664. /**
  137665. * Gets the shader compilation time capture status
  137666. */
  137667. get captureShaderCompilationTime(): boolean;
  137668. /**
  137669. * Enable or disable the shader compilation time capture
  137670. */
  137671. set captureShaderCompilationTime(value: boolean);
  137672. /**
  137673. * Instantiates a new engine instrumentation.
  137674. * This class can be used to get instrumentation data from a Babylon engine
  137675. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137676. * @param engine Defines the engine to instrument
  137677. */
  137678. constructor(
  137679. /**
  137680. * Define the instrumented engine.
  137681. */
  137682. engine: Engine);
  137683. /**
  137684. * Dispose and release associated resources.
  137685. */
  137686. dispose(): void;
  137687. }
  137688. }
  137689. declare module BABYLON {
  137690. /**
  137691. * This class can be used to get instrumentation data from a Babylon engine
  137692. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137693. */
  137694. export class SceneInstrumentation implements IDisposable {
  137695. /**
  137696. * Defines the scene to instrument
  137697. */
  137698. scene: Scene;
  137699. private _captureActiveMeshesEvaluationTime;
  137700. private _activeMeshesEvaluationTime;
  137701. private _captureRenderTargetsRenderTime;
  137702. private _renderTargetsRenderTime;
  137703. private _captureFrameTime;
  137704. private _frameTime;
  137705. private _captureRenderTime;
  137706. private _renderTime;
  137707. private _captureInterFrameTime;
  137708. private _interFrameTime;
  137709. private _captureParticlesRenderTime;
  137710. private _particlesRenderTime;
  137711. private _captureSpritesRenderTime;
  137712. private _spritesRenderTime;
  137713. private _capturePhysicsTime;
  137714. private _physicsTime;
  137715. private _captureAnimationsTime;
  137716. private _animationsTime;
  137717. private _captureCameraRenderTime;
  137718. private _cameraRenderTime;
  137719. private _onBeforeActiveMeshesEvaluationObserver;
  137720. private _onAfterActiveMeshesEvaluationObserver;
  137721. private _onBeforeRenderTargetsRenderObserver;
  137722. private _onAfterRenderTargetsRenderObserver;
  137723. private _onAfterRenderObserver;
  137724. private _onBeforeDrawPhaseObserver;
  137725. private _onAfterDrawPhaseObserver;
  137726. private _onBeforeAnimationsObserver;
  137727. private _onBeforeParticlesRenderingObserver;
  137728. private _onAfterParticlesRenderingObserver;
  137729. private _onBeforeSpritesRenderingObserver;
  137730. private _onAfterSpritesRenderingObserver;
  137731. private _onBeforePhysicsObserver;
  137732. private _onAfterPhysicsObserver;
  137733. private _onAfterAnimationsObserver;
  137734. private _onBeforeCameraRenderObserver;
  137735. private _onAfterCameraRenderObserver;
  137736. /**
  137737. * Gets the perf counter used for active meshes evaluation time
  137738. */
  137739. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137740. /**
  137741. * Gets the active meshes evaluation time capture status
  137742. */
  137743. get captureActiveMeshesEvaluationTime(): boolean;
  137744. /**
  137745. * Enable or disable the active meshes evaluation time capture
  137746. */
  137747. set captureActiveMeshesEvaluationTime(value: boolean);
  137748. /**
  137749. * Gets the perf counter used for render targets render time
  137750. */
  137751. get renderTargetsRenderTimeCounter(): PerfCounter;
  137752. /**
  137753. * Gets the render targets render time capture status
  137754. */
  137755. get captureRenderTargetsRenderTime(): boolean;
  137756. /**
  137757. * Enable or disable the render targets render time capture
  137758. */
  137759. set captureRenderTargetsRenderTime(value: boolean);
  137760. /**
  137761. * Gets the perf counter used for particles render time
  137762. */
  137763. get particlesRenderTimeCounter(): PerfCounter;
  137764. /**
  137765. * Gets the particles render time capture status
  137766. */
  137767. get captureParticlesRenderTime(): boolean;
  137768. /**
  137769. * Enable or disable the particles render time capture
  137770. */
  137771. set captureParticlesRenderTime(value: boolean);
  137772. /**
  137773. * Gets the perf counter used for sprites render time
  137774. */
  137775. get spritesRenderTimeCounter(): PerfCounter;
  137776. /**
  137777. * Gets the sprites render time capture status
  137778. */
  137779. get captureSpritesRenderTime(): boolean;
  137780. /**
  137781. * Enable or disable the sprites render time capture
  137782. */
  137783. set captureSpritesRenderTime(value: boolean);
  137784. /**
  137785. * Gets the perf counter used for physics time
  137786. */
  137787. get physicsTimeCounter(): PerfCounter;
  137788. /**
  137789. * Gets the physics time capture status
  137790. */
  137791. get capturePhysicsTime(): boolean;
  137792. /**
  137793. * Enable or disable the physics time capture
  137794. */
  137795. set capturePhysicsTime(value: boolean);
  137796. /**
  137797. * Gets the perf counter used for animations time
  137798. */
  137799. get animationsTimeCounter(): PerfCounter;
  137800. /**
  137801. * Gets the animations time capture status
  137802. */
  137803. get captureAnimationsTime(): boolean;
  137804. /**
  137805. * Enable or disable the animations time capture
  137806. */
  137807. set captureAnimationsTime(value: boolean);
  137808. /**
  137809. * Gets the perf counter used for frame time capture
  137810. */
  137811. get frameTimeCounter(): PerfCounter;
  137812. /**
  137813. * Gets the frame time capture status
  137814. */
  137815. get captureFrameTime(): boolean;
  137816. /**
  137817. * Enable or disable the frame time capture
  137818. */
  137819. set captureFrameTime(value: boolean);
  137820. /**
  137821. * Gets the perf counter used for inter-frames time capture
  137822. */
  137823. get interFrameTimeCounter(): PerfCounter;
  137824. /**
  137825. * Gets the inter-frames time capture status
  137826. */
  137827. get captureInterFrameTime(): boolean;
  137828. /**
  137829. * Enable or disable the inter-frames time capture
  137830. */
  137831. set captureInterFrameTime(value: boolean);
  137832. /**
  137833. * Gets the perf counter used for render time capture
  137834. */
  137835. get renderTimeCounter(): PerfCounter;
  137836. /**
  137837. * Gets the render time capture status
  137838. */
  137839. get captureRenderTime(): boolean;
  137840. /**
  137841. * Enable or disable the render time capture
  137842. */
  137843. set captureRenderTime(value: boolean);
  137844. /**
  137845. * Gets the perf counter used for camera render time capture
  137846. */
  137847. get cameraRenderTimeCounter(): PerfCounter;
  137848. /**
  137849. * Gets the camera render time capture status
  137850. */
  137851. get captureCameraRenderTime(): boolean;
  137852. /**
  137853. * Enable or disable the camera render time capture
  137854. */
  137855. set captureCameraRenderTime(value: boolean);
  137856. /**
  137857. * Gets the perf counter used for draw calls
  137858. */
  137859. get drawCallsCounter(): PerfCounter;
  137860. /**
  137861. * Instantiates a new scene instrumentation.
  137862. * This class can be used to get instrumentation data from a Babylon engine
  137863. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137864. * @param scene Defines the scene to instrument
  137865. */
  137866. constructor(
  137867. /**
  137868. * Defines the scene to instrument
  137869. */
  137870. scene: Scene);
  137871. /**
  137872. * Dispose and release associated resources.
  137873. */
  137874. dispose(): void;
  137875. }
  137876. }
  137877. declare module BABYLON {
  137878. /** @hidden */
  137879. export var glowMapGenerationPixelShader: {
  137880. name: string;
  137881. shader: string;
  137882. };
  137883. }
  137884. declare module BABYLON {
  137885. /** @hidden */
  137886. export var glowMapGenerationVertexShader: {
  137887. name: string;
  137888. shader: string;
  137889. };
  137890. }
  137891. declare module BABYLON {
  137892. /**
  137893. * Effect layer options. This helps customizing the behaviour
  137894. * of the effect layer.
  137895. */
  137896. export interface IEffectLayerOptions {
  137897. /**
  137898. * Multiplication factor apply to the canvas size to compute the render target size
  137899. * used to generated the objects (the smaller the faster).
  137900. */
  137901. mainTextureRatio: number;
  137902. /**
  137903. * Enforces a fixed size texture to ensure effect stability across devices.
  137904. */
  137905. mainTextureFixedSize?: number;
  137906. /**
  137907. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137908. */
  137909. alphaBlendingMode: number;
  137910. /**
  137911. * The camera attached to the layer.
  137912. */
  137913. camera: Nullable<Camera>;
  137914. /**
  137915. * The rendering group to draw the layer in.
  137916. */
  137917. renderingGroupId: number;
  137918. }
  137919. /**
  137920. * The effect layer Helps adding post process effect blended with the main pass.
  137921. *
  137922. * This can be for instance use to generate glow or higlight effects on the scene.
  137923. *
  137924. * The effect layer class can not be used directly and is intented to inherited from to be
  137925. * customized per effects.
  137926. */
  137927. export abstract class EffectLayer {
  137928. private _vertexBuffers;
  137929. private _indexBuffer;
  137930. private _cachedDefines;
  137931. private _effectLayerMapGenerationEffect;
  137932. private _effectLayerOptions;
  137933. private _mergeEffect;
  137934. protected _scene: Scene;
  137935. protected _engine: Engine;
  137936. protected _maxSize: number;
  137937. protected _mainTextureDesiredSize: ISize;
  137938. protected _mainTexture: RenderTargetTexture;
  137939. protected _shouldRender: boolean;
  137940. protected _postProcesses: PostProcess[];
  137941. protected _textures: BaseTexture[];
  137942. protected _emissiveTextureAndColor: {
  137943. texture: Nullable<BaseTexture>;
  137944. color: Color4;
  137945. };
  137946. /**
  137947. * The name of the layer
  137948. */
  137949. name: string;
  137950. /**
  137951. * The clear color of the texture used to generate the glow map.
  137952. */
  137953. neutralColor: Color4;
  137954. /**
  137955. * Specifies whether the highlight layer is enabled or not.
  137956. */
  137957. isEnabled: boolean;
  137958. /**
  137959. * Gets the camera attached to the layer.
  137960. */
  137961. get camera(): Nullable<Camera>;
  137962. /**
  137963. * Gets the rendering group id the layer should render in.
  137964. */
  137965. get renderingGroupId(): number;
  137966. set renderingGroupId(renderingGroupId: number);
  137967. /**
  137968. * An event triggered when the effect layer has been disposed.
  137969. */
  137970. onDisposeObservable: Observable<EffectLayer>;
  137971. /**
  137972. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137973. */
  137974. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137975. /**
  137976. * An event triggered when the generated texture is being merged in the scene.
  137977. */
  137978. onBeforeComposeObservable: Observable<EffectLayer>;
  137979. /**
  137980. * An event triggered when the mesh is rendered into the effect render target.
  137981. */
  137982. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137983. /**
  137984. * An event triggered after the mesh has been rendered into the effect render target.
  137985. */
  137986. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137987. /**
  137988. * An event triggered when the generated texture has been merged in the scene.
  137989. */
  137990. onAfterComposeObservable: Observable<EffectLayer>;
  137991. /**
  137992. * An event triggered when the efffect layer changes its size.
  137993. */
  137994. onSizeChangedObservable: Observable<EffectLayer>;
  137995. /** @hidden */
  137996. static _SceneComponentInitialization: (scene: Scene) => void;
  137997. /**
  137998. * Instantiates a new effect Layer and references it in the scene.
  137999. * @param name The name of the layer
  138000. * @param scene The scene to use the layer in
  138001. */
  138002. constructor(
  138003. /** The Friendly of the effect in the scene */
  138004. name: string, scene: Scene);
  138005. /**
  138006. * Get the effect name of the layer.
  138007. * @return The effect name
  138008. */
  138009. abstract getEffectName(): string;
  138010. /**
  138011. * Checks for the readiness of the element composing the layer.
  138012. * @param subMesh the mesh to check for
  138013. * @param useInstances specify whether or not to use instances to render the mesh
  138014. * @return true if ready otherwise, false
  138015. */
  138016. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138017. /**
  138018. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138019. * @returns true if the effect requires stencil during the main canvas render pass.
  138020. */
  138021. abstract needStencil(): boolean;
  138022. /**
  138023. * Create the merge effect. This is the shader use to blit the information back
  138024. * to the main canvas at the end of the scene rendering.
  138025. * @returns The effect containing the shader used to merge the effect on the main canvas
  138026. */
  138027. protected abstract _createMergeEffect(): Effect;
  138028. /**
  138029. * Creates the render target textures and post processes used in the effect layer.
  138030. */
  138031. protected abstract _createTextureAndPostProcesses(): void;
  138032. /**
  138033. * Implementation specific of rendering the generating effect on the main canvas.
  138034. * @param effect The effect used to render through
  138035. */
  138036. protected abstract _internalRender(effect: Effect): void;
  138037. /**
  138038. * Sets the required values for both the emissive texture and and the main color.
  138039. */
  138040. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138041. /**
  138042. * Free any resources and references associated to a mesh.
  138043. * Internal use
  138044. * @param mesh The mesh to free.
  138045. */
  138046. abstract _disposeMesh(mesh: Mesh): void;
  138047. /**
  138048. * Serializes this layer (Glow or Highlight for example)
  138049. * @returns a serialized layer object
  138050. */
  138051. abstract serialize?(): any;
  138052. /**
  138053. * Initializes the effect layer with the required options.
  138054. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  138055. */
  138056. protected _init(options: Partial<IEffectLayerOptions>): void;
  138057. /**
  138058. * Generates the index buffer of the full screen quad blending to the main canvas.
  138059. */
  138060. private _generateIndexBuffer;
  138061. /**
  138062. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  138063. */
  138064. private _generateVertexBuffer;
  138065. /**
  138066. * Sets the main texture desired size which is the closest power of two
  138067. * of the engine canvas size.
  138068. */
  138069. private _setMainTextureSize;
  138070. /**
  138071. * Creates the main texture for the effect layer.
  138072. */
  138073. protected _createMainTexture(): void;
  138074. /**
  138075. * Adds specific effects defines.
  138076. * @param defines The defines to add specifics to.
  138077. */
  138078. protected _addCustomEffectDefines(defines: string[]): void;
  138079. /**
  138080. * Checks for the readiness of the element composing the layer.
  138081. * @param subMesh the mesh to check for
  138082. * @param useInstances specify whether or not to use instances to render the mesh
  138083. * @param emissiveTexture the associated emissive texture used to generate the glow
  138084. * @return true if ready otherwise, false
  138085. */
  138086. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  138087. /**
  138088. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  138089. */
  138090. render(): void;
  138091. /**
  138092. * Determine if a given mesh will be used in the current effect.
  138093. * @param mesh mesh to test
  138094. * @returns true if the mesh will be used
  138095. */
  138096. hasMesh(mesh: AbstractMesh): boolean;
  138097. /**
  138098. * Returns true if the layer contains information to display, otherwise false.
  138099. * @returns true if the glow layer should be rendered
  138100. */
  138101. shouldRender(): boolean;
  138102. /**
  138103. * Returns true if the mesh should render, otherwise false.
  138104. * @param mesh The mesh to render
  138105. * @returns true if it should render otherwise false
  138106. */
  138107. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  138108. /**
  138109. * Returns true if the mesh can be rendered, otherwise false.
  138110. * @param mesh The mesh to render
  138111. * @param material The material used on the mesh
  138112. * @returns true if it can be rendered otherwise false
  138113. */
  138114. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138115. /**
  138116. * Returns true if the mesh should render, otherwise false.
  138117. * @param mesh The mesh to render
  138118. * @returns true if it should render otherwise false
  138119. */
  138120. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  138121. /**
  138122. * Renders the submesh passed in parameter to the generation map.
  138123. */
  138124. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  138125. /**
  138126. * Defines whether the current material of the mesh should be use to render the effect.
  138127. * @param mesh defines the current mesh to render
  138128. */
  138129. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138130. /**
  138131. * Rebuild the required buffers.
  138132. * @hidden Internal use only.
  138133. */
  138134. _rebuild(): void;
  138135. /**
  138136. * Dispose only the render target textures and post process.
  138137. */
  138138. private _disposeTextureAndPostProcesses;
  138139. /**
  138140. * Dispose the highlight layer and free resources.
  138141. */
  138142. dispose(): void;
  138143. /**
  138144. * Gets the class name of the effect layer
  138145. * @returns the string with the class name of the effect layer
  138146. */
  138147. getClassName(): string;
  138148. /**
  138149. * Creates an effect layer from parsed effect layer data
  138150. * @param parsedEffectLayer defines effect layer data
  138151. * @param scene defines the current scene
  138152. * @param rootUrl defines the root URL containing the effect layer information
  138153. * @returns a parsed effect Layer
  138154. */
  138155. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  138156. }
  138157. }
  138158. declare module BABYLON {
  138159. interface AbstractScene {
  138160. /**
  138161. * The list of effect layers (highlights/glow) added to the scene
  138162. * @see https://doc.babylonjs.com/how_to/highlight_layer
  138163. * @see https://doc.babylonjs.com/how_to/glow_layer
  138164. */
  138165. effectLayers: Array<EffectLayer>;
  138166. /**
  138167. * Removes the given effect layer from this scene.
  138168. * @param toRemove defines the effect layer to remove
  138169. * @returns the index of the removed effect layer
  138170. */
  138171. removeEffectLayer(toRemove: EffectLayer): number;
  138172. /**
  138173. * Adds the given effect layer to this scene
  138174. * @param newEffectLayer defines the effect layer to add
  138175. */
  138176. addEffectLayer(newEffectLayer: EffectLayer): void;
  138177. }
  138178. /**
  138179. * Defines the layer scene component responsible to manage any effect layers
  138180. * in a given scene.
  138181. */
  138182. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138183. /**
  138184. * The component name helpfull to identify the component in the list of scene components.
  138185. */
  138186. readonly name: string;
  138187. /**
  138188. * The scene the component belongs to.
  138189. */
  138190. scene: Scene;
  138191. private _engine;
  138192. private _renderEffects;
  138193. private _needStencil;
  138194. private _previousStencilState;
  138195. /**
  138196. * Creates a new instance of the component for the given scene
  138197. * @param scene Defines the scene to register the component in
  138198. */
  138199. constructor(scene: Scene);
  138200. /**
  138201. * Registers the component in a given scene
  138202. */
  138203. register(): void;
  138204. /**
  138205. * Rebuilds the elements related to this component in case of
  138206. * context lost for instance.
  138207. */
  138208. rebuild(): void;
  138209. /**
  138210. * Serializes the component data to the specified json object
  138211. * @param serializationObject The object to serialize to
  138212. */
  138213. serialize(serializationObject: any): void;
  138214. /**
  138215. * Adds all the elements from the container to the scene
  138216. * @param container the container holding the elements
  138217. */
  138218. addFromContainer(container: AbstractScene): void;
  138219. /**
  138220. * Removes all the elements in the container from the scene
  138221. * @param container contains the elements to remove
  138222. * @param dispose if the removed element should be disposed (default: false)
  138223. */
  138224. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138225. /**
  138226. * Disposes the component and the associated ressources.
  138227. */
  138228. dispose(): void;
  138229. private _isReadyForMesh;
  138230. private _renderMainTexture;
  138231. private _setStencil;
  138232. private _setStencilBack;
  138233. private _draw;
  138234. private _drawCamera;
  138235. private _drawRenderingGroup;
  138236. }
  138237. }
  138238. declare module BABYLON {
  138239. /** @hidden */
  138240. export var glowMapMergePixelShader: {
  138241. name: string;
  138242. shader: string;
  138243. };
  138244. }
  138245. declare module BABYLON {
  138246. /** @hidden */
  138247. export var glowMapMergeVertexShader: {
  138248. name: string;
  138249. shader: string;
  138250. };
  138251. }
  138252. declare module BABYLON {
  138253. interface AbstractScene {
  138254. /**
  138255. * Return a the first highlight layer of the scene with a given name.
  138256. * @param name The name of the highlight layer to look for.
  138257. * @return The highlight layer if found otherwise null.
  138258. */
  138259. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138260. }
  138261. /**
  138262. * Glow layer options. This helps customizing the behaviour
  138263. * of the glow layer.
  138264. */
  138265. export interface IGlowLayerOptions {
  138266. /**
  138267. * Multiplication factor apply to the canvas size to compute the render target size
  138268. * used to generated the glowing objects (the smaller the faster).
  138269. */
  138270. mainTextureRatio: number;
  138271. /**
  138272. * Enforces a fixed size texture to ensure resize independant blur.
  138273. */
  138274. mainTextureFixedSize?: number;
  138275. /**
  138276. * How big is the kernel of the blur texture.
  138277. */
  138278. blurKernelSize: number;
  138279. /**
  138280. * The camera attached to the layer.
  138281. */
  138282. camera: Nullable<Camera>;
  138283. /**
  138284. * Enable MSAA by chosing the number of samples.
  138285. */
  138286. mainTextureSamples?: number;
  138287. /**
  138288. * The rendering group to draw the layer in.
  138289. */
  138290. renderingGroupId: number;
  138291. }
  138292. /**
  138293. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138294. *
  138295. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138296. *
  138297. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138298. */
  138299. export class GlowLayer extends EffectLayer {
  138300. /**
  138301. * Effect Name of the layer.
  138302. */
  138303. static readonly EffectName: string;
  138304. /**
  138305. * The default blur kernel size used for the glow.
  138306. */
  138307. static DefaultBlurKernelSize: number;
  138308. /**
  138309. * The default texture size ratio used for the glow.
  138310. */
  138311. static DefaultTextureRatio: number;
  138312. /**
  138313. * Sets the kernel size of the blur.
  138314. */
  138315. set blurKernelSize(value: number);
  138316. /**
  138317. * Gets the kernel size of the blur.
  138318. */
  138319. get blurKernelSize(): number;
  138320. /**
  138321. * Sets the glow intensity.
  138322. */
  138323. set intensity(value: number);
  138324. /**
  138325. * Gets the glow intensity.
  138326. */
  138327. get intensity(): number;
  138328. private _options;
  138329. private _intensity;
  138330. private _horizontalBlurPostprocess1;
  138331. private _verticalBlurPostprocess1;
  138332. private _horizontalBlurPostprocess2;
  138333. private _verticalBlurPostprocess2;
  138334. private _blurTexture1;
  138335. private _blurTexture2;
  138336. private _postProcesses1;
  138337. private _postProcesses2;
  138338. private _includedOnlyMeshes;
  138339. private _excludedMeshes;
  138340. private _meshesUsingTheirOwnMaterials;
  138341. /**
  138342. * Callback used to let the user override the color selection on a per mesh basis
  138343. */
  138344. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138345. /**
  138346. * Callback used to let the user override the texture selection on a per mesh basis
  138347. */
  138348. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138349. /**
  138350. * Instantiates a new glow Layer and references it to the scene.
  138351. * @param name The name of the layer
  138352. * @param scene The scene to use the layer in
  138353. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138354. */
  138355. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138356. /**
  138357. * Get the effect name of the layer.
  138358. * @return The effect name
  138359. */
  138360. getEffectName(): string;
  138361. /**
  138362. * Create the merge effect. This is the shader use to blit the information back
  138363. * to the main canvas at the end of the scene rendering.
  138364. */
  138365. protected _createMergeEffect(): Effect;
  138366. /**
  138367. * Creates the render target textures and post processes used in the glow layer.
  138368. */
  138369. protected _createTextureAndPostProcesses(): void;
  138370. /**
  138371. * Checks for the readiness of the element composing the layer.
  138372. * @param subMesh the mesh to check for
  138373. * @param useInstances specify wether or not to use instances to render the mesh
  138374. * @param emissiveTexture the associated emissive texture used to generate the glow
  138375. * @return true if ready otherwise, false
  138376. */
  138377. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138378. /**
  138379. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138380. */
  138381. needStencil(): boolean;
  138382. /**
  138383. * Returns true if the mesh can be rendered, otherwise false.
  138384. * @param mesh The mesh to render
  138385. * @param material The material used on the mesh
  138386. * @returns true if it can be rendered otherwise false
  138387. */
  138388. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138389. /**
  138390. * Implementation specific of rendering the generating effect on the main canvas.
  138391. * @param effect The effect used to render through
  138392. */
  138393. protected _internalRender(effect: Effect): void;
  138394. /**
  138395. * Sets the required values for both the emissive texture and and the main color.
  138396. */
  138397. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138398. /**
  138399. * Returns true if the mesh should render, otherwise false.
  138400. * @param mesh The mesh to render
  138401. * @returns true if it should render otherwise false
  138402. */
  138403. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138404. /**
  138405. * Adds specific effects defines.
  138406. * @param defines The defines to add specifics to.
  138407. */
  138408. protected _addCustomEffectDefines(defines: string[]): void;
  138409. /**
  138410. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138411. * @param mesh The mesh to exclude from the glow layer
  138412. */
  138413. addExcludedMesh(mesh: Mesh): void;
  138414. /**
  138415. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138416. * @param mesh The mesh to remove
  138417. */
  138418. removeExcludedMesh(mesh: Mesh): void;
  138419. /**
  138420. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138421. * @param mesh The mesh to include in the glow layer
  138422. */
  138423. addIncludedOnlyMesh(mesh: Mesh): void;
  138424. /**
  138425. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138426. * @param mesh The mesh to remove
  138427. */
  138428. removeIncludedOnlyMesh(mesh: Mesh): void;
  138429. /**
  138430. * Determine if a given mesh will be used in the glow layer
  138431. * @param mesh The mesh to test
  138432. * @returns true if the mesh will be highlighted by the current glow layer
  138433. */
  138434. hasMesh(mesh: AbstractMesh): boolean;
  138435. /**
  138436. * Defines whether the current material of the mesh should be use to render the effect.
  138437. * @param mesh defines the current mesh to render
  138438. */
  138439. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138440. /**
  138441. * Add a mesh to be rendered through its own material and not with emissive only.
  138442. * @param mesh The mesh for which we need to use its material
  138443. */
  138444. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138445. /**
  138446. * Remove a mesh from being rendered through its own material and not with emissive only.
  138447. * @param mesh The mesh for which we need to not use its material
  138448. */
  138449. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138450. /**
  138451. * Free any resources and references associated to a mesh.
  138452. * Internal use
  138453. * @param mesh The mesh to free.
  138454. * @hidden
  138455. */
  138456. _disposeMesh(mesh: Mesh): void;
  138457. /**
  138458. * Gets the class name of the effect layer
  138459. * @returns the string with the class name of the effect layer
  138460. */
  138461. getClassName(): string;
  138462. /**
  138463. * Serializes this glow layer
  138464. * @returns a serialized glow layer object
  138465. */
  138466. serialize(): any;
  138467. /**
  138468. * Creates a Glow Layer from parsed glow layer data
  138469. * @param parsedGlowLayer defines glow layer data
  138470. * @param scene defines the current scene
  138471. * @param rootUrl defines the root URL containing the glow layer information
  138472. * @returns a parsed Glow Layer
  138473. */
  138474. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138475. }
  138476. }
  138477. declare module BABYLON {
  138478. /** @hidden */
  138479. export var glowBlurPostProcessPixelShader: {
  138480. name: string;
  138481. shader: string;
  138482. };
  138483. }
  138484. declare module BABYLON {
  138485. interface AbstractScene {
  138486. /**
  138487. * Return a the first highlight layer of the scene with a given name.
  138488. * @param name The name of the highlight layer to look for.
  138489. * @return The highlight layer if found otherwise null.
  138490. */
  138491. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138492. }
  138493. /**
  138494. * Highlight layer options. This helps customizing the behaviour
  138495. * of the highlight layer.
  138496. */
  138497. export interface IHighlightLayerOptions {
  138498. /**
  138499. * Multiplication factor apply to the canvas size to compute the render target size
  138500. * used to generated the glowing objects (the smaller the faster).
  138501. */
  138502. mainTextureRatio: number;
  138503. /**
  138504. * Enforces a fixed size texture to ensure resize independant blur.
  138505. */
  138506. mainTextureFixedSize?: number;
  138507. /**
  138508. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138509. * of the picture to blur (the smaller the faster).
  138510. */
  138511. blurTextureSizeRatio: number;
  138512. /**
  138513. * How big in texel of the blur texture is the vertical blur.
  138514. */
  138515. blurVerticalSize: number;
  138516. /**
  138517. * How big in texel of the blur texture is the horizontal blur.
  138518. */
  138519. blurHorizontalSize: number;
  138520. /**
  138521. * Alpha blending mode used to apply the blur. Default is combine.
  138522. */
  138523. alphaBlendingMode: number;
  138524. /**
  138525. * The camera attached to the layer.
  138526. */
  138527. camera: Nullable<Camera>;
  138528. /**
  138529. * Should we display highlight as a solid stroke?
  138530. */
  138531. isStroke?: boolean;
  138532. /**
  138533. * The rendering group to draw the layer in.
  138534. */
  138535. renderingGroupId: number;
  138536. }
  138537. /**
  138538. * The highlight layer Helps adding a glow effect around a mesh.
  138539. *
  138540. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138541. * glowy meshes to your scene.
  138542. *
  138543. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138544. */
  138545. export class HighlightLayer extends EffectLayer {
  138546. name: string;
  138547. /**
  138548. * Effect Name of the highlight layer.
  138549. */
  138550. static readonly EffectName: string;
  138551. /**
  138552. * The neutral color used during the preparation of the glow effect.
  138553. * This is black by default as the blend operation is a blend operation.
  138554. */
  138555. static NeutralColor: Color4;
  138556. /**
  138557. * Stencil value used for glowing meshes.
  138558. */
  138559. static GlowingMeshStencilReference: number;
  138560. /**
  138561. * Stencil value used for the other meshes in the scene.
  138562. */
  138563. static NormalMeshStencilReference: number;
  138564. /**
  138565. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138566. */
  138567. innerGlow: boolean;
  138568. /**
  138569. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138570. */
  138571. outerGlow: boolean;
  138572. /**
  138573. * Specifies the horizontal size of the blur.
  138574. */
  138575. set blurHorizontalSize(value: number);
  138576. /**
  138577. * Specifies the vertical size of the blur.
  138578. */
  138579. set blurVerticalSize(value: number);
  138580. /**
  138581. * Gets the horizontal size of the blur.
  138582. */
  138583. get blurHorizontalSize(): number;
  138584. /**
  138585. * Gets the vertical size of the blur.
  138586. */
  138587. get blurVerticalSize(): number;
  138588. /**
  138589. * An event triggered when the highlight layer is being blurred.
  138590. */
  138591. onBeforeBlurObservable: Observable<HighlightLayer>;
  138592. /**
  138593. * An event triggered when the highlight layer has been blurred.
  138594. */
  138595. onAfterBlurObservable: Observable<HighlightLayer>;
  138596. private _instanceGlowingMeshStencilReference;
  138597. private _options;
  138598. private _downSamplePostprocess;
  138599. private _horizontalBlurPostprocess;
  138600. private _verticalBlurPostprocess;
  138601. private _blurTexture;
  138602. private _meshes;
  138603. private _excludedMeshes;
  138604. /**
  138605. * Instantiates a new highlight Layer and references it to the scene..
  138606. * @param name The name of the layer
  138607. * @param scene The scene to use the layer in
  138608. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138609. */
  138610. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138611. /**
  138612. * Get the effect name of the layer.
  138613. * @return The effect name
  138614. */
  138615. getEffectName(): string;
  138616. /**
  138617. * Create the merge effect. This is the shader use to blit the information back
  138618. * to the main canvas at the end of the scene rendering.
  138619. */
  138620. protected _createMergeEffect(): Effect;
  138621. /**
  138622. * Creates the render target textures and post processes used in the highlight layer.
  138623. */
  138624. protected _createTextureAndPostProcesses(): void;
  138625. /**
  138626. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138627. */
  138628. needStencil(): boolean;
  138629. /**
  138630. * Checks for the readiness of the element composing the layer.
  138631. * @param subMesh the mesh to check for
  138632. * @param useInstances specify wether or not to use instances to render the mesh
  138633. * @param emissiveTexture the associated emissive texture used to generate the glow
  138634. * @return true if ready otherwise, false
  138635. */
  138636. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138637. /**
  138638. * Implementation specific of rendering the generating effect on the main canvas.
  138639. * @param effect The effect used to render through
  138640. */
  138641. protected _internalRender(effect: Effect): void;
  138642. /**
  138643. * Returns true if the layer contains information to display, otherwise false.
  138644. */
  138645. shouldRender(): boolean;
  138646. /**
  138647. * Returns true if the mesh should render, otherwise false.
  138648. * @param mesh The mesh to render
  138649. * @returns true if it should render otherwise false
  138650. */
  138651. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138652. /**
  138653. * Returns true if the mesh can be rendered, otherwise false.
  138654. * @param mesh The mesh to render
  138655. * @param material The material used on the mesh
  138656. * @returns true if it can be rendered otherwise false
  138657. */
  138658. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138659. /**
  138660. * Adds specific effects defines.
  138661. * @param defines The defines to add specifics to.
  138662. */
  138663. protected _addCustomEffectDefines(defines: string[]): void;
  138664. /**
  138665. * Sets the required values for both the emissive texture and and the main color.
  138666. */
  138667. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138668. /**
  138669. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138670. * @param mesh The mesh to exclude from the highlight layer
  138671. */
  138672. addExcludedMesh(mesh: Mesh): void;
  138673. /**
  138674. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138675. * @param mesh The mesh to highlight
  138676. */
  138677. removeExcludedMesh(mesh: Mesh): void;
  138678. /**
  138679. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138680. * @param mesh mesh to test
  138681. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138682. */
  138683. hasMesh(mesh: AbstractMesh): boolean;
  138684. /**
  138685. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138686. * @param mesh The mesh to highlight
  138687. * @param color The color of the highlight
  138688. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138689. */
  138690. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138691. /**
  138692. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138693. * @param mesh The mesh to highlight
  138694. */
  138695. removeMesh(mesh: Mesh): void;
  138696. /**
  138697. * Remove all the meshes currently referenced in the highlight layer
  138698. */
  138699. removeAllMeshes(): void;
  138700. /**
  138701. * Force the stencil to the normal expected value for none glowing parts
  138702. */
  138703. private _defaultStencilReference;
  138704. /**
  138705. * Free any resources and references associated to a mesh.
  138706. * Internal use
  138707. * @param mesh The mesh to free.
  138708. * @hidden
  138709. */
  138710. _disposeMesh(mesh: Mesh): void;
  138711. /**
  138712. * Dispose the highlight layer and free resources.
  138713. */
  138714. dispose(): void;
  138715. /**
  138716. * Gets the class name of the effect layer
  138717. * @returns the string with the class name of the effect layer
  138718. */
  138719. getClassName(): string;
  138720. /**
  138721. * Serializes this Highlight layer
  138722. * @returns a serialized Highlight layer object
  138723. */
  138724. serialize(): any;
  138725. /**
  138726. * Creates a Highlight layer from parsed Highlight layer data
  138727. * @param parsedHightlightLayer defines the Highlight layer data
  138728. * @param scene defines the current scene
  138729. * @param rootUrl defines the root URL containing the Highlight layer information
  138730. * @returns a parsed Highlight layer
  138731. */
  138732. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138733. }
  138734. }
  138735. declare module BABYLON {
  138736. interface AbstractScene {
  138737. /**
  138738. * The list of layers (background and foreground) of the scene
  138739. */
  138740. layers: Array<Layer>;
  138741. }
  138742. /**
  138743. * Defines the layer scene component responsible to manage any layers
  138744. * in a given scene.
  138745. */
  138746. export class LayerSceneComponent implements ISceneComponent {
  138747. /**
  138748. * The component name helpfull to identify the component in the list of scene components.
  138749. */
  138750. readonly name: string;
  138751. /**
  138752. * The scene the component belongs to.
  138753. */
  138754. scene: Scene;
  138755. private _engine;
  138756. /**
  138757. * Creates a new instance of the component for the given scene
  138758. * @param scene Defines the scene to register the component in
  138759. */
  138760. constructor(scene: Scene);
  138761. /**
  138762. * Registers the component in a given scene
  138763. */
  138764. register(): void;
  138765. /**
  138766. * Rebuilds the elements related to this component in case of
  138767. * context lost for instance.
  138768. */
  138769. rebuild(): void;
  138770. /**
  138771. * Disposes the component and the associated ressources.
  138772. */
  138773. dispose(): void;
  138774. private _draw;
  138775. private _drawCameraPredicate;
  138776. private _drawCameraBackground;
  138777. private _drawCameraForeground;
  138778. private _drawRenderTargetPredicate;
  138779. private _drawRenderTargetBackground;
  138780. private _drawRenderTargetForeground;
  138781. /**
  138782. * Adds all the elements from the container to the scene
  138783. * @param container the container holding the elements
  138784. */
  138785. addFromContainer(container: AbstractScene): void;
  138786. /**
  138787. * Removes all the elements in the container from the scene
  138788. * @param container contains the elements to remove
  138789. * @param dispose if the removed element should be disposed (default: false)
  138790. */
  138791. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138792. }
  138793. }
  138794. declare module BABYLON {
  138795. /** @hidden */
  138796. export var layerPixelShader: {
  138797. name: string;
  138798. shader: string;
  138799. };
  138800. }
  138801. declare module BABYLON {
  138802. /** @hidden */
  138803. export var layerVertexShader: {
  138804. name: string;
  138805. shader: string;
  138806. };
  138807. }
  138808. declare module BABYLON {
  138809. /**
  138810. * This represents a full screen 2d layer.
  138811. * This can be useful to display a picture in the background of your scene for instance.
  138812. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138813. */
  138814. export class Layer {
  138815. /**
  138816. * Define the name of the layer.
  138817. */
  138818. name: string;
  138819. /**
  138820. * Define the texture the layer should display.
  138821. */
  138822. texture: Nullable<Texture>;
  138823. /**
  138824. * Is the layer in background or foreground.
  138825. */
  138826. isBackground: boolean;
  138827. /**
  138828. * Define the color of the layer (instead of texture).
  138829. */
  138830. color: Color4;
  138831. /**
  138832. * Define the scale of the layer in order to zoom in out of the texture.
  138833. */
  138834. scale: Vector2;
  138835. /**
  138836. * Define an offset for the layer in order to shift the texture.
  138837. */
  138838. offset: Vector2;
  138839. /**
  138840. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138841. */
  138842. alphaBlendingMode: number;
  138843. /**
  138844. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138845. * Alpha test will not mix with the background color in case of transparency.
  138846. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138847. */
  138848. alphaTest: boolean;
  138849. /**
  138850. * Define a mask to restrict the layer to only some of the scene cameras.
  138851. */
  138852. layerMask: number;
  138853. /**
  138854. * Define the list of render target the layer is visible into.
  138855. */
  138856. renderTargetTextures: RenderTargetTexture[];
  138857. /**
  138858. * Define if the layer is only used in renderTarget or if it also
  138859. * renders in the main frame buffer of the canvas.
  138860. */
  138861. renderOnlyInRenderTargetTextures: boolean;
  138862. private _scene;
  138863. private _vertexBuffers;
  138864. private _indexBuffer;
  138865. private _effect;
  138866. private _previousDefines;
  138867. /**
  138868. * An event triggered when the layer is disposed.
  138869. */
  138870. onDisposeObservable: Observable<Layer>;
  138871. private _onDisposeObserver;
  138872. /**
  138873. * Back compatibility with callback before the onDisposeObservable existed.
  138874. * The set callback will be triggered when the layer has been disposed.
  138875. */
  138876. set onDispose(callback: () => void);
  138877. /**
  138878. * An event triggered before rendering the scene
  138879. */
  138880. onBeforeRenderObservable: Observable<Layer>;
  138881. private _onBeforeRenderObserver;
  138882. /**
  138883. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138884. * The set callback will be triggered just before rendering the layer.
  138885. */
  138886. set onBeforeRender(callback: () => void);
  138887. /**
  138888. * An event triggered after rendering the scene
  138889. */
  138890. onAfterRenderObservable: Observable<Layer>;
  138891. private _onAfterRenderObserver;
  138892. /**
  138893. * Back compatibility with callback before the onAfterRenderObservable existed.
  138894. * The set callback will be triggered just after rendering the layer.
  138895. */
  138896. set onAfterRender(callback: () => void);
  138897. /**
  138898. * Instantiates a new layer.
  138899. * This represents a full screen 2d layer.
  138900. * This can be useful to display a picture in the background of your scene for instance.
  138901. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138902. * @param name Define the name of the layer in the scene
  138903. * @param imgUrl Define the url of the texture to display in the layer
  138904. * @param scene Define the scene the layer belongs to
  138905. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138906. * @param color Defines a color for the layer
  138907. */
  138908. constructor(
  138909. /**
  138910. * Define the name of the layer.
  138911. */
  138912. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138913. private _createIndexBuffer;
  138914. /** @hidden */
  138915. _rebuild(): void;
  138916. /**
  138917. * Renders the layer in the scene.
  138918. */
  138919. render(): void;
  138920. /**
  138921. * Disposes and releases the associated ressources.
  138922. */
  138923. dispose(): void;
  138924. }
  138925. }
  138926. declare module BABYLON {
  138927. /** @hidden */
  138928. export var lensFlarePixelShader: {
  138929. name: string;
  138930. shader: string;
  138931. };
  138932. }
  138933. declare module BABYLON {
  138934. /** @hidden */
  138935. export var lensFlareVertexShader: {
  138936. name: string;
  138937. shader: string;
  138938. };
  138939. }
  138940. declare module BABYLON {
  138941. /**
  138942. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138943. * It is usually composed of several `lensFlare`.
  138944. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138945. */
  138946. export class LensFlareSystem {
  138947. /**
  138948. * Define the name of the lens flare system
  138949. */
  138950. name: string;
  138951. /**
  138952. * List of lens flares used in this system.
  138953. */
  138954. lensFlares: LensFlare[];
  138955. /**
  138956. * Define a limit from the border the lens flare can be visible.
  138957. */
  138958. borderLimit: number;
  138959. /**
  138960. * Define a viewport border we do not want to see the lens flare in.
  138961. */
  138962. viewportBorder: number;
  138963. /**
  138964. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138965. */
  138966. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138967. /**
  138968. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138969. */
  138970. layerMask: number;
  138971. /**
  138972. * Define the id of the lens flare system in the scene.
  138973. * (equal to name by default)
  138974. */
  138975. id: string;
  138976. private _scene;
  138977. private _emitter;
  138978. private _vertexBuffers;
  138979. private _indexBuffer;
  138980. private _effect;
  138981. private _positionX;
  138982. private _positionY;
  138983. private _isEnabled;
  138984. /** @hidden */
  138985. static _SceneComponentInitialization: (scene: Scene) => void;
  138986. /**
  138987. * Instantiates a lens flare system.
  138988. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138989. * It is usually composed of several `lensFlare`.
  138990. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138991. * @param name Define the name of the lens flare system in the scene
  138992. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138993. * @param scene Define the scene the lens flare system belongs to
  138994. */
  138995. constructor(
  138996. /**
  138997. * Define the name of the lens flare system
  138998. */
  138999. name: string, emitter: any, scene: Scene);
  139000. /**
  139001. * Define if the lens flare system is enabled.
  139002. */
  139003. get isEnabled(): boolean;
  139004. set isEnabled(value: boolean);
  139005. /**
  139006. * Get the scene the effects belongs to.
  139007. * @returns the scene holding the lens flare system
  139008. */
  139009. getScene(): Scene;
  139010. /**
  139011. * Get the emitter of the lens flare system.
  139012. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139013. * @returns the emitter of the lens flare system
  139014. */
  139015. getEmitter(): any;
  139016. /**
  139017. * Set the emitter of the lens flare system.
  139018. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139019. * @param newEmitter Define the new emitter of the system
  139020. */
  139021. setEmitter(newEmitter: any): void;
  139022. /**
  139023. * Get the lens flare system emitter position.
  139024. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  139025. * @returns the position
  139026. */
  139027. getEmitterPosition(): Vector3;
  139028. /**
  139029. * @hidden
  139030. */
  139031. computeEffectivePosition(globalViewport: Viewport): boolean;
  139032. /** @hidden */
  139033. _isVisible(): boolean;
  139034. /**
  139035. * @hidden
  139036. */
  139037. render(): boolean;
  139038. /**
  139039. * Dispose and release the lens flare with its associated resources.
  139040. */
  139041. dispose(): void;
  139042. /**
  139043. * Parse a lens flare system from a JSON repressentation
  139044. * @param parsedLensFlareSystem Define the JSON to parse
  139045. * @param scene Define the scene the parsed system should be instantiated in
  139046. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  139047. * @returns the parsed system
  139048. */
  139049. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  139050. /**
  139051. * Serialize the current Lens Flare System into a JSON representation.
  139052. * @returns the serialized JSON
  139053. */
  139054. serialize(): any;
  139055. }
  139056. }
  139057. declare module BABYLON {
  139058. /**
  139059. * This represents one of the lens effect in a `lensFlareSystem`.
  139060. * It controls one of the indiviual texture used in the effect.
  139061. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139062. */
  139063. export class LensFlare {
  139064. /**
  139065. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139066. */
  139067. size: number;
  139068. /**
  139069. * 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.
  139070. */
  139071. position: number;
  139072. /**
  139073. * Define the lens color.
  139074. */
  139075. color: Color3;
  139076. /**
  139077. * Define the lens texture.
  139078. */
  139079. texture: Nullable<Texture>;
  139080. /**
  139081. * Define the alpha mode to render this particular lens.
  139082. */
  139083. alphaMode: number;
  139084. private _system;
  139085. /**
  139086. * Creates a new Lens Flare.
  139087. * This represents one of the lens effect in a `lensFlareSystem`.
  139088. * It controls one of the indiviual texture used in the effect.
  139089. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139090. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  139091. * @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.
  139092. * @param color Define the lens color
  139093. * @param imgUrl Define the lens texture url
  139094. * @param system Define the `lensFlareSystem` this flare is part of
  139095. * @returns The newly created Lens Flare
  139096. */
  139097. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  139098. /**
  139099. * Instantiates a new Lens Flare.
  139100. * This represents one of the lens effect in a `lensFlareSystem`.
  139101. * It controls one of the indiviual texture used in the effect.
  139102. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139103. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  139104. * @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.
  139105. * @param color Define the lens color
  139106. * @param imgUrl Define the lens texture url
  139107. * @param system Define the `lensFlareSystem` this flare is part of
  139108. */
  139109. constructor(
  139110. /**
  139111. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139112. */
  139113. size: number,
  139114. /**
  139115. * 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.
  139116. */
  139117. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  139118. /**
  139119. * Dispose and release the lens flare with its associated resources.
  139120. */
  139121. dispose(): void;
  139122. }
  139123. }
  139124. declare module BABYLON {
  139125. interface AbstractScene {
  139126. /**
  139127. * The list of lens flare system added to the scene
  139128. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139129. */
  139130. lensFlareSystems: Array<LensFlareSystem>;
  139131. /**
  139132. * Removes the given lens flare system from this scene.
  139133. * @param toRemove The lens flare system to remove
  139134. * @returns The index of the removed lens flare system
  139135. */
  139136. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  139137. /**
  139138. * Adds the given lens flare system to this scene
  139139. * @param newLensFlareSystem The lens flare system to add
  139140. */
  139141. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  139142. /**
  139143. * Gets a lens flare system using its name
  139144. * @param name defines the name to look for
  139145. * @returns the lens flare system or null if not found
  139146. */
  139147. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  139148. /**
  139149. * Gets a lens flare system using its id
  139150. * @param id defines the id to look for
  139151. * @returns the lens flare system or null if not found
  139152. */
  139153. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  139154. }
  139155. /**
  139156. * Defines the lens flare scene component responsible to manage any lens flares
  139157. * in a given scene.
  139158. */
  139159. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  139160. /**
  139161. * The component name helpfull to identify the component in the list of scene components.
  139162. */
  139163. readonly name: string;
  139164. /**
  139165. * The scene the component belongs to.
  139166. */
  139167. scene: Scene;
  139168. /**
  139169. * Creates a new instance of the component for the given scene
  139170. * @param scene Defines the scene to register the component in
  139171. */
  139172. constructor(scene: Scene);
  139173. /**
  139174. * Registers the component in a given scene
  139175. */
  139176. register(): void;
  139177. /**
  139178. * Rebuilds the elements related to this component in case of
  139179. * context lost for instance.
  139180. */
  139181. rebuild(): void;
  139182. /**
  139183. * Adds all the elements from the container to the scene
  139184. * @param container the container holding the elements
  139185. */
  139186. addFromContainer(container: AbstractScene): void;
  139187. /**
  139188. * Removes all the elements in the container from the scene
  139189. * @param container contains the elements to remove
  139190. * @param dispose if the removed element should be disposed (default: false)
  139191. */
  139192. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139193. /**
  139194. * Serializes the component data to the specified json object
  139195. * @param serializationObject The object to serialize to
  139196. */
  139197. serialize(serializationObject: any): void;
  139198. /**
  139199. * Disposes the component and the associated ressources.
  139200. */
  139201. dispose(): void;
  139202. private _draw;
  139203. }
  139204. }
  139205. declare module BABYLON {
  139206. /** @hidden */
  139207. export var depthPixelShader: {
  139208. name: string;
  139209. shader: string;
  139210. };
  139211. }
  139212. declare module BABYLON {
  139213. /** @hidden */
  139214. export var depthVertexShader: {
  139215. name: string;
  139216. shader: string;
  139217. };
  139218. }
  139219. declare module BABYLON {
  139220. /**
  139221. * This represents a depth renderer in Babylon.
  139222. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139223. */
  139224. export class DepthRenderer {
  139225. private _scene;
  139226. private _depthMap;
  139227. private _effect;
  139228. private readonly _storeNonLinearDepth;
  139229. private readonly _clearColor;
  139230. /** Get if the depth renderer is using packed depth or not */
  139231. readonly isPacked: boolean;
  139232. private _cachedDefines;
  139233. private _camera;
  139234. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139235. enabled: boolean;
  139236. /**
  139237. * Specifiess that the depth renderer will only be used within
  139238. * the camera it is created for.
  139239. * This can help forcing its rendering during the camera processing.
  139240. */
  139241. useOnlyInActiveCamera: boolean;
  139242. /** @hidden */
  139243. static _SceneComponentInitialization: (scene: Scene) => void;
  139244. /**
  139245. * Instantiates a depth renderer
  139246. * @param scene The scene the renderer belongs to
  139247. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139248. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139249. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139250. */
  139251. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139252. /**
  139253. * Creates the depth rendering effect and checks if the effect is ready.
  139254. * @param subMesh The submesh to be used to render the depth map of
  139255. * @param useInstances If multiple world instances should be used
  139256. * @returns if the depth renderer is ready to render the depth map
  139257. */
  139258. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139259. /**
  139260. * Gets the texture which the depth map will be written to.
  139261. * @returns The depth map texture
  139262. */
  139263. getDepthMap(): RenderTargetTexture;
  139264. /**
  139265. * Disposes of the depth renderer.
  139266. */
  139267. dispose(): void;
  139268. }
  139269. }
  139270. declare module BABYLON {
  139271. /** @hidden */
  139272. export var minmaxReduxPixelShader: {
  139273. name: string;
  139274. shader: string;
  139275. };
  139276. }
  139277. declare module BABYLON {
  139278. /**
  139279. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139280. * and maximum values from all values of the texture.
  139281. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139282. * The source values are read from the red channel of the texture.
  139283. */
  139284. export class MinMaxReducer {
  139285. /**
  139286. * Observable triggered when the computation has been performed
  139287. */
  139288. onAfterReductionPerformed: Observable<{
  139289. min: number;
  139290. max: number;
  139291. }>;
  139292. protected _camera: Camera;
  139293. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139294. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139295. protected _postProcessManager: PostProcessManager;
  139296. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139297. protected _forceFullscreenViewport: boolean;
  139298. /**
  139299. * Creates a min/max reducer
  139300. * @param camera The camera to use for the post processes
  139301. */
  139302. constructor(camera: Camera);
  139303. /**
  139304. * Gets the texture used to read the values from.
  139305. */
  139306. get sourceTexture(): Nullable<RenderTargetTexture>;
  139307. /**
  139308. * Sets the source texture to read the values from.
  139309. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139310. * because in such textures '1' value must not be taken into account to compute the maximum
  139311. * as this value is used to clear the texture.
  139312. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139313. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139314. * @param depthRedux Indicates if the texture is a depth texture or not
  139315. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139316. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139317. */
  139318. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139319. /**
  139320. * Defines the refresh rate of the computation.
  139321. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139322. */
  139323. get refreshRate(): number;
  139324. set refreshRate(value: number);
  139325. protected _activated: boolean;
  139326. /**
  139327. * Gets the activation status of the reducer
  139328. */
  139329. get activated(): boolean;
  139330. /**
  139331. * Activates the reduction computation.
  139332. * When activated, the observers registered in onAfterReductionPerformed are
  139333. * called after the compuation is performed
  139334. */
  139335. activate(): void;
  139336. /**
  139337. * Deactivates the reduction computation.
  139338. */
  139339. deactivate(): void;
  139340. /**
  139341. * Disposes the min/max reducer
  139342. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  139343. */
  139344. dispose(disposeAll?: boolean): void;
  139345. }
  139346. }
  139347. declare module BABYLON {
  139348. /**
  139349. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139350. */
  139351. export class DepthReducer extends MinMaxReducer {
  139352. private _depthRenderer;
  139353. private _depthRendererId;
  139354. /**
  139355. * Gets the depth renderer used for the computation.
  139356. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139357. */
  139358. get depthRenderer(): Nullable<DepthRenderer>;
  139359. /**
  139360. * Creates a depth reducer
  139361. * @param camera The camera used to render the depth texture
  139362. */
  139363. constructor(camera: Camera);
  139364. /**
  139365. * Sets the depth renderer to use to generate the depth map
  139366. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139367. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139368. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139369. */
  139370. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139371. /** @hidden */
  139372. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139373. /**
  139374. * Activates the reduction computation.
  139375. * When activated, the observers registered in onAfterReductionPerformed are
  139376. * called after the compuation is performed
  139377. */
  139378. activate(): void;
  139379. /**
  139380. * Deactivates the reduction computation.
  139381. */
  139382. deactivate(): void;
  139383. /**
  139384. * Disposes the depth reducer
  139385. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  139386. */
  139387. dispose(disposeAll?: boolean): void;
  139388. }
  139389. }
  139390. declare module BABYLON {
  139391. /**
  139392. * A CSM implementation allowing casting shadows on large scenes.
  139393. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139394. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139395. */
  139396. export class CascadedShadowGenerator extends ShadowGenerator {
  139397. private static readonly frustumCornersNDCSpace;
  139398. /**
  139399. * Name of the CSM class
  139400. */
  139401. static CLASSNAME: string;
  139402. /**
  139403. * Defines the default number of cascades used by the CSM.
  139404. */
  139405. static readonly DEFAULT_CASCADES_COUNT: number;
  139406. /**
  139407. * Defines the minimum number of cascades used by the CSM.
  139408. */
  139409. static readonly MIN_CASCADES_COUNT: number;
  139410. /**
  139411. * Defines the maximum number of cascades used by the CSM.
  139412. */
  139413. static readonly MAX_CASCADES_COUNT: number;
  139414. protected _validateFilter(filter: number): number;
  139415. /**
  139416. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139417. */
  139418. penumbraDarkness: number;
  139419. private _numCascades;
  139420. /**
  139421. * Gets or set the number of cascades used by the CSM.
  139422. */
  139423. get numCascades(): number;
  139424. set numCascades(value: number);
  139425. /**
  139426. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139427. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139428. */
  139429. stabilizeCascades: boolean;
  139430. private _freezeShadowCastersBoundingInfo;
  139431. private _freezeShadowCastersBoundingInfoObservable;
  139432. /**
  139433. * Enables or disables the shadow casters bounding info computation.
  139434. * If your shadow casters don't move, you can disable this feature.
  139435. * If it is enabled, the bounding box computation is done every frame.
  139436. */
  139437. get freezeShadowCastersBoundingInfo(): boolean;
  139438. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139439. private _scbiMin;
  139440. private _scbiMax;
  139441. protected _computeShadowCastersBoundingInfo(): void;
  139442. protected _shadowCastersBoundingInfo: BoundingInfo;
  139443. /**
  139444. * Gets or sets the shadow casters bounding info.
  139445. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139446. * so that the system won't overwrite the bounds you provide
  139447. */
  139448. get shadowCastersBoundingInfo(): BoundingInfo;
  139449. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139450. protected _breaksAreDirty: boolean;
  139451. protected _minDistance: number;
  139452. protected _maxDistance: number;
  139453. /**
  139454. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139455. *
  139456. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139457. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139458. * @param min minimal distance for the breaks (default to 0.)
  139459. * @param max maximal distance for the breaks (default to 1.)
  139460. */
  139461. setMinMaxDistance(min: number, max: number): void;
  139462. /** Gets the minimal distance used in the cascade break computation */
  139463. get minDistance(): number;
  139464. /** Gets the maximal distance used in the cascade break computation */
  139465. get maxDistance(): number;
  139466. /**
  139467. * Gets the class name of that object
  139468. * @returns "CascadedShadowGenerator"
  139469. */
  139470. getClassName(): string;
  139471. private _cascadeMinExtents;
  139472. private _cascadeMaxExtents;
  139473. /**
  139474. * Gets a cascade minimum extents
  139475. * @param cascadeIndex index of the cascade
  139476. * @returns the minimum cascade extents
  139477. */
  139478. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139479. /**
  139480. * Gets a cascade maximum extents
  139481. * @param cascadeIndex index of the cascade
  139482. * @returns the maximum cascade extents
  139483. */
  139484. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139485. private _cascades;
  139486. private _currentLayer;
  139487. private _viewSpaceFrustumsZ;
  139488. private _viewMatrices;
  139489. private _projectionMatrices;
  139490. private _transformMatrices;
  139491. private _transformMatricesAsArray;
  139492. private _frustumLengths;
  139493. private _lightSizeUVCorrection;
  139494. private _depthCorrection;
  139495. private _frustumCornersWorldSpace;
  139496. private _frustumCenter;
  139497. private _shadowCameraPos;
  139498. private _shadowMaxZ;
  139499. /**
  139500. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139501. * It defaults to camera.maxZ
  139502. */
  139503. get shadowMaxZ(): number;
  139504. /**
  139505. * Sets the shadow max z distance.
  139506. */
  139507. set shadowMaxZ(value: number);
  139508. protected _debug: boolean;
  139509. /**
  139510. * Gets or sets the debug flag.
  139511. * When enabled, the cascades are materialized by different colors on the screen.
  139512. */
  139513. get debug(): boolean;
  139514. set debug(dbg: boolean);
  139515. private _depthClamp;
  139516. /**
  139517. * Gets or sets the depth clamping value.
  139518. *
  139519. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139520. * to account for the shadow casters far away.
  139521. *
  139522. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139523. */
  139524. get depthClamp(): boolean;
  139525. set depthClamp(value: boolean);
  139526. private _cascadeBlendPercentage;
  139527. /**
  139528. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139529. * It defaults to 0.1 (10% blending).
  139530. */
  139531. get cascadeBlendPercentage(): number;
  139532. set cascadeBlendPercentage(value: number);
  139533. private _lambda;
  139534. /**
  139535. * Gets or set the lambda parameter.
  139536. * This parameter is used to split the camera frustum and create the cascades.
  139537. * It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split.
  139538. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139539. */
  139540. get lambda(): number;
  139541. set lambda(value: number);
  139542. /**
  139543. * Gets the view matrix corresponding to a given cascade
  139544. * @param cascadeNum cascade to retrieve the view matrix from
  139545. * @returns the cascade view matrix
  139546. */
  139547. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139548. /**
  139549. * Gets the projection matrix corresponding to a given cascade
  139550. * @param cascadeNum cascade to retrieve the projection matrix from
  139551. * @returns the cascade projection matrix
  139552. */
  139553. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139554. /**
  139555. * Gets the transformation matrix corresponding to a given cascade
  139556. * @param cascadeNum cascade to retrieve the transformation matrix from
  139557. * @returns the cascade transformation matrix
  139558. */
  139559. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139560. private _depthRenderer;
  139561. /**
  139562. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139563. *
  139564. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139565. *
  139566. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139567. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139568. * @param depthRenderer The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created
  139569. */
  139570. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139571. private _depthReducer;
  139572. private _autoCalcDepthBounds;
  139573. /**
  139574. * Gets or sets the autoCalcDepthBounds property.
  139575. *
  139576. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139577. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139578. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139579. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139580. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139581. */
  139582. get autoCalcDepthBounds(): boolean;
  139583. set autoCalcDepthBounds(value: boolean);
  139584. /**
  139585. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139586. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139587. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139588. * for setting the refresh rate on the renderer yourself!
  139589. */
  139590. get autoCalcDepthBoundsRefreshRate(): number;
  139591. set autoCalcDepthBoundsRefreshRate(value: number);
  139592. /**
  139593. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139594. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139595. * you change the camera near/far planes!
  139596. */
  139597. splitFrustum(): void;
  139598. private _splitFrustum;
  139599. private _computeMatrices;
  139600. private _computeFrustumInWorldSpace;
  139601. private _computeCascadeFrustum;
  139602. /**
  139603. * Support test.
  139604. */
  139605. static get IsSupported(): boolean;
  139606. /** @hidden */
  139607. static _SceneComponentInitialization: (scene: Scene) => void;
  139608. /**
  139609. * Creates a Cascaded Shadow Generator object.
  139610. * A ShadowGenerator is the required tool to use the shadows.
  139611. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139612. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139613. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139614. * @param light The directional light object generating the shadows.
  139615. * @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.
  139616. */
  139617. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139618. protected _initializeGenerator(): void;
  139619. protected _createTargetRenderTexture(): void;
  139620. protected _initializeShadowMap(): void;
  139621. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139622. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139623. /**
  139624. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139625. * @param defines Defines of the material we want to update
  139626. * @param lightIndex Index of the light in the enabled light list of the material
  139627. */
  139628. prepareDefines(defines: any, lightIndex: number): void;
  139629. /**
  139630. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139631. * defined in the generator but impacting the effect).
  139632. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139633. * @param effect The effect we are binfing the information for
  139634. */
  139635. bindShadowLight(lightIndex: string, effect: Effect): void;
  139636. /**
  139637. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139638. * (eq to view projection * shadow projection matrices)
  139639. * @returns The transform matrix used to create the shadow map
  139640. */
  139641. getTransformMatrix(): Matrix;
  139642. /**
  139643. * Disposes the ShadowGenerator.
  139644. * Returns nothing.
  139645. */
  139646. dispose(): void;
  139647. /**
  139648. * Serializes the shadow generator setup to a json object.
  139649. * @returns The serialized JSON object
  139650. */
  139651. serialize(): any;
  139652. /**
  139653. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139654. * @param parsedShadowGenerator The JSON object to parse
  139655. * @param scene The scene to create the shadow map for
  139656. * @returns The parsed shadow generator
  139657. */
  139658. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139659. }
  139660. }
  139661. declare module BABYLON {
  139662. /**
  139663. * Defines the shadow generator component responsible to manage any shadow generators
  139664. * in a given scene.
  139665. */
  139666. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139667. /**
  139668. * The component name helpfull to identify the component in the list of scene components.
  139669. */
  139670. readonly name: string;
  139671. /**
  139672. * The scene the component belongs to.
  139673. */
  139674. scene: Scene;
  139675. /**
  139676. * Creates a new instance of the component for the given scene
  139677. * @param scene Defines the scene to register the component in
  139678. */
  139679. constructor(scene: Scene);
  139680. /**
  139681. * Registers the component in a given scene
  139682. */
  139683. register(): void;
  139684. /**
  139685. * Rebuilds the elements related to this component in case of
  139686. * context lost for instance.
  139687. */
  139688. rebuild(): void;
  139689. /**
  139690. * Serializes the component data to the specified json object
  139691. * @param serializationObject The object to serialize to
  139692. */
  139693. serialize(serializationObject: any): void;
  139694. /**
  139695. * Adds all the elements from the container to the scene
  139696. * @param container the container holding the elements
  139697. */
  139698. addFromContainer(container: AbstractScene): void;
  139699. /**
  139700. * Removes all the elements in the container from the scene
  139701. * @param container contains the elements to remove
  139702. * @param dispose if the removed element should be disposed (default: false)
  139703. */
  139704. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139705. /**
  139706. * Rebuilds the elements related to this component in case of
  139707. * context lost for instance.
  139708. */
  139709. dispose(): void;
  139710. private _gatherRenderTargets;
  139711. }
  139712. }
  139713. declare module BABYLON {
  139714. /**
  139715. * A point light is a light defined by an unique point in world space.
  139716. * The light is emitted in every direction from this point.
  139717. * A good example of a point light is a standard light bulb.
  139718. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139719. */
  139720. export class PointLight extends ShadowLight {
  139721. private _shadowAngle;
  139722. /**
  139723. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139724. * This specifies what angle the shadow will use to be created.
  139725. *
  139726. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139727. */
  139728. get shadowAngle(): number;
  139729. /**
  139730. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139731. * This specifies what angle the shadow will use to be created.
  139732. *
  139733. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139734. */
  139735. set shadowAngle(value: number);
  139736. /**
  139737. * Gets the direction if it has been set.
  139738. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139739. */
  139740. get direction(): Vector3;
  139741. /**
  139742. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139743. */
  139744. set direction(value: Vector3);
  139745. /**
  139746. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139747. * A PointLight emits the light in every direction.
  139748. * It can cast shadows.
  139749. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139750. * ```javascript
  139751. * var pointLight = new PointLight("pl", camera.position, scene);
  139752. * ```
  139753. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139754. * @param name The light friendly name
  139755. * @param position The position of the point light in the scene
  139756. * @param scene The scene the lights belongs to
  139757. */
  139758. constructor(name: string, position: Vector3, scene: Scene);
  139759. /**
  139760. * Returns the string "PointLight"
  139761. * @returns the class name
  139762. */
  139763. getClassName(): string;
  139764. /**
  139765. * Returns the integer 0.
  139766. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139767. */
  139768. getTypeID(): number;
  139769. /**
  139770. * Specifies wether or not the shadowmap should be a cube texture.
  139771. * @returns true if the shadowmap needs to be a cube texture.
  139772. */
  139773. needCube(): boolean;
  139774. /**
  139775. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139776. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139777. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139778. */
  139779. getShadowDirection(faceIndex?: number): Vector3;
  139780. /**
  139781. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139782. * - fov = PI / 2
  139783. * - aspect ratio : 1.0
  139784. * - z-near and far equal to the active camera minZ and maxZ.
  139785. * Returns the PointLight.
  139786. */
  139787. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139788. protected _buildUniformLayout(): void;
  139789. /**
  139790. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139791. * @param effect The effect to update
  139792. * @param lightIndex The index of the light in the effect to update
  139793. * @returns The point light
  139794. */
  139795. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139796. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139797. /**
  139798. * Prepares the list of defines specific to the light type.
  139799. * @param defines the list of defines
  139800. * @param lightIndex defines the index of the light for the effect
  139801. */
  139802. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139803. }
  139804. }
  139805. declare module BABYLON {
  139806. /**
  139807. * Header information of HDR texture files.
  139808. */
  139809. export interface HDRInfo {
  139810. /**
  139811. * The height of the texture in pixels.
  139812. */
  139813. height: number;
  139814. /**
  139815. * The width of the texture in pixels.
  139816. */
  139817. width: number;
  139818. /**
  139819. * The index of the beginning of the data in the binary file.
  139820. */
  139821. dataPosition: number;
  139822. }
  139823. /**
  139824. * This groups tools to convert HDR texture to native colors array.
  139825. */
  139826. export class HDRTools {
  139827. private static Ldexp;
  139828. private static Rgbe2float;
  139829. private static readStringLine;
  139830. /**
  139831. * Reads header information from an RGBE texture stored in a native array.
  139832. * More information on this format are available here:
  139833. * https://en.wikipedia.org/wiki/RGBE_image_format
  139834. *
  139835. * @param uint8array The binary file stored in native array.
  139836. * @return The header information.
  139837. */
  139838. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139839. /**
  139840. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139841. * This RGBE texture needs to store the information as a panorama.
  139842. *
  139843. * More information on this format are available here:
  139844. * https://en.wikipedia.org/wiki/RGBE_image_format
  139845. *
  139846. * @param buffer The binary file stored in an array buffer.
  139847. * @param size The expected size of the extracted cubemap.
  139848. * @return The Cube Map information.
  139849. */
  139850. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139851. /**
  139852. * Returns the pixels data extracted from an RGBE texture.
  139853. * This pixels will be stored left to right up to down in the R G B order in one array.
  139854. *
  139855. * More information on this format are available here:
  139856. * https://en.wikipedia.org/wiki/RGBE_image_format
  139857. *
  139858. * @param uint8array The binary file stored in an array buffer.
  139859. * @param hdrInfo The header information of the file.
  139860. * @return The pixels data in RGB right to left up to down order.
  139861. */
  139862. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139863. private static RGBE_ReadPixels_RLE;
  139864. private static RGBE_ReadPixels_NOT_RLE;
  139865. }
  139866. }
  139867. declare module BABYLON {
  139868. /**
  139869. * Effect Render Options
  139870. */
  139871. export interface IEffectRendererOptions {
  139872. /**
  139873. * Defines the vertices positions.
  139874. */
  139875. positions?: number[];
  139876. /**
  139877. * Defines the indices.
  139878. */
  139879. indices?: number[];
  139880. }
  139881. /**
  139882. * Helper class to render one or more effects.
  139883. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139884. */
  139885. export class EffectRenderer {
  139886. private engine;
  139887. private static _DefaultOptions;
  139888. private _vertexBuffers;
  139889. private _indexBuffer;
  139890. private _fullscreenViewport;
  139891. /**
  139892. * Creates an effect renderer
  139893. * @param engine the engine to use for rendering
  139894. * @param options defines the options of the effect renderer
  139895. */
  139896. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139897. /**
  139898. * Sets the current viewport in normalized coordinates 0-1
  139899. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139900. */
  139901. setViewport(viewport?: Viewport): void;
  139902. /**
  139903. * Binds the embedded attributes buffer to the effect.
  139904. * @param effect Defines the effect to bind the attributes for
  139905. */
  139906. bindBuffers(effect: Effect): void;
  139907. /**
  139908. * Sets the current effect wrapper to use during draw.
  139909. * The effect needs to be ready before calling this api.
  139910. * This also sets the default full screen position attribute.
  139911. * @param effectWrapper Defines the effect to draw with
  139912. */
  139913. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139914. /**
  139915. * Restores engine states
  139916. */
  139917. restoreStates(): void;
  139918. /**
  139919. * Draws a full screen quad.
  139920. */
  139921. draw(): void;
  139922. private isRenderTargetTexture;
  139923. /**
  139924. * renders one or more effects to a specified texture
  139925. * @param effectWrapper the effect to renderer
  139926. * @param outputTexture texture to draw to, if null it will render to the screen.
  139927. */
  139928. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139929. /**
  139930. * Disposes of the effect renderer
  139931. */
  139932. dispose(): void;
  139933. }
  139934. /**
  139935. * Options to create an EffectWrapper
  139936. */
  139937. interface EffectWrapperCreationOptions {
  139938. /**
  139939. * Engine to use to create the effect
  139940. */
  139941. engine: ThinEngine;
  139942. /**
  139943. * Fragment shader for the effect
  139944. */
  139945. fragmentShader: string;
  139946. /**
  139947. * Use the shader store instead of direct source code
  139948. */
  139949. useShaderStore?: boolean;
  139950. /**
  139951. * Vertex shader for the effect
  139952. */
  139953. vertexShader?: string;
  139954. /**
  139955. * Attributes to use in the shader
  139956. */
  139957. attributeNames?: Array<string>;
  139958. /**
  139959. * Uniforms to use in the shader
  139960. */
  139961. uniformNames?: Array<string>;
  139962. /**
  139963. * Texture sampler names to use in the shader
  139964. */
  139965. samplerNames?: Array<string>;
  139966. /**
  139967. * Defines to use in the shader
  139968. */
  139969. defines?: Array<string>;
  139970. /**
  139971. * Callback when effect is compiled
  139972. */
  139973. onCompiled?: Nullable<(effect: Effect) => void>;
  139974. /**
  139975. * The friendly name of the effect displayed in Spector.
  139976. */
  139977. name?: string;
  139978. }
  139979. /**
  139980. * Wraps an effect to be used for rendering
  139981. */
  139982. export class EffectWrapper {
  139983. /**
  139984. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139985. */
  139986. onApplyObservable: Observable<{}>;
  139987. /**
  139988. * The underlying effect
  139989. */
  139990. effect: Effect;
  139991. /**
  139992. * Creates an effect to be renderer
  139993. * @param creationOptions options to create the effect
  139994. */
  139995. constructor(creationOptions: EffectWrapperCreationOptions);
  139996. /**
  139997. * Disposes of the effect wrapper
  139998. */
  139999. dispose(): void;
  140000. }
  140001. }
  140002. declare module BABYLON {
  140003. /** @hidden */
  140004. export var hdrFilteringVertexShader: {
  140005. name: string;
  140006. shader: string;
  140007. };
  140008. }
  140009. declare module BABYLON {
  140010. /** @hidden */
  140011. export var hdrFilteringPixelShader: {
  140012. name: string;
  140013. shader: string;
  140014. };
  140015. }
  140016. declare module BABYLON {
  140017. /**
  140018. * Options for texture filtering
  140019. */
  140020. interface IHDRFilteringOptions {
  140021. /**
  140022. * Scales pixel intensity for the input HDR map.
  140023. */
  140024. hdrScale?: number;
  140025. /**
  140026. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  140027. */
  140028. quality?: number;
  140029. }
  140030. /**
  140031. * Filters HDR maps to get correct renderings of PBR reflections
  140032. */
  140033. export class HDRFiltering {
  140034. private _engine;
  140035. private _effectRenderer;
  140036. private _effectWrapper;
  140037. private _lodGenerationOffset;
  140038. private _lodGenerationScale;
  140039. /**
  140040. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  140041. * you care about baking speed.
  140042. */
  140043. quality: number;
  140044. /**
  140045. * Scales pixel intensity for the input HDR map.
  140046. */
  140047. hdrScale: number;
  140048. /**
  140049. * Instantiates HDR filter for reflection maps
  140050. *
  140051. * @param engine Thin engine
  140052. * @param options Options
  140053. */
  140054. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  140055. private _createRenderTarget;
  140056. private _prefilterInternal;
  140057. private _createEffect;
  140058. /**
  140059. * Get a value indicating if the filter is ready to be used
  140060. * @param texture Texture to filter
  140061. * @returns true if the filter is ready
  140062. */
  140063. isReady(texture: BaseTexture): boolean;
  140064. /**
  140065. * Prefilters a cube texture to have mipmap levels representing roughness values.
  140066. * Prefiltering will be invoked at the end of next rendering pass.
  140067. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  140068. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  140069. * @param texture Texture to filter
  140070. * @param onFinished Callback when filtering is done
  140071. * @return Promise called when prefiltering is done
  140072. */
  140073. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  140074. }
  140075. }
  140076. declare module BABYLON {
  140077. /**
  140078. * This represents a texture coming from an HDR input.
  140079. *
  140080. * The only supported format is currently panorama picture stored in RGBE format.
  140081. * Example of such files can be found on HDRLib: http://hdrlib.com/
  140082. */
  140083. export class HDRCubeTexture extends BaseTexture {
  140084. private static _facesMapping;
  140085. private _generateHarmonics;
  140086. private _noMipmap;
  140087. private _prefilterOnLoad;
  140088. private _textureMatrix;
  140089. private _size;
  140090. private _onLoad;
  140091. private _onError;
  140092. /**
  140093. * The texture URL.
  140094. */
  140095. url: string;
  140096. protected _isBlocking: boolean;
  140097. /**
  140098. * Sets wether or not the texture is blocking during loading.
  140099. */
  140100. set isBlocking(value: boolean);
  140101. /**
  140102. * Gets wether or not the texture is blocking during loading.
  140103. */
  140104. get isBlocking(): boolean;
  140105. protected _rotationY: number;
  140106. /**
  140107. * Sets texture matrix rotation angle around Y axis in radians.
  140108. */
  140109. set rotationY(value: number);
  140110. /**
  140111. * Gets texture matrix rotation angle around Y axis radians.
  140112. */
  140113. get rotationY(): number;
  140114. /**
  140115. * Gets or sets the center of the bounding box associated with the cube texture
  140116. * It must define where the camera used to render the texture was set
  140117. */
  140118. boundingBoxPosition: Vector3;
  140119. private _boundingBoxSize;
  140120. /**
  140121. * Gets or sets the size of the bounding box associated with the cube texture
  140122. * When defined, the cubemap will switch to local mode
  140123. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  140124. * @example https://www.babylonjs-playground.com/#RNASML
  140125. */
  140126. set boundingBoxSize(value: Vector3);
  140127. get boundingBoxSize(): Vector3;
  140128. /**
  140129. * Instantiates an HDRTexture from the following parameters.
  140130. *
  140131. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  140132. * @param sceneOrEngine The scene or engine the texture will be used in
  140133. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140134. * @param noMipmap Forces to not generate the mipmap if true
  140135. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  140136. * @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)
  140137. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  140138. */
  140139. constructor(url: string, sceneOrEngine: Scene | ThinEngine, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, prefilterOnLoad?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  140140. /**
  140141. * Get the current class name of the texture useful for serialization or dynamic coding.
  140142. * @returns "HDRCubeTexture"
  140143. */
  140144. getClassName(): string;
  140145. /**
  140146. * Occurs when the file is raw .hdr file.
  140147. */
  140148. private loadTexture;
  140149. clone(): HDRCubeTexture;
  140150. delayLoad(): void;
  140151. /**
  140152. * Get the texture reflection matrix used to rotate/transform the reflection.
  140153. * @returns the reflection matrix
  140154. */
  140155. getReflectionTextureMatrix(): Matrix;
  140156. /**
  140157. * Set the texture reflection matrix used to rotate/transform the reflection.
  140158. * @param value Define the reflection matrix to set
  140159. */
  140160. setReflectionTextureMatrix(value: Matrix): void;
  140161. /**
  140162. * Parses a JSON representation of an HDR Texture in order to create the texture
  140163. * @param parsedTexture Define the JSON representation
  140164. * @param scene Define the scene the texture should be created in
  140165. * @param rootUrl Define the root url in case we need to load relative dependencies
  140166. * @returns the newly created texture after parsing
  140167. */
  140168. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140169. serialize(): any;
  140170. }
  140171. }
  140172. declare module BABYLON {
  140173. /**
  140174. * Class used to control physics engine
  140175. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140176. */
  140177. export class PhysicsEngine implements IPhysicsEngine {
  140178. private _physicsPlugin;
  140179. /**
  140180. * Global value used to control the smallest number supported by the simulation
  140181. */
  140182. static Epsilon: number;
  140183. private _impostors;
  140184. private _joints;
  140185. private _subTimeStep;
  140186. /**
  140187. * Gets the gravity vector used by the simulation
  140188. */
  140189. gravity: Vector3;
  140190. /**
  140191. * Factory used to create the default physics plugin.
  140192. * @returns The default physics plugin
  140193. */
  140194. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140195. /**
  140196. * Creates a new Physics Engine
  140197. * @param gravity defines the gravity vector used by the simulation
  140198. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  140199. */
  140200. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  140201. /**
  140202. * Sets the gravity vector used by the simulation
  140203. * @param gravity defines the gravity vector to use
  140204. */
  140205. setGravity(gravity: Vector3): void;
  140206. /**
  140207. * Set the time step of the physics engine.
  140208. * Default is 1/60.
  140209. * To slow it down, enter 1/600 for example.
  140210. * To speed it up, 1/30
  140211. * @param newTimeStep defines the new timestep to apply to this world.
  140212. */
  140213. setTimeStep(newTimeStep?: number): void;
  140214. /**
  140215. * Get the time step of the physics engine.
  140216. * @returns the current time step
  140217. */
  140218. getTimeStep(): number;
  140219. /**
  140220. * Set the sub time step of the physics engine.
  140221. * Default is 0 meaning there is no sub steps
  140222. * To increase physics resolution precision, set a small value (like 1 ms)
  140223. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140224. */
  140225. setSubTimeStep(subTimeStep?: number): void;
  140226. /**
  140227. * Get the sub time step of the physics engine.
  140228. * @returns the current sub time step
  140229. */
  140230. getSubTimeStep(): number;
  140231. /**
  140232. * Release all resources
  140233. */
  140234. dispose(): void;
  140235. /**
  140236. * Gets the name of the current physics plugin
  140237. * @returns the name of the plugin
  140238. */
  140239. getPhysicsPluginName(): string;
  140240. /**
  140241. * Adding a new impostor for the impostor tracking.
  140242. * This will be done by the impostor itself.
  140243. * @param impostor the impostor to add
  140244. */
  140245. addImpostor(impostor: PhysicsImpostor): void;
  140246. /**
  140247. * Remove an impostor from the engine.
  140248. * This impostor and its mesh will not longer be updated by the physics engine.
  140249. * @param impostor the impostor to remove
  140250. */
  140251. removeImpostor(impostor: PhysicsImpostor): void;
  140252. /**
  140253. * Add a joint to the physics engine
  140254. * @param mainImpostor defines the main impostor to which the joint is added.
  140255. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140256. * @param joint defines the joint that will connect both impostors.
  140257. */
  140258. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140259. /**
  140260. * Removes a joint from the simulation
  140261. * @param mainImpostor defines the impostor used with the joint
  140262. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140263. * @param joint defines the joint to remove
  140264. */
  140265. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140266. /**
  140267. * Called by the scene. No need to call it.
  140268. * @param delta defines the timespam between frames
  140269. */
  140270. _step(delta: number): void;
  140271. /**
  140272. * Gets the current plugin used to run the simulation
  140273. * @returns current plugin
  140274. */
  140275. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140276. /**
  140277. * Gets the list of physic impostors
  140278. * @returns an array of PhysicsImpostor
  140279. */
  140280. getImpostors(): Array<PhysicsImpostor>;
  140281. /**
  140282. * Gets the impostor for a physics enabled object
  140283. * @param object defines the object impersonated by the impostor
  140284. * @returns the PhysicsImpostor or null if not found
  140285. */
  140286. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140287. /**
  140288. * Gets the impostor for a physics body object
  140289. * @param body defines physics body used by the impostor
  140290. * @returns the PhysicsImpostor or null if not found
  140291. */
  140292. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140293. /**
  140294. * Does a raycast in the physics world
  140295. * @param from when should the ray start?
  140296. * @param to when should the ray end?
  140297. * @returns PhysicsRaycastResult
  140298. */
  140299. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140300. }
  140301. }
  140302. declare module BABYLON {
  140303. /** @hidden */
  140304. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140305. private _useDeltaForWorldStep;
  140306. world: any;
  140307. name: string;
  140308. private _physicsMaterials;
  140309. private _fixedTimeStep;
  140310. private _cannonRaycastResult;
  140311. private _raycastResult;
  140312. private _physicsBodysToRemoveAfterStep;
  140313. private _firstFrame;
  140314. BJSCANNON: any;
  140315. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140316. setGravity(gravity: Vector3): void;
  140317. setTimeStep(timeStep: number): void;
  140318. getTimeStep(): number;
  140319. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140320. private _removeMarkedPhysicsBodiesFromWorld;
  140321. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140322. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140323. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140324. private _processChildMeshes;
  140325. removePhysicsBody(impostor: PhysicsImpostor): void;
  140326. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140327. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140328. private _addMaterial;
  140329. private _checkWithEpsilon;
  140330. private _createShape;
  140331. private _createHeightmap;
  140332. private _minus90X;
  140333. private _plus90X;
  140334. private _tmpPosition;
  140335. private _tmpDeltaPosition;
  140336. private _tmpUnityRotation;
  140337. private _updatePhysicsBodyTransformation;
  140338. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140339. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140340. isSupported(): boolean;
  140341. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140342. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140343. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140344. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140345. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140346. getBodyMass(impostor: PhysicsImpostor): number;
  140347. getBodyFriction(impostor: PhysicsImpostor): number;
  140348. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140349. getBodyRestitution(impostor: PhysicsImpostor): number;
  140350. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140351. sleepBody(impostor: PhysicsImpostor): void;
  140352. wakeUpBody(impostor: PhysicsImpostor): void;
  140353. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140354. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140355. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140356. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140357. getRadius(impostor: PhysicsImpostor): number;
  140358. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140359. dispose(): void;
  140360. private _extendNamespace;
  140361. /**
  140362. * Does a raycast in the physics world
  140363. * @param from when should the ray start?
  140364. * @param to when should the ray end?
  140365. * @returns PhysicsRaycastResult
  140366. */
  140367. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140368. }
  140369. }
  140370. declare module BABYLON {
  140371. /** @hidden */
  140372. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140373. private _useDeltaForWorldStep;
  140374. world: any;
  140375. name: string;
  140376. BJSOIMO: any;
  140377. private _raycastResult;
  140378. private _fixedTimeStep;
  140379. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140380. setGravity(gravity: Vector3): void;
  140381. setTimeStep(timeStep: number): void;
  140382. getTimeStep(): number;
  140383. private _tmpImpostorsArray;
  140384. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140385. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140386. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140387. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140388. private _tmpPositionVector;
  140389. removePhysicsBody(impostor: PhysicsImpostor): void;
  140390. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140391. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140392. isSupported(): boolean;
  140393. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140394. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140395. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140396. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140397. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140398. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140399. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140400. getBodyMass(impostor: PhysicsImpostor): number;
  140401. getBodyFriction(impostor: PhysicsImpostor): number;
  140402. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140403. getBodyRestitution(impostor: PhysicsImpostor): number;
  140404. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140405. sleepBody(impostor: PhysicsImpostor): void;
  140406. wakeUpBody(impostor: PhysicsImpostor): void;
  140407. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140408. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140409. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140410. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140411. getRadius(impostor: PhysicsImpostor): number;
  140412. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140413. dispose(): void;
  140414. /**
  140415. * Does a raycast in the physics world
  140416. * @param from when should the ray start?
  140417. * @param to when should the ray end?
  140418. * @returns PhysicsRaycastResult
  140419. */
  140420. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140421. }
  140422. }
  140423. declare module BABYLON {
  140424. /**
  140425. * AmmoJS Physics plugin
  140426. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140427. * @see https://github.com/kripken/ammo.js/
  140428. */
  140429. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140430. private _useDeltaForWorldStep;
  140431. /**
  140432. * Reference to the Ammo library
  140433. */
  140434. bjsAMMO: any;
  140435. /**
  140436. * Created ammoJS world which physics bodies are added to
  140437. */
  140438. world: any;
  140439. /**
  140440. * Name of the plugin
  140441. */
  140442. name: string;
  140443. private _timeStep;
  140444. private _fixedTimeStep;
  140445. private _maxSteps;
  140446. private _tmpQuaternion;
  140447. private _tmpAmmoTransform;
  140448. private _tmpAmmoQuaternion;
  140449. private _tmpAmmoConcreteContactResultCallback;
  140450. private _collisionConfiguration;
  140451. private _dispatcher;
  140452. private _overlappingPairCache;
  140453. private _solver;
  140454. private _softBodySolver;
  140455. private _tmpAmmoVectorA;
  140456. private _tmpAmmoVectorB;
  140457. private _tmpAmmoVectorC;
  140458. private _tmpAmmoVectorD;
  140459. private _tmpContactCallbackResult;
  140460. private _tmpAmmoVectorRCA;
  140461. private _tmpAmmoVectorRCB;
  140462. private _raycastResult;
  140463. private static readonly DISABLE_COLLISION_FLAG;
  140464. private static readonly KINEMATIC_FLAG;
  140465. private static readonly DISABLE_DEACTIVATION_FLAG;
  140466. /**
  140467. * Initializes the ammoJS plugin
  140468. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140469. * @param ammoInjection can be used to inject your own ammo reference
  140470. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140471. */
  140472. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140473. /**
  140474. * Sets the gravity of the physics world (m/(s^2))
  140475. * @param gravity Gravity to set
  140476. */
  140477. setGravity(gravity: Vector3): void;
  140478. /**
  140479. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140480. * @param timeStep timestep to use in seconds
  140481. */
  140482. setTimeStep(timeStep: number): void;
  140483. /**
  140484. * 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)
  140485. * @param fixedTimeStep fixedTimeStep to use in seconds
  140486. */
  140487. setFixedTimeStep(fixedTimeStep: number): void;
  140488. /**
  140489. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140490. * @param maxSteps the maximum number of steps by the physics engine per frame
  140491. */
  140492. setMaxSteps(maxSteps: number): void;
  140493. /**
  140494. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140495. * @returns the current timestep in seconds
  140496. */
  140497. getTimeStep(): number;
  140498. /**
  140499. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140500. */
  140501. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140502. private _isImpostorInContact;
  140503. private _isImpostorPairInContact;
  140504. private _stepSimulation;
  140505. /**
  140506. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140507. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140508. * After the step the babylon meshes are set to the position of the physics imposters
  140509. * @param delta amount of time to step forward
  140510. * @param impostors array of imposters to update before/after the step
  140511. */
  140512. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140513. /**
  140514. * Update babylon mesh to match physics world object
  140515. * @param impostor imposter to match
  140516. */
  140517. private _afterSoftStep;
  140518. /**
  140519. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140520. * @param impostor imposter to match
  140521. */
  140522. private _ropeStep;
  140523. /**
  140524. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140525. * @param impostor imposter to match
  140526. */
  140527. private _softbodyOrClothStep;
  140528. private _tmpMatrix;
  140529. /**
  140530. * Applies an impulse on the imposter
  140531. * @param impostor imposter to apply impulse to
  140532. * @param force amount of force to be applied to the imposter
  140533. * @param contactPoint the location to apply the impulse on the imposter
  140534. */
  140535. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140536. /**
  140537. * Applies a force on the imposter
  140538. * @param impostor imposter to apply force
  140539. * @param force amount of force to be applied to the imposter
  140540. * @param contactPoint the location to apply the force on the imposter
  140541. */
  140542. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140543. /**
  140544. * Creates a physics body using the plugin
  140545. * @param impostor the imposter to create the physics body on
  140546. */
  140547. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140548. /**
  140549. * Removes the physics body from the imposter and disposes of the body's memory
  140550. * @param impostor imposter to remove the physics body from
  140551. */
  140552. removePhysicsBody(impostor: PhysicsImpostor): void;
  140553. /**
  140554. * Generates a joint
  140555. * @param impostorJoint the imposter joint to create the joint with
  140556. */
  140557. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140558. /**
  140559. * Removes a joint
  140560. * @param impostorJoint the imposter joint to remove the joint from
  140561. */
  140562. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140563. private _addMeshVerts;
  140564. /**
  140565. * Initialise the soft body vertices to match its object's (mesh) vertices
  140566. * Softbody vertices (nodes) are in world space and to match this
  140567. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140568. * @param impostor to create the softbody for
  140569. */
  140570. private _softVertexData;
  140571. /**
  140572. * Create an impostor's soft body
  140573. * @param impostor to create the softbody for
  140574. */
  140575. private _createSoftbody;
  140576. /**
  140577. * Create cloth for an impostor
  140578. * @param impostor to create the softbody for
  140579. */
  140580. private _createCloth;
  140581. /**
  140582. * Create rope for an impostor
  140583. * @param impostor to create the softbody for
  140584. */
  140585. private _createRope;
  140586. /**
  140587. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140588. * @param impostor to create the custom physics shape for
  140589. */
  140590. private _createCustom;
  140591. private _addHullVerts;
  140592. private _createShape;
  140593. /**
  140594. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140595. * @param impostor imposter containing the physics body and babylon object
  140596. */
  140597. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140598. /**
  140599. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140600. * @param impostor imposter containing the physics body and babylon object
  140601. * @param newPosition new position
  140602. * @param newRotation new rotation
  140603. */
  140604. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140605. /**
  140606. * If this plugin is supported
  140607. * @returns true if its supported
  140608. */
  140609. isSupported(): boolean;
  140610. /**
  140611. * Sets the linear velocity of the physics body
  140612. * @param impostor imposter to set the velocity on
  140613. * @param velocity velocity to set
  140614. */
  140615. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140616. /**
  140617. * Sets the angular velocity of the physics body
  140618. * @param impostor imposter to set the velocity on
  140619. * @param velocity velocity to set
  140620. */
  140621. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140622. /**
  140623. * gets the linear velocity
  140624. * @param impostor imposter to get linear velocity from
  140625. * @returns linear velocity
  140626. */
  140627. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140628. /**
  140629. * gets the angular velocity
  140630. * @param impostor imposter to get angular velocity from
  140631. * @returns angular velocity
  140632. */
  140633. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140634. /**
  140635. * Sets the mass of physics body
  140636. * @param impostor imposter to set the mass on
  140637. * @param mass mass to set
  140638. */
  140639. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140640. /**
  140641. * Gets the mass of the physics body
  140642. * @param impostor imposter to get the mass from
  140643. * @returns mass
  140644. */
  140645. getBodyMass(impostor: PhysicsImpostor): number;
  140646. /**
  140647. * Gets friction of the impostor
  140648. * @param impostor impostor to get friction from
  140649. * @returns friction value
  140650. */
  140651. getBodyFriction(impostor: PhysicsImpostor): number;
  140652. /**
  140653. * Sets friction of the impostor
  140654. * @param impostor impostor to set friction on
  140655. * @param friction friction value
  140656. */
  140657. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140658. /**
  140659. * Gets restitution of the impostor
  140660. * @param impostor impostor to get restitution from
  140661. * @returns restitution value
  140662. */
  140663. getBodyRestitution(impostor: PhysicsImpostor): number;
  140664. /**
  140665. * Sets resitution of the impostor
  140666. * @param impostor impostor to set resitution on
  140667. * @param restitution resitution value
  140668. */
  140669. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140670. /**
  140671. * Gets pressure inside the impostor
  140672. * @param impostor impostor to get pressure from
  140673. * @returns pressure value
  140674. */
  140675. getBodyPressure(impostor: PhysicsImpostor): number;
  140676. /**
  140677. * Sets pressure inside a soft body impostor
  140678. * Cloth and rope must remain 0 pressure
  140679. * @param impostor impostor to set pressure on
  140680. * @param pressure pressure value
  140681. */
  140682. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140683. /**
  140684. * Gets stiffness of the impostor
  140685. * @param impostor impostor to get stiffness from
  140686. * @returns pressure value
  140687. */
  140688. getBodyStiffness(impostor: PhysicsImpostor): number;
  140689. /**
  140690. * Sets stiffness of the impostor
  140691. * @param impostor impostor to set stiffness on
  140692. * @param stiffness stiffness value from 0 to 1
  140693. */
  140694. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140695. /**
  140696. * Gets velocityIterations of the impostor
  140697. * @param impostor impostor to get velocity iterations from
  140698. * @returns velocityIterations value
  140699. */
  140700. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140701. /**
  140702. * Sets velocityIterations of the impostor
  140703. * @param impostor impostor to set velocity iterations on
  140704. * @param velocityIterations velocityIterations value
  140705. */
  140706. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140707. /**
  140708. * Gets positionIterations of the impostor
  140709. * @param impostor impostor to get position iterations from
  140710. * @returns positionIterations value
  140711. */
  140712. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140713. /**
  140714. * Sets positionIterations of the impostor
  140715. * @param impostor impostor to set position on
  140716. * @param positionIterations positionIterations value
  140717. */
  140718. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140719. /**
  140720. * Append an anchor to a cloth object
  140721. * @param impostor is the cloth impostor to add anchor to
  140722. * @param otherImpostor is the rigid impostor to anchor to
  140723. * @param width ratio across width from 0 to 1
  140724. * @param height ratio up height from 0 to 1
  140725. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140726. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140727. */
  140728. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140729. /**
  140730. * Append an hook to a rope object
  140731. * @param impostor is the rope impostor to add hook to
  140732. * @param otherImpostor is the rigid impostor to hook to
  140733. * @param length ratio along the rope from 0 to 1
  140734. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140735. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140736. */
  140737. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140738. /**
  140739. * Sleeps the physics body and stops it from being active
  140740. * @param impostor impostor to sleep
  140741. */
  140742. sleepBody(impostor: PhysicsImpostor): void;
  140743. /**
  140744. * Activates the physics body
  140745. * @param impostor impostor to activate
  140746. */
  140747. wakeUpBody(impostor: PhysicsImpostor): void;
  140748. /**
  140749. * Updates the distance parameters of the joint
  140750. * @param joint joint to update
  140751. * @param maxDistance maximum distance of the joint
  140752. * @param minDistance minimum distance of the joint
  140753. */
  140754. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140755. /**
  140756. * Sets a motor on the joint
  140757. * @param joint joint to set motor on
  140758. * @param speed speed of the motor
  140759. * @param maxForce maximum force of the motor
  140760. * @param motorIndex index of the motor
  140761. */
  140762. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140763. /**
  140764. * Sets the motors limit
  140765. * @param joint joint to set limit on
  140766. * @param upperLimit upper limit
  140767. * @param lowerLimit lower limit
  140768. */
  140769. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140770. /**
  140771. * Syncs the position and rotation of a mesh with the impostor
  140772. * @param mesh mesh to sync
  140773. * @param impostor impostor to update the mesh with
  140774. */
  140775. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140776. /**
  140777. * Gets the radius of the impostor
  140778. * @param impostor impostor to get radius from
  140779. * @returns the radius
  140780. */
  140781. getRadius(impostor: PhysicsImpostor): number;
  140782. /**
  140783. * Gets the box size of the impostor
  140784. * @param impostor impostor to get box size from
  140785. * @param result the resulting box size
  140786. */
  140787. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140788. /**
  140789. * Disposes of the impostor
  140790. */
  140791. dispose(): void;
  140792. /**
  140793. * Does a raycast in the physics world
  140794. * @param from when should the ray start?
  140795. * @param to when should the ray end?
  140796. * @returns PhysicsRaycastResult
  140797. */
  140798. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140799. }
  140800. }
  140801. declare module BABYLON {
  140802. interface AbstractScene {
  140803. /**
  140804. * The list of reflection probes added to the scene
  140805. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140806. */
  140807. reflectionProbes: Array<ReflectionProbe>;
  140808. /**
  140809. * Removes the given reflection probe from this scene.
  140810. * @param toRemove The reflection probe to remove
  140811. * @returns The index of the removed reflection probe
  140812. */
  140813. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140814. /**
  140815. * Adds the given reflection probe to this scene.
  140816. * @param newReflectionProbe The reflection probe to add
  140817. */
  140818. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140819. }
  140820. /**
  140821. * Class used to generate realtime reflection / refraction cube textures
  140822. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140823. */
  140824. export class ReflectionProbe {
  140825. /** defines the name of the probe */
  140826. name: string;
  140827. private _scene;
  140828. private _renderTargetTexture;
  140829. private _projectionMatrix;
  140830. private _viewMatrix;
  140831. private _target;
  140832. private _add;
  140833. private _attachedMesh;
  140834. private _invertYAxis;
  140835. /** Gets or sets probe position (center of the cube map) */
  140836. position: Vector3;
  140837. /**
  140838. * Creates a new reflection probe
  140839. * @param name defines the name of the probe
  140840. * @param size defines the texture resolution (for each face)
  140841. * @param scene defines the hosting scene
  140842. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140843. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140844. */
  140845. constructor(
  140846. /** defines the name of the probe */
  140847. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140848. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140849. get samples(): number;
  140850. set samples(value: number);
  140851. /** Gets or sets the refresh rate to use (on every frame by default) */
  140852. get refreshRate(): number;
  140853. set refreshRate(value: number);
  140854. /**
  140855. * Gets the hosting scene
  140856. * @returns a Scene
  140857. */
  140858. getScene(): Scene;
  140859. /** Gets the internal CubeTexture used to render to */
  140860. get cubeTexture(): RenderTargetTexture;
  140861. /** Gets the list of meshes to render */
  140862. get renderList(): Nullable<AbstractMesh[]>;
  140863. /**
  140864. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140865. * @param mesh defines the mesh to attach to
  140866. */
  140867. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140868. /**
  140869. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140870. * @param renderingGroupId The rendering group id corresponding to its index
  140871. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140872. */
  140873. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140874. /**
  140875. * Clean all associated resources
  140876. */
  140877. dispose(): void;
  140878. /**
  140879. * Converts the reflection probe information to a readable string for debug purpose.
  140880. * @param fullDetails Supports for multiple levels of logging within scene loading
  140881. * @returns the human readable reflection probe info
  140882. */
  140883. toString(fullDetails?: boolean): string;
  140884. /**
  140885. * Get the class name of the relfection probe.
  140886. * @returns "ReflectionProbe"
  140887. */
  140888. getClassName(): string;
  140889. /**
  140890. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140891. * @returns The JSON representation of the texture
  140892. */
  140893. serialize(): any;
  140894. /**
  140895. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140896. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140897. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140898. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140899. * @returns The parsed reflection probe if successful
  140900. */
  140901. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140902. }
  140903. }
  140904. declare module BABYLON {
  140905. /** @hidden */
  140906. export var _BabylonLoaderRegistered: boolean;
  140907. /**
  140908. * Helps setting up some configuration for the babylon file loader.
  140909. */
  140910. export class BabylonFileLoaderConfiguration {
  140911. /**
  140912. * The loader does not allow injecting custom physix engine into the plugins.
  140913. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140914. * So you could set this variable to your engine import to make it work.
  140915. */
  140916. static LoaderInjectedPhysicsEngine: any;
  140917. }
  140918. }
  140919. declare module BABYLON {
  140920. /**
  140921. * The Physically based simple base material of BJS.
  140922. *
  140923. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140924. * It is used as the base class for both the specGloss and metalRough conventions.
  140925. */
  140926. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140927. /**
  140928. * Number of Simultaneous lights allowed on the material.
  140929. */
  140930. maxSimultaneousLights: number;
  140931. /**
  140932. * If sets to true, disables all the lights affecting the material.
  140933. */
  140934. disableLighting: boolean;
  140935. /**
  140936. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140937. */
  140938. environmentTexture: BaseTexture;
  140939. /**
  140940. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140941. */
  140942. invertNormalMapX: boolean;
  140943. /**
  140944. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140945. */
  140946. invertNormalMapY: boolean;
  140947. /**
  140948. * Normal map used in the model.
  140949. */
  140950. normalTexture: BaseTexture;
  140951. /**
  140952. * Emissivie color used to self-illuminate the model.
  140953. */
  140954. emissiveColor: Color3;
  140955. /**
  140956. * Emissivie texture used to self-illuminate the model.
  140957. */
  140958. emissiveTexture: BaseTexture;
  140959. /**
  140960. * Occlusion Channel Strenght.
  140961. */
  140962. occlusionStrength: number;
  140963. /**
  140964. * Occlusion Texture of the material (adding extra occlusion effects).
  140965. */
  140966. occlusionTexture: BaseTexture;
  140967. /**
  140968. * Defines the alpha limits in alpha test mode.
  140969. */
  140970. alphaCutOff: number;
  140971. /**
  140972. * Gets the current double sided mode.
  140973. */
  140974. get doubleSided(): boolean;
  140975. /**
  140976. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140977. */
  140978. set doubleSided(value: boolean);
  140979. /**
  140980. * Stores the pre-calculated light information of a mesh in a texture.
  140981. */
  140982. lightmapTexture: BaseTexture;
  140983. /**
  140984. * If true, the light map contains occlusion information instead of lighting info.
  140985. */
  140986. useLightmapAsShadowmap: boolean;
  140987. /**
  140988. * Instantiates a new PBRMaterial instance.
  140989. *
  140990. * @param name The material name
  140991. * @param scene The scene the material will be use in.
  140992. */
  140993. constructor(name: string, scene: Scene);
  140994. getClassName(): string;
  140995. }
  140996. }
  140997. declare module BABYLON {
  140998. /**
  140999. * The PBR material of BJS following the metal roughness convention.
  141000. *
  141001. * This fits to the PBR convention in the GLTF definition:
  141002. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  141003. */
  141004. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  141005. /**
  141006. * The base color has two different interpretations depending on the value of metalness.
  141007. * When the material is a metal, the base color is the specific measured reflectance value
  141008. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  141009. * of the material.
  141010. */
  141011. baseColor: Color3;
  141012. /**
  141013. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  141014. * well as opacity information in the alpha channel.
  141015. */
  141016. baseTexture: BaseTexture;
  141017. /**
  141018. * Specifies the metallic scalar value of the material.
  141019. * Can also be used to scale the metalness values of the metallic texture.
  141020. */
  141021. metallic: number;
  141022. /**
  141023. * Specifies the roughness scalar value of the material.
  141024. * Can also be used to scale the roughness values of the metallic texture.
  141025. */
  141026. roughness: number;
  141027. /**
  141028. * Texture containing both the metallic value in the B channel and the
  141029. * roughness value in the G channel to keep better precision.
  141030. */
  141031. metallicRoughnessTexture: BaseTexture;
  141032. /**
  141033. * Instantiates a new PBRMetalRoughnessMaterial instance.
  141034. *
  141035. * @param name The material name
  141036. * @param scene The scene the material will be use in.
  141037. */
  141038. constructor(name: string, scene: Scene);
  141039. /**
  141040. * Return the currrent class name of the material.
  141041. */
  141042. getClassName(): string;
  141043. /**
  141044. * Makes a duplicate of the current material.
  141045. * @param name - name to use for the new material.
  141046. */
  141047. clone(name: string): PBRMetallicRoughnessMaterial;
  141048. /**
  141049. * Serialize the material to a parsable JSON object.
  141050. */
  141051. serialize(): any;
  141052. /**
  141053. * Parses a JSON object correponding to the serialize function.
  141054. */
  141055. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  141056. }
  141057. }
  141058. declare module BABYLON {
  141059. /**
  141060. * The PBR material of BJS following the specular glossiness convention.
  141061. *
  141062. * This fits to the PBR convention in the GLTF definition:
  141063. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  141064. */
  141065. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  141066. /**
  141067. * Specifies the diffuse color of the material.
  141068. */
  141069. diffuseColor: Color3;
  141070. /**
  141071. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  141072. * channel.
  141073. */
  141074. diffuseTexture: BaseTexture;
  141075. /**
  141076. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  141077. */
  141078. specularColor: Color3;
  141079. /**
  141080. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  141081. */
  141082. glossiness: number;
  141083. /**
  141084. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  141085. */
  141086. specularGlossinessTexture: BaseTexture;
  141087. /**
  141088. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  141089. *
  141090. * @param name The material name
  141091. * @param scene The scene the material will be use in.
  141092. */
  141093. constructor(name: string, scene: Scene);
  141094. /**
  141095. * Return the currrent class name of the material.
  141096. */
  141097. getClassName(): string;
  141098. /**
  141099. * Makes a duplicate of the current material.
  141100. * @param name - name to use for the new material.
  141101. */
  141102. clone(name: string): PBRSpecularGlossinessMaterial;
  141103. /**
  141104. * Serialize the material to a parsable JSON object.
  141105. */
  141106. serialize(): any;
  141107. /**
  141108. * Parses a JSON object correponding to the serialize function.
  141109. */
  141110. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  141111. }
  141112. }
  141113. declare module BABYLON {
  141114. /**
  141115. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  141116. * It can help converting any input color in a desired output one. This can then be used to create effects
  141117. * from sepia, black and white to sixties or futuristic rendering...
  141118. *
  141119. * The only supported format is currently 3dl.
  141120. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  141121. */
  141122. export class ColorGradingTexture extends BaseTexture {
  141123. /**
  141124. * The texture URL.
  141125. */
  141126. url: string;
  141127. /**
  141128. * Empty line regex stored for GC.
  141129. */
  141130. private static _noneEmptyLineRegex;
  141131. private _textureMatrix;
  141132. private _onLoad;
  141133. /**
  141134. * Instantiates a ColorGradingTexture from the following parameters.
  141135. *
  141136. * @param url The location of the color gradind data (currently only supporting 3dl)
  141137. * @param sceneOrEngine The scene or engine the texture will be used in
  141138. * @param onLoad defines a callback triggered when the texture has been loaded
  141139. */
  141140. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  141141. /**
  141142. * Fires the onload event from the constructor if requested.
  141143. */
  141144. private _triggerOnLoad;
  141145. /**
  141146. * Returns the texture matrix used in most of the material.
  141147. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  141148. */
  141149. getTextureMatrix(): Matrix;
  141150. /**
  141151. * Occurs when the file being loaded is a .3dl LUT file.
  141152. */
  141153. private load3dlTexture;
  141154. /**
  141155. * Starts the loading process of the texture.
  141156. */
  141157. private loadTexture;
  141158. /**
  141159. * Clones the color gradind texture.
  141160. */
  141161. clone(): ColorGradingTexture;
  141162. /**
  141163. * Called during delayed load for textures.
  141164. */
  141165. delayLoad(): void;
  141166. /**
  141167. * Parses a color grading texture serialized by Babylon.
  141168. * @param parsedTexture The texture information being parsedTexture
  141169. * @param scene The scene to load the texture in
  141170. * @param rootUrl The root url of the data assets to load
  141171. * @return A color gradind texture
  141172. */
  141173. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141174. /**
  141175. * Serializes the LUT texture to json format.
  141176. */
  141177. serialize(): any;
  141178. }
  141179. }
  141180. declare module BABYLON {
  141181. /**
  141182. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141183. */
  141184. export class EquiRectangularCubeTexture extends BaseTexture {
  141185. /** The six faces of the cube. */
  141186. private static _FacesMapping;
  141187. private _noMipmap;
  141188. private _onLoad;
  141189. private _onError;
  141190. /** The size of the cubemap. */
  141191. private _size;
  141192. /** The buffer of the image. */
  141193. private _buffer;
  141194. /** The width of the input image. */
  141195. private _width;
  141196. /** The height of the input image. */
  141197. private _height;
  141198. /** The URL to the image. */
  141199. url: string;
  141200. /**
  141201. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  141202. * @param url The location of the image
  141203. * @param scene The scene the texture will be used in
  141204. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  141205. * @param noMipmap Forces to not generate the mipmap if true
  141206. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  141207. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  141208. * @param onLoad — defines a callback called when texture is loaded
  141209. * @param onError — defines a callback called if there is an error
  141210. */
  141211. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141212. /**
  141213. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141214. */
  141215. private loadImage;
  141216. /**
  141217. * Convert the image buffer into a cubemap and create a CubeTexture.
  141218. */
  141219. private loadTexture;
  141220. /**
  141221. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141222. * @param buffer The ArrayBuffer that should be converted.
  141223. * @returns The buffer as Float32Array.
  141224. */
  141225. private getFloat32ArrayFromArrayBuffer;
  141226. /**
  141227. * Get the current class name of the texture useful for serialization or dynamic coding.
  141228. * @returns "EquiRectangularCubeTexture"
  141229. */
  141230. getClassName(): string;
  141231. /**
  141232. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141233. * @returns A clone of the current EquiRectangularCubeTexture.
  141234. */
  141235. clone(): EquiRectangularCubeTexture;
  141236. }
  141237. }
  141238. declare module BABYLON {
  141239. /**
  141240. * Defines the options related to the creation of an HtmlElementTexture
  141241. */
  141242. export interface IHtmlElementTextureOptions {
  141243. /**
  141244. * Defines wether mip maps should be created or not.
  141245. */
  141246. generateMipMaps?: boolean;
  141247. /**
  141248. * Defines the sampling mode of the texture.
  141249. */
  141250. samplingMode?: number;
  141251. /**
  141252. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141253. */
  141254. engine: Nullable<ThinEngine>;
  141255. /**
  141256. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141257. */
  141258. scene: Nullable<Scene>;
  141259. }
  141260. /**
  141261. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141262. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141263. * is automatically managed.
  141264. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141265. * in your application.
  141266. *
  141267. * As the update is not automatic, you need to call them manually.
  141268. */
  141269. export class HtmlElementTexture extends BaseTexture {
  141270. /**
  141271. * The texture URL.
  141272. */
  141273. element: HTMLVideoElement | HTMLCanvasElement;
  141274. private static readonly DefaultOptions;
  141275. private _textureMatrix;
  141276. private _isVideo;
  141277. private _generateMipMaps;
  141278. private _samplingMode;
  141279. /**
  141280. * Instantiates a HtmlElementTexture from the following parameters.
  141281. *
  141282. * @param name Defines the name of the texture
  141283. * @param element Defines the video or canvas the texture is filled with
  141284. * @param options Defines the other none mandatory texture creation options
  141285. */
  141286. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141287. private _createInternalTexture;
  141288. /**
  141289. * Returns the texture matrix used in most of the material.
  141290. */
  141291. getTextureMatrix(): Matrix;
  141292. /**
  141293. * Updates the content of the texture.
  141294. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141295. */
  141296. update(invertY?: Nullable<boolean>): void;
  141297. }
  141298. }
  141299. declare module BABYLON {
  141300. /**
  141301. * Based on jsTGALoader - Javascript loader for TGA file
  141302. * By Vincent Thibault
  141303. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141304. */
  141305. export class TGATools {
  141306. private static _TYPE_INDEXED;
  141307. private static _TYPE_RGB;
  141308. private static _TYPE_GREY;
  141309. private static _TYPE_RLE_INDEXED;
  141310. private static _TYPE_RLE_RGB;
  141311. private static _TYPE_RLE_GREY;
  141312. private static _ORIGIN_MASK;
  141313. private static _ORIGIN_SHIFT;
  141314. private static _ORIGIN_BL;
  141315. private static _ORIGIN_BR;
  141316. private static _ORIGIN_UL;
  141317. private static _ORIGIN_UR;
  141318. /**
  141319. * Gets the header of a TGA file
  141320. * @param data defines the TGA data
  141321. * @returns the header
  141322. */
  141323. static GetTGAHeader(data: Uint8Array): any;
  141324. /**
  141325. * Uploads TGA content to a Babylon Texture
  141326. * @hidden
  141327. */
  141328. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141329. /** @hidden */
  141330. 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;
  141331. /** @hidden */
  141332. 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;
  141333. /** @hidden */
  141334. 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;
  141335. /** @hidden */
  141336. 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;
  141337. /** @hidden */
  141338. 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;
  141339. /** @hidden */
  141340. 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;
  141341. }
  141342. }
  141343. declare module BABYLON {
  141344. /**
  141345. * Implementation of the TGA Texture Loader.
  141346. * @hidden
  141347. */
  141348. export class _TGATextureLoader implements IInternalTextureLoader {
  141349. /**
  141350. * Defines wether the loader supports cascade loading the different faces.
  141351. */
  141352. readonly supportCascades: boolean;
  141353. /**
  141354. * This returns if the loader support the current file information.
  141355. * @param extension defines the file extension of the file being loaded
  141356. * @returns true if the loader can load the specified file
  141357. */
  141358. canLoad(extension: string): boolean;
  141359. /**
  141360. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141361. * @param data contains the texture data
  141362. * @param texture defines the BabylonJS internal texture
  141363. * @param createPolynomials will be true if polynomials have been requested
  141364. * @param onLoad defines the callback to trigger once the texture is ready
  141365. * @param onError defines the callback to trigger in case of error
  141366. */
  141367. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141368. /**
  141369. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141370. * @param data contains the texture data
  141371. * @param texture defines the BabylonJS internal texture
  141372. * @param callback defines the method to call once ready to upload
  141373. */
  141374. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141375. }
  141376. }
  141377. declare module BABYLON {
  141378. /**
  141379. * Info about the .basis files
  141380. */
  141381. class BasisFileInfo {
  141382. /**
  141383. * If the file has alpha
  141384. */
  141385. hasAlpha: boolean;
  141386. /**
  141387. * Info about each image of the basis file
  141388. */
  141389. images: Array<{
  141390. levels: Array<{
  141391. width: number;
  141392. height: number;
  141393. transcodedPixels: ArrayBufferView;
  141394. }>;
  141395. }>;
  141396. }
  141397. /**
  141398. * Result of transcoding a basis file
  141399. */
  141400. class TranscodeResult {
  141401. /**
  141402. * Info about the .basis file
  141403. */
  141404. fileInfo: BasisFileInfo;
  141405. /**
  141406. * Format to use when loading the file
  141407. */
  141408. format: number;
  141409. }
  141410. /**
  141411. * Configuration options for the Basis transcoder
  141412. */
  141413. export class BasisTranscodeConfiguration {
  141414. /**
  141415. * Supported compression formats used to determine the supported output format of the transcoder
  141416. */
  141417. supportedCompressionFormats?: {
  141418. /**
  141419. * etc1 compression format
  141420. */
  141421. etc1?: boolean;
  141422. /**
  141423. * s3tc compression format
  141424. */
  141425. s3tc?: boolean;
  141426. /**
  141427. * pvrtc compression format
  141428. */
  141429. pvrtc?: boolean;
  141430. /**
  141431. * etc2 compression format
  141432. */
  141433. etc2?: boolean;
  141434. };
  141435. /**
  141436. * If mipmap levels should be loaded for transcoded images (Default: true)
  141437. */
  141438. loadMipmapLevels?: boolean;
  141439. /**
  141440. * Index of a single image to load (Default: all images)
  141441. */
  141442. loadSingleImage?: number;
  141443. }
  141444. /**
  141445. * Used to load .Basis files
  141446. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141447. */
  141448. export class BasisTools {
  141449. private static _IgnoreSupportedFormats;
  141450. /**
  141451. * URL to use when loading the basis transcoder
  141452. */
  141453. static JSModuleURL: string;
  141454. /**
  141455. * URL to use when loading the wasm module for the transcoder
  141456. */
  141457. static WasmModuleURL: string;
  141458. /**
  141459. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141460. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141461. * @returns internal format corresponding to the Basis format
  141462. */
  141463. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141464. private static _WorkerPromise;
  141465. private static _Worker;
  141466. private static _actionId;
  141467. private static _CreateWorkerAsync;
  141468. /**
  141469. * Transcodes a loaded image file to compressed pixel data
  141470. * @param data image data to transcode
  141471. * @param config configuration options for the transcoding
  141472. * @returns a promise resulting in the transcoded image
  141473. */
  141474. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141475. /**
  141476. * Loads a texture from the transcode result
  141477. * @param texture texture load to
  141478. * @param transcodeResult the result of transcoding the basis file to load from
  141479. */
  141480. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141481. }
  141482. }
  141483. declare module BABYLON {
  141484. /**
  141485. * Loader for .basis file format
  141486. */
  141487. export class _BasisTextureLoader implements IInternalTextureLoader {
  141488. /**
  141489. * Defines whether the loader supports cascade loading the different faces.
  141490. */
  141491. readonly supportCascades: boolean;
  141492. /**
  141493. * This returns if the loader support the current file information.
  141494. * @param extension defines the file extension of the file being loaded
  141495. * @returns true if the loader can load the specified file
  141496. */
  141497. canLoad(extension: string): boolean;
  141498. /**
  141499. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141500. * @param data contains the texture data
  141501. * @param texture defines the BabylonJS internal texture
  141502. * @param createPolynomials will be true if polynomials have been requested
  141503. * @param onLoad defines the callback to trigger once the texture is ready
  141504. * @param onError defines the callback to trigger in case of error
  141505. */
  141506. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141507. /**
  141508. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141509. * @param data contains the texture data
  141510. * @param texture defines the BabylonJS internal texture
  141511. * @param callback defines the method to call once ready to upload
  141512. */
  141513. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141514. }
  141515. }
  141516. declare module BABYLON {
  141517. /**
  141518. * Defines the basic options interface of a TexturePacker Frame
  141519. */
  141520. export interface ITexturePackerFrame {
  141521. /**
  141522. * The frame ID
  141523. */
  141524. id: number;
  141525. /**
  141526. * The frames Scale
  141527. */
  141528. scale: Vector2;
  141529. /**
  141530. * The Frames offset
  141531. */
  141532. offset: Vector2;
  141533. }
  141534. /**
  141535. * This is a support class for frame Data on texture packer sets.
  141536. */
  141537. export class TexturePackerFrame implements ITexturePackerFrame {
  141538. /**
  141539. * The frame ID
  141540. */
  141541. id: number;
  141542. /**
  141543. * The frames Scale
  141544. */
  141545. scale: Vector2;
  141546. /**
  141547. * The Frames offset
  141548. */
  141549. offset: Vector2;
  141550. /**
  141551. * Initializes a texture package frame.
  141552. * @param id The numerical frame identifier
  141553. * @param scale Scalar Vector2 for UV frame
  141554. * @param offset Vector2 for the frame position in UV units.
  141555. * @returns TexturePackerFrame
  141556. */
  141557. constructor(id: number, scale: Vector2, offset: Vector2);
  141558. }
  141559. }
  141560. declare module BABYLON {
  141561. /**
  141562. * Defines the basic options interface of a TexturePacker
  141563. */
  141564. export interface ITexturePackerOptions {
  141565. /**
  141566. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141567. */
  141568. map?: string[];
  141569. /**
  141570. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141571. */
  141572. uvsIn?: string;
  141573. /**
  141574. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141575. */
  141576. uvsOut?: string;
  141577. /**
  141578. * number representing the layout style. Defaults to LAYOUT_STRIP
  141579. */
  141580. layout?: number;
  141581. /**
  141582. * number of columns if using custom column count layout(2). This defaults to 4.
  141583. */
  141584. colnum?: number;
  141585. /**
  141586. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141587. */
  141588. updateInputMeshes?: boolean;
  141589. /**
  141590. * boolean flag to dispose all the source textures. Defaults to true.
  141591. */
  141592. disposeSources?: boolean;
  141593. /**
  141594. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141595. */
  141596. fillBlanks?: boolean;
  141597. /**
  141598. * string value representing the context fill style color. Defaults to 'black'.
  141599. */
  141600. customFillColor?: string;
  141601. /**
  141602. * Width and Height Value of each Frame in the TexturePacker Sets
  141603. */
  141604. frameSize?: number;
  141605. /**
  141606. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141607. */
  141608. paddingRatio?: number;
  141609. /**
  141610. * Number that declares the fill method for the padding gutter.
  141611. */
  141612. paddingMode?: number;
  141613. /**
  141614. * If in SUBUV_COLOR padding mode what color to use.
  141615. */
  141616. paddingColor?: Color3 | Color4;
  141617. }
  141618. /**
  141619. * Defines the basic interface of a TexturePacker JSON File
  141620. */
  141621. export interface ITexturePackerJSON {
  141622. /**
  141623. * The frame ID
  141624. */
  141625. name: string;
  141626. /**
  141627. * The base64 channel data
  141628. */
  141629. sets: any;
  141630. /**
  141631. * The options of the Packer
  141632. */
  141633. options: ITexturePackerOptions;
  141634. /**
  141635. * The frame data of the Packer
  141636. */
  141637. frames: Array<number>;
  141638. }
  141639. /**
  141640. * This is a support class that generates a series of packed texture sets.
  141641. * @see https://doc.babylonjs.com/babylon101/materials
  141642. */
  141643. export class TexturePacker {
  141644. /** Packer Layout Constant 0 */
  141645. static readonly LAYOUT_STRIP: number;
  141646. /** Packer Layout Constant 1 */
  141647. static readonly LAYOUT_POWER2: number;
  141648. /** Packer Layout Constant 2 */
  141649. static readonly LAYOUT_COLNUM: number;
  141650. /** Packer Layout Constant 0 */
  141651. static readonly SUBUV_WRAP: number;
  141652. /** Packer Layout Constant 1 */
  141653. static readonly SUBUV_EXTEND: number;
  141654. /** Packer Layout Constant 2 */
  141655. static readonly SUBUV_COLOR: number;
  141656. /** The Name of the Texture Package */
  141657. name: string;
  141658. /** The scene scope of the TexturePacker */
  141659. scene: Scene;
  141660. /** The Meshes to target */
  141661. meshes: AbstractMesh[];
  141662. /** Arguments passed with the Constructor */
  141663. options: ITexturePackerOptions;
  141664. /** The promise that is started upon initialization */
  141665. promise: Nullable<Promise<TexturePacker | string>>;
  141666. /** The Container object for the channel sets that are generated */
  141667. sets: object;
  141668. /** The Container array for the frames that are generated */
  141669. frames: TexturePackerFrame[];
  141670. /** The expected number of textures the system is parsing. */
  141671. private _expecting;
  141672. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141673. private _paddingValue;
  141674. /**
  141675. * Initializes a texture package series from an array of meshes or a single mesh.
  141676. * @param name The name of the package
  141677. * @param meshes The target meshes to compose the package from
  141678. * @param options The arguments that texture packer should follow while building.
  141679. * @param scene The scene which the textures are scoped to.
  141680. * @returns TexturePacker
  141681. */
  141682. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141683. /**
  141684. * Starts the package process
  141685. * @param resolve The promises resolution function
  141686. * @returns TexturePacker
  141687. */
  141688. private _createFrames;
  141689. /**
  141690. * Calculates the Size of the Channel Sets
  141691. * @returns Vector2
  141692. */
  141693. private _calculateSize;
  141694. /**
  141695. * Calculates the UV data for the frames.
  141696. * @param baseSize the base frameSize
  141697. * @param padding the base frame padding
  141698. * @param dtSize size of the Dynamic Texture for that channel
  141699. * @param dtUnits is 1/dtSize
  141700. * @param update flag to update the input meshes
  141701. */
  141702. private _calculateMeshUVFrames;
  141703. /**
  141704. * Calculates the frames Offset.
  141705. * @param index of the frame
  141706. * @returns Vector2
  141707. */
  141708. private _getFrameOffset;
  141709. /**
  141710. * Updates a Mesh to the frame data
  141711. * @param mesh that is the target
  141712. * @param frameID or the frame index
  141713. */
  141714. private _updateMeshUV;
  141715. /**
  141716. * Updates a Meshes materials to use the texture packer channels
  141717. * @param m is the mesh to target
  141718. * @param force all channels on the packer to be set.
  141719. */
  141720. private _updateTextureReferences;
  141721. /**
  141722. * Public method to set a Mesh to a frame
  141723. * @param m that is the target
  141724. * @param frameID or the frame index
  141725. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141726. */
  141727. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141728. /**
  141729. * Starts the async promise to compile the texture packer.
  141730. * @returns Promise<void>
  141731. */
  141732. processAsync(): Promise<void>;
  141733. /**
  141734. * Disposes all textures associated with this packer
  141735. */
  141736. dispose(): void;
  141737. /**
  141738. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141739. * @param imageType is the image type to use.
  141740. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141741. */
  141742. download(imageType?: string, quality?: number): void;
  141743. /**
  141744. * Public method to load a texturePacker JSON file.
  141745. * @param data of the JSON file in string format.
  141746. */
  141747. updateFromJSON(data: string): void;
  141748. }
  141749. }
  141750. declare module BABYLON {
  141751. /**
  141752. * 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.
  141753. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141754. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141755. */
  141756. export class CustomProceduralTexture extends ProceduralTexture {
  141757. private _animate;
  141758. private _time;
  141759. private _config;
  141760. private _texturePath;
  141761. /**
  141762. * Instantiates a new Custom Procedural Texture.
  141763. * 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.
  141764. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141765. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141766. * @param name Define the name of the texture
  141767. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141768. * @param size Define the size of the texture to create
  141769. * @param scene Define the scene the texture belongs to
  141770. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141771. * @param generateMipMaps Define if the texture should creates mip maps or not
  141772. */
  141773. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141774. private _loadJson;
  141775. /**
  141776. * Is the texture ready to be used ? (rendered at least once)
  141777. * @returns true if ready, otherwise, false.
  141778. */
  141779. isReady(): boolean;
  141780. /**
  141781. * Render the texture to its associated render target.
  141782. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141783. */
  141784. render(useCameraPostProcess?: boolean): void;
  141785. /**
  141786. * Update the list of dependant textures samplers in the shader.
  141787. */
  141788. updateTextures(): void;
  141789. /**
  141790. * Update the uniform values of the procedural texture in the shader.
  141791. */
  141792. updateShaderUniforms(): void;
  141793. /**
  141794. * Define if the texture animates or not.
  141795. */
  141796. get animate(): boolean;
  141797. set animate(value: boolean);
  141798. }
  141799. }
  141800. declare module BABYLON {
  141801. /** @hidden */
  141802. export var noisePixelShader: {
  141803. name: string;
  141804. shader: string;
  141805. };
  141806. }
  141807. declare module BABYLON {
  141808. /**
  141809. * Class used to generate noise procedural textures
  141810. */
  141811. export class NoiseProceduralTexture extends ProceduralTexture {
  141812. /** Gets or sets the start time (default is 0) */
  141813. time: number;
  141814. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141815. brightness: number;
  141816. /** Defines the number of octaves to process */
  141817. octaves: number;
  141818. /** Defines the level of persistence (0.8 by default) */
  141819. persistence: number;
  141820. /** Gets or sets animation speed factor (default is 1) */
  141821. animationSpeedFactor: number;
  141822. /**
  141823. * Creates a new NoiseProceduralTexture
  141824. * @param name defines the name fo the texture
  141825. * @param size defines the size of the texture (default is 256)
  141826. * @param scene defines the hosting scene
  141827. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141828. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141829. */
  141830. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141831. private _updateShaderUniforms;
  141832. protected _getDefines(): string;
  141833. /** Generate the current state of the procedural texture */
  141834. render(useCameraPostProcess?: boolean): void;
  141835. /**
  141836. * Serializes this noise procedural texture
  141837. * @returns a serialized noise procedural texture object
  141838. */
  141839. serialize(): any;
  141840. /**
  141841. * Clone the texture.
  141842. * @returns the cloned texture
  141843. */
  141844. clone(): NoiseProceduralTexture;
  141845. /**
  141846. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141847. * @param parsedTexture defines parsed texture data
  141848. * @param scene defines the current scene
  141849. * @param rootUrl defines the root URL containing noise procedural texture information
  141850. * @returns a parsed NoiseProceduralTexture
  141851. */
  141852. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141853. }
  141854. }
  141855. declare module BABYLON {
  141856. /**
  141857. * Raw cube texture where the raw buffers are passed in
  141858. */
  141859. export class RawCubeTexture extends CubeTexture {
  141860. /**
  141861. * Creates a cube texture where the raw buffers are passed in.
  141862. * @param scene defines the scene the texture is attached to
  141863. * @param data defines the array of data to use to create each face
  141864. * @param size defines the size of the textures
  141865. * @param format defines the format of the data
  141866. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141867. * @param generateMipMaps defines if the engine should generate the mip levels
  141868. * @param invertY defines if data must be stored with Y axis inverted
  141869. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141870. * @param compression defines the compression used (null by default)
  141871. */
  141872. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141873. /**
  141874. * Updates the raw cube texture.
  141875. * @param data defines the data to store
  141876. * @param format defines the data format
  141877. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141878. * @param invertY defines if data must be stored with Y axis inverted
  141879. * @param compression defines the compression used (null by default)
  141880. * @param level defines which level of the texture to update
  141881. */
  141882. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141883. /**
  141884. * Updates a raw cube texture with RGBD encoded data.
  141885. * @param data defines the array of data [mipmap][face] to use to create each face
  141886. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141887. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141888. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141889. * @returns a promsie that resolves when the operation is complete
  141890. */
  141891. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141892. /**
  141893. * Clones the raw cube texture.
  141894. * @return a new cube texture
  141895. */
  141896. clone(): CubeTexture;
  141897. /** @hidden */
  141898. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141899. }
  141900. }
  141901. declare module BABYLON {
  141902. /**
  141903. * Class used to store 2D array textures containing user data
  141904. */
  141905. export class RawTexture2DArray extends Texture {
  141906. /** Gets or sets the texture format to use */
  141907. format: number;
  141908. /**
  141909. * Create a new RawTexture2DArray
  141910. * @param data defines the data of the texture
  141911. * @param width defines the width of the texture
  141912. * @param height defines the height of the texture
  141913. * @param depth defines the number of layers of the texture
  141914. * @param format defines the texture format to use
  141915. * @param scene defines the hosting scene
  141916. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141917. * @param invertY defines if texture must be stored with Y axis inverted
  141918. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141919. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141920. */
  141921. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141922. /** Gets or sets the texture format to use */
  141923. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141924. /**
  141925. * Update the texture with new data
  141926. * @param data defines the data to store in the texture
  141927. */
  141928. update(data: ArrayBufferView): void;
  141929. }
  141930. }
  141931. declare module BABYLON {
  141932. /**
  141933. * Class used to store 3D textures containing user data
  141934. */
  141935. export class RawTexture3D extends Texture {
  141936. /** Gets or sets the texture format to use */
  141937. format: number;
  141938. /**
  141939. * Create a new RawTexture3D
  141940. * @param data defines the data of the texture
  141941. * @param width defines the width of the texture
  141942. * @param height defines the height of the texture
  141943. * @param depth defines the depth of the texture
  141944. * @param format defines the texture format to use
  141945. * @param scene defines the hosting scene
  141946. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141947. * @param invertY defines if texture must be stored with Y axis inverted
  141948. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141949. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141950. */
  141951. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141952. /** Gets or sets the texture format to use */
  141953. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141954. /**
  141955. * Update the texture with new data
  141956. * @param data defines the data to store in the texture
  141957. */
  141958. update(data: ArrayBufferView): void;
  141959. }
  141960. }
  141961. declare module BABYLON {
  141962. /**
  141963. * Creates a refraction texture used by refraction channel of the standard material.
  141964. * It is like a mirror but to see through a material.
  141965. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141966. */
  141967. export class RefractionTexture extends RenderTargetTexture {
  141968. /**
  141969. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141970. * 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.
  141971. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141972. */
  141973. refractionPlane: Plane;
  141974. /**
  141975. * Define how deep under the surface we should see.
  141976. */
  141977. depth: number;
  141978. /**
  141979. * Creates a refraction texture used by refraction channel of the standard material.
  141980. * It is like a mirror but to see through a material.
  141981. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141982. * @param name Define the texture name
  141983. * @param size Define the size of the underlying texture
  141984. * @param scene Define the scene the refraction belongs to
  141985. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141986. */
  141987. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141988. /**
  141989. * Clone the refraction texture.
  141990. * @returns the cloned texture
  141991. */
  141992. clone(): RefractionTexture;
  141993. /**
  141994. * Serialize the texture to a JSON representation you could use in Parse later on
  141995. * @returns the serialized JSON representation
  141996. */
  141997. serialize(): any;
  141998. }
  141999. }
  142000. declare module BABYLON {
  142001. /**
  142002. * Block used to add support for vertex skinning (bones)
  142003. */
  142004. export class BonesBlock extends NodeMaterialBlock {
  142005. /**
  142006. * Creates a new BonesBlock
  142007. * @param name defines the block name
  142008. */
  142009. constructor(name: string);
  142010. /**
  142011. * Initialize the block and prepare the context for build
  142012. * @param state defines the state that will be used for the build
  142013. */
  142014. initialize(state: NodeMaterialBuildState): void;
  142015. /**
  142016. * Gets the current class name
  142017. * @returns the class name
  142018. */
  142019. getClassName(): string;
  142020. /**
  142021. * Gets the matrix indices input component
  142022. */
  142023. get matricesIndices(): NodeMaterialConnectionPoint;
  142024. /**
  142025. * Gets the matrix weights input component
  142026. */
  142027. get matricesWeights(): NodeMaterialConnectionPoint;
  142028. /**
  142029. * Gets the extra matrix indices input component
  142030. */
  142031. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  142032. /**
  142033. * Gets the extra matrix weights input component
  142034. */
  142035. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  142036. /**
  142037. * Gets the world input component
  142038. */
  142039. get world(): NodeMaterialConnectionPoint;
  142040. /**
  142041. * Gets the output component
  142042. */
  142043. get output(): NodeMaterialConnectionPoint;
  142044. autoConfigure(material: NodeMaterial): void;
  142045. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  142046. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142047. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142048. protected _buildBlock(state: NodeMaterialBuildState): this;
  142049. }
  142050. }
  142051. declare module BABYLON {
  142052. /**
  142053. * Block used to add support for instances
  142054. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  142055. */
  142056. export class InstancesBlock extends NodeMaterialBlock {
  142057. /**
  142058. * Creates a new InstancesBlock
  142059. * @param name defines the block name
  142060. */
  142061. constructor(name: string);
  142062. /**
  142063. * Gets the current class name
  142064. * @returns the class name
  142065. */
  142066. getClassName(): string;
  142067. /**
  142068. * Gets the first world row input component
  142069. */
  142070. get world0(): NodeMaterialConnectionPoint;
  142071. /**
  142072. * Gets the second world row input component
  142073. */
  142074. get world1(): NodeMaterialConnectionPoint;
  142075. /**
  142076. * Gets the third world row input component
  142077. */
  142078. get world2(): NodeMaterialConnectionPoint;
  142079. /**
  142080. * Gets the forth world row input component
  142081. */
  142082. get world3(): NodeMaterialConnectionPoint;
  142083. /**
  142084. * Gets the world input component
  142085. */
  142086. get world(): NodeMaterialConnectionPoint;
  142087. /**
  142088. * Gets the output component
  142089. */
  142090. get output(): NodeMaterialConnectionPoint;
  142091. /**
  142092. * Gets the isntanceID component
  142093. */
  142094. get instanceID(): NodeMaterialConnectionPoint;
  142095. autoConfigure(material: NodeMaterial): void;
  142096. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  142097. protected _buildBlock(state: NodeMaterialBuildState): this;
  142098. }
  142099. }
  142100. declare module BABYLON {
  142101. /**
  142102. * Block used to add morph targets support to vertex shader
  142103. */
  142104. export class MorphTargetsBlock extends NodeMaterialBlock {
  142105. private _repeatableContentAnchor;
  142106. /**
  142107. * Create a new MorphTargetsBlock
  142108. * @param name defines the block name
  142109. */
  142110. constructor(name: string);
  142111. /**
  142112. * Gets the current class name
  142113. * @returns the class name
  142114. */
  142115. getClassName(): string;
  142116. /**
  142117. * Gets the position input component
  142118. */
  142119. get position(): NodeMaterialConnectionPoint;
  142120. /**
  142121. * Gets the normal input component
  142122. */
  142123. get normal(): NodeMaterialConnectionPoint;
  142124. /**
  142125. * Gets the tangent input component
  142126. */
  142127. get tangent(): NodeMaterialConnectionPoint;
  142128. /**
  142129. * Gets the tangent input component
  142130. */
  142131. get uv(): NodeMaterialConnectionPoint;
  142132. /**
  142133. * Gets the position output component
  142134. */
  142135. get positionOutput(): NodeMaterialConnectionPoint;
  142136. /**
  142137. * Gets the normal output component
  142138. */
  142139. get normalOutput(): NodeMaterialConnectionPoint;
  142140. /**
  142141. * Gets the tangent output component
  142142. */
  142143. get tangentOutput(): NodeMaterialConnectionPoint;
  142144. /**
  142145. * Gets the tangent output component
  142146. */
  142147. get uvOutput(): NodeMaterialConnectionPoint;
  142148. initialize(state: NodeMaterialBuildState): void;
  142149. autoConfigure(material: NodeMaterial): void;
  142150. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142151. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142152. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  142153. protected _buildBlock(state: NodeMaterialBuildState): this;
  142154. }
  142155. }
  142156. declare module BABYLON {
  142157. /**
  142158. * Block used to get data information from a light
  142159. */
  142160. export class LightInformationBlock extends NodeMaterialBlock {
  142161. private _lightDataUniformName;
  142162. private _lightColorUniformName;
  142163. private _lightTypeDefineName;
  142164. /**
  142165. * Gets or sets the light associated with this block
  142166. */
  142167. light: Nullable<Light>;
  142168. /**
  142169. * Creates a new LightInformationBlock
  142170. * @param name defines the block name
  142171. */
  142172. constructor(name: string);
  142173. /**
  142174. * Gets the current class name
  142175. * @returns the class name
  142176. */
  142177. getClassName(): string;
  142178. /**
  142179. * Gets the world position input component
  142180. */
  142181. get worldPosition(): NodeMaterialConnectionPoint;
  142182. /**
  142183. * Gets the direction output component
  142184. */
  142185. get direction(): NodeMaterialConnectionPoint;
  142186. /**
  142187. * Gets the direction output component
  142188. */
  142189. get color(): NodeMaterialConnectionPoint;
  142190. /**
  142191. * Gets the direction output component
  142192. */
  142193. get intensity(): NodeMaterialConnectionPoint;
  142194. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142195. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142196. protected _buildBlock(state: NodeMaterialBuildState): this;
  142197. serialize(): any;
  142198. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142199. }
  142200. }
  142201. declare module BABYLON {
  142202. /**
  142203. * Block used to add image processing support to fragment shader
  142204. */
  142205. export class ImageProcessingBlock extends NodeMaterialBlock {
  142206. /**
  142207. * Create a new ImageProcessingBlock
  142208. * @param name defines the block name
  142209. */
  142210. constructor(name: string);
  142211. /**
  142212. * Gets the current class name
  142213. * @returns the class name
  142214. */
  142215. getClassName(): string;
  142216. /**
  142217. * Gets the color input component
  142218. */
  142219. get color(): NodeMaterialConnectionPoint;
  142220. /**
  142221. * Gets the output component
  142222. */
  142223. get output(): NodeMaterialConnectionPoint;
  142224. /**
  142225. * Initialize the block and prepare the context for build
  142226. * @param state defines the state that will be used for the build
  142227. */
  142228. initialize(state: NodeMaterialBuildState): void;
  142229. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142230. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142231. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142232. protected _buildBlock(state: NodeMaterialBuildState): this;
  142233. }
  142234. }
  142235. declare module BABYLON {
  142236. /**
  142237. * Block used to pertub normals based on a normal map
  142238. */
  142239. export class PerturbNormalBlock extends NodeMaterialBlock {
  142240. private _tangentSpaceParameterName;
  142241. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142242. invertX: boolean;
  142243. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142244. invertY: boolean;
  142245. /**
  142246. * Create a new PerturbNormalBlock
  142247. * @param name defines the block name
  142248. */
  142249. constructor(name: string);
  142250. /**
  142251. * Gets the current class name
  142252. * @returns the class name
  142253. */
  142254. getClassName(): string;
  142255. /**
  142256. * Gets the world position input component
  142257. */
  142258. get worldPosition(): NodeMaterialConnectionPoint;
  142259. /**
  142260. * Gets the world normal input component
  142261. */
  142262. get worldNormal(): NodeMaterialConnectionPoint;
  142263. /**
  142264. * Gets the world tangent input component
  142265. */
  142266. get worldTangent(): NodeMaterialConnectionPoint;
  142267. /**
  142268. * Gets the uv input component
  142269. */
  142270. get uv(): NodeMaterialConnectionPoint;
  142271. /**
  142272. * Gets the normal map color input component
  142273. */
  142274. get normalMapColor(): NodeMaterialConnectionPoint;
  142275. /**
  142276. * Gets the strength input component
  142277. */
  142278. get strength(): NodeMaterialConnectionPoint;
  142279. /**
  142280. * Gets the output component
  142281. */
  142282. get output(): NodeMaterialConnectionPoint;
  142283. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142284. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142285. autoConfigure(material: NodeMaterial): void;
  142286. protected _buildBlock(state: NodeMaterialBuildState): this;
  142287. protected _dumpPropertiesCode(): string;
  142288. serialize(): any;
  142289. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142290. }
  142291. }
  142292. declare module BABYLON {
  142293. /**
  142294. * Block used to discard a pixel if a value is smaller than a cutoff
  142295. */
  142296. export class DiscardBlock extends NodeMaterialBlock {
  142297. /**
  142298. * Create a new DiscardBlock
  142299. * @param name defines the block name
  142300. */
  142301. constructor(name: string);
  142302. /**
  142303. * Gets the current class name
  142304. * @returns the class name
  142305. */
  142306. getClassName(): string;
  142307. /**
  142308. * Gets the color input component
  142309. */
  142310. get value(): NodeMaterialConnectionPoint;
  142311. /**
  142312. * Gets the cutoff input component
  142313. */
  142314. get cutoff(): NodeMaterialConnectionPoint;
  142315. protected _buildBlock(state: NodeMaterialBuildState): this;
  142316. }
  142317. }
  142318. declare module BABYLON {
  142319. /**
  142320. * Block used to test if the fragment shader is front facing
  142321. */
  142322. export class FrontFacingBlock extends NodeMaterialBlock {
  142323. /**
  142324. * Creates a new FrontFacingBlock
  142325. * @param name defines the block name
  142326. */
  142327. constructor(name: string);
  142328. /**
  142329. * Gets the current class name
  142330. * @returns the class name
  142331. */
  142332. getClassName(): string;
  142333. /**
  142334. * Gets the output component
  142335. */
  142336. get output(): NodeMaterialConnectionPoint;
  142337. protected _buildBlock(state: NodeMaterialBuildState): this;
  142338. }
  142339. }
  142340. declare module BABYLON {
  142341. /**
  142342. * Block used to get the derivative value on x and y of a given input
  142343. */
  142344. export class DerivativeBlock extends NodeMaterialBlock {
  142345. /**
  142346. * Create a new DerivativeBlock
  142347. * @param name defines the block name
  142348. */
  142349. constructor(name: string);
  142350. /**
  142351. * Gets the current class name
  142352. * @returns the class name
  142353. */
  142354. getClassName(): string;
  142355. /**
  142356. * Gets the input component
  142357. */
  142358. get input(): NodeMaterialConnectionPoint;
  142359. /**
  142360. * Gets the derivative output on x
  142361. */
  142362. get dx(): NodeMaterialConnectionPoint;
  142363. /**
  142364. * Gets the derivative output on y
  142365. */
  142366. get dy(): NodeMaterialConnectionPoint;
  142367. protected _buildBlock(state: NodeMaterialBuildState): this;
  142368. }
  142369. }
  142370. declare module BABYLON {
  142371. /**
  142372. * Block used to make gl_FragCoord available
  142373. */
  142374. export class FragCoordBlock extends NodeMaterialBlock {
  142375. /**
  142376. * Creates a new FragCoordBlock
  142377. * @param name defines the block name
  142378. */
  142379. constructor(name: string);
  142380. /**
  142381. * Gets the current class name
  142382. * @returns the class name
  142383. */
  142384. getClassName(): string;
  142385. /**
  142386. * Gets the xy component
  142387. */
  142388. get xy(): NodeMaterialConnectionPoint;
  142389. /**
  142390. * Gets the xyz component
  142391. */
  142392. get xyz(): NodeMaterialConnectionPoint;
  142393. /**
  142394. * Gets the xyzw component
  142395. */
  142396. get xyzw(): NodeMaterialConnectionPoint;
  142397. /**
  142398. * Gets the x component
  142399. */
  142400. get x(): NodeMaterialConnectionPoint;
  142401. /**
  142402. * Gets the y component
  142403. */
  142404. get y(): NodeMaterialConnectionPoint;
  142405. /**
  142406. * Gets the z component
  142407. */
  142408. get z(): NodeMaterialConnectionPoint;
  142409. /**
  142410. * Gets the w component
  142411. */
  142412. get output(): NodeMaterialConnectionPoint;
  142413. protected writeOutputs(state: NodeMaterialBuildState): string;
  142414. protected _buildBlock(state: NodeMaterialBuildState): this;
  142415. }
  142416. }
  142417. declare module BABYLON {
  142418. /**
  142419. * Block used to get the screen sizes
  142420. */
  142421. export class ScreenSizeBlock extends NodeMaterialBlock {
  142422. private _varName;
  142423. private _scene;
  142424. /**
  142425. * Creates a new ScreenSizeBlock
  142426. * @param name defines the block name
  142427. */
  142428. constructor(name: string);
  142429. /**
  142430. * Gets the current class name
  142431. * @returns the class name
  142432. */
  142433. getClassName(): string;
  142434. /**
  142435. * Gets the xy component
  142436. */
  142437. get xy(): NodeMaterialConnectionPoint;
  142438. /**
  142439. * Gets the x component
  142440. */
  142441. get x(): NodeMaterialConnectionPoint;
  142442. /**
  142443. * Gets the y component
  142444. */
  142445. get y(): NodeMaterialConnectionPoint;
  142446. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142447. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142448. protected _buildBlock(state: NodeMaterialBuildState): this;
  142449. }
  142450. }
  142451. declare module BABYLON {
  142452. /**
  142453. * Block used to add support for scene fog
  142454. */
  142455. export class FogBlock extends NodeMaterialBlock {
  142456. private _fogDistanceName;
  142457. private _fogParameters;
  142458. /**
  142459. * Create a new FogBlock
  142460. * @param name defines the block name
  142461. */
  142462. constructor(name: string);
  142463. /**
  142464. * Gets the current class name
  142465. * @returns the class name
  142466. */
  142467. getClassName(): string;
  142468. /**
  142469. * Gets the world position input component
  142470. */
  142471. get worldPosition(): NodeMaterialConnectionPoint;
  142472. /**
  142473. * Gets the view input component
  142474. */
  142475. get view(): NodeMaterialConnectionPoint;
  142476. /**
  142477. * Gets the color input component
  142478. */
  142479. get input(): NodeMaterialConnectionPoint;
  142480. /**
  142481. * Gets the fog color input component
  142482. */
  142483. get fogColor(): NodeMaterialConnectionPoint;
  142484. /**
  142485. * Gets the output component
  142486. */
  142487. get output(): NodeMaterialConnectionPoint;
  142488. autoConfigure(material: NodeMaterial): void;
  142489. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142490. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142491. protected _buildBlock(state: NodeMaterialBuildState): this;
  142492. }
  142493. }
  142494. declare module BABYLON {
  142495. /**
  142496. * Block used to add light in the fragment shader
  142497. */
  142498. export class LightBlock extends NodeMaterialBlock {
  142499. private _lightId;
  142500. /**
  142501. * Gets or sets the light associated with this block
  142502. */
  142503. light: Nullable<Light>;
  142504. /**
  142505. * Create a new LightBlock
  142506. * @param name defines the block name
  142507. */
  142508. constructor(name: string);
  142509. /**
  142510. * Gets the current class name
  142511. * @returns the class name
  142512. */
  142513. getClassName(): string;
  142514. /**
  142515. * Gets the world position input component
  142516. */
  142517. get worldPosition(): NodeMaterialConnectionPoint;
  142518. /**
  142519. * Gets the world normal input component
  142520. */
  142521. get worldNormal(): NodeMaterialConnectionPoint;
  142522. /**
  142523. * Gets the camera (or eye) position component
  142524. */
  142525. get cameraPosition(): NodeMaterialConnectionPoint;
  142526. /**
  142527. * Gets the glossiness component
  142528. */
  142529. get glossiness(): NodeMaterialConnectionPoint;
  142530. /**
  142531. * Gets the glossinness power component
  142532. */
  142533. get glossPower(): NodeMaterialConnectionPoint;
  142534. /**
  142535. * Gets the diffuse color component
  142536. */
  142537. get diffuseColor(): NodeMaterialConnectionPoint;
  142538. /**
  142539. * Gets the specular color component
  142540. */
  142541. get specularColor(): NodeMaterialConnectionPoint;
  142542. /**
  142543. * Gets the diffuse output component
  142544. */
  142545. get diffuseOutput(): NodeMaterialConnectionPoint;
  142546. /**
  142547. * Gets the specular output component
  142548. */
  142549. get specularOutput(): NodeMaterialConnectionPoint;
  142550. /**
  142551. * Gets the shadow output component
  142552. */
  142553. get shadow(): NodeMaterialConnectionPoint;
  142554. autoConfigure(material: NodeMaterial): void;
  142555. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142556. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142557. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142558. private _injectVertexCode;
  142559. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142560. serialize(): any;
  142561. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142562. }
  142563. }
  142564. declare module BABYLON {
  142565. /**
  142566. * Block used to read a reflection texture from a sampler
  142567. */
  142568. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142569. /**
  142570. * Create a new ReflectionTextureBlock
  142571. * @param name defines the block name
  142572. */
  142573. constructor(name: string);
  142574. /**
  142575. * Gets the current class name
  142576. * @returns the class name
  142577. */
  142578. getClassName(): string;
  142579. /**
  142580. * Gets the world position input component
  142581. */
  142582. get position(): NodeMaterialConnectionPoint;
  142583. /**
  142584. * Gets the world position input component
  142585. */
  142586. get worldPosition(): NodeMaterialConnectionPoint;
  142587. /**
  142588. * Gets the world normal input component
  142589. */
  142590. get worldNormal(): NodeMaterialConnectionPoint;
  142591. /**
  142592. * Gets the world input component
  142593. */
  142594. get world(): NodeMaterialConnectionPoint;
  142595. /**
  142596. * Gets the camera (or eye) position component
  142597. */
  142598. get cameraPosition(): NodeMaterialConnectionPoint;
  142599. /**
  142600. * Gets the view input component
  142601. */
  142602. get view(): NodeMaterialConnectionPoint;
  142603. /**
  142604. * Gets the rgb output component
  142605. */
  142606. get rgb(): NodeMaterialConnectionPoint;
  142607. /**
  142608. * Gets the rgba output component
  142609. */
  142610. get rgba(): NodeMaterialConnectionPoint;
  142611. /**
  142612. * Gets the r output component
  142613. */
  142614. get r(): NodeMaterialConnectionPoint;
  142615. /**
  142616. * Gets the g output component
  142617. */
  142618. get g(): NodeMaterialConnectionPoint;
  142619. /**
  142620. * Gets the b output component
  142621. */
  142622. get b(): NodeMaterialConnectionPoint;
  142623. /**
  142624. * Gets the a output component
  142625. */
  142626. get a(): NodeMaterialConnectionPoint;
  142627. autoConfigure(material: NodeMaterial): void;
  142628. protected _buildBlock(state: NodeMaterialBuildState): this;
  142629. }
  142630. }
  142631. declare module BABYLON {
  142632. /**
  142633. * Block used to add 2 vectors
  142634. */
  142635. export class AddBlock extends NodeMaterialBlock {
  142636. /**
  142637. * Creates a new AddBlock
  142638. * @param name defines the block name
  142639. */
  142640. constructor(name: string);
  142641. /**
  142642. * Gets the current class name
  142643. * @returns the class name
  142644. */
  142645. getClassName(): string;
  142646. /**
  142647. * Gets the left operand input component
  142648. */
  142649. get left(): NodeMaterialConnectionPoint;
  142650. /**
  142651. * Gets the right operand input component
  142652. */
  142653. get right(): NodeMaterialConnectionPoint;
  142654. /**
  142655. * Gets the output component
  142656. */
  142657. get output(): NodeMaterialConnectionPoint;
  142658. protected _buildBlock(state: NodeMaterialBuildState): this;
  142659. }
  142660. }
  142661. declare module BABYLON {
  142662. /**
  142663. * Block used to scale a vector by a float
  142664. */
  142665. export class ScaleBlock extends NodeMaterialBlock {
  142666. /**
  142667. * Creates a new ScaleBlock
  142668. * @param name defines the block name
  142669. */
  142670. constructor(name: string);
  142671. /**
  142672. * Gets the current class name
  142673. * @returns the class name
  142674. */
  142675. getClassName(): string;
  142676. /**
  142677. * Gets the input component
  142678. */
  142679. get input(): NodeMaterialConnectionPoint;
  142680. /**
  142681. * Gets the factor input component
  142682. */
  142683. get factor(): NodeMaterialConnectionPoint;
  142684. /**
  142685. * Gets the output component
  142686. */
  142687. get output(): NodeMaterialConnectionPoint;
  142688. protected _buildBlock(state: NodeMaterialBuildState): this;
  142689. }
  142690. }
  142691. declare module BABYLON {
  142692. /**
  142693. * Block used to clamp a float
  142694. */
  142695. export class ClampBlock extends NodeMaterialBlock {
  142696. /** Gets or sets the minimum range */
  142697. minimum: number;
  142698. /** Gets or sets the maximum range */
  142699. maximum: number;
  142700. /**
  142701. * Creates a new ClampBlock
  142702. * @param name defines the block name
  142703. */
  142704. constructor(name: string);
  142705. /**
  142706. * Gets the current class name
  142707. * @returns the class name
  142708. */
  142709. getClassName(): string;
  142710. /**
  142711. * Gets the value input component
  142712. */
  142713. get value(): NodeMaterialConnectionPoint;
  142714. /**
  142715. * Gets the output component
  142716. */
  142717. get output(): NodeMaterialConnectionPoint;
  142718. protected _buildBlock(state: NodeMaterialBuildState): this;
  142719. protected _dumpPropertiesCode(): string;
  142720. serialize(): any;
  142721. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142722. }
  142723. }
  142724. declare module BABYLON {
  142725. /**
  142726. * Block used to apply a cross product between 2 vectors
  142727. */
  142728. export class CrossBlock extends NodeMaterialBlock {
  142729. /**
  142730. * Creates a new CrossBlock
  142731. * @param name defines the block name
  142732. */
  142733. constructor(name: string);
  142734. /**
  142735. * Gets the current class name
  142736. * @returns the class name
  142737. */
  142738. getClassName(): string;
  142739. /**
  142740. * Gets the left operand input component
  142741. */
  142742. get left(): NodeMaterialConnectionPoint;
  142743. /**
  142744. * Gets the right operand input component
  142745. */
  142746. get right(): NodeMaterialConnectionPoint;
  142747. /**
  142748. * Gets the output component
  142749. */
  142750. get output(): NodeMaterialConnectionPoint;
  142751. protected _buildBlock(state: NodeMaterialBuildState): this;
  142752. }
  142753. }
  142754. declare module BABYLON {
  142755. /**
  142756. * Block used to apply a dot product between 2 vectors
  142757. */
  142758. export class DotBlock extends NodeMaterialBlock {
  142759. /**
  142760. * Creates a new DotBlock
  142761. * @param name defines the block name
  142762. */
  142763. constructor(name: string);
  142764. /**
  142765. * Gets the current class name
  142766. * @returns the class name
  142767. */
  142768. getClassName(): string;
  142769. /**
  142770. * Gets the left operand input component
  142771. */
  142772. get left(): NodeMaterialConnectionPoint;
  142773. /**
  142774. * Gets the right operand input component
  142775. */
  142776. get right(): NodeMaterialConnectionPoint;
  142777. /**
  142778. * Gets the output component
  142779. */
  142780. get output(): NodeMaterialConnectionPoint;
  142781. protected _buildBlock(state: NodeMaterialBuildState): this;
  142782. }
  142783. }
  142784. declare module BABYLON {
  142785. /**
  142786. * Block used to normalize a vector
  142787. */
  142788. export class NormalizeBlock extends NodeMaterialBlock {
  142789. /**
  142790. * Creates a new NormalizeBlock
  142791. * @param name defines the block name
  142792. */
  142793. constructor(name: string);
  142794. /**
  142795. * Gets the current class name
  142796. * @returns the class name
  142797. */
  142798. getClassName(): string;
  142799. /**
  142800. * Gets the input component
  142801. */
  142802. get input(): NodeMaterialConnectionPoint;
  142803. /**
  142804. * Gets the output component
  142805. */
  142806. get output(): NodeMaterialConnectionPoint;
  142807. protected _buildBlock(state: NodeMaterialBuildState): this;
  142808. }
  142809. }
  142810. declare module BABYLON {
  142811. /**
  142812. * Operations supported by the Trigonometry block
  142813. */
  142814. export enum TrigonometryBlockOperations {
  142815. /** Cos */
  142816. Cos = 0,
  142817. /** Sin */
  142818. Sin = 1,
  142819. /** Abs */
  142820. Abs = 2,
  142821. /** Exp */
  142822. Exp = 3,
  142823. /** Exp2 */
  142824. Exp2 = 4,
  142825. /** Round */
  142826. Round = 5,
  142827. /** Floor */
  142828. Floor = 6,
  142829. /** Ceiling */
  142830. Ceiling = 7,
  142831. /** Square root */
  142832. Sqrt = 8,
  142833. /** Log */
  142834. Log = 9,
  142835. /** Tangent */
  142836. Tan = 10,
  142837. /** Arc tangent */
  142838. ArcTan = 11,
  142839. /** Arc cosinus */
  142840. ArcCos = 12,
  142841. /** Arc sinus */
  142842. ArcSin = 13,
  142843. /** Fraction */
  142844. Fract = 14,
  142845. /** Sign */
  142846. Sign = 15,
  142847. /** To radians (from degrees) */
  142848. Radians = 16,
  142849. /** To degrees (from radians) */
  142850. Degrees = 17
  142851. }
  142852. /**
  142853. * Block used to apply trigonometry operation to floats
  142854. */
  142855. export class TrigonometryBlock extends NodeMaterialBlock {
  142856. /**
  142857. * Gets or sets the operation applied by the block
  142858. */
  142859. operation: TrigonometryBlockOperations;
  142860. /**
  142861. * Creates a new TrigonometryBlock
  142862. * @param name defines the block name
  142863. */
  142864. constructor(name: string);
  142865. /**
  142866. * Gets the current class name
  142867. * @returns the class name
  142868. */
  142869. getClassName(): string;
  142870. /**
  142871. * Gets the input component
  142872. */
  142873. get input(): NodeMaterialConnectionPoint;
  142874. /**
  142875. * Gets the output component
  142876. */
  142877. get output(): NodeMaterialConnectionPoint;
  142878. protected _buildBlock(state: NodeMaterialBuildState): this;
  142879. serialize(): any;
  142880. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142881. protected _dumpPropertiesCode(): string;
  142882. }
  142883. }
  142884. declare module BABYLON {
  142885. /**
  142886. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142887. */
  142888. export class ColorMergerBlock extends NodeMaterialBlock {
  142889. /**
  142890. * Create a new ColorMergerBlock
  142891. * @param name defines the block name
  142892. */
  142893. constructor(name: string);
  142894. /**
  142895. * Gets the current class name
  142896. * @returns the class name
  142897. */
  142898. getClassName(): string;
  142899. /**
  142900. * Gets the rgb component (input)
  142901. */
  142902. get rgbIn(): NodeMaterialConnectionPoint;
  142903. /**
  142904. * Gets the r component (input)
  142905. */
  142906. get r(): NodeMaterialConnectionPoint;
  142907. /**
  142908. * Gets the g component (input)
  142909. */
  142910. get g(): NodeMaterialConnectionPoint;
  142911. /**
  142912. * Gets the b component (input)
  142913. */
  142914. get b(): NodeMaterialConnectionPoint;
  142915. /**
  142916. * Gets the a component (input)
  142917. */
  142918. get a(): NodeMaterialConnectionPoint;
  142919. /**
  142920. * Gets the rgba component (output)
  142921. */
  142922. get rgba(): NodeMaterialConnectionPoint;
  142923. /**
  142924. * Gets the rgb component (output)
  142925. */
  142926. get rgbOut(): NodeMaterialConnectionPoint;
  142927. /**
  142928. * Gets the rgb component (output)
  142929. * @deprecated Please use rgbOut instead.
  142930. */
  142931. get rgb(): NodeMaterialConnectionPoint;
  142932. protected _buildBlock(state: NodeMaterialBuildState): this;
  142933. }
  142934. }
  142935. declare module BABYLON {
  142936. /**
  142937. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142938. */
  142939. export class VectorSplitterBlock extends NodeMaterialBlock {
  142940. /**
  142941. * Create a new VectorSplitterBlock
  142942. * @param name defines the block name
  142943. */
  142944. constructor(name: string);
  142945. /**
  142946. * Gets the current class name
  142947. * @returns the class name
  142948. */
  142949. getClassName(): string;
  142950. /**
  142951. * Gets the xyzw component (input)
  142952. */
  142953. get xyzw(): NodeMaterialConnectionPoint;
  142954. /**
  142955. * Gets the xyz component (input)
  142956. */
  142957. get xyzIn(): NodeMaterialConnectionPoint;
  142958. /**
  142959. * Gets the xy component (input)
  142960. */
  142961. get xyIn(): NodeMaterialConnectionPoint;
  142962. /**
  142963. * Gets the xyz component (output)
  142964. */
  142965. get xyzOut(): NodeMaterialConnectionPoint;
  142966. /**
  142967. * Gets the xy component (output)
  142968. */
  142969. get xyOut(): NodeMaterialConnectionPoint;
  142970. /**
  142971. * Gets the x component (output)
  142972. */
  142973. get x(): NodeMaterialConnectionPoint;
  142974. /**
  142975. * Gets the y component (output)
  142976. */
  142977. get y(): NodeMaterialConnectionPoint;
  142978. /**
  142979. * Gets the z component (output)
  142980. */
  142981. get z(): NodeMaterialConnectionPoint;
  142982. /**
  142983. * Gets the w component (output)
  142984. */
  142985. get w(): NodeMaterialConnectionPoint;
  142986. protected _inputRename(name: string): string;
  142987. protected _outputRename(name: string): string;
  142988. protected _buildBlock(state: NodeMaterialBuildState): this;
  142989. }
  142990. }
  142991. declare module BABYLON {
  142992. /**
  142993. * Block used to lerp between 2 values
  142994. */
  142995. export class LerpBlock extends NodeMaterialBlock {
  142996. /**
  142997. * Creates a new LerpBlock
  142998. * @param name defines the block name
  142999. */
  143000. constructor(name: string);
  143001. /**
  143002. * Gets the current class name
  143003. * @returns the class name
  143004. */
  143005. getClassName(): string;
  143006. /**
  143007. * Gets the left operand input component
  143008. */
  143009. get left(): NodeMaterialConnectionPoint;
  143010. /**
  143011. * Gets the right operand input component
  143012. */
  143013. get right(): NodeMaterialConnectionPoint;
  143014. /**
  143015. * Gets the gradient operand input component
  143016. */
  143017. get gradient(): NodeMaterialConnectionPoint;
  143018. /**
  143019. * Gets the output component
  143020. */
  143021. get output(): NodeMaterialConnectionPoint;
  143022. protected _buildBlock(state: NodeMaterialBuildState): this;
  143023. }
  143024. }
  143025. declare module BABYLON {
  143026. /**
  143027. * Block used to divide 2 vectors
  143028. */
  143029. export class DivideBlock extends NodeMaterialBlock {
  143030. /**
  143031. * Creates a new DivideBlock
  143032. * @param name defines the block name
  143033. */
  143034. constructor(name: string);
  143035. /**
  143036. * Gets the current class name
  143037. * @returns the class name
  143038. */
  143039. getClassName(): string;
  143040. /**
  143041. * Gets the left operand input component
  143042. */
  143043. get left(): NodeMaterialConnectionPoint;
  143044. /**
  143045. * Gets the right operand input component
  143046. */
  143047. get right(): NodeMaterialConnectionPoint;
  143048. /**
  143049. * Gets the output component
  143050. */
  143051. get output(): NodeMaterialConnectionPoint;
  143052. protected _buildBlock(state: NodeMaterialBuildState): this;
  143053. }
  143054. }
  143055. declare module BABYLON {
  143056. /**
  143057. * Block used to subtract 2 vectors
  143058. */
  143059. export class SubtractBlock extends NodeMaterialBlock {
  143060. /**
  143061. * Creates a new SubtractBlock
  143062. * @param name defines the block name
  143063. */
  143064. constructor(name: string);
  143065. /**
  143066. * Gets the current class name
  143067. * @returns the class name
  143068. */
  143069. getClassName(): string;
  143070. /**
  143071. * Gets the left operand input component
  143072. */
  143073. get left(): NodeMaterialConnectionPoint;
  143074. /**
  143075. * Gets the right operand input component
  143076. */
  143077. get right(): NodeMaterialConnectionPoint;
  143078. /**
  143079. * Gets the output component
  143080. */
  143081. get output(): NodeMaterialConnectionPoint;
  143082. protected _buildBlock(state: NodeMaterialBuildState): this;
  143083. }
  143084. }
  143085. declare module BABYLON {
  143086. /**
  143087. * Block used to step a value
  143088. */
  143089. export class StepBlock extends NodeMaterialBlock {
  143090. /**
  143091. * Creates a new StepBlock
  143092. * @param name defines the block name
  143093. */
  143094. constructor(name: string);
  143095. /**
  143096. * Gets the current class name
  143097. * @returns the class name
  143098. */
  143099. getClassName(): string;
  143100. /**
  143101. * Gets the value operand input component
  143102. */
  143103. get value(): NodeMaterialConnectionPoint;
  143104. /**
  143105. * Gets the edge operand input component
  143106. */
  143107. get edge(): NodeMaterialConnectionPoint;
  143108. /**
  143109. * Gets the output component
  143110. */
  143111. get output(): NodeMaterialConnectionPoint;
  143112. protected _buildBlock(state: NodeMaterialBuildState): this;
  143113. }
  143114. }
  143115. declare module BABYLON {
  143116. /**
  143117. * Block used to get the opposite (1 - x) of a value
  143118. */
  143119. export class OneMinusBlock extends NodeMaterialBlock {
  143120. /**
  143121. * Creates a new OneMinusBlock
  143122. * @param name defines the block name
  143123. */
  143124. constructor(name: string);
  143125. /**
  143126. * Gets the current class name
  143127. * @returns the class name
  143128. */
  143129. getClassName(): string;
  143130. /**
  143131. * Gets the input component
  143132. */
  143133. get input(): NodeMaterialConnectionPoint;
  143134. /**
  143135. * Gets the output component
  143136. */
  143137. get output(): NodeMaterialConnectionPoint;
  143138. protected _buildBlock(state: NodeMaterialBuildState): this;
  143139. }
  143140. }
  143141. declare module BABYLON {
  143142. /**
  143143. * Block used to get the view direction
  143144. */
  143145. export class ViewDirectionBlock extends NodeMaterialBlock {
  143146. /**
  143147. * Creates a new ViewDirectionBlock
  143148. * @param name defines the block name
  143149. */
  143150. constructor(name: string);
  143151. /**
  143152. * Gets the current class name
  143153. * @returns the class name
  143154. */
  143155. getClassName(): string;
  143156. /**
  143157. * Gets the world position component
  143158. */
  143159. get worldPosition(): NodeMaterialConnectionPoint;
  143160. /**
  143161. * Gets the camera position component
  143162. */
  143163. get cameraPosition(): NodeMaterialConnectionPoint;
  143164. /**
  143165. * Gets the output component
  143166. */
  143167. get output(): NodeMaterialConnectionPoint;
  143168. autoConfigure(material: NodeMaterial): void;
  143169. protected _buildBlock(state: NodeMaterialBuildState): this;
  143170. }
  143171. }
  143172. declare module BABYLON {
  143173. /**
  143174. * Block used to compute fresnel value
  143175. */
  143176. export class FresnelBlock extends NodeMaterialBlock {
  143177. /**
  143178. * Create a new FresnelBlock
  143179. * @param name defines the block name
  143180. */
  143181. constructor(name: string);
  143182. /**
  143183. * Gets the current class name
  143184. * @returns the class name
  143185. */
  143186. getClassName(): string;
  143187. /**
  143188. * Gets the world normal input component
  143189. */
  143190. get worldNormal(): NodeMaterialConnectionPoint;
  143191. /**
  143192. * Gets the view direction input component
  143193. */
  143194. get viewDirection(): NodeMaterialConnectionPoint;
  143195. /**
  143196. * Gets the bias input component
  143197. */
  143198. get bias(): NodeMaterialConnectionPoint;
  143199. /**
  143200. * Gets the camera (or eye) position component
  143201. */
  143202. get power(): NodeMaterialConnectionPoint;
  143203. /**
  143204. * Gets the fresnel output component
  143205. */
  143206. get fresnel(): NodeMaterialConnectionPoint;
  143207. autoConfigure(material: NodeMaterial): void;
  143208. protected _buildBlock(state: NodeMaterialBuildState): this;
  143209. }
  143210. }
  143211. declare module BABYLON {
  143212. /**
  143213. * Block used to get the max of 2 values
  143214. */
  143215. export class MaxBlock extends NodeMaterialBlock {
  143216. /**
  143217. * Creates a new MaxBlock
  143218. * @param name defines the block name
  143219. */
  143220. constructor(name: string);
  143221. /**
  143222. * Gets the current class name
  143223. * @returns the class name
  143224. */
  143225. getClassName(): string;
  143226. /**
  143227. * Gets the left operand input component
  143228. */
  143229. get left(): NodeMaterialConnectionPoint;
  143230. /**
  143231. * Gets the right operand input component
  143232. */
  143233. get right(): NodeMaterialConnectionPoint;
  143234. /**
  143235. * Gets the output component
  143236. */
  143237. get output(): NodeMaterialConnectionPoint;
  143238. protected _buildBlock(state: NodeMaterialBuildState): this;
  143239. }
  143240. }
  143241. declare module BABYLON {
  143242. /**
  143243. * Block used to get the min of 2 values
  143244. */
  143245. export class MinBlock extends NodeMaterialBlock {
  143246. /**
  143247. * Creates a new MinBlock
  143248. * @param name defines the block name
  143249. */
  143250. constructor(name: string);
  143251. /**
  143252. * Gets the current class name
  143253. * @returns the class name
  143254. */
  143255. getClassName(): string;
  143256. /**
  143257. * Gets the left operand input component
  143258. */
  143259. get left(): NodeMaterialConnectionPoint;
  143260. /**
  143261. * Gets the right operand input component
  143262. */
  143263. get right(): NodeMaterialConnectionPoint;
  143264. /**
  143265. * Gets the output component
  143266. */
  143267. get output(): NodeMaterialConnectionPoint;
  143268. protected _buildBlock(state: NodeMaterialBuildState): this;
  143269. }
  143270. }
  143271. declare module BABYLON {
  143272. /**
  143273. * Block used to get the distance between 2 values
  143274. */
  143275. export class DistanceBlock extends NodeMaterialBlock {
  143276. /**
  143277. * Creates a new DistanceBlock
  143278. * @param name defines the block name
  143279. */
  143280. constructor(name: string);
  143281. /**
  143282. * Gets the current class name
  143283. * @returns the class name
  143284. */
  143285. getClassName(): string;
  143286. /**
  143287. * Gets the left operand input component
  143288. */
  143289. get left(): NodeMaterialConnectionPoint;
  143290. /**
  143291. * Gets the right operand input component
  143292. */
  143293. get right(): NodeMaterialConnectionPoint;
  143294. /**
  143295. * Gets the output component
  143296. */
  143297. get output(): NodeMaterialConnectionPoint;
  143298. protected _buildBlock(state: NodeMaterialBuildState): this;
  143299. }
  143300. }
  143301. declare module BABYLON {
  143302. /**
  143303. * Block used to get the length of a vector
  143304. */
  143305. export class LengthBlock extends NodeMaterialBlock {
  143306. /**
  143307. * Creates a new LengthBlock
  143308. * @param name defines the block name
  143309. */
  143310. constructor(name: string);
  143311. /**
  143312. * Gets the current class name
  143313. * @returns the class name
  143314. */
  143315. getClassName(): string;
  143316. /**
  143317. * Gets the value input component
  143318. */
  143319. get value(): NodeMaterialConnectionPoint;
  143320. /**
  143321. * Gets the output component
  143322. */
  143323. get output(): NodeMaterialConnectionPoint;
  143324. protected _buildBlock(state: NodeMaterialBuildState): this;
  143325. }
  143326. }
  143327. declare module BABYLON {
  143328. /**
  143329. * Block used to get negative version of a value (i.e. x * -1)
  143330. */
  143331. export class NegateBlock extends NodeMaterialBlock {
  143332. /**
  143333. * Creates a new NegateBlock
  143334. * @param name defines the block name
  143335. */
  143336. constructor(name: string);
  143337. /**
  143338. * Gets the current class name
  143339. * @returns the class name
  143340. */
  143341. getClassName(): string;
  143342. /**
  143343. * Gets the value input component
  143344. */
  143345. get value(): NodeMaterialConnectionPoint;
  143346. /**
  143347. * Gets the output component
  143348. */
  143349. get output(): NodeMaterialConnectionPoint;
  143350. protected _buildBlock(state: NodeMaterialBuildState): this;
  143351. }
  143352. }
  143353. declare module BABYLON {
  143354. /**
  143355. * Block used to get the value of the first parameter raised to the power of the second
  143356. */
  143357. export class PowBlock extends NodeMaterialBlock {
  143358. /**
  143359. * Creates a new PowBlock
  143360. * @param name defines the block name
  143361. */
  143362. constructor(name: string);
  143363. /**
  143364. * Gets the current class name
  143365. * @returns the class name
  143366. */
  143367. getClassName(): string;
  143368. /**
  143369. * Gets the value operand input component
  143370. */
  143371. get value(): NodeMaterialConnectionPoint;
  143372. /**
  143373. * Gets the power operand input component
  143374. */
  143375. get power(): NodeMaterialConnectionPoint;
  143376. /**
  143377. * Gets the output component
  143378. */
  143379. get output(): NodeMaterialConnectionPoint;
  143380. protected _buildBlock(state: NodeMaterialBuildState): this;
  143381. }
  143382. }
  143383. declare module BABYLON {
  143384. /**
  143385. * Block used to get a random number
  143386. */
  143387. export class RandomNumberBlock extends NodeMaterialBlock {
  143388. /**
  143389. * Creates a new RandomNumberBlock
  143390. * @param name defines the block name
  143391. */
  143392. constructor(name: string);
  143393. /**
  143394. * Gets the current class name
  143395. * @returns the class name
  143396. */
  143397. getClassName(): string;
  143398. /**
  143399. * Gets the seed input component
  143400. */
  143401. get seed(): NodeMaterialConnectionPoint;
  143402. /**
  143403. * Gets the output component
  143404. */
  143405. get output(): NodeMaterialConnectionPoint;
  143406. protected _buildBlock(state: NodeMaterialBuildState): this;
  143407. }
  143408. }
  143409. declare module BABYLON {
  143410. /**
  143411. * Block used to compute arc tangent of 2 values
  143412. */
  143413. export class ArcTan2Block extends NodeMaterialBlock {
  143414. /**
  143415. * Creates a new ArcTan2Block
  143416. * @param name defines the block name
  143417. */
  143418. constructor(name: string);
  143419. /**
  143420. * Gets the current class name
  143421. * @returns the class name
  143422. */
  143423. getClassName(): string;
  143424. /**
  143425. * Gets the x operand input component
  143426. */
  143427. get x(): NodeMaterialConnectionPoint;
  143428. /**
  143429. * Gets the y operand input component
  143430. */
  143431. get y(): NodeMaterialConnectionPoint;
  143432. /**
  143433. * Gets the output component
  143434. */
  143435. get output(): NodeMaterialConnectionPoint;
  143436. protected _buildBlock(state: NodeMaterialBuildState): this;
  143437. }
  143438. }
  143439. declare module BABYLON {
  143440. /**
  143441. * Block used to smooth step a value
  143442. */
  143443. export class SmoothStepBlock extends NodeMaterialBlock {
  143444. /**
  143445. * Creates a new SmoothStepBlock
  143446. * @param name defines the block name
  143447. */
  143448. constructor(name: string);
  143449. /**
  143450. * Gets the current class name
  143451. * @returns the class name
  143452. */
  143453. getClassName(): string;
  143454. /**
  143455. * Gets the value operand input component
  143456. */
  143457. get value(): NodeMaterialConnectionPoint;
  143458. /**
  143459. * Gets the first edge operand input component
  143460. */
  143461. get edge0(): NodeMaterialConnectionPoint;
  143462. /**
  143463. * Gets the second edge operand input component
  143464. */
  143465. get edge1(): NodeMaterialConnectionPoint;
  143466. /**
  143467. * Gets the output component
  143468. */
  143469. get output(): NodeMaterialConnectionPoint;
  143470. protected _buildBlock(state: NodeMaterialBuildState): this;
  143471. }
  143472. }
  143473. declare module BABYLON {
  143474. /**
  143475. * Block used to get the reciprocal (1 / x) of a value
  143476. */
  143477. export class ReciprocalBlock extends NodeMaterialBlock {
  143478. /**
  143479. * Creates a new ReciprocalBlock
  143480. * @param name defines the block name
  143481. */
  143482. constructor(name: string);
  143483. /**
  143484. * Gets the current class name
  143485. * @returns the class name
  143486. */
  143487. getClassName(): string;
  143488. /**
  143489. * Gets the input component
  143490. */
  143491. get input(): NodeMaterialConnectionPoint;
  143492. /**
  143493. * Gets the output component
  143494. */
  143495. get output(): NodeMaterialConnectionPoint;
  143496. protected _buildBlock(state: NodeMaterialBuildState): this;
  143497. }
  143498. }
  143499. declare module BABYLON {
  143500. /**
  143501. * Block used to replace a color by another one
  143502. */
  143503. export class ReplaceColorBlock extends NodeMaterialBlock {
  143504. /**
  143505. * Creates a new ReplaceColorBlock
  143506. * @param name defines the block name
  143507. */
  143508. constructor(name: string);
  143509. /**
  143510. * Gets the current class name
  143511. * @returns the class name
  143512. */
  143513. getClassName(): string;
  143514. /**
  143515. * Gets the value input component
  143516. */
  143517. get value(): NodeMaterialConnectionPoint;
  143518. /**
  143519. * Gets the reference input component
  143520. */
  143521. get reference(): NodeMaterialConnectionPoint;
  143522. /**
  143523. * Gets the distance input component
  143524. */
  143525. get distance(): NodeMaterialConnectionPoint;
  143526. /**
  143527. * Gets the replacement input component
  143528. */
  143529. get replacement(): NodeMaterialConnectionPoint;
  143530. /**
  143531. * Gets the output component
  143532. */
  143533. get output(): NodeMaterialConnectionPoint;
  143534. protected _buildBlock(state: NodeMaterialBuildState): this;
  143535. }
  143536. }
  143537. declare module BABYLON {
  143538. /**
  143539. * Block used to posterize a value
  143540. * @see https://en.wikipedia.org/wiki/Posterization
  143541. */
  143542. export class PosterizeBlock extends NodeMaterialBlock {
  143543. /**
  143544. * Creates a new PosterizeBlock
  143545. * @param name defines the block name
  143546. */
  143547. constructor(name: string);
  143548. /**
  143549. * Gets the current class name
  143550. * @returns the class name
  143551. */
  143552. getClassName(): string;
  143553. /**
  143554. * Gets the value input component
  143555. */
  143556. get value(): NodeMaterialConnectionPoint;
  143557. /**
  143558. * Gets the steps input component
  143559. */
  143560. get steps(): NodeMaterialConnectionPoint;
  143561. /**
  143562. * Gets the output component
  143563. */
  143564. get output(): NodeMaterialConnectionPoint;
  143565. protected _buildBlock(state: NodeMaterialBuildState): this;
  143566. }
  143567. }
  143568. declare module BABYLON {
  143569. /**
  143570. * Operations supported by the Wave block
  143571. */
  143572. export enum WaveBlockKind {
  143573. /** SawTooth */
  143574. SawTooth = 0,
  143575. /** Square */
  143576. Square = 1,
  143577. /** Triangle */
  143578. Triangle = 2
  143579. }
  143580. /**
  143581. * Block used to apply wave operation to floats
  143582. */
  143583. export class WaveBlock extends NodeMaterialBlock {
  143584. /**
  143585. * Gets or sets the kibnd of wave to be applied by the block
  143586. */
  143587. kind: WaveBlockKind;
  143588. /**
  143589. * Creates a new WaveBlock
  143590. * @param name defines the block name
  143591. */
  143592. constructor(name: string);
  143593. /**
  143594. * Gets the current class name
  143595. * @returns the class name
  143596. */
  143597. getClassName(): string;
  143598. /**
  143599. * Gets the input component
  143600. */
  143601. get input(): NodeMaterialConnectionPoint;
  143602. /**
  143603. * Gets the output component
  143604. */
  143605. get output(): NodeMaterialConnectionPoint;
  143606. protected _buildBlock(state: NodeMaterialBuildState): this;
  143607. serialize(): any;
  143608. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143609. }
  143610. }
  143611. declare module BABYLON {
  143612. /**
  143613. * Class used to store a color step for the GradientBlock
  143614. */
  143615. export class GradientBlockColorStep {
  143616. /**
  143617. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143618. */
  143619. step: number;
  143620. /**
  143621. * Gets or sets the color associated with this step
  143622. */
  143623. color: Color3;
  143624. /**
  143625. * Creates a new GradientBlockColorStep
  143626. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143627. * @param color defines the color associated with this step
  143628. */
  143629. constructor(
  143630. /**
  143631. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143632. */
  143633. step: number,
  143634. /**
  143635. * Gets or sets the color associated with this step
  143636. */
  143637. color: Color3);
  143638. }
  143639. /**
  143640. * Block used to return a color from a gradient based on an input value between 0 and 1
  143641. */
  143642. export class GradientBlock extends NodeMaterialBlock {
  143643. /**
  143644. * Gets or sets the list of color steps
  143645. */
  143646. colorSteps: GradientBlockColorStep[];
  143647. /**
  143648. * Creates a new GradientBlock
  143649. * @param name defines the block name
  143650. */
  143651. constructor(name: string);
  143652. /**
  143653. * Gets the current class name
  143654. * @returns the class name
  143655. */
  143656. getClassName(): string;
  143657. /**
  143658. * Gets the gradient input component
  143659. */
  143660. get gradient(): NodeMaterialConnectionPoint;
  143661. /**
  143662. * Gets the output component
  143663. */
  143664. get output(): NodeMaterialConnectionPoint;
  143665. private _writeColorConstant;
  143666. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143667. serialize(): any;
  143668. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143669. protected _dumpPropertiesCode(): string;
  143670. }
  143671. }
  143672. declare module BABYLON {
  143673. /**
  143674. * Block used to normalize lerp between 2 values
  143675. */
  143676. export class NLerpBlock extends NodeMaterialBlock {
  143677. /**
  143678. * Creates a new NLerpBlock
  143679. * @param name defines the block name
  143680. */
  143681. constructor(name: string);
  143682. /**
  143683. * Gets the current class name
  143684. * @returns the class name
  143685. */
  143686. getClassName(): string;
  143687. /**
  143688. * Gets the left operand input component
  143689. */
  143690. get left(): NodeMaterialConnectionPoint;
  143691. /**
  143692. * Gets the right operand input component
  143693. */
  143694. get right(): NodeMaterialConnectionPoint;
  143695. /**
  143696. * Gets the gradient operand input component
  143697. */
  143698. get gradient(): NodeMaterialConnectionPoint;
  143699. /**
  143700. * Gets the output component
  143701. */
  143702. get output(): NodeMaterialConnectionPoint;
  143703. protected _buildBlock(state: NodeMaterialBuildState): this;
  143704. }
  143705. }
  143706. declare module BABYLON {
  143707. /**
  143708. * block used to Generate a Worley Noise 3D Noise Pattern
  143709. */
  143710. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143711. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143712. manhattanDistance: boolean;
  143713. /**
  143714. * Creates a new WorleyNoise3DBlock
  143715. * @param name defines the block name
  143716. */
  143717. constructor(name: string);
  143718. /**
  143719. * Gets the current class name
  143720. * @returns the class name
  143721. */
  143722. getClassName(): string;
  143723. /**
  143724. * Gets the seed input component
  143725. */
  143726. get seed(): NodeMaterialConnectionPoint;
  143727. /**
  143728. * Gets the jitter input component
  143729. */
  143730. get jitter(): NodeMaterialConnectionPoint;
  143731. /**
  143732. * Gets the output component
  143733. */
  143734. get output(): NodeMaterialConnectionPoint;
  143735. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143736. /**
  143737. * Exposes the properties to the UI?
  143738. */
  143739. protected _dumpPropertiesCode(): string;
  143740. /**
  143741. * Exposes the properties to the Seralize?
  143742. */
  143743. serialize(): any;
  143744. /**
  143745. * Exposes the properties to the deseralize?
  143746. */
  143747. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143748. }
  143749. }
  143750. declare module BABYLON {
  143751. /**
  143752. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143753. */
  143754. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143755. /**
  143756. * Creates a new SimplexPerlin3DBlock
  143757. * @param name defines the block name
  143758. */
  143759. constructor(name: string);
  143760. /**
  143761. * Gets the current class name
  143762. * @returns the class name
  143763. */
  143764. getClassName(): string;
  143765. /**
  143766. * Gets the seed operand input component
  143767. */
  143768. get seed(): NodeMaterialConnectionPoint;
  143769. /**
  143770. * Gets the output component
  143771. */
  143772. get output(): NodeMaterialConnectionPoint;
  143773. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143774. }
  143775. }
  143776. declare module BABYLON {
  143777. /**
  143778. * Block used to blend normals
  143779. */
  143780. export class NormalBlendBlock extends NodeMaterialBlock {
  143781. /**
  143782. * Creates a new NormalBlendBlock
  143783. * @param name defines the block name
  143784. */
  143785. constructor(name: string);
  143786. /**
  143787. * Gets the current class name
  143788. * @returns the class name
  143789. */
  143790. getClassName(): string;
  143791. /**
  143792. * Gets the first input component
  143793. */
  143794. get normalMap0(): NodeMaterialConnectionPoint;
  143795. /**
  143796. * Gets the second input component
  143797. */
  143798. get normalMap1(): NodeMaterialConnectionPoint;
  143799. /**
  143800. * Gets the output component
  143801. */
  143802. get output(): NodeMaterialConnectionPoint;
  143803. protected _buildBlock(state: NodeMaterialBuildState): this;
  143804. }
  143805. }
  143806. declare module BABYLON {
  143807. /**
  143808. * Block used to rotate a 2d vector by a given angle
  143809. */
  143810. export class Rotate2dBlock extends NodeMaterialBlock {
  143811. /**
  143812. * Creates a new Rotate2dBlock
  143813. * @param name defines the block name
  143814. */
  143815. constructor(name: string);
  143816. /**
  143817. * Gets the current class name
  143818. * @returns the class name
  143819. */
  143820. getClassName(): string;
  143821. /**
  143822. * Gets the input vector
  143823. */
  143824. get input(): NodeMaterialConnectionPoint;
  143825. /**
  143826. * Gets the input angle
  143827. */
  143828. get angle(): NodeMaterialConnectionPoint;
  143829. /**
  143830. * Gets the output component
  143831. */
  143832. get output(): NodeMaterialConnectionPoint;
  143833. autoConfigure(material: NodeMaterial): void;
  143834. protected _buildBlock(state: NodeMaterialBuildState): this;
  143835. }
  143836. }
  143837. declare module BABYLON {
  143838. /**
  143839. * Block used to get the reflected vector from a direction and a normal
  143840. */
  143841. export class ReflectBlock extends NodeMaterialBlock {
  143842. /**
  143843. * Creates a new ReflectBlock
  143844. * @param name defines the block name
  143845. */
  143846. constructor(name: string);
  143847. /**
  143848. * Gets the current class name
  143849. * @returns the class name
  143850. */
  143851. getClassName(): string;
  143852. /**
  143853. * Gets the incident component
  143854. */
  143855. get incident(): NodeMaterialConnectionPoint;
  143856. /**
  143857. * Gets the normal component
  143858. */
  143859. get normal(): NodeMaterialConnectionPoint;
  143860. /**
  143861. * Gets the output component
  143862. */
  143863. get output(): NodeMaterialConnectionPoint;
  143864. protected _buildBlock(state: NodeMaterialBuildState): this;
  143865. }
  143866. }
  143867. declare module BABYLON {
  143868. /**
  143869. * Block used to get the refracted vector from a direction and a normal
  143870. */
  143871. export class RefractBlock extends NodeMaterialBlock {
  143872. /**
  143873. * Creates a new RefractBlock
  143874. * @param name defines the block name
  143875. */
  143876. constructor(name: string);
  143877. /**
  143878. * Gets the current class name
  143879. * @returns the class name
  143880. */
  143881. getClassName(): string;
  143882. /**
  143883. * Gets the incident component
  143884. */
  143885. get incident(): NodeMaterialConnectionPoint;
  143886. /**
  143887. * Gets the normal component
  143888. */
  143889. get normal(): NodeMaterialConnectionPoint;
  143890. /**
  143891. * Gets the index of refraction component
  143892. */
  143893. get ior(): NodeMaterialConnectionPoint;
  143894. /**
  143895. * Gets the output component
  143896. */
  143897. get output(): NodeMaterialConnectionPoint;
  143898. protected _buildBlock(state: NodeMaterialBuildState): this;
  143899. }
  143900. }
  143901. declare module BABYLON {
  143902. /**
  143903. * Block used to desaturate a color
  143904. */
  143905. export class DesaturateBlock extends NodeMaterialBlock {
  143906. /**
  143907. * Creates a new DesaturateBlock
  143908. * @param name defines the block name
  143909. */
  143910. constructor(name: string);
  143911. /**
  143912. * Gets the current class name
  143913. * @returns the class name
  143914. */
  143915. getClassName(): string;
  143916. /**
  143917. * Gets the color operand input component
  143918. */
  143919. get color(): NodeMaterialConnectionPoint;
  143920. /**
  143921. * Gets the level operand input component
  143922. */
  143923. get level(): NodeMaterialConnectionPoint;
  143924. /**
  143925. * Gets the output component
  143926. */
  143927. get output(): NodeMaterialConnectionPoint;
  143928. protected _buildBlock(state: NodeMaterialBuildState): this;
  143929. }
  143930. }
  143931. declare module BABYLON {
  143932. /**
  143933. * Block used to implement the ambient occlusion module of the PBR material
  143934. */
  143935. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143936. /**
  143937. * Create a new AmbientOcclusionBlock
  143938. * @param name defines the block name
  143939. */
  143940. constructor(name: string);
  143941. /**
  143942. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143943. */
  143944. useAmbientInGrayScale: boolean;
  143945. /**
  143946. * Initialize the block and prepare the context for build
  143947. * @param state defines the state that will be used for the build
  143948. */
  143949. initialize(state: NodeMaterialBuildState): void;
  143950. /**
  143951. * Gets the current class name
  143952. * @returns the class name
  143953. */
  143954. getClassName(): string;
  143955. /**
  143956. * Gets the texture input component
  143957. */
  143958. get texture(): NodeMaterialConnectionPoint;
  143959. /**
  143960. * Gets the texture intensity component
  143961. */
  143962. get intensity(): NodeMaterialConnectionPoint;
  143963. /**
  143964. * Gets the direct light intensity input component
  143965. */
  143966. get directLightIntensity(): NodeMaterialConnectionPoint;
  143967. /**
  143968. * Gets the ambient occlusion object output component
  143969. */
  143970. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143971. /**
  143972. * Gets the main code of the block (fragment side)
  143973. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143974. * @returns the shader code
  143975. */
  143976. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143977. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143978. protected _buildBlock(state: NodeMaterialBuildState): this;
  143979. protected _dumpPropertiesCode(): string;
  143980. serialize(): any;
  143981. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143982. }
  143983. }
  143984. declare module BABYLON {
  143985. /**
  143986. * Block used to implement the reflection module of the PBR material
  143987. */
  143988. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143989. /** @hidden */
  143990. _defineLODReflectionAlpha: string;
  143991. /** @hidden */
  143992. _defineLinearSpecularReflection: string;
  143993. private _vEnvironmentIrradianceName;
  143994. /** @hidden */
  143995. _vReflectionMicrosurfaceInfosName: string;
  143996. /** @hidden */
  143997. _vReflectionInfosName: string;
  143998. /** @hidden */
  143999. _vReflectionFilteringInfoName: string;
  144000. private _scene;
  144001. /**
  144002. * The three properties below are set by the main PBR block prior to calling methods of this class.
  144003. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144004. * It's less burden on the user side in the editor part.
  144005. */
  144006. /** @hidden */
  144007. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144008. /** @hidden */
  144009. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144010. /** @hidden */
  144011. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  144012. /**
  144013. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  144014. * diffuse part of the IBL.
  144015. */
  144016. useSphericalHarmonics: boolean;
  144017. /**
  144018. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  144019. */
  144020. forceIrradianceInFragment: boolean;
  144021. /**
  144022. * Create a new ReflectionBlock
  144023. * @param name defines the block name
  144024. */
  144025. constructor(name: string);
  144026. /**
  144027. * Gets the current class name
  144028. * @returns the class name
  144029. */
  144030. getClassName(): string;
  144031. /**
  144032. * Gets the position input component
  144033. */
  144034. get position(): NodeMaterialConnectionPoint;
  144035. /**
  144036. * Gets the world position input component
  144037. */
  144038. get worldPosition(): NodeMaterialConnectionPoint;
  144039. /**
  144040. * Gets the world normal input component
  144041. */
  144042. get worldNormal(): NodeMaterialConnectionPoint;
  144043. /**
  144044. * Gets the world input component
  144045. */
  144046. get world(): NodeMaterialConnectionPoint;
  144047. /**
  144048. * Gets the camera (or eye) position component
  144049. */
  144050. get cameraPosition(): NodeMaterialConnectionPoint;
  144051. /**
  144052. * Gets the view input component
  144053. */
  144054. get view(): NodeMaterialConnectionPoint;
  144055. /**
  144056. * Gets the color input component
  144057. */
  144058. get color(): NodeMaterialConnectionPoint;
  144059. /**
  144060. * Gets the reflection object output component
  144061. */
  144062. get reflection(): NodeMaterialConnectionPoint;
  144063. /**
  144064. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  144065. */
  144066. get hasTexture(): boolean;
  144067. /**
  144068. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  144069. */
  144070. get reflectionColor(): string;
  144071. protected _getTexture(): Nullable<BaseTexture>;
  144072. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144073. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144074. /**
  144075. * Gets the code to inject in the vertex shader
  144076. * @param state current state of the node material building
  144077. * @returns the shader code
  144078. */
  144079. handleVertexSide(state: NodeMaterialBuildState): string;
  144080. /**
  144081. * Gets the main code of the block (fragment side)
  144082. * @param state current state of the node material building
  144083. * @param normalVarName name of the existing variable corresponding to the normal
  144084. * @returns the shader code
  144085. */
  144086. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  144087. protected _buildBlock(state: NodeMaterialBuildState): this;
  144088. protected _dumpPropertiesCode(): string;
  144089. serialize(): any;
  144090. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144091. }
  144092. }
  144093. declare module BABYLON {
  144094. /**
  144095. * Block used to implement the sheen module of the PBR material
  144096. */
  144097. export class SheenBlock extends NodeMaterialBlock {
  144098. /**
  144099. * Create a new SheenBlock
  144100. * @param name defines the block name
  144101. */
  144102. constructor(name: string);
  144103. /**
  144104. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  144105. * It allows the strength of the sheen effect to not depend on the base color of the material,
  144106. * making it easier to setup and tweak the effect
  144107. */
  144108. albedoScaling: boolean;
  144109. /**
  144110. * Defines if the sheen is linked to the sheen color.
  144111. */
  144112. linkSheenWithAlbedo: boolean;
  144113. /**
  144114. * Initialize the block and prepare the context for build
  144115. * @param state defines the state that will be used for the build
  144116. */
  144117. initialize(state: NodeMaterialBuildState): void;
  144118. /**
  144119. * Gets the current class name
  144120. * @returns the class name
  144121. */
  144122. getClassName(): string;
  144123. /**
  144124. * Gets the intensity input component
  144125. */
  144126. get intensity(): NodeMaterialConnectionPoint;
  144127. /**
  144128. * Gets the color input component
  144129. */
  144130. get color(): NodeMaterialConnectionPoint;
  144131. /**
  144132. * Gets the roughness input component
  144133. */
  144134. get roughness(): NodeMaterialConnectionPoint;
  144135. /**
  144136. * Gets the sheen object output component
  144137. */
  144138. get sheen(): NodeMaterialConnectionPoint;
  144139. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144140. /**
  144141. * Gets the main code of the block (fragment side)
  144142. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144143. * @returns the shader code
  144144. */
  144145. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  144146. protected _buildBlock(state: NodeMaterialBuildState): this;
  144147. protected _dumpPropertiesCode(): string;
  144148. serialize(): any;
  144149. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144150. }
  144151. }
  144152. declare module BABYLON {
  144153. /**
  144154. * Block used to implement the reflectivity module of the PBR material
  144155. */
  144156. export class ReflectivityBlock extends NodeMaterialBlock {
  144157. private _metallicReflectanceColor;
  144158. private _metallicF0Factor;
  144159. /** @hidden */
  144160. _vMetallicReflectanceFactorsName: string;
  144161. /**
  144162. * The property below is set by the main PBR block prior to calling methods of this class.
  144163. */
  144164. /** @hidden */
  144165. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  144166. /**
  144167. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144168. */
  144169. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144170. /**
  144171. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144172. */
  144173. useMetallnessFromMetallicTextureBlue: boolean;
  144174. /**
  144175. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144176. */
  144177. useRoughnessFromMetallicTextureAlpha: boolean;
  144178. /**
  144179. * Specifies if the metallic texture contains the roughness information in its green channel.
  144180. */
  144181. useRoughnessFromMetallicTextureGreen: boolean;
  144182. /**
  144183. * Create a new ReflectivityBlock
  144184. * @param name defines the block name
  144185. */
  144186. constructor(name: string);
  144187. /**
  144188. * Initialize the block and prepare the context for build
  144189. * @param state defines the state that will be used for the build
  144190. */
  144191. initialize(state: NodeMaterialBuildState): void;
  144192. /**
  144193. * Gets the current class name
  144194. * @returns the class name
  144195. */
  144196. getClassName(): string;
  144197. /**
  144198. * Gets the metallic input component
  144199. */
  144200. get metallic(): NodeMaterialConnectionPoint;
  144201. /**
  144202. * Gets the roughness input component
  144203. */
  144204. get roughness(): NodeMaterialConnectionPoint;
  144205. /**
  144206. * Gets the texture input component
  144207. */
  144208. get texture(): NodeMaterialConnectionPoint;
  144209. /**
  144210. * Gets the reflectivity object output component
  144211. */
  144212. get reflectivity(): NodeMaterialConnectionPoint;
  144213. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144214. /**
  144215. * Gets the main code of the block (fragment side)
  144216. * @param state current state of the node material building
  144217. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144218. * @returns the shader code
  144219. */
  144220. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144221. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144222. protected _buildBlock(state: NodeMaterialBuildState): this;
  144223. protected _dumpPropertiesCode(): string;
  144224. serialize(): any;
  144225. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144226. }
  144227. }
  144228. declare module BABYLON {
  144229. /**
  144230. * Block used to implement the anisotropy module of the PBR material
  144231. */
  144232. export class AnisotropyBlock extends NodeMaterialBlock {
  144233. /**
  144234. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144235. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144236. * It's less burden on the user side in the editor part.
  144237. */
  144238. /** @hidden */
  144239. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144240. /** @hidden */
  144241. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144242. /**
  144243. * Create a new AnisotropyBlock
  144244. * @param name defines the block name
  144245. */
  144246. constructor(name: string);
  144247. /**
  144248. * Initialize the block and prepare the context for build
  144249. * @param state defines the state that will be used for the build
  144250. */
  144251. initialize(state: NodeMaterialBuildState): void;
  144252. /**
  144253. * Gets the current class name
  144254. * @returns the class name
  144255. */
  144256. getClassName(): string;
  144257. /**
  144258. * Gets the intensity input component
  144259. */
  144260. get intensity(): NodeMaterialConnectionPoint;
  144261. /**
  144262. * Gets the direction input component
  144263. */
  144264. get direction(): NodeMaterialConnectionPoint;
  144265. /**
  144266. * Gets the texture input component
  144267. */
  144268. get texture(): NodeMaterialConnectionPoint;
  144269. /**
  144270. * Gets the uv input component
  144271. */
  144272. get uv(): NodeMaterialConnectionPoint;
  144273. /**
  144274. * Gets the worldTangent input component
  144275. */
  144276. get worldTangent(): NodeMaterialConnectionPoint;
  144277. /**
  144278. * Gets the anisotropy object output component
  144279. */
  144280. get anisotropy(): NodeMaterialConnectionPoint;
  144281. private _generateTBNSpace;
  144282. /**
  144283. * Gets the main code of the block (fragment side)
  144284. * @param state current state of the node material building
  144285. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144286. * @returns the shader code
  144287. */
  144288. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144289. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144290. protected _buildBlock(state: NodeMaterialBuildState): this;
  144291. }
  144292. }
  144293. declare module BABYLON {
  144294. /**
  144295. * Block used to implement the clear coat module of the PBR material
  144296. */
  144297. export class ClearCoatBlock extends NodeMaterialBlock {
  144298. private _scene;
  144299. /**
  144300. * Create a new ClearCoatBlock
  144301. * @param name defines the block name
  144302. */
  144303. constructor(name: string);
  144304. /**
  144305. * Initialize the block and prepare the context for build
  144306. * @param state defines the state that will be used for the build
  144307. */
  144308. initialize(state: NodeMaterialBuildState): void;
  144309. /**
  144310. * Gets the current class name
  144311. * @returns the class name
  144312. */
  144313. getClassName(): string;
  144314. /**
  144315. * Gets the intensity input component
  144316. */
  144317. get intensity(): NodeMaterialConnectionPoint;
  144318. /**
  144319. * Gets the roughness input component
  144320. */
  144321. get roughness(): NodeMaterialConnectionPoint;
  144322. /**
  144323. * Gets the ior input component
  144324. */
  144325. get ior(): NodeMaterialConnectionPoint;
  144326. /**
  144327. * Gets the texture input component
  144328. */
  144329. get texture(): NodeMaterialConnectionPoint;
  144330. /**
  144331. * Gets the bump texture input component
  144332. */
  144333. get bumpTexture(): NodeMaterialConnectionPoint;
  144334. /**
  144335. * Gets the uv input component
  144336. */
  144337. get uv(): NodeMaterialConnectionPoint;
  144338. /**
  144339. * Gets the tint color input component
  144340. */
  144341. get tintColor(): NodeMaterialConnectionPoint;
  144342. /**
  144343. * Gets the tint "at distance" input component
  144344. */
  144345. get tintAtDistance(): NodeMaterialConnectionPoint;
  144346. /**
  144347. * Gets the tint thickness input component
  144348. */
  144349. get tintThickness(): NodeMaterialConnectionPoint;
  144350. /**
  144351. * Gets the world tangent input component
  144352. */
  144353. get worldTangent(): NodeMaterialConnectionPoint;
  144354. /**
  144355. * Gets the clear coat object output component
  144356. */
  144357. get clearcoat(): NodeMaterialConnectionPoint;
  144358. autoConfigure(material: NodeMaterial): void;
  144359. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144360. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144361. private _generateTBNSpace;
  144362. /**
  144363. * Gets the main code of the block (fragment side)
  144364. * @param state current state of the node material building
  144365. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144366. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144367. * @param worldPosVarName name of the variable holding the world position
  144368. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144369. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144370. * @param worldNormalVarName name of the variable holding the world normal
  144371. * @returns the shader code
  144372. */
  144373. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144374. protected _buildBlock(state: NodeMaterialBuildState): this;
  144375. }
  144376. }
  144377. declare module BABYLON {
  144378. /**
  144379. * Block used to implement the sub surface module of the PBR material
  144380. */
  144381. export class SubSurfaceBlock extends NodeMaterialBlock {
  144382. /**
  144383. * Create a new SubSurfaceBlock
  144384. * @param name defines the block name
  144385. */
  144386. constructor(name: string);
  144387. /**
  144388. * Stores the intensity of the different subsurface effects in the thickness texture.
  144389. * * the green channel is the translucency intensity.
  144390. * * the blue channel is the scattering intensity.
  144391. * * the alpha channel is the refraction intensity.
  144392. */
  144393. useMaskFromThicknessTexture: boolean;
  144394. /**
  144395. * Initialize the block and prepare the context for build
  144396. * @param state defines the state that will be used for the build
  144397. */
  144398. initialize(state: NodeMaterialBuildState): void;
  144399. /**
  144400. * Gets the current class name
  144401. * @returns the class name
  144402. */
  144403. getClassName(): string;
  144404. /**
  144405. * Gets the min thickness input component
  144406. */
  144407. get minThickness(): NodeMaterialConnectionPoint;
  144408. /**
  144409. * Gets the max thickness input component
  144410. */
  144411. get maxThickness(): NodeMaterialConnectionPoint;
  144412. /**
  144413. * Gets the thickness texture component
  144414. */
  144415. get thicknessTexture(): NodeMaterialConnectionPoint;
  144416. /**
  144417. * Gets the tint color input component
  144418. */
  144419. get tintColor(): NodeMaterialConnectionPoint;
  144420. /**
  144421. * Gets the translucency intensity input component
  144422. */
  144423. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144424. /**
  144425. * Gets the translucency diffusion distance input component
  144426. */
  144427. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144428. /**
  144429. * Gets the refraction object parameters
  144430. */
  144431. get refraction(): NodeMaterialConnectionPoint;
  144432. /**
  144433. * Gets the sub surface object output component
  144434. */
  144435. get subsurface(): NodeMaterialConnectionPoint;
  144436. autoConfigure(material: NodeMaterial): void;
  144437. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144438. /**
  144439. * Gets the main code of the block (fragment side)
  144440. * @param state current state of the node material building
  144441. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144442. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144443. * @param worldPosVarName name of the variable holding the world position
  144444. * @returns the shader code
  144445. */
  144446. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144447. protected _buildBlock(state: NodeMaterialBuildState): this;
  144448. }
  144449. }
  144450. declare module BABYLON {
  144451. /**
  144452. * Block used to implement the PBR metallic/roughness model
  144453. */
  144454. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144455. /**
  144456. * Gets or sets the light associated with this block
  144457. */
  144458. light: Nullable<Light>;
  144459. private _lightId;
  144460. private _scene;
  144461. private _environmentBRDFTexture;
  144462. private _environmentBrdfSamplerName;
  144463. private _vNormalWName;
  144464. private _invertNormalName;
  144465. /**
  144466. * Create a new ReflectionBlock
  144467. * @param name defines the block name
  144468. */
  144469. constructor(name: string);
  144470. /**
  144471. * Intensity of the direct lights e.g. the four lights available in your scene.
  144472. * This impacts both the direct diffuse and specular highlights.
  144473. */
  144474. directIntensity: number;
  144475. /**
  144476. * Intensity of the environment e.g. how much the environment will light the object
  144477. * either through harmonics for rough material or through the refelction for shiny ones.
  144478. */
  144479. environmentIntensity: number;
  144480. /**
  144481. * This is a special control allowing the reduction of the specular highlights coming from the
  144482. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144483. */
  144484. specularIntensity: number;
  144485. /**
  144486. * Defines the falloff type used in this material.
  144487. * It by default is Physical.
  144488. */
  144489. lightFalloff: number;
  144490. /**
  144491. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144492. */
  144493. useAlphaFromAlbedoTexture: boolean;
  144494. /**
  144495. * Specifies that alpha test should be used
  144496. */
  144497. useAlphaTest: boolean;
  144498. /**
  144499. * Defines the alpha limits in alpha test mode.
  144500. */
  144501. alphaTestCutoff: number;
  144502. /**
  144503. * Specifies that alpha blending should be used
  144504. */
  144505. useAlphaBlending: boolean;
  144506. /**
  144507. * Defines if the alpha value should be determined via the rgb values.
  144508. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144509. */
  144510. opacityRGB: boolean;
  144511. /**
  144512. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144513. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144514. */
  144515. useRadianceOverAlpha: boolean;
  144516. /**
  144517. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144518. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144519. */
  144520. useSpecularOverAlpha: boolean;
  144521. /**
  144522. * Enables specular anti aliasing in the PBR shader.
  144523. * It will both interacts on the Geometry for analytical and IBL lighting.
  144524. * It also prefilter the roughness map based on the bump values.
  144525. */
  144526. enableSpecularAntiAliasing: boolean;
  144527. /**
  144528. * Enables realtime filtering on the texture.
  144529. */
  144530. realTimeFiltering: boolean;
  144531. /**
  144532. * Quality switch for realtime filtering
  144533. */
  144534. realTimeFilteringQuality: number;
  144535. /**
  144536. * Defines if the material uses energy conservation.
  144537. */
  144538. useEnergyConservation: boolean;
  144539. /**
  144540. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144541. * too much the area relying on ambient texture to define their ambient occlusion.
  144542. */
  144543. useRadianceOcclusion: boolean;
  144544. /**
  144545. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144546. * makes the reflect vector face the model (under horizon).
  144547. */
  144548. useHorizonOcclusion: boolean;
  144549. /**
  144550. * If set to true, no lighting calculations will be applied.
  144551. */
  144552. unlit: boolean;
  144553. /**
  144554. * Force normal to face away from face.
  144555. */
  144556. forceNormalForward: boolean;
  144557. /**
  144558. * Defines the material debug mode.
  144559. * It helps seeing only some components of the material while troubleshooting.
  144560. */
  144561. debugMode: number;
  144562. /**
  144563. * Specify from where on screen the debug mode should start.
  144564. * The value goes from -1 (full screen) to 1 (not visible)
  144565. * It helps with side by side comparison against the final render
  144566. * This defaults to 0
  144567. */
  144568. debugLimit: number;
  144569. /**
  144570. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144571. * You can use the factor to better multiply the final value.
  144572. */
  144573. debugFactor: number;
  144574. /**
  144575. * Initialize the block and prepare the context for build
  144576. * @param state defines the state that will be used for the build
  144577. */
  144578. initialize(state: NodeMaterialBuildState): void;
  144579. /**
  144580. * Gets the current class name
  144581. * @returns the class name
  144582. */
  144583. getClassName(): string;
  144584. /**
  144585. * Gets the world position input component
  144586. */
  144587. get worldPosition(): NodeMaterialConnectionPoint;
  144588. /**
  144589. * Gets the world normal input component
  144590. */
  144591. get worldNormal(): NodeMaterialConnectionPoint;
  144592. /**
  144593. * Gets the perturbed normal input component
  144594. */
  144595. get perturbedNormal(): NodeMaterialConnectionPoint;
  144596. /**
  144597. * Gets the camera position input component
  144598. */
  144599. get cameraPosition(): NodeMaterialConnectionPoint;
  144600. /**
  144601. * Gets the base color input component
  144602. */
  144603. get baseColor(): NodeMaterialConnectionPoint;
  144604. /**
  144605. * Gets the opacity texture input component
  144606. */
  144607. get opacityTexture(): NodeMaterialConnectionPoint;
  144608. /**
  144609. * Gets the ambient color input component
  144610. */
  144611. get ambientColor(): NodeMaterialConnectionPoint;
  144612. /**
  144613. * Gets the reflectivity object parameters
  144614. */
  144615. get reflectivity(): NodeMaterialConnectionPoint;
  144616. /**
  144617. * Gets the ambient occlusion object parameters
  144618. */
  144619. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144620. /**
  144621. * Gets the reflection object parameters
  144622. */
  144623. get reflection(): NodeMaterialConnectionPoint;
  144624. /**
  144625. * Gets the sheen object parameters
  144626. */
  144627. get sheen(): NodeMaterialConnectionPoint;
  144628. /**
  144629. * Gets the clear coat object parameters
  144630. */
  144631. get clearcoat(): NodeMaterialConnectionPoint;
  144632. /**
  144633. * Gets the sub surface object parameters
  144634. */
  144635. get subsurface(): NodeMaterialConnectionPoint;
  144636. /**
  144637. * Gets the anisotropy object parameters
  144638. */
  144639. get anisotropy(): NodeMaterialConnectionPoint;
  144640. /**
  144641. * Gets the ambient output component
  144642. */
  144643. get ambient(): NodeMaterialConnectionPoint;
  144644. /**
  144645. * Gets the diffuse output component
  144646. */
  144647. get diffuse(): NodeMaterialConnectionPoint;
  144648. /**
  144649. * Gets the specular output component
  144650. */
  144651. get specular(): NodeMaterialConnectionPoint;
  144652. /**
  144653. * Gets the sheen output component
  144654. */
  144655. get sheenDir(): NodeMaterialConnectionPoint;
  144656. /**
  144657. * Gets the clear coat output component
  144658. */
  144659. get clearcoatDir(): NodeMaterialConnectionPoint;
  144660. /**
  144661. * Gets the indirect diffuse output component
  144662. */
  144663. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144664. /**
  144665. * Gets the indirect specular output component
  144666. */
  144667. get specularIndirect(): NodeMaterialConnectionPoint;
  144668. /**
  144669. * Gets the indirect sheen output component
  144670. */
  144671. get sheenIndirect(): NodeMaterialConnectionPoint;
  144672. /**
  144673. * Gets the indirect clear coat output component
  144674. */
  144675. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144676. /**
  144677. * Gets the refraction output component
  144678. */
  144679. get refraction(): NodeMaterialConnectionPoint;
  144680. /**
  144681. * Gets the global lighting output component
  144682. */
  144683. get lighting(): NodeMaterialConnectionPoint;
  144684. /**
  144685. * Gets the shadow output component
  144686. */
  144687. get shadow(): NodeMaterialConnectionPoint;
  144688. /**
  144689. * Gets the alpha output component
  144690. */
  144691. get alpha(): NodeMaterialConnectionPoint;
  144692. autoConfigure(material: NodeMaterial): void;
  144693. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144694. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144695. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144696. private _injectVertexCode;
  144697. /**
  144698. * Gets the code corresponding to the albedo/opacity module
  144699. * @returns the shader code
  144700. */
  144701. getAlbedoOpacityCode(): string;
  144702. protected _buildBlock(state: NodeMaterialBuildState): this;
  144703. protected _dumpPropertiesCode(): string;
  144704. serialize(): any;
  144705. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144706. }
  144707. }
  144708. declare module BABYLON {
  144709. /**
  144710. * Block used to compute value of one parameter modulo another
  144711. */
  144712. export class ModBlock extends NodeMaterialBlock {
  144713. /**
  144714. * Creates a new ModBlock
  144715. * @param name defines the block name
  144716. */
  144717. constructor(name: string);
  144718. /**
  144719. * Gets the current class name
  144720. * @returns the class name
  144721. */
  144722. getClassName(): string;
  144723. /**
  144724. * Gets the left operand input component
  144725. */
  144726. get left(): NodeMaterialConnectionPoint;
  144727. /**
  144728. * Gets the right operand input component
  144729. */
  144730. get right(): NodeMaterialConnectionPoint;
  144731. /**
  144732. * Gets the output component
  144733. */
  144734. get output(): NodeMaterialConnectionPoint;
  144735. protected _buildBlock(state: NodeMaterialBuildState): this;
  144736. }
  144737. }
  144738. declare module BABYLON {
  144739. /**
  144740. * Helper class to push actions to a pool of workers.
  144741. */
  144742. export class WorkerPool implements IDisposable {
  144743. private _workerInfos;
  144744. private _pendingActions;
  144745. /**
  144746. * Constructor
  144747. * @param workers Array of workers to use for actions
  144748. */
  144749. constructor(workers: Array<Worker>);
  144750. /**
  144751. * Terminates all workers and clears any pending actions.
  144752. */
  144753. dispose(): void;
  144754. /**
  144755. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144756. * pended until a worker has completed its action.
  144757. * @param action The action to perform. Call onComplete when the action is complete.
  144758. */
  144759. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144760. private _execute;
  144761. }
  144762. }
  144763. declare module BABYLON {
  144764. /**
  144765. * Configuration for Draco compression
  144766. */
  144767. export interface IDracoCompressionConfiguration {
  144768. /**
  144769. * Configuration for the decoder.
  144770. */
  144771. decoder: {
  144772. /**
  144773. * The url to the WebAssembly module.
  144774. */
  144775. wasmUrl?: string;
  144776. /**
  144777. * The url to the WebAssembly binary.
  144778. */
  144779. wasmBinaryUrl?: string;
  144780. /**
  144781. * The url to the fallback JavaScript module.
  144782. */
  144783. fallbackUrl?: string;
  144784. };
  144785. }
  144786. /**
  144787. * Draco compression (https://google.github.io/draco/)
  144788. *
  144789. * This class wraps the Draco module.
  144790. *
  144791. * **Encoder**
  144792. *
  144793. * The encoder is not currently implemented.
  144794. *
  144795. * **Decoder**
  144796. *
  144797. * 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.
  144798. *
  144799. * To update the configuration, use the following code:
  144800. * ```javascript
  144801. * DracoCompression.Configuration = {
  144802. * decoder: {
  144803. * wasmUrl: "<url to the WebAssembly library>",
  144804. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144805. * fallbackUrl: "<url to the fallback JavaScript library>",
  144806. * }
  144807. * };
  144808. * ```
  144809. *
  144810. * 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.
  144811. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144812. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144813. *
  144814. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144815. * ```javascript
  144816. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144817. * ```
  144818. *
  144819. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144820. */
  144821. export class DracoCompression implements IDisposable {
  144822. private _workerPoolPromise?;
  144823. private _decoderModulePromise?;
  144824. /**
  144825. * The configuration. Defaults to the following urls:
  144826. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144827. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144828. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144829. */
  144830. static Configuration: IDracoCompressionConfiguration;
  144831. /**
  144832. * Returns true if the decoder configuration is available.
  144833. */
  144834. static get DecoderAvailable(): boolean;
  144835. /**
  144836. * Default number of workers to create when creating the draco compression object.
  144837. */
  144838. static DefaultNumWorkers: number;
  144839. private static GetDefaultNumWorkers;
  144840. private static _Default;
  144841. /**
  144842. * Default instance for the draco compression object.
  144843. */
  144844. static get Default(): DracoCompression;
  144845. /**
  144846. * Constructor
  144847. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144848. */
  144849. constructor(numWorkers?: number);
  144850. /**
  144851. * Stop all async operations and release resources.
  144852. */
  144853. dispose(): void;
  144854. /**
  144855. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144856. * @returns a promise that resolves when ready
  144857. */
  144858. whenReadyAsync(): Promise<void>;
  144859. /**
  144860. * Decode Draco compressed mesh data to vertex data.
  144861. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144862. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144863. * @returns A promise that resolves with the decoded vertex data
  144864. */
  144865. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144866. [kind: string]: number;
  144867. }): Promise<VertexData>;
  144868. }
  144869. }
  144870. declare module BABYLON {
  144871. /**
  144872. * Class for building Constructive Solid Geometry
  144873. */
  144874. export class CSG {
  144875. private polygons;
  144876. /**
  144877. * The world matrix
  144878. */
  144879. matrix: Matrix;
  144880. /**
  144881. * Stores the position
  144882. */
  144883. position: Vector3;
  144884. /**
  144885. * Stores the rotation
  144886. */
  144887. rotation: Vector3;
  144888. /**
  144889. * Stores the rotation quaternion
  144890. */
  144891. rotationQuaternion: Nullable<Quaternion>;
  144892. /**
  144893. * Stores the scaling vector
  144894. */
  144895. scaling: Vector3;
  144896. /**
  144897. * Convert the Mesh to CSG
  144898. * @param mesh The Mesh to convert to CSG
  144899. * @returns A new CSG from the Mesh
  144900. */
  144901. static FromMesh(mesh: Mesh): CSG;
  144902. /**
  144903. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144904. * @param polygons Polygons used to construct a CSG solid
  144905. */
  144906. private static FromPolygons;
  144907. /**
  144908. * Clones, or makes a deep copy, of the CSG
  144909. * @returns A new CSG
  144910. */
  144911. clone(): CSG;
  144912. /**
  144913. * Unions this CSG with another CSG
  144914. * @param csg The CSG to union against this CSG
  144915. * @returns The unioned CSG
  144916. */
  144917. union(csg: CSG): CSG;
  144918. /**
  144919. * Unions this CSG with another CSG in place
  144920. * @param csg The CSG to union against this CSG
  144921. */
  144922. unionInPlace(csg: CSG): void;
  144923. /**
  144924. * Subtracts this CSG with another CSG
  144925. * @param csg The CSG to subtract against this CSG
  144926. * @returns A new CSG
  144927. */
  144928. subtract(csg: CSG): CSG;
  144929. /**
  144930. * Subtracts this CSG with another CSG in place
  144931. * @param csg The CSG to subtact against this CSG
  144932. */
  144933. subtractInPlace(csg: CSG): void;
  144934. /**
  144935. * Intersect this CSG with another CSG
  144936. * @param csg The CSG to intersect against this CSG
  144937. * @returns A new CSG
  144938. */
  144939. intersect(csg: CSG): CSG;
  144940. /**
  144941. * Intersects this CSG with another CSG in place
  144942. * @param csg The CSG to intersect against this CSG
  144943. */
  144944. intersectInPlace(csg: CSG): void;
  144945. /**
  144946. * Return a new CSG solid with solid and empty space switched. This solid is
  144947. * not modified.
  144948. * @returns A new CSG solid with solid and empty space switched
  144949. */
  144950. inverse(): CSG;
  144951. /**
  144952. * Inverses the CSG in place
  144953. */
  144954. inverseInPlace(): void;
  144955. /**
  144956. * This is used to keep meshes transformations so they can be restored
  144957. * when we build back a Babylon Mesh
  144958. * NB : All CSG operations are performed in world coordinates
  144959. * @param csg The CSG to copy the transform attributes from
  144960. * @returns This CSG
  144961. */
  144962. copyTransformAttributes(csg: CSG): CSG;
  144963. /**
  144964. * Build Raw mesh from CSG
  144965. * Coordinates here are in world space
  144966. * @param name The name of the mesh geometry
  144967. * @param scene The Scene
  144968. * @param keepSubMeshes Specifies if the submeshes should be kept
  144969. * @returns A new Mesh
  144970. */
  144971. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144972. /**
  144973. * Build Mesh from CSG taking material and transforms into account
  144974. * @param name The name of the Mesh
  144975. * @param material The material of the Mesh
  144976. * @param scene The Scene
  144977. * @param keepSubMeshes Specifies if submeshes should be kept
  144978. * @returns The new Mesh
  144979. */
  144980. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144981. }
  144982. }
  144983. declare module BABYLON {
  144984. /**
  144985. * Class used to create a trail following a mesh
  144986. */
  144987. export class TrailMesh extends Mesh {
  144988. private _generator;
  144989. private _autoStart;
  144990. private _running;
  144991. private _diameter;
  144992. private _length;
  144993. private _sectionPolygonPointsCount;
  144994. private _sectionVectors;
  144995. private _sectionNormalVectors;
  144996. private _beforeRenderObserver;
  144997. /**
  144998. * @constructor
  144999. * @param name The value used by scene.getMeshByName() to do a lookup.
  145000. * @param generator The mesh or transform node to generate a trail.
  145001. * @param scene The scene to add this mesh to.
  145002. * @param diameter Diameter of trailing mesh. Default is 1.
  145003. * @param length Length of trailing mesh. Default is 60.
  145004. * @param autoStart Automatically start trailing mesh. Default true.
  145005. */
  145006. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  145007. /**
  145008. * "TrailMesh"
  145009. * @returns "TrailMesh"
  145010. */
  145011. getClassName(): string;
  145012. private _createMesh;
  145013. /**
  145014. * Start trailing mesh.
  145015. */
  145016. start(): void;
  145017. /**
  145018. * Stop trailing mesh.
  145019. */
  145020. stop(): void;
  145021. /**
  145022. * Update trailing mesh geometry.
  145023. */
  145024. update(): void;
  145025. /**
  145026. * Returns a new TrailMesh object.
  145027. * @param name is a string, the name given to the new mesh
  145028. * @param newGenerator use new generator object for cloned trail mesh
  145029. * @returns a new mesh
  145030. */
  145031. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  145032. /**
  145033. * Serializes this trail mesh
  145034. * @param serializationObject object to write serialization to
  145035. */
  145036. serialize(serializationObject: any): void;
  145037. /**
  145038. * Parses a serialized trail mesh
  145039. * @param parsedMesh the serialized mesh
  145040. * @param scene the scene to create the trail mesh in
  145041. * @returns the created trail mesh
  145042. */
  145043. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  145044. }
  145045. }
  145046. declare module BABYLON {
  145047. /**
  145048. * Class containing static functions to help procedurally build meshes
  145049. */
  145050. export class TiledBoxBuilder {
  145051. /**
  145052. * Creates a box mesh
  145053. * 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)
  145054. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145055. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145056. * * 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
  145057. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145058. * @param name defines the name of the mesh
  145059. * @param options defines the options used to create the mesh
  145060. * @param scene defines the hosting scene
  145061. * @returns the box mesh
  145062. */
  145063. static CreateTiledBox(name: string, options: {
  145064. pattern?: number;
  145065. width?: number;
  145066. height?: number;
  145067. depth?: number;
  145068. tileSize?: number;
  145069. tileWidth?: number;
  145070. tileHeight?: number;
  145071. alignHorizontal?: number;
  145072. alignVertical?: number;
  145073. faceUV?: Vector4[];
  145074. faceColors?: Color4[];
  145075. sideOrientation?: number;
  145076. updatable?: boolean;
  145077. }, scene?: Nullable<Scene>): Mesh;
  145078. }
  145079. }
  145080. declare module BABYLON {
  145081. /**
  145082. * Class containing static functions to help procedurally build meshes
  145083. */
  145084. export class TorusKnotBuilder {
  145085. /**
  145086. * Creates a torus knot mesh
  145087. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145088. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145089. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145090. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145091. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145092. * * 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
  145093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145094. * @param name defines the name of the mesh
  145095. * @param options defines the options used to create the mesh
  145096. * @param scene defines the hosting scene
  145097. * @returns the torus knot mesh
  145098. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145099. */
  145100. static CreateTorusKnot(name: string, options: {
  145101. radius?: number;
  145102. tube?: number;
  145103. radialSegments?: number;
  145104. tubularSegments?: number;
  145105. p?: number;
  145106. q?: number;
  145107. updatable?: boolean;
  145108. sideOrientation?: number;
  145109. frontUVs?: Vector4;
  145110. backUVs?: Vector4;
  145111. }, scene: any): Mesh;
  145112. }
  145113. }
  145114. declare module BABYLON {
  145115. /**
  145116. * Polygon
  145117. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  145118. */
  145119. export class Polygon {
  145120. /**
  145121. * Creates a rectangle
  145122. * @param xmin bottom X coord
  145123. * @param ymin bottom Y coord
  145124. * @param xmax top X coord
  145125. * @param ymax top Y coord
  145126. * @returns points that make the resulting rectation
  145127. */
  145128. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  145129. /**
  145130. * Creates a circle
  145131. * @param radius radius of circle
  145132. * @param cx scale in x
  145133. * @param cy scale in y
  145134. * @param numberOfSides number of sides that make up the circle
  145135. * @returns points that make the resulting circle
  145136. */
  145137. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  145138. /**
  145139. * Creates a polygon from input string
  145140. * @param input Input polygon data
  145141. * @returns the parsed points
  145142. */
  145143. static Parse(input: string): Vector2[];
  145144. /**
  145145. * Starts building a polygon from x and y coordinates
  145146. * @param x x coordinate
  145147. * @param y y coordinate
  145148. * @returns the started path2
  145149. */
  145150. static StartingAt(x: number, y: number): Path2;
  145151. }
  145152. /**
  145153. * Builds a polygon
  145154. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  145155. */
  145156. export class PolygonMeshBuilder {
  145157. private _points;
  145158. private _outlinepoints;
  145159. private _holes;
  145160. private _name;
  145161. private _scene;
  145162. private _epoints;
  145163. private _eholes;
  145164. private _addToepoint;
  145165. /**
  145166. * Babylon reference to the earcut plugin.
  145167. */
  145168. bjsEarcut: any;
  145169. /**
  145170. * Creates a PolygonMeshBuilder
  145171. * @param name name of the builder
  145172. * @param contours Path of the polygon
  145173. * @param scene scene to add to when creating the mesh
  145174. * @param earcutInjection can be used to inject your own earcut reference
  145175. */
  145176. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145177. /**
  145178. * Adds a whole within the polygon
  145179. * @param hole Array of points defining the hole
  145180. * @returns this
  145181. */
  145182. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145183. /**
  145184. * Creates the polygon
  145185. * @param updatable If the mesh should be updatable
  145186. * @param depth The depth of the mesh created
  145187. * @returns the created mesh
  145188. */
  145189. build(updatable?: boolean, depth?: number): Mesh;
  145190. /**
  145191. * Creates the polygon
  145192. * @param depth The depth of the mesh created
  145193. * @returns the created VertexData
  145194. */
  145195. buildVertexData(depth?: number): VertexData;
  145196. /**
  145197. * Adds a side to the polygon
  145198. * @param positions points that make the polygon
  145199. * @param normals normals of the polygon
  145200. * @param uvs uvs of the polygon
  145201. * @param indices indices of the polygon
  145202. * @param bounds bounds of the polygon
  145203. * @param points points of the polygon
  145204. * @param depth depth of the polygon
  145205. * @param flip flip of the polygon
  145206. */
  145207. private addSide;
  145208. }
  145209. }
  145210. declare module BABYLON {
  145211. /**
  145212. * Class containing static functions to help procedurally build meshes
  145213. */
  145214. export class PolygonBuilder {
  145215. /**
  145216. * Creates a polygon mesh
  145217. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145218. * * 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
  145219. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145220. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145221. * * 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)
  145222. * * Remember you can only change the shape positions, not their number when updating a polygon
  145223. * @param name defines the name of the mesh
  145224. * @param options defines the options used to create the mesh
  145225. * @param scene defines the hosting scene
  145226. * @param earcutInjection can be used to inject your own earcut reference
  145227. * @returns the polygon mesh
  145228. */
  145229. static CreatePolygon(name: string, options: {
  145230. shape: Vector3[];
  145231. holes?: Vector3[][];
  145232. depth?: number;
  145233. faceUV?: Vector4[];
  145234. faceColors?: Color4[];
  145235. updatable?: boolean;
  145236. sideOrientation?: number;
  145237. frontUVs?: Vector4;
  145238. backUVs?: Vector4;
  145239. wrap?: boolean;
  145240. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145241. /**
  145242. * Creates an extruded polygon mesh, with depth in the Y direction.
  145243. * * 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)
  145244. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145245. * @param name defines the name of the mesh
  145246. * @param options defines the options used to create the mesh
  145247. * @param scene defines the hosting scene
  145248. * @param earcutInjection can be used to inject your own earcut reference
  145249. * @returns the polygon mesh
  145250. */
  145251. static ExtrudePolygon(name: string, options: {
  145252. shape: Vector3[];
  145253. holes?: Vector3[][];
  145254. depth?: number;
  145255. faceUV?: Vector4[];
  145256. faceColors?: Color4[];
  145257. updatable?: boolean;
  145258. sideOrientation?: number;
  145259. frontUVs?: Vector4;
  145260. backUVs?: Vector4;
  145261. wrap?: boolean;
  145262. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145263. }
  145264. }
  145265. declare module BABYLON {
  145266. /**
  145267. * Class containing static functions to help procedurally build meshes
  145268. */
  145269. export class LatheBuilder {
  145270. /**
  145271. * Creates lathe mesh.
  145272. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145273. * * 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
  145274. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145275. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145276. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145277. * * 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
  145278. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145279. * * 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
  145280. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145281. * * 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
  145282. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145283. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145284. * @param name defines the name of the mesh
  145285. * @param options defines the options used to create the mesh
  145286. * @param scene defines the hosting scene
  145287. * @returns the lathe mesh
  145288. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145289. */
  145290. static CreateLathe(name: string, options: {
  145291. shape: Vector3[];
  145292. radius?: number;
  145293. tessellation?: number;
  145294. clip?: number;
  145295. arc?: number;
  145296. closed?: boolean;
  145297. updatable?: boolean;
  145298. sideOrientation?: number;
  145299. frontUVs?: Vector4;
  145300. backUVs?: Vector4;
  145301. cap?: number;
  145302. invertUV?: boolean;
  145303. }, scene?: Nullable<Scene>): Mesh;
  145304. }
  145305. }
  145306. declare module BABYLON {
  145307. /**
  145308. * Class containing static functions to help procedurally build meshes
  145309. */
  145310. export class TiledPlaneBuilder {
  145311. /**
  145312. * Creates a tiled plane mesh
  145313. * * The parameter `pattern` will, depending on value, do nothing or
  145314. * * * flip (reflect about central vertical) alternate tiles across and up
  145315. * * * flip every tile on alternate rows
  145316. * * * rotate (180 degs) alternate tiles across and up
  145317. * * * rotate every tile on alternate rows
  145318. * * * flip and rotate alternate tiles across and up
  145319. * * * flip and rotate every tile on alternate rows
  145320. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145321. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145322. * * 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
  145323. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145324. * * 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)
  145325. * * 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)
  145326. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145327. * @param name defines the name of the mesh
  145328. * @param options defines the options used to create the mesh
  145329. * @param scene defines the hosting scene
  145330. * @returns the box mesh
  145331. */
  145332. static CreateTiledPlane(name: string, options: {
  145333. pattern?: number;
  145334. tileSize?: number;
  145335. tileWidth?: number;
  145336. tileHeight?: number;
  145337. size?: number;
  145338. width?: number;
  145339. height?: number;
  145340. alignHorizontal?: number;
  145341. alignVertical?: number;
  145342. sideOrientation?: number;
  145343. frontUVs?: Vector4;
  145344. backUVs?: Vector4;
  145345. updatable?: boolean;
  145346. }, scene?: Nullable<Scene>): Mesh;
  145347. }
  145348. }
  145349. declare module BABYLON {
  145350. /**
  145351. * Class containing static functions to help procedurally build meshes
  145352. */
  145353. export class TubeBuilder {
  145354. /**
  145355. * Creates a tube mesh.
  145356. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145357. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145358. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145359. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145360. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145361. * * 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)
  145362. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145363. * * 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
  145364. * * 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
  145365. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145366. * * 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
  145367. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145368. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145369. * @param name defines the name of the mesh
  145370. * @param options defines the options used to create the mesh
  145371. * @param scene defines the hosting scene
  145372. * @returns the tube mesh
  145373. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145374. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145375. */
  145376. static CreateTube(name: string, options: {
  145377. path: Vector3[];
  145378. radius?: number;
  145379. tessellation?: number;
  145380. radiusFunction?: {
  145381. (i: number, distance: number): number;
  145382. };
  145383. cap?: number;
  145384. arc?: number;
  145385. updatable?: boolean;
  145386. sideOrientation?: number;
  145387. frontUVs?: Vector4;
  145388. backUVs?: Vector4;
  145389. instance?: Mesh;
  145390. invertUV?: boolean;
  145391. }, scene?: Nullable<Scene>): Mesh;
  145392. }
  145393. }
  145394. declare module BABYLON {
  145395. /**
  145396. * Class containing static functions to help procedurally build meshes
  145397. */
  145398. export class IcoSphereBuilder {
  145399. /**
  145400. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145401. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145402. * * 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`)
  145403. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145404. * * 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
  145405. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145406. * * 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
  145407. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145408. * @param name defines the name of the mesh
  145409. * @param options defines the options used to create the mesh
  145410. * @param scene defines the hosting scene
  145411. * @returns the icosahedron mesh
  145412. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145413. */
  145414. static CreateIcoSphere(name: string, options: {
  145415. radius?: number;
  145416. radiusX?: number;
  145417. radiusY?: number;
  145418. radiusZ?: number;
  145419. flat?: boolean;
  145420. subdivisions?: number;
  145421. sideOrientation?: number;
  145422. frontUVs?: Vector4;
  145423. backUVs?: Vector4;
  145424. updatable?: boolean;
  145425. }, scene?: Nullable<Scene>): Mesh;
  145426. }
  145427. }
  145428. declare module BABYLON {
  145429. /**
  145430. * Class containing static functions to help procedurally build meshes
  145431. */
  145432. export class DecalBuilder {
  145433. /**
  145434. * Creates a decal mesh.
  145435. * 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
  145436. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145437. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145438. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145439. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145440. * @param name defines the name of the mesh
  145441. * @param sourceMesh defines the mesh where the decal must be applied
  145442. * @param options defines the options used to create the mesh
  145443. * @param scene defines the hosting scene
  145444. * @returns the decal mesh
  145445. * @see https://doc.babylonjs.com/how_to/decals
  145446. */
  145447. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145448. position?: Vector3;
  145449. normal?: Vector3;
  145450. size?: Vector3;
  145451. angle?: number;
  145452. }): Mesh;
  145453. }
  145454. }
  145455. declare module BABYLON {
  145456. /**
  145457. * Class containing static functions to help procedurally build meshes
  145458. */
  145459. export class MeshBuilder {
  145460. /**
  145461. * Creates a box mesh
  145462. * * The parameter `size` sets the size (float) of each box side (default 1)
  145463. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145464. * * 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)
  145465. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145466. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145467. * * 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
  145468. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145469. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145470. * @param name defines the name of the mesh
  145471. * @param options defines the options used to create the mesh
  145472. * @param scene defines the hosting scene
  145473. * @returns the box mesh
  145474. */
  145475. static CreateBox(name: string, options: {
  145476. size?: number;
  145477. width?: number;
  145478. height?: number;
  145479. depth?: number;
  145480. faceUV?: Vector4[];
  145481. faceColors?: Color4[];
  145482. sideOrientation?: number;
  145483. frontUVs?: Vector4;
  145484. backUVs?: Vector4;
  145485. wrap?: boolean;
  145486. topBaseAt?: number;
  145487. bottomBaseAt?: number;
  145488. updatable?: boolean;
  145489. }, scene?: Nullable<Scene>): Mesh;
  145490. /**
  145491. * Creates a tiled box mesh
  145492. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145493. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145494. * @param name defines the name of the mesh
  145495. * @param options defines the options used to create the mesh
  145496. * @param scene defines the hosting scene
  145497. * @returns the tiled box mesh
  145498. */
  145499. static CreateTiledBox(name: string, options: {
  145500. pattern?: number;
  145501. size?: number;
  145502. width?: number;
  145503. height?: number;
  145504. depth: number;
  145505. tileSize?: number;
  145506. tileWidth?: number;
  145507. tileHeight?: number;
  145508. faceUV?: Vector4[];
  145509. faceColors?: Color4[];
  145510. alignHorizontal?: number;
  145511. alignVertical?: number;
  145512. sideOrientation?: number;
  145513. updatable?: boolean;
  145514. }, scene?: Nullable<Scene>): Mesh;
  145515. /**
  145516. * Creates a sphere mesh
  145517. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145518. * * 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`)
  145519. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145520. * * 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
  145521. * * 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)
  145522. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145523. * * 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
  145524. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145525. * @param name defines the name of the mesh
  145526. * @param options defines the options used to create the mesh
  145527. * @param scene defines the hosting scene
  145528. * @returns the sphere mesh
  145529. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145530. */
  145531. static CreateSphere(name: string, options: {
  145532. segments?: number;
  145533. diameter?: number;
  145534. diameterX?: number;
  145535. diameterY?: number;
  145536. diameterZ?: number;
  145537. arc?: number;
  145538. slice?: number;
  145539. sideOrientation?: number;
  145540. frontUVs?: Vector4;
  145541. backUVs?: Vector4;
  145542. updatable?: boolean;
  145543. }, scene?: Nullable<Scene>): Mesh;
  145544. /**
  145545. * Creates a plane polygonal mesh. By default, this is a disc
  145546. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145547. * * 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
  145548. * * 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
  145549. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145550. * * 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
  145551. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145552. * @param name defines the name of the mesh
  145553. * @param options defines the options used to create the mesh
  145554. * @param scene defines the hosting scene
  145555. * @returns the plane polygonal mesh
  145556. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145557. */
  145558. static CreateDisc(name: string, options: {
  145559. radius?: number;
  145560. tessellation?: number;
  145561. arc?: number;
  145562. updatable?: boolean;
  145563. sideOrientation?: number;
  145564. frontUVs?: Vector4;
  145565. backUVs?: Vector4;
  145566. }, scene?: Nullable<Scene>): Mesh;
  145567. /**
  145568. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145569. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145570. * * 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`)
  145571. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145572. * * 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
  145573. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145574. * * 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
  145575. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145576. * @param name defines the name of the mesh
  145577. * @param options defines the options used to create the mesh
  145578. * @param scene defines the hosting scene
  145579. * @returns the icosahedron mesh
  145580. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145581. */
  145582. static CreateIcoSphere(name: string, options: {
  145583. radius?: number;
  145584. radiusX?: number;
  145585. radiusY?: number;
  145586. radiusZ?: number;
  145587. flat?: boolean;
  145588. subdivisions?: number;
  145589. sideOrientation?: number;
  145590. frontUVs?: Vector4;
  145591. backUVs?: Vector4;
  145592. updatable?: boolean;
  145593. }, scene?: Nullable<Scene>): Mesh;
  145594. /**
  145595. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145596. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145597. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145598. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145599. * * 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
  145600. * * 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
  145601. * * 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
  145602. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145603. * * 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
  145604. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145605. * * 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
  145606. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145607. * * 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
  145608. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145609. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145610. * @param name defines the name of the mesh
  145611. * @param options defines the options used to create the mesh
  145612. * @param scene defines the hosting scene
  145613. * @returns the ribbon mesh
  145614. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145615. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145616. */
  145617. static CreateRibbon(name: string, options: {
  145618. pathArray: Vector3[][];
  145619. closeArray?: boolean;
  145620. closePath?: boolean;
  145621. offset?: number;
  145622. updatable?: boolean;
  145623. sideOrientation?: number;
  145624. frontUVs?: Vector4;
  145625. backUVs?: Vector4;
  145626. instance?: Mesh;
  145627. invertUV?: boolean;
  145628. uvs?: Vector2[];
  145629. colors?: Color4[];
  145630. }, scene?: Nullable<Scene>): Mesh;
  145631. /**
  145632. * Creates a cylinder or a cone mesh
  145633. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145634. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145635. * * 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.
  145636. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145637. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145638. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145639. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145640. * * 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).
  145641. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145642. * * 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).
  145643. * * 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
  145644. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145645. * * 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
  145646. * * 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.
  145647. * * If `enclose` is false, a ring surface is one element.
  145648. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145649. * * 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
  145650. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145651. * * 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
  145652. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145653. * @param name defines the name of the mesh
  145654. * @param options defines the options used to create the mesh
  145655. * @param scene defines the hosting scene
  145656. * @returns the cylinder mesh
  145657. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145658. */
  145659. static CreateCylinder(name: string, options: {
  145660. height?: number;
  145661. diameterTop?: number;
  145662. diameterBottom?: number;
  145663. diameter?: number;
  145664. tessellation?: number;
  145665. subdivisions?: number;
  145666. arc?: number;
  145667. faceColors?: Color4[];
  145668. faceUV?: Vector4[];
  145669. updatable?: boolean;
  145670. hasRings?: boolean;
  145671. enclose?: boolean;
  145672. cap?: number;
  145673. sideOrientation?: number;
  145674. frontUVs?: Vector4;
  145675. backUVs?: Vector4;
  145676. }, scene?: Nullable<Scene>): Mesh;
  145677. /**
  145678. * Creates a torus mesh
  145679. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145680. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145681. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145682. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145683. * * 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
  145684. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145685. * @param name defines the name of the mesh
  145686. * @param options defines the options used to create the mesh
  145687. * @param scene defines the hosting scene
  145688. * @returns the torus mesh
  145689. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145690. */
  145691. static CreateTorus(name: string, options: {
  145692. diameter?: number;
  145693. thickness?: number;
  145694. tessellation?: number;
  145695. updatable?: boolean;
  145696. sideOrientation?: number;
  145697. frontUVs?: Vector4;
  145698. backUVs?: Vector4;
  145699. }, scene?: Nullable<Scene>): Mesh;
  145700. /**
  145701. * Creates a torus knot mesh
  145702. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145703. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145704. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145705. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145706. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145707. * * 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
  145708. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145709. * @param name defines the name of the mesh
  145710. * @param options defines the options used to create the mesh
  145711. * @param scene defines the hosting scene
  145712. * @returns the torus knot mesh
  145713. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145714. */
  145715. static CreateTorusKnot(name: string, options: {
  145716. radius?: number;
  145717. tube?: number;
  145718. radialSegments?: number;
  145719. tubularSegments?: number;
  145720. p?: number;
  145721. q?: number;
  145722. updatable?: boolean;
  145723. sideOrientation?: number;
  145724. frontUVs?: Vector4;
  145725. backUVs?: Vector4;
  145726. }, scene?: Nullable<Scene>): Mesh;
  145727. /**
  145728. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145729. * * 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
  145730. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145731. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145732. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145733. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145734. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145735. * * 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
  145736. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145738. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145739. * @param name defines the name of the new line system
  145740. * @param options defines the options used to create the line system
  145741. * @param scene defines the hosting scene
  145742. * @returns a new line system mesh
  145743. */
  145744. static CreateLineSystem(name: string, options: {
  145745. lines: Vector3[][];
  145746. updatable?: boolean;
  145747. instance?: Nullable<LinesMesh>;
  145748. colors?: Nullable<Color4[][]>;
  145749. useVertexAlpha?: boolean;
  145750. }, scene: Nullable<Scene>): LinesMesh;
  145751. /**
  145752. * Creates a line mesh
  145753. * 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
  145754. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145755. * * The parameter `points` is an array successive Vector3
  145756. * * 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
  145757. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145758. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145759. * * When updating an instance, remember that only point positions can change, not the number of points
  145760. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145761. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145762. * @param name defines the name of the new line system
  145763. * @param options defines the options used to create the line system
  145764. * @param scene defines the hosting scene
  145765. * @returns a new line mesh
  145766. */
  145767. static CreateLines(name: string, options: {
  145768. points: Vector3[];
  145769. updatable?: boolean;
  145770. instance?: Nullable<LinesMesh>;
  145771. colors?: Color4[];
  145772. useVertexAlpha?: boolean;
  145773. }, scene?: Nullable<Scene>): LinesMesh;
  145774. /**
  145775. * Creates a dashed line mesh
  145776. * * 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
  145777. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145778. * * The parameter `points` is an array successive Vector3
  145779. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145780. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145781. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145782. * * 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
  145783. * * When updating an instance, remember that only point positions can change, not the number of points
  145784. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145785. * @param name defines the name of the mesh
  145786. * @param options defines the options used to create the mesh
  145787. * @param scene defines the hosting scene
  145788. * @returns the dashed line mesh
  145789. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145790. */
  145791. static CreateDashedLines(name: string, options: {
  145792. points: Vector3[];
  145793. dashSize?: number;
  145794. gapSize?: number;
  145795. dashNb?: number;
  145796. updatable?: boolean;
  145797. instance?: LinesMesh;
  145798. }, scene?: Nullable<Scene>): LinesMesh;
  145799. /**
  145800. * 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.
  145801. * * 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.
  145802. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145803. * * 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.
  145804. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145805. * * 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
  145806. * * 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
  145807. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145808. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145809. * * 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
  145810. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145811. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145812. * @param name defines the name of the mesh
  145813. * @param options defines the options used to create the mesh
  145814. * @param scene defines the hosting scene
  145815. * @returns the extruded shape mesh
  145816. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145817. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145818. */
  145819. static ExtrudeShape(name: string, options: {
  145820. shape: Vector3[];
  145821. path: Vector3[];
  145822. scale?: number;
  145823. rotation?: number;
  145824. cap?: number;
  145825. updatable?: boolean;
  145826. sideOrientation?: number;
  145827. frontUVs?: Vector4;
  145828. backUVs?: Vector4;
  145829. instance?: Mesh;
  145830. invertUV?: boolean;
  145831. }, scene?: Nullable<Scene>): Mesh;
  145832. /**
  145833. * Creates an custom extruded shape mesh.
  145834. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145835. * * 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.
  145836. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145837. * * 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
  145838. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145839. * * 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
  145840. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145841. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145842. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145843. * * 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
  145844. * * 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
  145845. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145846. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145847. * * 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
  145848. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145849. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145850. * @param name defines the name of the mesh
  145851. * @param options defines the options used to create the mesh
  145852. * @param scene defines the hosting scene
  145853. * @returns the custom extruded shape mesh
  145854. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145855. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145856. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145857. */
  145858. static ExtrudeShapeCustom(name: string, options: {
  145859. shape: Vector3[];
  145860. path: Vector3[];
  145861. scaleFunction?: any;
  145862. rotationFunction?: any;
  145863. ribbonCloseArray?: boolean;
  145864. ribbonClosePath?: boolean;
  145865. cap?: number;
  145866. updatable?: boolean;
  145867. sideOrientation?: number;
  145868. frontUVs?: Vector4;
  145869. backUVs?: Vector4;
  145870. instance?: Mesh;
  145871. invertUV?: boolean;
  145872. }, scene?: Nullable<Scene>): Mesh;
  145873. /**
  145874. * Creates lathe mesh.
  145875. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145876. * * 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
  145877. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145878. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145879. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145880. * * 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
  145881. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145882. * * 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
  145883. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145884. * * 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
  145885. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145886. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145887. * @param name defines the name of the mesh
  145888. * @param options defines the options used to create the mesh
  145889. * @param scene defines the hosting scene
  145890. * @returns the lathe mesh
  145891. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145892. */
  145893. static CreateLathe(name: string, options: {
  145894. shape: Vector3[];
  145895. radius?: number;
  145896. tessellation?: number;
  145897. clip?: number;
  145898. arc?: number;
  145899. closed?: boolean;
  145900. updatable?: boolean;
  145901. sideOrientation?: number;
  145902. frontUVs?: Vector4;
  145903. backUVs?: Vector4;
  145904. cap?: number;
  145905. invertUV?: boolean;
  145906. }, scene?: Nullable<Scene>): Mesh;
  145907. /**
  145908. * Creates a tiled plane mesh
  145909. * * You can set a limited pattern arrangement with the tiles
  145910. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145911. * * 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
  145912. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145913. * @param name defines the name of the mesh
  145914. * @param options defines the options used to create the mesh
  145915. * @param scene defines the hosting scene
  145916. * @returns the plane mesh
  145917. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145918. */
  145919. static CreateTiledPlane(name: string, options: {
  145920. pattern?: number;
  145921. tileSize?: number;
  145922. tileWidth?: number;
  145923. tileHeight?: number;
  145924. size?: number;
  145925. width?: number;
  145926. height?: number;
  145927. alignHorizontal?: number;
  145928. alignVertical?: number;
  145929. sideOrientation?: number;
  145930. frontUVs?: Vector4;
  145931. backUVs?: Vector4;
  145932. updatable?: boolean;
  145933. }, scene?: Nullable<Scene>): Mesh;
  145934. /**
  145935. * Creates a plane mesh
  145936. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145937. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145938. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145939. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145940. * * 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
  145941. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145942. * @param name defines the name of the mesh
  145943. * @param options defines the options used to create the mesh
  145944. * @param scene defines the hosting scene
  145945. * @returns the plane mesh
  145946. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145947. */
  145948. static CreatePlane(name: string, options: {
  145949. size?: number;
  145950. width?: number;
  145951. height?: number;
  145952. sideOrientation?: number;
  145953. frontUVs?: Vector4;
  145954. backUVs?: Vector4;
  145955. updatable?: boolean;
  145956. sourcePlane?: Plane;
  145957. }, scene?: Nullable<Scene>): Mesh;
  145958. /**
  145959. * Creates a ground mesh
  145960. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145961. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145962. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145963. * @param name defines the name of the mesh
  145964. * @param options defines the options used to create the mesh
  145965. * @param scene defines the hosting scene
  145966. * @returns the ground mesh
  145967. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145968. */
  145969. static CreateGround(name: string, options: {
  145970. width?: number;
  145971. height?: number;
  145972. subdivisions?: number;
  145973. subdivisionsX?: number;
  145974. subdivisionsY?: number;
  145975. updatable?: boolean;
  145976. }, scene?: Nullable<Scene>): Mesh;
  145977. /**
  145978. * Creates a tiled ground mesh
  145979. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145980. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145981. * * 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
  145982. * * 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
  145983. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145984. * @param name defines the name of the mesh
  145985. * @param options defines the options used to create the mesh
  145986. * @param scene defines the hosting scene
  145987. * @returns the tiled ground mesh
  145988. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145989. */
  145990. static CreateTiledGround(name: string, options: {
  145991. xmin: number;
  145992. zmin: number;
  145993. xmax: number;
  145994. zmax: number;
  145995. subdivisions?: {
  145996. w: number;
  145997. h: number;
  145998. };
  145999. precision?: {
  146000. w: number;
  146001. h: number;
  146002. };
  146003. updatable?: boolean;
  146004. }, scene?: Nullable<Scene>): Mesh;
  146005. /**
  146006. * Creates a ground mesh from a height map
  146007. * * The parameter `url` sets the URL of the height map image resource.
  146008. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  146009. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  146010. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  146011. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  146012. * * 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.
  146013. * * 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).
  146014. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  146015. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146016. * @param name defines the name of the mesh
  146017. * @param url defines the url to the height map
  146018. * @param options defines the options used to create the mesh
  146019. * @param scene defines the hosting scene
  146020. * @returns the ground mesh
  146021. * @see https://doc.babylonjs.com/babylon101/height_map
  146022. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  146023. */
  146024. static CreateGroundFromHeightMap(name: string, url: string, options: {
  146025. width?: number;
  146026. height?: number;
  146027. subdivisions?: number;
  146028. minHeight?: number;
  146029. maxHeight?: number;
  146030. colorFilter?: Color3;
  146031. alphaFilter?: number;
  146032. updatable?: boolean;
  146033. onReady?: (mesh: GroundMesh) => void;
  146034. }, scene?: Nullable<Scene>): GroundMesh;
  146035. /**
  146036. * Creates a polygon mesh
  146037. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  146038. * * 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
  146039. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146040. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146041. * * 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)
  146042. * * Remember you can only change the shape positions, not their number when updating a polygon
  146043. * @param name defines the name of the mesh
  146044. * @param options defines the options used to create the mesh
  146045. * @param scene defines the hosting scene
  146046. * @param earcutInjection can be used to inject your own earcut reference
  146047. * @returns the polygon mesh
  146048. */
  146049. static CreatePolygon(name: string, options: {
  146050. shape: Vector3[];
  146051. holes?: Vector3[][];
  146052. depth?: number;
  146053. faceUV?: Vector4[];
  146054. faceColors?: Color4[];
  146055. updatable?: boolean;
  146056. sideOrientation?: number;
  146057. frontUVs?: Vector4;
  146058. backUVs?: Vector4;
  146059. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146060. /**
  146061. * Creates an extruded polygon mesh, with depth in the Y direction.
  146062. * * 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)
  146063. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146064. * @param name defines the name of the mesh
  146065. * @param options defines the options used to create the mesh
  146066. * @param scene defines the hosting scene
  146067. * @param earcutInjection can be used to inject your own earcut reference
  146068. * @returns the polygon mesh
  146069. */
  146070. static ExtrudePolygon(name: string, options: {
  146071. shape: Vector3[];
  146072. holes?: Vector3[][];
  146073. depth?: number;
  146074. faceUV?: Vector4[];
  146075. faceColors?: Color4[];
  146076. updatable?: boolean;
  146077. sideOrientation?: number;
  146078. frontUVs?: Vector4;
  146079. backUVs?: Vector4;
  146080. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146081. /**
  146082. * Creates a tube mesh.
  146083. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146084. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146085. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146086. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146087. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146088. * * 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)
  146089. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146090. * * 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
  146091. * * 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
  146092. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146093. * * 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
  146094. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146095. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146096. * @param name defines the name of the mesh
  146097. * @param options defines the options used to create the mesh
  146098. * @param scene defines the hosting scene
  146099. * @returns the tube mesh
  146100. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146101. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146102. */
  146103. static CreateTube(name: string, options: {
  146104. path: Vector3[];
  146105. radius?: number;
  146106. tessellation?: number;
  146107. radiusFunction?: {
  146108. (i: number, distance: number): number;
  146109. };
  146110. cap?: number;
  146111. arc?: number;
  146112. updatable?: boolean;
  146113. sideOrientation?: number;
  146114. frontUVs?: Vector4;
  146115. backUVs?: Vector4;
  146116. instance?: Mesh;
  146117. invertUV?: boolean;
  146118. }, scene?: Nullable<Scene>): Mesh;
  146119. /**
  146120. * Creates a polyhedron mesh
  146121. * * 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
  146122. * * The parameter `size` (positive float, default 1) sets the polygon size
  146123. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  146124. * * 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`
  146125. * * 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
  146126. * * 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)`)
  146127. * * 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
  146128. * * 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
  146129. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146130. * * 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
  146131. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146132. * @param name defines the name of the mesh
  146133. * @param options defines the options used to create the mesh
  146134. * @param scene defines the hosting scene
  146135. * @returns the polyhedron mesh
  146136. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  146137. */
  146138. static CreatePolyhedron(name: string, options: {
  146139. type?: number;
  146140. size?: number;
  146141. sizeX?: number;
  146142. sizeY?: number;
  146143. sizeZ?: number;
  146144. custom?: any;
  146145. faceUV?: Vector4[];
  146146. faceColors?: Color4[];
  146147. flat?: boolean;
  146148. updatable?: boolean;
  146149. sideOrientation?: number;
  146150. frontUVs?: Vector4;
  146151. backUVs?: Vector4;
  146152. }, scene?: Nullable<Scene>): Mesh;
  146153. /**
  146154. * Creates a decal mesh.
  146155. * 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
  146156. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146157. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146158. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146159. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146160. * @param name defines the name of the mesh
  146161. * @param sourceMesh defines the mesh where the decal must be applied
  146162. * @param options defines the options used to create the mesh
  146163. * @param scene defines the hosting scene
  146164. * @returns the decal mesh
  146165. * @see https://doc.babylonjs.com/how_to/decals
  146166. */
  146167. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146168. position?: Vector3;
  146169. normal?: Vector3;
  146170. size?: Vector3;
  146171. angle?: number;
  146172. }): Mesh;
  146173. }
  146174. }
  146175. declare module BABYLON {
  146176. /**
  146177. * A simplifier interface for future simplification implementations
  146178. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146179. */
  146180. export interface ISimplifier {
  146181. /**
  146182. * Simplification of a given mesh according to the given settings.
  146183. * Since this requires computation, it is assumed that the function runs async.
  146184. * @param settings The settings of the simplification, including quality and distance
  146185. * @param successCallback A callback that will be called after the mesh was simplified.
  146186. * @param errorCallback in case of an error, this callback will be called. optional.
  146187. */
  146188. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146189. }
  146190. /**
  146191. * Expected simplification settings.
  146192. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146193. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146194. */
  146195. export interface ISimplificationSettings {
  146196. /**
  146197. * Gets or sets the expected quality
  146198. */
  146199. quality: number;
  146200. /**
  146201. * Gets or sets the distance when this optimized version should be used
  146202. */
  146203. distance: number;
  146204. /**
  146205. * Gets an already optimized mesh
  146206. */
  146207. optimizeMesh?: boolean;
  146208. }
  146209. /**
  146210. * Class used to specify simplification options
  146211. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146212. */
  146213. export class SimplificationSettings implements ISimplificationSettings {
  146214. /** expected quality */
  146215. quality: number;
  146216. /** distance when this optimized version should be used */
  146217. distance: number;
  146218. /** already optimized mesh */
  146219. optimizeMesh?: boolean | undefined;
  146220. /**
  146221. * Creates a SimplificationSettings
  146222. * @param quality expected quality
  146223. * @param distance distance when this optimized version should be used
  146224. * @param optimizeMesh already optimized mesh
  146225. */
  146226. constructor(
  146227. /** expected quality */
  146228. quality: number,
  146229. /** distance when this optimized version should be used */
  146230. distance: number,
  146231. /** already optimized mesh */
  146232. optimizeMesh?: boolean | undefined);
  146233. }
  146234. /**
  146235. * Interface used to define a simplification task
  146236. */
  146237. export interface ISimplificationTask {
  146238. /**
  146239. * Array of settings
  146240. */
  146241. settings: Array<ISimplificationSettings>;
  146242. /**
  146243. * Simplification type
  146244. */
  146245. simplificationType: SimplificationType;
  146246. /**
  146247. * Mesh to simplify
  146248. */
  146249. mesh: Mesh;
  146250. /**
  146251. * Callback called on success
  146252. */
  146253. successCallback?: () => void;
  146254. /**
  146255. * Defines if parallel processing can be used
  146256. */
  146257. parallelProcessing: boolean;
  146258. }
  146259. /**
  146260. * Queue used to order the simplification tasks
  146261. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146262. */
  146263. export class SimplificationQueue {
  146264. private _simplificationArray;
  146265. /**
  146266. * Gets a boolean indicating that the process is still running
  146267. */
  146268. running: boolean;
  146269. /**
  146270. * Creates a new queue
  146271. */
  146272. constructor();
  146273. /**
  146274. * Adds a new simplification task
  146275. * @param task defines a task to add
  146276. */
  146277. addTask(task: ISimplificationTask): void;
  146278. /**
  146279. * Execute next task
  146280. */
  146281. executeNext(): void;
  146282. /**
  146283. * Execute a simplification task
  146284. * @param task defines the task to run
  146285. */
  146286. runSimplification(task: ISimplificationTask): void;
  146287. private getSimplifier;
  146288. }
  146289. /**
  146290. * The implemented types of simplification
  146291. * At the moment only Quadratic Error Decimation is implemented
  146292. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146293. */
  146294. export enum SimplificationType {
  146295. /** Quadratic error decimation */
  146296. QUADRATIC = 0
  146297. }
  146298. /**
  146299. * An implementation of the Quadratic Error simplification algorithm.
  146300. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146301. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146302. * @author RaananW
  146303. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146304. */
  146305. export class QuadraticErrorSimplification implements ISimplifier {
  146306. private _mesh;
  146307. private triangles;
  146308. private vertices;
  146309. private references;
  146310. private _reconstructedMesh;
  146311. /** Gets or sets the number pf sync interations */
  146312. syncIterations: number;
  146313. /** Gets or sets the aggressiveness of the simplifier */
  146314. aggressiveness: number;
  146315. /** Gets or sets the number of allowed iterations for decimation */
  146316. decimationIterations: number;
  146317. /** Gets or sets the espilon to use for bounding box computation */
  146318. boundingBoxEpsilon: number;
  146319. /**
  146320. * Creates a new QuadraticErrorSimplification
  146321. * @param _mesh defines the target mesh
  146322. */
  146323. constructor(_mesh: Mesh);
  146324. /**
  146325. * Simplification of a given mesh according to the given settings.
  146326. * Since this requires computation, it is assumed that the function runs async.
  146327. * @param settings The settings of the simplification, including quality and distance
  146328. * @param successCallback A callback that will be called after the mesh was simplified.
  146329. */
  146330. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146331. private runDecimation;
  146332. private initWithMesh;
  146333. private init;
  146334. private reconstructMesh;
  146335. private initDecimatedMesh;
  146336. private isFlipped;
  146337. private updateTriangles;
  146338. private identifyBorder;
  146339. private updateMesh;
  146340. private vertexError;
  146341. private calculateError;
  146342. }
  146343. }
  146344. declare module BABYLON {
  146345. interface Scene {
  146346. /** @hidden (Backing field) */
  146347. _simplificationQueue: SimplificationQueue;
  146348. /**
  146349. * Gets or sets the simplification queue attached to the scene
  146350. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146351. */
  146352. simplificationQueue: SimplificationQueue;
  146353. }
  146354. interface Mesh {
  146355. /**
  146356. * Simplify the mesh according to the given array of settings.
  146357. * Function will return immediately and will simplify async
  146358. * @param settings a collection of simplification settings
  146359. * @param parallelProcessing should all levels calculate parallel or one after the other
  146360. * @param simplificationType the type of simplification to run
  146361. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146362. * @returns the current mesh
  146363. */
  146364. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146365. }
  146366. /**
  146367. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146368. * created in a scene
  146369. */
  146370. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146371. /**
  146372. * The component name helpfull to identify the component in the list of scene components.
  146373. */
  146374. readonly name: string;
  146375. /**
  146376. * The scene the component belongs to.
  146377. */
  146378. scene: Scene;
  146379. /**
  146380. * Creates a new instance of the component for the given scene
  146381. * @param scene Defines the scene to register the component in
  146382. */
  146383. constructor(scene: Scene);
  146384. /**
  146385. * Registers the component in a given scene
  146386. */
  146387. register(): void;
  146388. /**
  146389. * Rebuilds the elements related to this component in case of
  146390. * context lost for instance.
  146391. */
  146392. rebuild(): void;
  146393. /**
  146394. * Disposes the component and the associated ressources
  146395. */
  146396. dispose(): void;
  146397. private _beforeCameraUpdate;
  146398. }
  146399. }
  146400. declare module BABYLON {
  146401. interface Mesh {
  146402. /**
  146403. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146404. */
  146405. thinInstanceEnablePicking: boolean;
  146406. /**
  146407. * Creates a new thin instance
  146408. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146409. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  146410. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146411. */
  146412. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146413. /**
  146414. * Adds the transformation (matrix) of the current mesh as a thin instance
  146415. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  146416. * @returns the thin instance index number
  146417. */
  146418. thinInstanceAddSelf(refresh: boolean): number;
  146419. /**
  146420. * Registers a custom attribute to be used with thin instances
  146421. * @param kind name of the attribute
  146422. * @param stride size in floats of the attribute
  146423. */
  146424. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146425. /**
  146426. * Sets the matrix of a thin instance
  146427. * @param index index of the thin instance
  146428. * @param matrix matrix to set
  146429. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  146430. */
  146431. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146432. /**
  146433. * Sets the value of a custom attribute for a thin instance
  146434. * @param kind name of the attribute
  146435. * @param index index of the thin instance
  146436. * @param value value to set
  146437. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  146438. */
  146439. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146440. /**
  146441. * Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.
  146442. */
  146443. thinInstanceCount: number;
  146444. /**
  146445. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146446. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146447. * @param buffer buffer to set
  146448. * @param stride size in floats of each value of the buffer
  146449. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146450. */
  146451. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146452. /**
  146453. * Gets the list of world matrices
  146454. * @return an array containing all the world matrices from the thin instances
  146455. */
  146456. thinInstanceGetWorldMatrices(): Matrix[];
  146457. /**
  146458. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146459. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146460. */
  146461. thinInstanceBufferUpdated(kind: string): void;
  146462. /**
  146463. * Applies a partial update to a buffer directly on the GPU
  146464. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  146465. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146466. * @param data the data to set in the GPU buffer
  146467. * @param offset the offset in the GPU buffer where to update the data
  146468. */
  146469. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  146470. /**
  146471. * Refreshes the bounding info, taking into account all the thin instances defined
  146472. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146473. */
  146474. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146475. /** @hidden */
  146476. _thinInstanceInitializeUserStorage(): void;
  146477. /** @hidden */
  146478. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146479. /** @hidden */
  146480. _userThinInstanceBuffersStorage: {
  146481. data: {
  146482. [key: string]: Float32Array;
  146483. };
  146484. sizes: {
  146485. [key: string]: number;
  146486. };
  146487. vertexBuffers: {
  146488. [key: string]: Nullable<VertexBuffer>;
  146489. };
  146490. strides: {
  146491. [key: string]: number;
  146492. };
  146493. };
  146494. }
  146495. }
  146496. declare module BABYLON {
  146497. /**
  146498. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146499. */
  146500. export interface INavigationEnginePlugin {
  146501. /**
  146502. * plugin name
  146503. */
  146504. name: string;
  146505. /**
  146506. * Creates a navigation mesh
  146507. * @param meshes array of all the geometry used to compute the navigatio mesh
  146508. * @param parameters bunch of parameters used to filter geometry
  146509. */
  146510. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146511. /**
  146512. * Create a navigation mesh debug mesh
  146513. * @param scene is where the mesh will be added
  146514. * @returns debug display mesh
  146515. */
  146516. createDebugNavMesh(scene: Scene): Mesh;
  146517. /**
  146518. * Get a navigation mesh constrained position, closest to the parameter position
  146519. * @param position world position
  146520. * @returns the closest point to position constrained by the navigation mesh
  146521. */
  146522. getClosestPoint(position: Vector3): Vector3;
  146523. /**
  146524. * Get a navigation mesh constrained position, closest to the parameter position
  146525. * @param position world position
  146526. * @param result output the closest point to position constrained by the navigation mesh
  146527. */
  146528. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146529. /**
  146530. * Get a navigation mesh constrained position, within a particular radius
  146531. * @param position world position
  146532. * @param maxRadius the maximum distance to the constrained world position
  146533. * @returns the closest point to position constrained by the navigation mesh
  146534. */
  146535. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146536. /**
  146537. * Get a navigation mesh constrained position, within a particular radius
  146538. * @param position world position
  146539. * @param maxRadius the maximum distance to the constrained world position
  146540. * @param result output the closest point to position constrained by the navigation mesh
  146541. */
  146542. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146543. /**
  146544. * Compute the final position from a segment made of destination-position
  146545. * @param position world position
  146546. * @param destination world position
  146547. * @returns the resulting point along the navmesh
  146548. */
  146549. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146550. /**
  146551. * Compute the final position from a segment made of destination-position
  146552. * @param position world position
  146553. * @param destination world position
  146554. * @param result output the resulting point along the navmesh
  146555. */
  146556. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146557. /**
  146558. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146559. * @param start world position
  146560. * @param end world position
  146561. * @returns array containing world position composing the path
  146562. */
  146563. computePath(start: Vector3, end: Vector3): Vector3[];
  146564. /**
  146565. * If this plugin is supported
  146566. * @returns true if plugin is supported
  146567. */
  146568. isSupported(): boolean;
  146569. /**
  146570. * Create a new Crowd so you can add agents
  146571. * @param maxAgents the maximum agent count in the crowd
  146572. * @param maxAgentRadius the maximum radius an agent can have
  146573. * @param scene to attach the crowd to
  146574. * @returns the crowd you can add agents to
  146575. */
  146576. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146577. /**
  146578. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146579. * The queries will try to find a solution within those bounds
  146580. * default is (1,1,1)
  146581. * @param extent x,y,z value that define the extent around the queries point of reference
  146582. */
  146583. setDefaultQueryExtent(extent: Vector3): void;
  146584. /**
  146585. * Get the Bounding box extent specified by setDefaultQueryExtent
  146586. * @returns the box extent values
  146587. */
  146588. getDefaultQueryExtent(): Vector3;
  146589. /**
  146590. * build the navmesh from a previously saved state using getNavmeshData
  146591. * @param data the Uint8Array returned by getNavmeshData
  146592. */
  146593. buildFromNavmeshData(data: Uint8Array): void;
  146594. /**
  146595. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146596. * @returns data the Uint8Array that can be saved and reused
  146597. */
  146598. getNavmeshData(): Uint8Array;
  146599. /**
  146600. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146601. * @param result output the box extent values
  146602. */
  146603. getDefaultQueryExtentToRef(result: Vector3): void;
  146604. /**
  146605. * Release all resources
  146606. */
  146607. dispose(): void;
  146608. }
  146609. /**
  146610. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146611. */
  146612. export interface ICrowd {
  146613. /**
  146614. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146615. * You can attach anything to that node. The node position is updated in the scene update tick.
  146616. * @param pos world position that will be constrained by the navigation mesh
  146617. * @param parameters agent parameters
  146618. * @param transform hooked to the agent that will be update by the scene
  146619. * @returns agent index
  146620. */
  146621. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146622. /**
  146623. * Returns the agent position in world space
  146624. * @param index agent index returned by addAgent
  146625. * @returns world space position
  146626. */
  146627. getAgentPosition(index: number): Vector3;
  146628. /**
  146629. * Gets the agent position result in world space
  146630. * @param index agent index returned by addAgent
  146631. * @param result output world space position
  146632. */
  146633. getAgentPositionToRef(index: number, result: Vector3): void;
  146634. /**
  146635. * Gets the agent velocity in world space
  146636. * @param index agent index returned by addAgent
  146637. * @returns world space velocity
  146638. */
  146639. getAgentVelocity(index: number): Vector3;
  146640. /**
  146641. * Gets the agent velocity result in world space
  146642. * @param index agent index returned by addAgent
  146643. * @param result output world space velocity
  146644. */
  146645. getAgentVelocityToRef(index: number, result: Vector3): void;
  146646. /**
  146647. * remove a particular agent previously created
  146648. * @param index agent index returned by addAgent
  146649. */
  146650. removeAgent(index: number): void;
  146651. /**
  146652. * get the list of all agents attached to this crowd
  146653. * @returns list of agent indices
  146654. */
  146655. getAgents(): number[];
  146656. /**
  146657. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146658. * @param deltaTime in seconds
  146659. */
  146660. update(deltaTime: number): void;
  146661. /**
  146662. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146663. * @param index agent index returned by addAgent
  146664. * @param destination targeted world position
  146665. */
  146666. agentGoto(index: number, destination: Vector3): void;
  146667. /**
  146668. * Teleport the agent to a new position
  146669. * @param index agent index returned by addAgent
  146670. * @param destination targeted world position
  146671. */
  146672. agentTeleport(index: number, destination: Vector3): void;
  146673. /**
  146674. * Update agent parameters
  146675. * @param index agent index returned by addAgent
  146676. * @param parameters agent parameters
  146677. */
  146678. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146679. /**
  146680. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146681. * The queries will try to find a solution within those bounds
  146682. * default is (1,1,1)
  146683. * @param extent x,y,z value that define the extent around the queries point of reference
  146684. */
  146685. setDefaultQueryExtent(extent: Vector3): void;
  146686. /**
  146687. * Get the Bounding box extent specified by setDefaultQueryExtent
  146688. * @returns the box extent values
  146689. */
  146690. getDefaultQueryExtent(): Vector3;
  146691. /**
  146692. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146693. * @param result output the box extent values
  146694. */
  146695. getDefaultQueryExtentToRef(result: Vector3): void;
  146696. /**
  146697. * Release all resources
  146698. */
  146699. dispose(): void;
  146700. }
  146701. /**
  146702. * Configures an agent
  146703. */
  146704. export interface IAgentParameters {
  146705. /**
  146706. * Agent radius. [Limit: >= 0]
  146707. */
  146708. radius: number;
  146709. /**
  146710. * Agent height. [Limit: > 0]
  146711. */
  146712. height: number;
  146713. /**
  146714. * Maximum allowed acceleration. [Limit: >= 0]
  146715. */
  146716. maxAcceleration: number;
  146717. /**
  146718. * Maximum allowed speed. [Limit: >= 0]
  146719. */
  146720. maxSpeed: number;
  146721. /**
  146722. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146723. */
  146724. collisionQueryRange: number;
  146725. /**
  146726. * The path visibility optimization range. [Limit: > 0]
  146727. */
  146728. pathOptimizationRange: number;
  146729. /**
  146730. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146731. */
  146732. separationWeight: number;
  146733. }
  146734. /**
  146735. * Configures the navigation mesh creation
  146736. */
  146737. export interface INavMeshParameters {
  146738. /**
  146739. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146740. */
  146741. cs: number;
  146742. /**
  146743. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146744. */
  146745. ch: number;
  146746. /**
  146747. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146748. */
  146749. walkableSlopeAngle: number;
  146750. /**
  146751. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146752. * be considered walkable. [Limit: >= 3] [Units: vx]
  146753. */
  146754. walkableHeight: number;
  146755. /**
  146756. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146757. */
  146758. walkableClimb: number;
  146759. /**
  146760. * The distance to erode/shrink the walkable area of the heightfield away from
  146761. * obstructions. [Limit: >=0] [Units: vx]
  146762. */
  146763. walkableRadius: number;
  146764. /**
  146765. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146766. */
  146767. maxEdgeLen: number;
  146768. /**
  146769. * The maximum distance a simplfied contour's border edges should deviate
  146770. * the original raw contour. [Limit: >=0] [Units: vx]
  146771. */
  146772. maxSimplificationError: number;
  146773. /**
  146774. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146775. */
  146776. minRegionArea: number;
  146777. /**
  146778. * Any regions with a span count smaller than this value will, if possible,
  146779. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146780. */
  146781. mergeRegionArea: number;
  146782. /**
  146783. * The maximum number of vertices allowed for polygons generated during the
  146784. * contour to polygon conversion process. [Limit: >= 3]
  146785. */
  146786. maxVertsPerPoly: number;
  146787. /**
  146788. * Sets the sampling distance to use when generating the detail mesh.
  146789. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146790. */
  146791. detailSampleDist: number;
  146792. /**
  146793. * The maximum distance the detail mesh surface should deviate from heightfield
  146794. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146795. */
  146796. detailSampleMaxError: number;
  146797. }
  146798. }
  146799. declare module BABYLON {
  146800. /**
  146801. * RecastJS navigation plugin
  146802. */
  146803. export class RecastJSPlugin implements INavigationEnginePlugin {
  146804. /**
  146805. * Reference to the Recast library
  146806. */
  146807. bjsRECAST: any;
  146808. /**
  146809. * plugin name
  146810. */
  146811. name: string;
  146812. /**
  146813. * the first navmesh created. We might extend this to support multiple navmeshes
  146814. */
  146815. navMesh: any;
  146816. /**
  146817. * Initializes the recastJS plugin
  146818. * @param recastInjection can be used to inject your own recast reference
  146819. */
  146820. constructor(recastInjection?: any);
  146821. /**
  146822. * Creates a navigation mesh
  146823. * @param meshes array of all the geometry used to compute the navigatio mesh
  146824. * @param parameters bunch of parameters used to filter geometry
  146825. */
  146826. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146827. /**
  146828. * Create a navigation mesh debug mesh
  146829. * @param scene is where the mesh will be added
  146830. * @returns debug display mesh
  146831. */
  146832. createDebugNavMesh(scene: Scene): Mesh;
  146833. /**
  146834. * Get a navigation mesh constrained position, closest to the parameter position
  146835. * @param position world position
  146836. * @returns the closest point to position constrained by the navigation mesh
  146837. */
  146838. getClosestPoint(position: Vector3): Vector3;
  146839. /**
  146840. * Get a navigation mesh constrained position, closest to the parameter position
  146841. * @param position world position
  146842. * @param result output the closest point to position constrained by the navigation mesh
  146843. */
  146844. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146845. /**
  146846. * Get a navigation mesh constrained position, within a particular radius
  146847. * @param position world position
  146848. * @param maxRadius the maximum distance to the constrained world position
  146849. * @returns the closest point to position constrained by the navigation mesh
  146850. */
  146851. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146852. /**
  146853. * Get a navigation mesh constrained position, within a particular radius
  146854. * @param position world position
  146855. * @param maxRadius the maximum distance to the constrained world position
  146856. * @param result output the closest point to position constrained by the navigation mesh
  146857. */
  146858. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146859. /**
  146860. * Compute the final position from a segment made of destination-position
  146861. * @param position world position
  146862. * @param destination world position
  146863. * @returns the resulting point along the navmesh
  146864. */
  146865. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146866. /**
  146867. * Compute the final position from a segment made of destination-position
  146868. * @param position world position
  146869. * @param destination world position
  146870. * @param result output the resulting point along the navmesh
  146871. */
  146872. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146873. /**
  146874. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146875. * @param start world position
  146876. * @param end world position
  146877. * @returns array containing world position composing the path
  146878. */
  146879. computePath(start: Vector3, end: Vector3): Vector3[];
  146880. /**
  146881. * Create a new Crowd so you can add agents
  146882. * @param maxAgents the maximum agent count in the crowd
  146883. * @param maxAgentRadius the maximum radius an agent can have
  146884. * @param scene to attach the crowd to
  146885. * @returns the crowd you can add agents to
  146886. */
  146887. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146888. /**
  146889. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146890. * The queries will try to find a solution within those bounds
  146891. * default is (1,1,1)
  146892. * @param extent x,y,z value that define the extent around the queries point of reference
  146893. */
  146894. setDefaultQueryExtent(extent: Vector3): void;
  146895. /**
  146896. * Get the Bounding box extent specified by setDefaultQueryExtent
  146897. * @returns the box extent values
  146898. */
  146899. getDefaultQueryExtent(): Vector3;
  146900. /**
  146901. * build the navmesh from a previously saved state using getNavmeshData
  146902. * @param data the Uint8Array returned by getNavmeshData
  146903. */
  146904. buildFromNavmeshData(data: Uint8Array): void;
  146905. /**
  146906. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146907. * @returns data the Uint8Array that can be saved and reused
  146908. */
  146909. getNavmeshData(): Uint8Array;
  146910. /**
  146911. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146912. * @param result output the box extent values
  146913. */
  146914. getDefaultQueryExtentToRef(result: Vector3): void;
  146915. /**
  146916. * Disposes
  146917. */
  146918. dispose(): void;
  146919. /**
  146920. * If this plugin is supported
  146921. * @returns true if plugin is supported
  146922. */
  146923. isSupported(): boolean;
  146924. }
  146925. /**
  146926. * Recast detour crowd implementation
  146927. */
  146928. export class RecastJSCrowd implements ICrowd {
  146929. /**
  146930. * Recast/detour plugin
  146931. */
  146932. bjsRECASTPlugin: RecastJSPlugin;
  146933. /**
  146934. * Link to the detour crowd
  146935. */
  146936. recastCrowd: any;
  146937. /**
  146938. * One transform per agent
  146939. */
  146940. transforms: TransformNode[];
  146941. /**
  146942. * All agents created
  146943. */
  146944. agents: number[];
  146945. /**
  146946. * Link to the scene is kept to unregister the crowd from the scene
  146947. */
  146948. private _scene;
  146949. /**
  146950. * Observer for crowd updates
  146951. */
  146952. private _onBeforeAnimationsObserver;
  146953. /**
  146954. * Constructor
  146955. * @param plugin recastJS plugin
  146956. * @param maxAgents the maximum agent count in the crowd
  146957. * @param maxAgentRadius the maximum radius an agent can have
  146958. * @param scene to attach the crowd to
  146959. * @returns the crowd you can add agents to
  146960. */
  146961. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146962. /**
  146963. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146964. * You can attach anything to that node. The node position is updated in the scene update tick.
  146965. * @param pos world position that will be constrained by the navigation mesh
  146966. * @param parameters agent parameters
  146967. * @param transform hooked to the agent that will be update by the scene
  146968. * @returns agent index
  146969. */
  146970. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146971. /**
  146972. * Returns the agent position in world space
  146973. * @param index agent index returned by addAgent
  146974. * @returns world space position
  146975. */
  146976. getAgentPosition(index: number): Vector3;
  146977. /**
  146978. * Returns the agent position result in world space
  146979. * @param index agent index returned by addAgent
  146980. * @param result output world space position
  146981. */
  146982. getAgentPositionToRef(index: number, result: Vector3): void;
  146983. /**
  146984. * Returns the agent velocity in world space
  146985. * @param index agent index returned by addAgent
  146986. * @returns world space velocity
  146987. */
  146988. getAgentVelocity(index: number): Vector3;
  146989. /**
  146990. * Returns the agent velocity result in world space
  146991. * @param index agent index returned by addAgent
  146992. * @param result output world space velocity
  146993. */
  146994. getAgentVelocityToRef(index: number, result: Vector3): void;
  146995. /**
  146996. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146997. * @param index agent index returned by addAgent
  146998. * @param destination targeted world position
  146999. */
  147000. agentGoto(index: number, destination: Vector3): void;
  147001. /**
  147002. * Teleport the agent to a new position
  147003. * @param index agent index returned by addAgent
  147004. * @param destination targeted world position
  147005. */
  147006. agentTeleport(index: number, destination: Vector3): void;
  147007. /**
  147008. * Update agent parameters
  147009. * @param index agent index returned by addAgent
  147010. * @param parameters agent parameters
  147011. */
  147012. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147013. /**
  147014. * remove a particular agent previously created
  147015. * @param index agent index returned by addAgent
  147016. */
  147017. removeAgent(index: number): void;
  147018. /**
  147019. * get the list of all agents attached to this crowd
  147020. * @returns list of agent indices
  147021. */
  147022. getAgents(): number[];
  147023. /**
  147024. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147025. * @param deltaTime in seconds
  147026. */
  147027. update(deltaTime: number): void;
  147028. /**
  147029. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147030. * The queries will try to find a solution within those bounds
  147031. * default is (1,1,1)
  147032. * @param extent x,y,z value that define the extent around the queries point of reference
  147033. */
  147034. setDefaultQueryExtent(extent: Vector3): void;
  147035. /**
  147036. * Get the Bounding box extent specified by setDefaultQueryExtent
  147037. * @returns the box extent values
  147038. */
  147039. getDefaultQueryExtent(): Vector3;
  147040. /**
  147041. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147042. * @param result output the box extent values
  147043. */
  147044. getDefaultQueryExtentToRef(result: Vector3): void;
  147045. /**
  147046. * Release all resources
  147047. */
  147048. dispose(): void;
  147049. }
  147050. }
  147051. declare module BABYLON {
  147052. /**
  147053. * Class used to enable access to IndexedDB
  147054. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  147055. */
  147056. export class Database implements IOfflineProvider {
  147057. private _callbackManifestChecked;
  147058. private _currentSceneUrl;
  147059. private _db;
  147060. private _enableSceneOffline;
  147061. private _enableTexturesOffline;
  147062. private _manifestVersionFound;
  147063. private _mustUpdateRessources;
  147064. private _hasReachedQuota;
  147065. private _isSupported;
  147066. private _idbFactory;
  147067. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  147068. private static IsUASupportingBlobStorage;
  147069. /**
  147070. * Gets a boolean indicating if Database storate is enabled (off by default)
  147071. */
  147072. static IDBStorageEnabled: boolean;
  147073. /**
  147074. * Gets a boolean indicating if scene must be saved in the database
  147075. */
  147076. get enableSceneOffline(): boolean;
  147077. /**
  147078. * Gets a boolean indicating if textures must be saved in the database
  147079. */
  147080. get enableTexturesOffline(): boolean;
  147081. /**
  147082. * Creates a new Database
  147083. * @param urlToScene defines the url to load the scene
  147084. * @param callbackManifestChecked defines the callback to use when manifest is checked
  147085. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  147086. */
  147087. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  147088. private static _ParseURL;
  147089. private static _ReturnFullUrlLocation;
  147090. private _checkManifestFile;
  147091. /**
  147092. * Open the database and make it available
  147093. * @param successCallback defines the callback to call on success
  147094. * @param errorCallback defines the callback to call on error
  147095. */
  147096. open(successCallback: () => void, errorCallback: () => void): void;
  147097. /**
  147098. * Loads an image from the database
  147099. * @param url defines the url to load from
  147100. * @param image defines the target DOM image
  147101. */
  147102. loadImage(url: string, image: HTMLImageElement): void;
  147103. private _loadImageFromDBAsync;
  147104. private _saveImageIntoDBAsync;
  147105. private _checkVersionFromDB;
  147106. private _loadVersionFromDBAsync;
  147107. private _saveVersionIntoDBAsync;
  147108. /**
  147109. * Loads a file from database
  147110. * @param url defines the URL to load from
  147111. * @param sceneLoaded defines a callback to call on success
  147112. * @param progressCallBack defines a callback to call when progress changed
  147113. * @param errorCallback defines a callback to call on error
  147114. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  147115. */
  147116. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  147117. private _loadFileAsync;
  147118. private _saveFileAsync;
  147119. /**
  147120. * Validates if xhr data is correct
  147121. * @param xhr defines the request to validate
  147122. * @param dataType defines the expected data type
  147123. * @returns true if data is correct
  147124. */
  147125. private static _ValidateXHRData;
  147126. }
  147127. }
  147128. declare module BABYLON {
  147129. /** @hidden */
  147130. export var gpuUpdateParticlesPixelShader: {
  147131. name: string;
  147132. shader: string;
  147133. };
  147134. }
  147135. declare module BABYLON {
  147136. /** @hidden */
  147137. export var gpuUpdateParticlesVertexShader: {
  147138. name: string;
  147139. shader: string;
  147140. };
  147141. }
  147142. declare module BABYLON {
  147143. /** @hidden */
  147144. export var clipPlaneFragmentDeclaration2: {
  147145. name: string;
  147146. shader: string;
  147147. };
  147148. }
  147149. declare module BABYLON {
  147150. /** @hidden */
  147151. export var gpuRenderParticlesPixelShader: {
  147152. name: string;
  147153. shader: string;
  147154. };
  147155. }
  147156. declare module BABYLON {
  147157. /** @hidden */
  147158. export var clipPlaneVertexDeclaration2: {
  147159. name: string;
  147160. shader: string;
  147161. };
  147162. }
  147163. declare module BABYLON {
  147164. /** @hidden */
  147165. export var gpuRenderParticlesVertexShader: {
  147166. name: string;
  147167. shader: string;
  147168. };
  147169. }
  147170. declare module BABYLON {
  147171. /**
  147172. * This represents a GPU particle system in Babylon
  147173. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147174. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147175. */
  147176. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147177. /**
  147178. * The layer mask we are rendering the particles through.
  147179. */
  147180. layerMask: number;
  147181. private _capacity;
  147182. private _activeCount;
  147183. private _currentActiveCount;
  147184. private _accumulatedCount;
  147185. private _renderEffect;
  147186. private _updateEffect;
  147187. private _buffer0;
  147188. private _buffer1;
  147189. private _spriteBuffer;
  147190. private _updateVAO;
  147191. private _renderVAO;
  147192. private _targetIndex;
  147193. private _sourceBuffer;
  147194. private _targetBuffer;
  147195. private _currentRenderId;
  147196. private _started;
  147197. private _stopped;
  147198. private _timeDelta;
  147199. private _randomTexture;
  147200. private _randomTexture2;
  147201. private _attributesStrideSize;
  147202. private _updateEffectOptions;
  147203. private _randomTextureSize;
  147204. private _actualFrame;
  147205. private _customEffect;
  147206. private readonly _rawTextureWidth;
  147207. /**
  147208. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147209. */
  147210. static get IsSupported(): boolean;
  147211. /**
  147212. * An event triggered when the system is disposed.
  147213. */
  147214. onDisposeObservable: Observable<IParticleSystem>;
  147215. /**
  147216. * Gets the maximum number of particles active at the same time.
  147217. * @returns The max number of active particles.
  147218. */
  147219. getCapacity(): number;
  147220. /**
  147221. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147222. * to override the particles.
  147223. */
  147224. forceDepthWrite: boolean;
  147225. /**
  147226. * Gets or set the number of active particles
  147227. */
  147228. get activeParticleCount(): number;
  147229. set activeParticleCount(value: number);
  147230. private _preWarmDone;
  147231. /**
  147232. * Specifies if the particles are updated in emitter local space or world space.
  147233. */
  147234. isLocal: boolean;
  147235. /** Gets or sets a matrix to use to compute projection */
  147236. defaultProjectionMatrix: Matrix;
  147237. /**
  147238. * Is this system ready to be used/rendered
  147239. * @return true if the system is ready
  147240. */
  147241. isReady(): boolean;
  147242. /**
  147243. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147244. * @returns True if it has been started, otherwise false.
  147245. */
  147246. isStarted(): boolean;
  147247. /**
  147248. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147249. * @returns True if it has been stopped, otherwise false.
  147250. */
  147251. isStopped(): boolean;
  147252. /**
  147253. * Gets a boolean indicating that the system is stopping
  147254. * @returns true if the system is currently stopping
  147255. */
  147256. isStopping(): boolean;
  147257. /**
  147258. * Gets the number of particles active at the same time.
  147259. * @returns The number of active particles.
  147260. */
  147261. getActiveCount(): number;
  147262. /**
  147263. * Starts the particle system and begins to emit
  147264. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147265. */
  147266. start(delay?: number): void;
  147267. /**
  147268. * Stops the particle system.
  147269. */
  147270. stop(): void;
  147271. /**
  147272. * Remove all active particles
  147273. */
  147274. reset(): void;
  147275. /**
  147276. * Returns the string "GPUParticleSystem"
  147277. * @returns a string containing the class name
  147278. */
  147279. getClassName(): string;
  147280. /**
  147281. * Gets the custom effect used to render the particles
  147282. * @param blendMode Blend mode for which the effect should be retrieved
  147283. * @returns The effect
  147284. */
  147285. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147286. /**
  147287. * Sets the custom effect used to render the particles
  147288. * @param effect The effect to set
  147289. * @param blendMode Blend mode for which the effect should be set
  147290. */
  147291. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147292. /** @hidden */
  147293. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147294. /**
  147295. * Observable that will be called just before the particles are drawn
  147296. */
  147297. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147298. /**
  147299. * Gets the name of the particle vertex shader
  147300. */
  147301. get vertexShaderName(): string;
  147302. private _colorGradientsTexture;
  147303. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147304. /**
  147305. * Adds a new color gradient
  147306. * @param gradient defines the gradient to use (between 0 and 1)
  147307. * @param color1 defines the color to affect to the specified gradient
  147308. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147309. * @returns the current particle system
  147310. */
  147311. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147312. private _refreshColorGradient;
  147313. /** Force the system to rebuild all gradients that need to be resync */
  147314. forceRefreshGradients(): void;
  147315. /**
  147316. * Remove a specific color gradient
  147317. * @param gradient defines the gradient to remove
  147318. * @returns the current particle system
  147319. */
  147320. removeColorGradient(gradient: number): GPUParticleSystem;
  147321. private _angularSpeedGradientsTexture;
  147322. private _sizeGradientsTexture;
  147323. private _velocityGradientsTexture;
  147324. private _limitVelocityGradientsTexture;
  147325. private _dragGradientsTexture;
  147326. private _addFactorGradient;
  147327. /**
  147328. * Adds a new size gradient
  147329. * @param gradient defines the gradient to use (between 0 and 1)
  147330. * @param factor defines the size factor to affect to the specified gradient
  147331. * @returns the current particle system
  147332. */
  147333. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147334. /**
  147335. * Remove a specific size gradient
  147336. * @param gradient defines the gradient to remove
  147337. * @returns the current particle system
  147338. */
  147339. removeSizeGradient(gradient: number): GPUParticleSystem;
  147340. private _refreshFactorGradient;
  147341. /**
  147342. * Adds a new angular speed gradient
  147343. * @param gradient defines the gradient to use (between 0 and 1)
  147344. * @param factor defines the angular speed to affect to the specified gradient
  147345. * @returns the current particle system
  147346. */
  147347. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147348. /**
  147349. * Remove a specific angular speed gradient
  147350. * @param gradient defines the gradient to remove
  147351. * @returns the current particle system
  147352. */
  147353. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147354. /**
  147355. * Adds a new velocity gradient
  147356. * @param gradient defines the gradient to use (between 0 and 1)
  147357. * @param factor defines the velocity to affect to the specified gradient
  147358. * @returns the current particle system
  147359. */
  147360. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147361. /**
  147362. * Remove a specific velocity gradient
  147363. * @param gradient defines the gradient to remove
  147364. * @returns the current particle system
  147365. */
  147366. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147367. /**
  147368. * Adds a new limit velocity gradient
  147369. * @param gradient defines the gradient to use (between 0 and 1)
  147370. * @param factor defines the limit velocity value to affect to the specified gradient
  147371. * @returns the current particle system
  147372. */
  147373. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147374. /**
  147375. * Remove a specific limit velocity gradient
  147376. * @param gradient defines the gradient to remove
  147377. * @returns the current particle system
  147378. */
  147379. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147380. /**
  147381. * Adds a new drag gradient
  147382. * @param gradient defines the gradient to use (between 0 and 1)
  147383. * @param factor defines the drag value to affect to the specified gradient
  147384. * @returns the current particle system
  147385. */
  147386. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147387. /**
  147388. * Remove a specific drag gradient
  147389. * @param gradient defines the gradient to remove
  147390. * @returns the current particle system
  147391. */
  147392. removeDragGradient(gradient: number): GPUParticleSystem;
  147393. /**
  147394. * Not supported by GPUParticleSystem
  147395. * @param gradient defines the gradient to use (between 0 and 1)
  147396. * @param factor defines the emit rate value to affect to the specified gradient
  147397. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147398. * @returns the current particle system
  147399. */
  147400. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147401. /**
  147402. * Not supported by GPUParticleSystem
  147403. * @param gradient defines the gradient to remove
  147404. * @returns the current particle system
  147405. */
  147406. removeEmitRateGradient(gradient: number): IParticleSystem;
  147407. /**
  147408. * Not supported by GPUParticleSystem
  147409. * @param gradient defines the gradient to use (between 0 and 1)
  147410. * @param factor defines the start size value to affect to the specified gradient
  147411. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147412. * @returns the current particle system
  147413. */
  147414. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147415. /**
  147416. * Not supported by GPUParticleSystem
  147417. * @param gradient defines the gradient to remove
  147418. * @returns the current particle system
  147419. */
  147420. removeStartSizeGradient(gradient: number): IParticleSystem;
  147421. /**
  147422. * Not supported by GPUParticleSystem
  147423. * @param gradient defines the gradient to use (between 0 and 1)
  147424. * @param min defines the color remap minimal range
  147425. * @param max defines the color remap maximal range
  147426. * @returns the current particle system
  147427. */
  147428. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147429. /**
  147430. * Not supported by GPUParticleSystem
  147431. * @param gradient defines the gradient to remove
  147432. * @returns the current particle system
  147433. */
  147434. removeColorRemapGradient(): IParticleSystem;
  147435. /**
  147436. * Not supported by GPUParticleSystem
  147437. * @param gradient defines the gradient to use (between 0 and 1)
  147438. * @param min defines the alpha remap minimal range
  147439. * @param max defines the alpha remap maximal range
  147440. * @returns the current particle system
  147441. */
  147442. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147443. /**
  147444. * Not supported by GPUParticleSystem
  147445. * @param gradient defines the gradient to remove
  147446. * @returns the current particle system
  147447. */
  147448. removeAlphaRemapGradient(): IParticleSystem;
  147449. /**
  147450. * Not supported by GPUParticleSystem
  147451. * @param gradient defines the gradient to use (between 0 and 1)
  147452. * @param color defines the color to affect to the specified gradient
  147453. * @returns the current particle system
  147454. */
  147455. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147456. /**
  147457. * Not supported by GPUParticleSystem
  147458. * @param gradient defines the gradient to remove
  147459. * @returns the current particle system
  147460. */
  147461. removeRampGradient(): IParticleSystem;
  147462. /**
  147463. * Not supported by GPUParticleSystem
  147464. * @returns the list of ramp gradients
  147465. */
  147466. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147467. /**
  147468. * Not supported by GPUParticleSystem
  147469. * Gets or sets a boolean indicating that ramp gradients must be used
  147470. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147471. */
  147472. get useRampGradients(): boolean;
  147473. set useRampGradients(value: boolean);
  147474. /**
  147475. * Not supported by GPUParticleSystem
  147476. * @param gradient defines the gradient to use (between 0 and 1)
  147477. * @param factor defines the life time factor to affect to the specified gradient
  147478. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147479. * @returns the current particle system
  147480. */
  147481. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147482. /**
  147483. * Not supported by GPUParticleSystem
  147484. * @param gradient defines the gradient to remove
  147485. * @returns the current particle system
  147486. */
  147487. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147488. /**
  147489. * Instantiates a GPU particle system.
  147490. * 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.
  147491. * @param name The name of the particle system
  147492. * @param options The options used to create the system
  147493. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147494. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147495. * @param customEffect a custom effect used to change the way particles are rendered by default
  147496. */
  147497. constructor(name: string, options: Partial<{
  147498. capacity: number;
  147499. randomTextureSize: number;
  147500. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147501. protected _reset(): void;
  147502. private _createUpdateVAO;
  147503. private _createRenderVAO;
  147504. private _initialize;
  147505. /** @hidden */
  147506. _recreateUpdateEffect(): void;
  147507. private _getEffect;
  147508. /**
  147509. * Fill the defines array according to the current settings of the particle system
  147510. * @param defines Array to be updated
  147511. * @param blendMode blend mode to take into account when updating the array
  147512. */
  147513. fillDefines(defines: Array<string>, blendMode?: number): void;
  147514. /**
  147515. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147516. * @param uniforms Uniforms array to fill
  147517. * @param attributes Attributes array to fill
  147518. * @param samplers Samplers array to fill
  147519. */
  147520. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147521. /** @hidden */
  147522. _recreateRenderEffect(): Effect;
  147523. /**
  147524. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147525. * @param preWarm defines if we are in the pre-warmimg phase
  147526. */
  147527. animate(preWarm?: boolean): void;
  147528. private _createFactorGradientTexture;
  147529. private _createSizeGradientTexture;
  147530. private _createAngularSpeedGradientTexture;
  147531. private _createVelocityGradientTexture;
  147532. private _createLimitVelocityGradientTexture;
  147533. private _createDragGradientTexture;
  147534. private _createColorGradientTexture;
  147535. /**
  147536. * Renders the particle system in its current state
  147537. * @param preWarm defines if the system should only update the particles but not render them
  147538. * @returns the current number of particles
  147539. */
  147540. render(preWarm?: boolean): number;
  147541. /**
  147542. * Rebuilds the particle system
  147543. */
  147544. rebuild(): void;
  147545. private _releaseBuffers;
  147546. private _releaseVAOs;
  147547. /**
  147548. * Disposes the particle system and free the associated resources
  147549. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147550. */
  147551. dispose(disposeTexture?: boolean): void;
  147552. /**
  147553. * Clones the particle system.
  147554. * @param name The name of the cloned object
  147555. * @param newEmitter The new emitter to use
  147556. * @returns the cloned particle system
  147557. */
  147558. clone(name: string, newEmitter: any): GPUParticleSystem;
  147559. /**
  147560. * Serializes the particle system to a JSON object
  147561. * @param serializeTexture defines if the texture must be serialized as well
  147562. * @returns the JSON object
  147563. */
  147564. serialize(serializeTexture?: boolean): any;
  147565. /**
  147566. * Parses a JSON object to create a GPU particle system.
  147567. * @param parsedParticleSystem The JSON object to parse
  147568. * @param sceneOrEngine The scene or the engine to create the particle system in
  147569. * @param rootUrl The root url to use to load external dependencies like texture
  147570. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147571. * @returns the parsed GPU particle system
  147572. */
  147573. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147574. }
  147575. }
  147576. declare module BABYLON {
  147577. /**
  147578. * Represents a set of particle systems working together to create a specific effect
  147579. */
  147580. export class ParticleSystemSet implements IDisposable {
  147581. /**
  147582. * Gets or sets base Assets URL
  147583. */
  147584. static BaseAssetsUrl: string;
  147585. private _emitterCreationOptions;
  147586. private _emitterNode;
  147587. /**
  147588. * Gets the particle system list
  147589. */
  147590. systems: IParticleSystem[];
  147591. /**
  147592. * Gets the emitter node used with this set
  147593. */
  147594. get emitterNode(): Nullable<TransformNode>;
  147595. /**
  147596. * Creates a new emitter mesh as a sphere
  147597. * @param options defines the options used to create the sphere
  147598. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147599. * @param scene defines the hosting scene
  147600. */
  147601. setEmitterAsSphere(options: {
  147602. diameter: number;
  147603. segments: number;
  147604. color: Color3;
  147605. }, renderingGroupId: number, scene: Scene): void;
  147606. /**
  147607. * Starts all particle systems of the set
  147608. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147609. */
  147610. start(emitter?: AbstractMesh): void;
  147611. /**
  147612. * Release all associated resources
  147613. */
  147614. dispose(): void;
  147615. /**
  147616. * Serialize the set into a JSON compatible object
  147617. * @param serializeTexture defines if the texture must be serialized as well
  147618. * @returns a JSON compatible representation of the set
  147619. */
  147620. serialize(serializeTexture?: boolean): any;
  147621. /**
  147622. * Parse a new ParticleSystemSet from a serialized source
  147623. * @param data defines a JSON compatible representation of the set
  147624. * @param scene defines the hosting scene
  147625. * @param gpu defines if we want GPU particles or CPU particles
  147626. * @returns a new ParticleSystemSet
  147627. */
  147628. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147629. }
  147630. }
  147631. declare module BABYLON {
  147632. /**
  147633. * This class is made for on one-liner static method to help creating particle system set.
  147634. */
  147635. export class ParticleHelper {
  147636. /**
  147637. * Gets or sets base Assets URL
  147638. */
  147639. static BaseAssetsUrl: string;
  147640. /** Define the Url to load snippets */
  147641. static SnippetUrl: string;
  147642. /**
  147643. * Create a default particle system that you can tweak
  147644. * @param emitter defines the emitter to use
  147645. * @param capacity defines the system capacity (default is 500 particles)
  147646. * @param scene defines the hosting scene
  147647. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147648. * @returns the new Particle system
  147649. */
  147650. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147651. /**
  147652. * This is the main static method (one-liner) of this helper to create different particle systems
  147653. * @param type This string represents the type to the particle system to create
  147654. * @param scene The scene where the particle system should live
  147655. * @param gpu If the system will use gpu
  147656. * @returns the ParticleSystemSet created
  147657. */
  147658. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147659. /**
  147660. * Static function used to export a particle system to a ParticleSystemSet variable.
  147661. * Please note that the emitter shape is not exported
  147662. * @param systems defines the particle systems to export
  147663. * @returns the created particle system set
  147664. */
  147665. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147666. /**
  147667. * Creates a particle system from a snippet saved in a remote file
  147668. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147669. * @param url defines the url to load from
  147670. * @param scene defines the hosting scene
  147671. * @param gpu If the system will use gpu
  147672. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147673. * @returns a promise that will resolve to the new particle system
  147674. */
  147675. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147676. /**
  147677. * Creates a particle system from a snippet saved by the particle system editor
  147678. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147679. * @param scene defines the hosting scene
  147680. * @param gpu If the system will use gpu
  147681. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147682. * @returns a promise that will resolve to the new particle system
  147683. */
  147684. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147685. }
  147686. }
  147687. declare module BABYLON {
  147688. interface Engine {
  147689. /**
  147690. * Create an effect to use with particle systems.
  147691. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147692. * the particle system for which you want to create a custom effect in the last parameter
  147693. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147694. * @param uniformsNames defines a list of attribute names
  147695. * @param samplers defines an array of string used to represent textures
  147696. * @param defines defines the string containing the defines to use to compile the shaders
  147697. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147698. * @param onCompiled defines a function to call when the effect creation is successful
  147699. * @param onError defines a function to call when the effect creation has failed
  147700. * @param particleSystem the particle system you want to create the effect for
  147701. * @returns the new Effect
  147702. */
  147703. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147704. }
  147705. interface Mesh {
  147706. /**
  147707. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147708. * @returns an array of IParticleSystem
  147709. */
  147710. getEmittedParticleSystems(): IParticleSystem[];
  147711. /**
  147712. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147713. * @returns an array of IParticleSystem
  147714. */
  147715. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147716. }
  147717. }
  147718. declare module BABYLON {
  147719. /** Defines the 4 color options */
  147720. export enum PointColor {
  147721. /** color value */
  147722. Color = 2,
  147723. /** uv value */
  147724. UV = 1,
  147725. /** random value */
  147726. Random = 0,
  147727. /** stated value */
  147728. Stated = 3
  147729. }
  147730. /**
  147731. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147732. * 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.
  147733. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147734. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147735. *
  147736. * Full documentation here : TO BE ENTERED
  147737. */
  147738. export class PointsCloudSystem implements IDisposable {
  147739. /**
  147740. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147741. * Example : var p = SPS.particles[i];
  147742. */
  147743. particles: CloudPoint[];
  147744. /**
  147745. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147746. */
  147747. nbParticles: number;
  147748. /**
  147749. * This a counter for your own usage. It's not set by any SPS functions.
  147750. */
  147751. counter: number;
  147752. /**
  147753. * The PCS name. This name is also given to the underlying mesh.
  147754. */
  147755. name: string;
  147756. /**
  147757. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147758. */
  147759. mesh: Mesh;
  147760. /**
  147761. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147762. * Please read :
  147763. */
  147764. vars: any;
  147765. /**
  147766. * @hidden
  147767. */
  147768. _size: number;
  147769. private _scene;
  147770. private _promises;
  147771. private _positions;
  147772. private _indices;
  147773. private _normals;
  147774. private _colors;
  147775. private _uvs;
  147776. private _indices32;
  147777. private _positions32;
  147778. private _colors32;
  147779. private _uvs32;
  147780. private _updatable;
  147781. private _isVisibilityBoxLocked;
  147782. private _alwaysVisible;
  147783. private _groups;
  147784. private _groupCounter;
  147785. private _computeParticleColor;
  147786. private _computeParticleTexture;
  147787. private _computeParticleRotation;
  147788. private _computeBoundingBox;
  147789. private _isReady;
  147790. /**
  147791. * Creates a PCS (Points Cloud System) object
  147792. * @param name (String) is the PCS name, this will be the underlying mesh name
  147793. * @param pointSize (number) is the size for each point
  147794. * @param scene (Scene) is the scene in which the PCS is added
  147795. * @param options defines the options of the PCS e.g.
  147796. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147797. */
  147798. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147799. updatable?: boolean;
  147800. });
  147801. /**
  147802. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147803. * If no points were added to the PCS, the returned mesh is just a single point.
  147804. * @returns a promise for the created mesh
  147805. */
  147806. buildMeshAsync(): Promise<Mesh>;
  147807. /**
  147808. * @hidden
  147809. */
  147810. private _buildMesh;
  147811. private _addParticle;
  147812. private _randomUnitVector;
  147813. private _getColorIndicesForCoord;
  147814. private _setPointsColorOrUV;
  147815. private _colorFromTexture;
  147816. private _calculateDensity;
  147817. /**
  147818. * Adds points to the PCS in random positions within a unit sphere
  147819. * @param nb (positive integer) the number of particles to be created from this model
  147820. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147821. * @returns the number of groups in the system
  147822. */
  147823. addPoints(nb: number, pointFunction?: any): number;
  147824. /**
  147825. * Adds points to the PCS from the surface of the model shape
  147826. * @param mesh is any Mesh object that will be used as a surface model for the points
  147827. * @param nb (positive integer) the number of particles to be created from this model
  147828. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147829. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147830. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147831. * @returns the number of groups in the system
  147832. */
  147833. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147834. /**
  147835. * Adds points to the PCS inside the model shape
  147836. * @param mesh is any Mesh object that will be used as a surface model for the points
  147837. * @param nb (positive integer) the number of particles to be created from this model
  147838. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147839. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147840. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147841. * @returns the number of groups in the system
  147842. */
  147843. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147844. /**
  147845. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147846. * This method calls `updateParticle()` for each particle of the SPS.
  147847. * For an animated SPS, it is usually called within the render loop.
  147848. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147849. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147850. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147851. * @returns the PCS.
  147852. */
  147853. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147854. /**
  147855. * Disposes the PCS.
  147856. */
  147857. dispose(): void;
  147858. /**
  147859. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147860. * doc :
  147861. * @returns the PCS.
  147862. */
  147863. refreshVisibleSize(): PointsCloudSystem;
  147864. /**
  147865. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147866. * @param size the size (float) of the visibility box
  147867. * note : this doesn't lock the PCS mesh bounding box.
  147868. * doc :
  147869. */
  147870. setVisibilityBox(size: number): void;
  147871. /**
  147872. * Gets whether the PCS is always visible or not
  147873. * doc :
  147874. */
  147875. get isAlwaysVisible(): boolean;
  147876. /**
  147877. * Sets the PCS as always visible or not
  147878. * doc :
  147879. */
  147880. set isAlwaysVisible(val: boolean);
  147881. /**
  147882. * Tells to `setParticles()` to compute the particle rotations or not
  147883. * Default value : false. The PCS is faster when it's set to false
  147884. * Note : particle rotations are only applied to parent particles
  147885. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147886. */
  147887. set computeParticleRotation(val: boolean);
  147888. /**
  147889. * Tells to `setParticles()` to compute the particle colors or not.
  147890. * Default value : true. The PCS is faster when it's set to false.
  147891. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147892. */
  147893. set computeParticleColor(val: boolean);
  147894. set computeParticleTexture(val: boolean);
  147895. /**
  147896. * Gets if `setParticles()` computes the particle colors or not.
  147897. * Default value : false. The PCS is faster when it's set to false.
  147898. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147899. */
  147900. get computeParticleColor(): boolean;
  147901. /**
  147902. * Gets if `setParticles()` computes the particle textures or not.
  147903. * Default value : false. The PCS is faster when it's set to false.
  147904. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147905. */
  147906. get computeParticleTexture(): boolean;
  147907. /**
  147908. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147909. */
  147910. set computeBoundingBox(val: boolean);
  147911. /**
  147912. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147913. */
  147914. get computeBoundingBox(): boolean;
  147915. /**
  147916. * This function does nothing. It may be overwritten to set all the particle first values.
  147917. * The PCS doesn't call this function, you may have to call it by your own.
  147918. * doc :
  147919. */
  147920. initParticles(): void;
  147921. /**
  147922. * This function does nothing. It may be overwritten to recycle a particle
  147923. * The PCS doesn't call this function, you can to call it
  147924. * doc :
  147925. * @param particle The particle to recycle
  147926. * @returns the recycled particle
  147927. */
  147928. recycleParticle(particle: CloudPoint): CloudPoint;
  147929. /**
  147930. * Updates a particle : this function should be overwritten by the user.
  147931. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147932. * doc :
  147933. * @example : just set a particle position or velocity and recycle conditions
  147934. * @param particle The particle to update
  147935. * @returns the updated particle
  147936. */
  147937. updateParticle(particle: CloudPoint): CloudPoint;
  147938. /**
  147939. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147940. * This does nothing and may be overwritten by the user.
  147941. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147942. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147943. * @param update the boolean update value actually passed to setParticles()
  147944. */
  147945. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147946. /**
  147947. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147948. * This will be passed three parameters.
  147949. * This does nothing and may be overwritten by the user.
  147950. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147951. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147952. * @param update the boolean update value actually passed to setParticles()
  147953. */
  147954. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147955. }
  147956. }
  147957. declare module BABYLON {
  147958. /**
  147959. * Represents one particle of a points cloud system.
  147960. */
  147961. export class CloudPoint {
  147962. /**
  147963. * particle global index
  147964. */
  147965. idx: number;
  147966. /**
  147967. * The color of the particle
  147968. */
  147969. color: Nullable<Color4>;
  147970. /**
  147971. * The world space position of the particle.
  147972. */
  147973. position: Vector3;
  147974. /**
  147975. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147976. */
  147977. rotation: Vector3;
  147978. /**
  147979. * The world space rotation quaternion of the particle.
  147980. */
  147981. rotationQuaternion: Nullable<Quaternion>;
  147982. /**
  147983. * The uv of the particle.
  147984. */
  147985. uv: Nullable<Vector2>;
  147986. /**
  147987. * The current speed of the particle.
  147988. */
  147989. velocity: Vector3;
  147990. /**
  147991. * The pivot point in the particle local space.
  147992. */
  147993. pivot: Vector3;
  147994. /**
  147995. * Must the particle be translated from its pivot point in its local space ?
  147996. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147997. * Default : false
  147998. */
  147999. translateFromPivot: boolean;
  148000. /**
  148001. * Index of this particle in the global "positions" array (Internal use)
  148002. * @hidden
  148003. */
  148004. _pos: number;
  148005. /**
  148006. * @hidden Index of this particle in the global "indices" array (Internal use)
  148007. */
  148008. _ind: number;
  148009. /**
  148010. * Group this particle belongs to
  148011. */
  148012. _group: PointsGroup;
  148013. /**
  148014. * Group id of this particle
  148015. */
  148016. groupId: number;
  148017. /**
  148018. * Index of the particle in its group id (Internal use)
  148019. */
  148020. idxInGroup: number;
  148021. /**
  148022. * @hidden Particle BoundingInfo object (Internal use)
  148023. */
  148024. _boundingInfo: BoundingInfo;
  148025. /**
  148026. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  148027. */
  148028. _pcs: PointsCloudSystem;
  148029. /**
  148030. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  148031. */
  148032. _stillInvisible: boolean;
  148033. /**
  148034. * @hidden Last computed particle rotation matrix
  148035. */
  148036. _rotationMatrix: number[];
  148037. /**
  148038. * Parent particle Id, if any.
  148039. * Default null.
  148040. */
  148041. parentId: Nullable<number>;
  148042. /**
  148043. * @hidden Internal global position in the PCS.
  148044. */
  148045. _globalPosition: Vector3;
  148046. /**
  148047. * Creates a Point Cloud object.
  148048. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  148049. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  148050. * @param group (PointsGroup) is the group the particle belongs to
  148051. * @param groupId (integer) is the group identifier in the PCS.
  148052. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  148053. * @param pcs defines the PCS it is associated to
  148054. */
  148055. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  148056. /**
  148057. * get point size
  148058. */
  148059. get size(): Vector3;
  148060. /**
  148061. * Set point size
  148062. */
  148063. set size(scale: Vector3);
  148064. /**
  148065. * Legacy support, changed quaternion to rotationQuaternion
  148066. */
  148067. get quaternion(): Nullable<Quaternion>;
  148068. /**
  148069. * Legacy support, changed quaternion to rotationQuaternion
  148070. */
  148071. set quaternion(q: Nullable<Quaternion>);
  148072. /**
  148073. * Returns a boolean. True if the particle intersects a mesh, else false
  148074. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  148075. * @param target is the object (point or mesh) what the intersection is computed against
  148076. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  148077. * @returns true if it intersects
  148078. */
  148079. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  148080. /**
  148081. * get the rotation matrix of the particle
  148082. * @hidden
  148083. */
  148084. getRotationMatrix(m: Matrix): void;
  148085. }
  148086. /**
  148087. * Represents a group of points in a points cloud system
  148088. * * PCS internal tool, don't use it manually.
  148089. */
  148090. export class PointsGroup {
  148091. /**
  148092. * The group id
  148093. * @hidden
  148094. */
  148095. groupID: number;
  148096. /**
  148097. * image data for group (internal use)
  148098. * @hidden
  148099. */
  148100. _groupImageData: Nullable<ArrayBufferView>;
  148101. /**
  148102. * Image Width (internal use)
  148103. * @hidden
  148104. */
  148105. _groupImgWidth: number;
  148106. /**
  148107. * Image Height (internal use)
  148108. * @hidden
  148109. */
  148110. _groupImgHeight: number;
  148111. /**
  148112. * Custom position function (internal use)
  148113. * @hidden
  148114. */
  148115. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  148116. /**
  148117. * density per facet for surface points
  148118. * @hidden
  148119. */
  148120. _groupDensity: number[];
  148121. /**
  148122. * Only when points are colored by texture carries pointer to texture list array
  148123. * @hidden
  148124. */
  148125. _textureNb: number;
  148126. /**
  148127. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  148128. * PCS internal tool, don't use it manually.
  148129. * @hidden
  148130. */
  148131. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  148132. }
  148133. }
  148134. declare module BABYLON {
  148135. interface Scene {
  148136. /** @hidden (Backing field) */
  148137. _physicsEngine: Nullable<IPhysicsEngine>;
  148138. /** @hidden */
  148139. _physicsTimeAccumulator: number;
  148140. /**
  148141. * Gets the current physics engine
  148142. * @returns a IPhysicsEngine or null if none attached
  148143. */
  148144. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  148145. /**
  148146. * Enables physics to the current scene
  148147. * @param gravity defines the scene's gravity for the physics engine
  148148. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  148149. * @return a boolean indicating if the physics engine was initialized
  148150. */
  148151. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  148152. /**
  148153. * Disables and disposes the physics engine associated with the scene
  148154. */
  148155. disablePhysicsEngine(): void;
  148156. /**
  148157. * Gets a boolean indicating if there is an active physics engine
  148158. * @returns a boolean indicating if there is an active physics engine
  148159. */
  148160. isPhysicsEnabled(): boolean;
  148161. /**
  148162. * Deletes a physics compound impostor
  148163. * @param compound defines the compound to delete
  148164. */
  148165. deleteCompoundImpostor(compound: any): void;
  148166. /**
  148167. * An event triggered when physic simulation is about to be run
  148168. */
  148169. onBeforePhysicsObservable: Observable<Scene>;
  148170. /**
  148171. * An event triggered when physic simulation has been done
  148172. */
  148173. onAfterPhysicsObservable: Observable<Scene>;
  148174. }
  148175. interface AbstractMesh {
  148176. /** @hidden */
  148177. _physicsImpostor: Nullable<PhysicsImpostor>;
  148178. /**
  148179. * Gets or sets impostor used for physic simulation
  148180. * @see https://doc.babylonjs.com/features/physics_engine
  148181. */
  148182. physicsImpostor: Nullable<PhysicsImpostor>;
  148183. /**
  148184. * Gets the current physics impostor
  148185. * @see https://doc.babylonjs.com/features/physics_engine
  148186. * @returns a physics impostor or null
  148187. */
  148188. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148189. /** Apply a physic impulse to the mesh
  148190. * @param force defines the force to apply
  148191. * @param contactPoint defines where to apply the force
  148192. * @returns the current mesh
  148193. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148194. */
  148195. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148196. /**
  148197. * Creates a physic joint between two meshes
  148198. * @param otherMesh defines the other mesh to use
  148199. * @param pivot1 defines the pivot to use on this mesh
  148200. * @param pivot2 defines the pivot to use on the other mesh
  148201. * @param options defines additional options (can be plugin dependent)
  148202. * @returns the current mesh
  148203. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148204. */
  148205. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148206. /** @hidden */
  148207. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148208. }
  148209. /**
  148210. * Defines the physics engine scene component responsible to manage a physics engine
  148211. */
  148212. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148213. /**
  148214. * The component name helpful to identify the component in the list of scene components.
  148215. */
  148216. readonly name: string;
  148217. /**
  148218. * The scene the component belongs to.
  148219. */
  148220. scene: Scene;
  148221. /**
  148222. * Creates a new instance of the component for the given scene
  148223. * @param scene Defines the scene to register the component in
  148224. */
  148225. constructor(scene: Scene);
  148226. /**
  148227. * Registers the component in a given scene
  148228. */
  148229. register(): void;
  148230. /**
  148231. * Rebuilds the elements related to this component in case of
  148232. * context lost for instance.
  148233. */
  148234. rebuild(): void;
  148235. /**
  148236. * Disposes the component and the associated ressources
  148237. */
  148238. dispose(): void;
  148239. }
  148240. }
  148241. declare module BABYLON {
  148242. /**
  148243. * A helper for physics simulations
  148244. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148245. */
  148246. export class PhysicsHelper {
  148247. private _scene;
  148248. private _physicsEngine;
  148249. /**
  148250. * Initializes the Physics helper
  148251. * @param scene Babylon.js scene
  148252. */
  148253. constructor(scene: Scene);
  148254. /**
  148255. * Applies a radial explosion impulse
  148256. * @param origin the origin of the explosion
  148257. * @param radiusOrEventOptions the radius or the options of radial explosion
  148258. * @param strength the explosion strength
  148259. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148260. * @returns A physics radial explosion event, or null
  148261. */
  148262. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148263. /**
  148264. * Applies a radial explosion force
  148265. * @param origin the origin of the explosion
  148266. * @param radiusOrEventOptions the radius or the options of radial explosion
  148267. * @param strength the explosion strength
  148268. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148269. * @returns A physics radial explosion event, or null
  148270. */
  148271. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148272. /**
  148273. * Creates a gravitational field
  148274. * @param origin the origin of the explosion
  148275. * @param radiusOrEventOptions the radius or the options of radial explosion
  148276. * @param strength the explosion strength
  148277. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148278. * @returns A physics gravitational field event, or null
  148279. */
  148280. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148281. /**
  148282. * Creates a physics updraft event
  148283. * @param origin the origin of the updraft
  148284. * @param radiusOrEventOptions the radius or the options of the updraft
  148285. * @param strength the strength of the updraft
  148286. * @param height the height of the updraft
  148287. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148288. * @returns A physics updraft event, or null
  148289. */
  148290. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148291. /**
  148292. * Creates a physics vortex event
  148293. * @param origin the of the vortex
  148294. * @param radiusOrEventOptions the radius or the options of the vortex
  148295. * @param strength the strength of the vortex
  148296. * @param height the height of the vortex
  148297. * @returns a Physics vortex event, or null
  148298. * A physics vortex event or null
  148299. */
  148300. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148301. }
  148302. /**
  148303. * Represents a physics radial explosion event
  148304. */
  148305. class PhysicsRadialExplosionEvent {
  148306. private _scene;
  148307. private _options;
  148308. private _sphere;
  148309. private _dataFetched;
  148310. /**
  148311. * Initializes a radial explosioin event
  148312. * @param _scene BabylonJS scene
  148313. * @param _options The options for the vortex event
  148314. */
  148315. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148316. /**
  148317. * Returns the data related to the radial explosion event (sphere).
  148318. * @returns The radial explosion event data
  148319. */
  148320. getData(): PhysicsRadialExplosionEventData;
  148321. /**
  148322. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148323. * @param impostor A physics imposter
  148324. * @param origin the origin of the explosion
  148325. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148326. */
  148327. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148328. /**
  148329. * Triggers affecterd impostors callbacks
  148330. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148331. */
  148332. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148333. /**
  148334. * Disposes the sphere.
  148335. * @param force Specifies if the sphere should be disposed by force
  148336. */
  148337. dispose(force?: boolean): void;
  148338. /*** Helpers ***/
  148339. private _prepareSphere;
  148340. private _intersectsWithSphere;
  148341. }
  148342. /**
  148343. * Represents a gravitational field event
  148344. */
  148345. class PhysicsGravitationalFieldEvent {
  148346. private _physicsHelper;
  148347. private _scene;
  148348. private _origin;
  148349. private _options;
  148350. private _tickCallback;
  148351. private _sphere;
  148352. private _dataFetched;
  148353. /**
  148354. * Initializes the physics gravitational field event
  148355. * @param _physicsHelper A physics helper
  148356. * @param _scene BabylonJS scene
  148357. * @param _origin The origin position of the gravitational field event
  148358. * @param _options The options for the vortex event
  148359. */
  148360. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148361. /**
  148362. * Returns the data related to the gravitational field event (sphere).
  148363. * @returns A gravitational field event
  148364. */
  148365. getData(): PhysicsGravitationalFieldEventData;
  148366. /**
  148367. * Enables the gravitational field.
  148368. */
  148369. enable(): void;
  148370. /**
  148371. * Disables the gravitational field.
  148372. */
  148373. disable(): void;
  148374. /**
  148375. * Disposes the sphere.
  148376. * @param force The force to dispose from the gravitational field event
  148377. */
  148378. dispose(force?: boolean): void;
  148379. private _tick;
  148380. }
  148381. /**
  148382. * Represents a physics updraft event
  148383. */
  148384. class PhysicsUpdraftEvent {
  148385. private _scene;
  148386. private _origin;
  148387. private _options;
  148388. private _physicsEngine;
  148389. private _originTop;
  148390. private _originDirection;
  148391. private _tickCallback;
  148392. private _cylinder;
  148393. private _cylinderPosition;
  148394. private _dataFetched;
  148395. /**
  148396. * Initializes the physics updraft event
  148397. * @param _scene BabylonJS scene
  148398. * @param _origin The origin position of the updraft
  148399. * @param _options The options for the updraft event
  148400. */
  148401. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148402. /**
  148403. * Returns the data related to the updraft event (cylinder).
  148404. * @returns A physics updraft event
  148405. */
  148406. getData(): PhysicsUpdraftEventData;
  148407. /**
  148408. * Enables the updraft.
  148409. */
  148410. enable(): void;
  148411. /**
  148412. * Disables the updraft.
  148413. */
  148414. disable(): void;
  148415. /**
  148416. * Disposes the cylinder.
  148417. * @param force Specifies if the updraft should be disposed by force
  148418. */
  148419. dispose(force?: boolean): void;
  148420. private getImpostorHitData;
  148421. private _tick;
  148422. /*** Helpers ***/
  148423. private _prepareCylinder;
  148424. private _intersectsWithCylinder;
  148425. }
  148426. /**
  148427. * Represents a physics vortex event
  148428. */
  148429. class PhysicsVortexEvent {
  148430. private _scene;
  148431. private _origin;
  148432. private _options;
  148433. private _physicsEngine;
  148434. private _originTop;
  148435. private _tickCallback;
  148436. private _cylinder;
  148437. private _cylinderPosition;
  148438. private _dataFetched;
  148439. /**
  148440. * Initializes the physics vortex event
  148441. * @param _scene The BabylonJS scene
  148442. * @param _origin The origin position of the vortex
  148443. * @param _options The options for the vortex event
  148444. */
  148445. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148446. /**
  148447. * Returns the data related to the vortex event (cylinder).
  148448. * @returns The physics vortex event data
  148449. */
  148450. getData(): PhysicsVortexEventData;
  148451. /**
  148452. * Enables the vortex.
  148453. */
  148454. enable(): void;
  148455. /**
  148456. * Disables the cortex.
  148457. */
  148458. disable(): void;
  148459. /**
  148460. * Disposes the sphere.
  148461. * @param force
  148462. */
  148463. dispose(force?: boolean): void;
  148464. private getImpostorHitData;
  148465. private _tick;
  148466. /*** Helpers ***/
  148467. private _prepareCylinder;
  148468. private _intersectsWithCylinder;
  148469. }
  148470. /**
  148471. * Options fot the radial explosion event
  148472. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148473. */
  148474. export class PhysicsRadialExplosionEventOptions {
  148475. /**
  148476. * The radius of the sphere for the radial explosion.
  148477. */
  148478. radius: number;
  148479. /**
  148480. * The strenth of the explosion.
  148481. */
  148482. strength: number;
  148483. /**
  148484. * The strenght of the force in correspondence to the distance of the affected object
  148485. */
  148486. falloff: PhysicsRadialImpulseFalloff;
  148487. /**
  148488. * Sphere options for the radial explosion.
  148489. */
  148490. sphere: {
  148491. segments: number;
  148492. diameter: number;
  148493. };
  148494. /**
  148495. * Sphere options for the radial explosion.
  148496. */
  148497. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148498. }
  148499. /**
  148500. * Options fot the updraft event
  148501. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148502. */
  148503. export class PhysicsUpdraftEventOptions {
  148504. /**
  148505. * The radius of the cylinder for the vortex
  148506. */
  148507. radius: number;
  148508. /**
  148509. * The strenth of the updraft.
  148510. */
  148511. strength: number;
  148512. /**
  148513. * The height of the cylinder for the updraft.
  148514. */
  148515. height: number;
  148516. /**
  148517. * The mode for the the updraft.
  148518. */
  148519. updraftMode: PhysicsUpdraftMode;
  148520. }
  148521. /**
  148522. * Options fot the vortex event
  148523. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148524. */
  148525. export class PhysicsVortexEventOptions {
  148526. /**
  148527. * The radius of the cylinder for the vortex
  148528. */
  148529. radius: number;
  148530. /**
  148531. * The strenth of the vortex.
  148532. */
  148533. strength: number;
  148534. /**
  148535. * The height of the cylinder for the vortex.
  148536. */
  148537. height: number;
  148538. /**
  148539. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148540. */
  148541. centripetalForceThreshold: number;
  148542. /**
  148543. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148544. */
  148545. centripetalForceMultiplier: number;
  148546. /**
  148547. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148548. */
  148549. centrifugalForceMultiplier: number;
  148550. /**
  148551. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148552. */
  148553. updraftForceMultiplier: number;
  148554. }
  148555. /**
  148556. * The strenght of the force in correspondence to the distance of the affected object
  148557. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148558. */
  148559. export enum PhysicsRadialImpulseFalloff {
  148560. /** Defines that impulse is constant in strength across it's whole radius */
  148561. Constant = 0,
  148562. /** Defines that impulse gets weaker if it's further from the origin */
  148563. Linear = 1
  148564. }
  148565. /**
  148566. * The strength of the force in correspondence to the distance of the affected object
  148567. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148568. */
  148569. export enum PhysicsUpdraftMode {
  148570. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148571. Center = 0,
  148572. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148573. Perpendicular = 1
  148574. }
  148575. /**
  148576. * Interface for a physics hit data
  148577. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148578. */
  148579. export interface PhysicsHitData {
  148580. /**
  148581. * The force applied at the contact point
  148582. */
  148583. force: Vector3;
  148584. /**
  148585. * The contact point
  148586. */
  148587. contactPoint: Vector3;
  148588. /**
  148589. * The distance from the origin to the contact point
  148590. */
  148591. distanceFromOrigin: number;
  148592. }
  148593. /**
  148594. * Interface for radial explosion event data
  148595. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148596. */
  148597. export interface PhysicsRadialExplosionEventData {
  148598. /**
  148599. * A sphere used for the radial explosion event
  148600. */
  148601. sphere: Mesh;
  148602. }
  148603. /**
  148604. * Interface for gravitational field event data
  148605. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148606. */
  148607. export interface PhysicsGravitationalFieldEventData {
  148608. /**
  148609. * A sphere mesh used for the gravitational field event
  148610. */
  148611. sphere: Mesh;
  148612. }
  148613. /**
  148614. * Interface for updraft event data
  148615. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148616. */
  148617. export interface PhysicsUpdraftEventData {
  148618. /**
  148619. * A cylinder used for the updraft event
  148620. */
  148621. cylinder: Mesh;
  148622. }
  148623. /**
  148624. * Interface for vortex event data
  148625. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148626. */
  148627. export interface PhysicsVortexEventData {
  148628. /**
  148629. * A cylinder used for the vortex event
  148630. */
  148631. cylinder: Mesh;
  148632. }
  148633. /**
  148634. * Interface for an affected physics impostor
  148635. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148636. */
  148637. export interface PhysicsAffectedImpostorWithData {
  148638. /**
  148639. * The impostor affected by the effect
  148640. */
  148641. impostor: PhysicsImpostor;
  148642. /**
  148643. * The data about the hit/horce from the explosion
  148644. */
  148645. hitData: PhysicsHitData;
  148646. }
  148647. }
  148648. declare module BABYLON {
  148649. /** @hidden */
  148650. export var blackAndWhitePixelShader: {
  148651. name: string;
  148652. shader: string;
  148653. };
  148654. }
  148655. declare module BABYLON {
  148656. /**
  148657. * Post process used to render in black and white
  148658. */
  148659. export class BlackAndWhitePostProcess extends PostProcess {
  148660. /**
  148661. * Linear about to convert he result to black and white (default: 1)
  148662. */
  148663. degree: number;
  148664. /**
  148665. * Gets a string identifying the name of the class
  148666. * @returns "BlackAndWhitePostProcess" string
  148667. */
  148668. getClassName(): string;
  148669. /**
  148670. * Creates a black and white post process
  148671. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148672. * @param name The name of the effect.
  148673. * @param options The required width/height ratio to downsize to before computing the render pass.
  148674. * @param camera The camera to apply the render pass to.
  148675. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148676. * @param engine The engine which the post process will be applied. (default: current engine)
  148677. * @param reusable If the post process can be reused on the same frame. (default: false)
  148678. */
  148679. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148680. /** @hidden */
  148681. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148682. }
  148683. }
  148684. declare module BABYLON {
  148685. /**
  148686. * This represents a set of one or more post processes in Babylon.
  148687. * A post process can be used to apply a shader to a texture after it is rendered.
  148688. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148689. */
  148690. export class PostProcessRenderEffect {
  148691. private _postProcesses;
  148692. private _getPostProcesses;
  148693. private _singleInstance;
  148694. private _cameras;
  148695. private _indicesForCamera;
  148696. /**
  148697. * Name of the effect
  148698. * @hidden
  148699. */
  148700. _name: string;
  148701. /**
  148702. * Instantiates a post process render effect.
  148703. * A post process can be used to apply a shader to a texture after it is rendered.
  148704. * @param engine The engine the effect is tied to
  148705. * @param name The name of the effect
  148706. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148707. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148708. */
  148709. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148710. /**
  148711. * Checks if all the post processes in the effect are supported.
  148712. */
  148713. get isSupported(): boolean;
  148714. /**
  148715. * Updates the current state of the effect
  148716. * @hidden
  148717. */
  148718. _update(): void;
  148719. /**
  148720. * Attaches the effect on cameras
  148721. * @param cameras The camera to attach to.
  148722. * @hidden
  148723. */
  148724. _attachCameras(cameras: Camera): void;
  148725. /**
  148726. * Attaches the effect on cameras
  148727. * @param cameras The camera to attach to.
  148728. * @hidden
  148729. */
  148730. _attachCameras(cameras: Camera[]): void;
  148731. /**
  148732. * Detaches the effect on cameras
  148733. * @param cameras The camera to detatch from.
  148734. * @hidden
  148735. */
  148736. _detachCameras(cameras: Camera): void;
  148737. /**
  148738. * Detatches the effect on cameras
  148739. * @param cameras The camera to detatch from.
  148740. * @hidden
  148741. */
  148742. _detachCameras(cameras: Camera[]): void;
  148743. /**
  148744. * Enables the effect on given cameras
  148745. * @param cameras The camera to enable.
  148746. * @hidden
  148747. */
  148748. _enable(cameras: Camera): void;
  148749. /**
  148750. * Enables the effect on given cameras
  148751. * @param cameras The camera to enable.
  148752. * @hidden
  148753. */
  148754. _enable(cameras: Nullable<Camera[]>): void;
  148755. /**
  148756. * Disables the effect on the given cameras
  148757. * @param cameras The camera to disable.
  148758. * @hidden
  148759. */
  148760. _disable(cameras: Camera): void;
  148761. /**
  148762. * Disables the effect on the given cameras
  148763. * @param cameras The camera to disable.
  148764. * @hidden
  148765. */
  148766. _disable(cameras: Nullable<Camera[]>): void;
  148767. /**
  148768. * Gets a list of the post processes contained in the effect.
  148769. * @param camera The camera to get the post processes on.
  148770. * @returns The list of the post processes in the effect.
  148771. */
  148772. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148773. }
  148774. }
  148775. declare module BABYLON {
  148776. /** @hidden */
  148777. export var extractHighlightsPixelShader: {
  148778. name: string;
  148779. shader: string;
  148780. };
  148781. }
  148782. declare module BABYLON {
  148783. /**
  148784. * 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.
  148785. */
  148786. export class ExtractHighlightsPostProcess extends PostProcess {
  148787. /**
  148788. * The luminance threshold, pixels below this value will be set to black.
  148789. */
  148790. threshold: number;
  148791. /** @hidden */
  148792. _exposure: number;
  148793. /**
  148794. * Post process which has the input texture to be used when performing highlight extraction
  148795. * @hidden
  148796. */
  148797. _inputPostProcess: Nullable<PostProcess>;
  148798. /**
  148799. * Gets a string identifying the name of the class
  148800. * @returns "ExtractHighlightsPostProcess" string
  148801. */
  148802. getClassName(): string;
  148803. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148804. }
  148805. }
  148806. declare module BABYLON {
  148807. /** @hidden */
  148808. export var bloomMergePixelShader: {
  148809. name: string;
  148810. shader: string;
  148811. };
  148812. }
  148813. declare module BABYLON {
  148814. /**
  148815. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148816. */
  148817. export class BloomMergePostProcess extends PostProcess {
  148818. /** Weight of the bloom to be added to the original input. */
  148819. weight: number;
  148820. /**
  148821. * Gets a string identifying the name of the class
  148822. * @returns "BloomMergePostProcess" string
  148823. */
  148824. getClassName(): string;
  148825. /**
  148826. * Creates a new instance of @see BloomMergePostProcess
  148827. * @param name The name of the effect.
  148828. * @param originalFromInput Post process which's input will be used for the merge.
  148829. * @param blurred Blurred highlights post process which's output will be used.
  148830. * @param weight Weight of the bloom to be added to the original input.
  148831. * @param options The required width/height ratio to downsize to before computing the render pass.
  148832. * @param camera The camera to apply the render pass to.
  148833. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148834. * @param engine The engine which the post process will be applied. (default: current engine)
  148835. * @param reusable If the post process can be reused on the same frame. (default: false)
  148836. * @param textureType Type of textures used when performing the post process. (default: 0)
  148837. * @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)
  148838. */
  148839. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148840. /** Weight of the bloom to be added to the original input. */
  148841. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148842. }
  148843. }
  148844. declare module BABYLON {
  148845. /**
  148846. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148847. */
  148848. export class BloomEffect extends PostProcessRenderEffect {
  148849. private bloomScale;
  148850. /**
  148851. * @hidden Internal
  148852. */
  148853. _effects: Array<PostProcess>;
  148854. /**
  148855. * @hidden Internal
  148856. */
  148857. _downscale: ExtractHighlightsPostProcess;
  148858. private _blurX;
  148859. private _blurY;
  148860. private _merge;
  148861. /**
  148862. * The luminance threshold to find bright areas of the image to bloom.
  148863. */
  148864. get threshold(): number;
  148865. set threshold(value: number);
  148866. /**
  148867. * The strength of the bloom.
  148868. */
  148869. get weight(): number;
  148870. set weight(value: number);
  148871. /**
  148872. * Specifies the size of the bloom blur kernel, relative to the final output size
  148873. */
  148874. get kernel(): number;
  148875. set kernel(value: number);
  148876. /**
  148877. * Creates a new instance of @see BloomEffect
  148878. * @param scene The scene the effect belongs to.
  148879. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148880. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148881. * @param bloomWeight The the strength of bloom.
  148882. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148883. * @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)
  148884. */
  148885. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148886. /**
  148887. * Disposes each of the internal effects for a given camera.
  148888. * @param camera The camera to dispose the effect on.
  148889. */
  148890. disposeEffects(camera: Camera): void;
  148891. /**
  148892. * @hidden Internal
  148893. */
  148894. _updateEffects(): void;
  148895. /**
  148896. * Internal
  148897. * @returns if all the contained post processes are ready.
  148898. * @hidden
  148899. */
  148900. _isReady(): boolean;
  148901. }
  148902. }
  148903. declare module BABYLON {
  148904. /** @hidden */
  148905. export var chromaticAberrationPixelShader: {
  148906. name: string;
  148907. shader: string;
  148908. };
  148909. }
  148910. declare module BABYLON {
  148911. /**
  148912. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148913. */
  148914. export class ChromaticAberrationPostProcess extends PostProcess {
  148915. /**
  148916. * The amount of seperation of rgb channels (default: 30)
  148917. */
  148918. aberrationAmount: number;
  148919. /**
  148920. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148921. */
  148922. radialIntensity: number;
  148923. /**
  148924. * 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))
  148925. */
  148926. direction: Vector2;
  148927. /**
  148928. * 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))
  148929. */
  148930. centerPosition: Vector2;
  148931. /** The width of the screen to apply the effect on */
  148932. screenWidth: number;
  148933. /** The height of the screen to apply the effect on */
  148934. screenHeight: number;
  148935. /**
  148936. * Gets a string identifying the name of the class
  148937. * @returns "ChromaticAberrationPostProcess" string
  148938. */
  148939. getClassName(): string;
  148940. /**
  148941. * Creates a new instance ChromaticAberrationPostProcess
  148942. * @param name The name of the effect.
  148943. * @param screenWidth The width of the screen to apply the effect on.
  148944. * @param screenHeight The height of the screen to apply the effect on.
  148945. * @param options The required width/height ratio to downsize to before computing the render pass.
  148946. * @param camera The camera to apply the render pass to.
  148947. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148948. * @param engine The engine which the post process will be applied. (default: current engine)
  148949. * @param reusable If the post process can be reused on the same frame. (default: false)
  148950. * @param textureType Type of textures used when performing the post process. (default: 0)
  148951. * @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)
  148952. */
  148953. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148954. /** @hidden */
  148955. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148956. }
  148957. }
  148958. declare module BABYLON {
  148959. /** @hidden */
  148960. export var circleOfConfusionPixelShader: {
  148961. name: string;
  148962. shader: string;
  148963. };
  148964. }
  148965. declare module BABYLON {
  148966. /**
  148967. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148968. */
  148969. export class CircleOfConfusionPostProcess extends PostProcess {
  148970. /**
  148971. * 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.
  148972. */
  148973. lensSize: number;
  148974. /**
  148975. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148976. */
  148977. fStop: number;
  148978. /**
  148979. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148980. */
  148981. focusDistance: number;
  148982. /**
  148983. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148984. */
  148985. focalLength: number;
  148986. /**
  148987. * Gets a string identifying the name of the class
  148988. * @returns "CircleOfConfusionPostProcess" string
  148989. */
  148990. getClassName(): string;
  148991. private _depthTexture;
  148992. /**
  148993. * Creates a new instance CircleOfConfusionPostProcess
  148994. * @param name The name of the effect.
  148995. * @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.
  148996. * @param options The required width/height ratio to downsize to before computing the render pass.
  148997. * @param camera The camera to apply the render pass to.
  148998. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148999. * @param engine The engine which the post process will be applied. (default: current engine)
  149000. * @param reusable If the post process can be reused on the same frame. (default: false)
  149001. * @param textureType Type of textures used when performing the post process. (default: 0)
  149002. * @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)
  149003. */
  149004. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149005. /**
  149006. * 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.
  149007. */
  149008. set depthTexture(value: RenderTargetTexture);
  149009. }
  149010. }
  149011. declare module BABYLON {
  149012. /** @hidden */
  149013. export var colorCorrectionPixelShader: {
  149014. name: string;
  149015. shader: string;
  149016. };
  149017. }
  149018. declare module BABYLON {
  149019. /**
  149020. *
  149021. * This post-process allows the modification of rendered colors by using
  149022. * a 'look-up table' (LUT). This effect is also called Color Grading.
  149023. *
  149024. * The object needs to be provided an url to a texture containing the color
  149025. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  149026. * Use an image editing software to tweak the LUT to match your needs.
  149027. *
  149028. * For an example of a color LUT, see here:
  149029. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  149030. * For explanations on color grading, see here:
  149031. * @see http://udn.epicgames.com/Three/ColorGrading.html
  149032. *
  149033. */
  149034. export class ColorCorrectionPostProcess extends PostProcess {
  149035. private _colorTableTexture;
  149036. /**
  149037. * Gets the color table url used to create the LUT texture
  149038. */
  149039. colorTableUrl: string;
  149040. /**
  149041. * Gets a string identifying the name of the class
  149042. * @returns "ColorCorrectionPostProcess" string
  149043. */
  149044. getClassName(): string;
  149045. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149046. /** @hidden */
  149047. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  149048. }
  149049. }
  149050. declare module BABYLON {
  149051. /** @hidden */
  149052. export var convolutionPixelShader: {
  149053. name: string;
  149054. shader: string;
  149055. };
  149056. }
  149057. declare module BABYLON {
  149058. /**
  149059. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  149060. * input texture to perform effects such as edge detection or sharpening
  149061. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149062. */
  149063. export class ConvolutionPostProcess extends PostProcess {
  149064. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  149065. kernel: number[];
  149066. /**
  149067. * Gets a string identifying the name of the class
  149068. * @returns "ConvolutionPostProcess" string
  149069. */
  149070. getClassName(): string;
  149071. /**
  149072. * Creates a new instance ConvolutionPostProcess
  149073. * @param name The name of the effect.
  149074. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  149075. * @param options The required width/height ratio to downsize to before computing the render pass.
  149076. * @param camera The camera to apply the render pass to.
  149077. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149078. * @param engine The engine which the post process will be applied. (default: current engine)
  149079. * @param reusable If the post process can be reused on the same frame. (default: false)
  149080. * @param textureType Type of textures used when performing the post process. (default: 0)
  149081. */
  149082. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149083. /** @hidden */
  149084. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  149085. /**
  149086. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149087. */
  149088. static EdgeDetect0Kernel: number[];
  149089. /**
  149090. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149091. */
  149092. static EdgeDetect1Kernel: number[];
  149093. /**
  149094. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149095. */
  149096. static EdgeDetect2Kernel: number[];
  149097. /**
  149098. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149099. */
  149100. static SharpenKernel: number[];
  149101. /**
  149102. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149103. */
  149104. static EmbossKernel: number[];
  149105. /**
  149106. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149107. */
  149108. static GaussianKernel: number[];
  149109. }
  149110. }
  149111. declare module BABYLON {
  149112. /**
  149113. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  149114. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  149115. * based on samples that have a large difference in distance than the center pixel.
  149116. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  149117. */
  149118. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  149119. /**
  149120. * The direction the blur should be applied
  149121. */
  149122. direction: Vector2;
  149123. /**
  149124. * Gets a string identifying the name of the class
  149125. * @returns "DepthOfFieldBlurPostProcess" string
  149126. */
  149127. getClassName(): string;
  149128. /**
  149129. * Creates a new instance CircleOfConfusionPostProcess
  149130. * @param name The name of the effect.
  149131. * @param scene The scene the effect belongs to.
  149132. * @param direction The direction the blur should be applied.
  149133. * @param kernel The size of the kernel used to blur.
  149134. * @param options The required width/height ratio to downsize to before computing the render pass.
  149135. * @param camera The camera to apply the render pass to.
  149136. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  149137. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  149138. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149139. * @param engine The engine which the post process will be applied. (default: current engine)
  149140. * @param reusable If the post process can be reused on the same frame. (default: false)
  149141. * @param textureType Type of textures used when performing the post process. (default: 0)
  149142. * @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)
  149143. */
  149144. 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);
  149145. }
  149146. }
  149147. declare module BABYLON {
  149148. /** @hidden */
  149149. export var depthOfFieldMergePixelShader: {
  149150. name: string;
  149151. shader: string;
  149152. };
  149153. }
  149154. declare module BABYLON {
  149155. /**
  149156. * Options to be set when merging outputs from the default pipeline.
  149157. */
  149158. export class DepthOfFieldMergePostProcessOptions {
  149159. /**
  149160. * The original image to merge on top of
  149161. */
  149162. originalFromInput: PostProcess;
  149163. /**
  149164. * Parameters to perform the merge of the depth of field effect
  149165. */
  149166. depthOfField?: {
  149167. circleOfConfusion: PostProcess;
  149168. blurSteps: Array<PostProcess>;
  149169. };
  149170. /**
  149171. * Parameters to perform the merge of bloom effect
  149172. */
  149173. bloom?: {
  149174. blurred: PostProcess;
  149175. weight: number;
  149176. };
  149177. }
  149178. /**
  149179. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149180. */
  149181. export class DepthOfFieldMergePostProcess extends PostProcess {
  149182. private blurSteps;
  149183. /**
  149184. * Gets a string identifying the name of the class
  149185. * @returns "DepthOfFieldMergePostProcess" string
  149186. */
  149187. getClassName(): string;
  149188. /**
  149189. * Creates a new instance of DepthOfFieldMergePostProcess
  149190. * @param name The name of the effect.
  149191. * @param originalFromInput Post process which's input will be used for the merge.
  149192. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149193. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149194. * @param options The required width/height ratio to downsize to before computing the render pass.
  149195. * @param camera The camera to apply the render pass to.
  149196. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149197. * @param engine The engine which the post process will be applied. (default: current engine)
  149198. * @param reusable If the post process can be reused on the same frame. (default: false)
  149199. * @param textureType Type of textures used when performing the post process. (default: 0)
  149200. * @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)
  149201. */
  149202. 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);
  149203. /**
  149204. * Updates the effect with the current post process compile time values and recompiles the shader.
  149205. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149206. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149207. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149208. * @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
  149209. * @param onCompiled Called when the shader has been compiled.
  149210. * @param onError Called if there is an error when compiling a shader.
  149211. */
  149212. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149213. }
  149214. }
  149215. declare module BABYLON {
  149216. /**
  149217. * Specifies the level of max blur that should be applied when using the depth of field effect
  149218. */
  149219. export enum DepthOfFieldEffectBlurLevel {
  149220. /**
  149221. * Subtle blur
  149222. */
  149223. Low = 0,
  149224. /**
  149225. * Medium blur
  149226. */
  149227. Medium = 1,
  149228. /**
  149229. * Large blur
  149230. */
  149231. High = 2
  149232. }
  149233. /**
  149234. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149235. */
  149236. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149237. private _circleOfConfusion;
  149238. /**
  149239. * @hidden Internal, blurs from high to low
  149240. */
  149241. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149242. private _depthOfFieldBlurY;
  149243. private _dofMerge;
  149244. /**
  149245. * @hidden Internal post processes in depth of field effect
  149246. */
  149247. _effects: Array<PostProcess>;
  149248. /**
  149249. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149250. */
  149251. set focalLength(value: number);
  149252. get focalLength(): number;
  149253. /**
  149254. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149255. */
  149256. set fStop(value: number);
  149257. get fStop(): number;
  149258. /**
  149259. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149260. */
  149261. set focusDistance(value: number);
  149262. get focusDistance(): number;
  149263. /**
  149264. * 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.
  149265. */
  149266. set lensSize(value: number);
  149267. get lensSize(): number;
  149268. /**
  149269. * Creates a new instance DepthOfFieldEffect
  149270. * @param scene The scene the effect belongs to.
  149271. * @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.
  149272. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149273. * @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)
  149274. */
  149275. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149276. /**
  149277. * Get the current class name of the current effet
  149278. * @returns "DepthOfFieldEffect"
  149279. */
  149280. getClassName(): string;
  149281. /**
  149282. * 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.
  149283. */
  149284. set depthTexture(value: RenderTargetTexture);
  149285. /**
  149286. * Disposes each of the internal effects for a given camera.
  149287. * @param camera The camera to dispose the effect on.
  149288. */
  149289. disposeEffects(camera: Camera): void;
  149290. /**
  149291. * @hidden Internal
  149292. */
  149293. _updateEffects(): void;
  149294. /**
  149295. * Internal
  149296. * @returns if all the contained post processes are ready.
  149297. * @hidden
  149298. */
  149299. _isReady(): boolean;
  149300. }
  149301. }
  149302. declare module BABYLON {
  149303. /** @hidden */
  149304. export var displayPassPixelShader: {
  149305. name: string;
  149306. shader: string;
  149307. };
  149308. }
  149309. declare module BABYLON {
  149310. /**
  149311. * DisplayPassPostProcess which produces an output the same as it's input
  149312. */
  149313. export class DisplayPassPostProcess extends PostProcess {
  149314. /**
  149315. * Gets a string identifying the name of the class
  149316. * @returns "DisplayPassPostProcess" string
  149317. */
  149318. getClassName(): string;
  149319. /**
  149320. * Creates the DisplayPassPostProcess
  149321. * @param name The name of the effect.
  149322. * @param options The required width/height ratio to downsize to before computing the render pass.
  149323. * @param camera The camera to apply the render pass to.
  149324. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149325. * @param engine The engine which the post process will be applied. (default: current engine)
  149326. * @param reusable If the post process can be reused on the same frame. (default: false)
  149327. */
  149328. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149329. /** @hidden */
  149330. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149331. }
  149332. }
  149333. declare module BABYLON {
  149334. /** @hidden */
  149335. export var filterPixelShader: {
  149336. name: string;
  149337. shader: string;
  149338. };
  149339. }
  149340. declare module BABYLON {
  149341. /**
  149342. * Applies a kernel filter to the image
  149343. */
  149344. export class FilterPostProcess extends PostProcess {
  149345. /** The matrix to be applied to the image */
  149346. kernelMatrix: Matrix;
  149347. /**
  149348. * Gets a string identifying the name of the class
  149349. * @returns "FilterPostProcess" string
  149350. */
  149351. getClassName(): string;
  149352. /**
  149353. *
  149354. * @param name The name of the effect.
  149355. * @param kernelMatrix The matrix to be applied to the image
  149356. * @param options The required width/height ratio to downsize to before computing the render pass.
  149357. * @param camera The camera to apply the render pass to.
  149358. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149359. * @param engine The engine which the post process will be applied. (default: current engine)
  149360. * @param reusable If the post process can be reused on the same frame. (default: false)
  149361. */
  149362. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149363. /** @hidden */
  149364. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149365. }
  149366. }
  149367. declare module BABYLON {
  149368. /** @hidden */
  149369. export var fxaaPixelShader: {
  149370. name: string;
  149371. shader: string;
  149372. };
  149373. }
  149374. declare module BABYLON {
  149375. /** @hidden */
  149376. export var fxaaVertexShader: {
  149377. name: string;
  149378. shader: string;
  149379. };
  149380. }
  149381. declare module BABYLON {
  149382. /**
  149383. * Fxaa post process
  149384. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149385. */
  149386. export class FxaaPostProcess extends PostProcess {
  149387. /**
  149388. * Gets a string identifying the name of the class
  149389. * @returns "FxaaPostProcess" string
  149390. */
  149391. getClassName(): string;
  149392. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149393. private _getDefines;
  149394. /** @hidden */
  149395. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149396. }
  149397. }
  149398. declare module BABYLON {
  149399. /** @hidden */
  149400. export var grainPixelShader: {
  149401. name: string;
  149402. shader: string;
  149403. };
  149404. }
  149405. declare module BABYLON {
  149406. /**
  149407. * The GrainPostProcess adds noise to the image at mid luminance levels
  149408. */
  149409. export class GrainPostProcess extends PostProcess {
  149410. /**
  149411. * The intensity of the grain added (default: 30)
  149412. */
  149413. intensity: number;
  149414. /**
  149415. * If the grain should be randomized on every frame
  149416. */
  149417. animated: boolean;
  149418. /**
  149419. * Gets a string identifying the name of the class
  149420. * @returns "GrainPostProcess" string
  149421. */
  149422. getClassName(): string;
  149423. /**
  149424. * Creates a new instance of @see GrainPostProcess
  149425. * @param name The name of the effect.
  149426. * @param options The required width/height ratio to downsize to before computing the render pass.
  149427. * @param camera The camera to apply the render pass to.
  149428. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149429. * @param engine The engine which the post process will be applied. (default: current engine)
  149430. * @param reusable If the post process can be reused on the same frame. (default: false)
  149431. * @param textureType Type of textures used when performing the post process. (default: 0)
  149432. * @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)
  149433. */
  149434. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149435. /** @hidden */
  149436. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149437. }
  149438. }
  149439. declare module BABYLON {
  149440. /** @hidden */
  149441. export var highlightsPixelShader: {
  149442. name: string;
  149443. shader: string;
  149444. };
  149445. }
  149446. declare module BABYLON {
  149447. /**
  149448. * Extracts highlights from the image
  149449. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149450. */
  149451. export class HighlightsPostProcess extends PostProcess {
  149452. /**
  149453. * Gets a string identifying the name of the class
  149454. * @returns "HighlightsPostProcess" string
  149455. */
  149456. getClassName(): string;
  149457. /**
  149458. * Extracts highlights from the image
  149459. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149460. * @param name The name of the effect.
  149461. * @param options The required width/height ratio to downsize to before computing the render pass.
  149462. * @param camera The camera to apply the render pass to.
  149463. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149464. * @param engine The engine which the post process will be applied. (default: current engine)
  149465. * @param reusable If the post process can be reused on the same frame. (default: false)
  149466. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149467. */
  149468. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149469. }
  149470. }
  149471. declare module BABYLON {
  149472. /** @hidden */
  149473. export var mrtFragmentDeclaration: {
  149474. name: string;
  149475. shader: string;
  149476. };
  149477. }
  149478. declare module BABYLON {
  149479. /** @hidden */
  149480. export var geometryPixelShader: {
  149481. name: string;
  149482. shader: string;
  149483. };
  149484. }
  149485. declare module BABYLON {
  149486. /** @hidden */
  149487. export var geometryVertexShader: {
  149488. name: string;
  149489. shader: string;
  149490. };
  149491. }
  149492. declare module BABYLON {
  149493. /** @hidden */
  149494. interface ISavedTransformationMatrix {
  149495. world: Matrix;
  149496. viewProjection: Matrix;
  149497. }
  149498. /**
  149499. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149500. */
  149501. export class GeometryBufferRenderer {
  149502. /**
  149503. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149504. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149505. */
  149506. static readonly POSITION_TEXTURE_TYPE: number;
  149507. /**
  149508. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149509. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149510. */
  149511. static readonly VELOCITY_TEXTURE_TYPE: number;
  149512. /**
  149513. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149514. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149515. */
  149516. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149517. /**
  149518. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149519. * in order to compute objects velocities when enableVelocity is set to "true"
  149520. * @hidden
  149521. */
  149522. _previousTransformationMatrices: {
  149523. [index: number]: ISavedTransformationMatrix;
  149524. };
  149525. /**
  149526. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149527. * in order to compute objects velocities when enableVelocity is set to "true"
  149528. * @hidden
  149529. */
  149530. _previousBonesTransformationMatrices: {
  149531. [index: number]: Float32Array;
  149532. };
  149533. /**
  149534. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149535. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149536. */
  149537. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149538. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149539. renderTransparentMeshes: boolean;
  149540. private _scene;
  149541. private _resizeObserver;
  149542. private _multiRenderTarget;
  149543. private _ratio;
  149544. private _enablePosition;
  149545. private _enableVelocity;
  149546. private _enableReflectivity;
  149547. private _positionIndex;
  149548. private _velocityIndex;
  149549. private _reflectivityIndex;
  149550. protected _effect: Effect;
  149551. protected _cachedDefines: string;
  149552. /**
  149553. * Set the render list (meshes to be rendered) used in the G buffer.
  149554. */
  149555. set renderList(meshes: Mesh[]);
  149556. /**
  149557. * Gets wether or not G buffer are supported by the running hardware.
  149558. * This requires draw buffer supports
  149559. */
  149560. get isSupported(): boolean;
  149561. /**
  149562. * Returns the index of the given texture type in the G-Buffer textures array
  149563. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149564. * @returns the index of the given texture type in the G-Buffer textures array
  149565. */
  149566. getTextureIndex(textureType: number): number;
  149567. /**
  149568. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149569. */
  149570. get enablePosition(): boolean;
  149571. /**
  149572. * Sets whether or not objects positions are enabled for the G buffer.
  149573. */
  149574. set enablePosition(enable: boolean);
  149575. /**
  149576. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149577. */
  149578. get enableVelocity(): boolean;
  149579. /**
  149580. * Sets wether or not objects velocities are enabled for the G buffer.
  149581. */
  149582. set enableVelocity(enable: boolean);
  149583. /**
  149584. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149585. */
  149586. get enableReflectivity(): boolean;
  149587. /**
  149588. * Sets wether or not objects roughness are enabled for the G buffer.
  149589. */
  149590. set enableReflectivity(enable: boolean);
  149591. /**
  149592. * Gets the scene associated with the buffer.
  149593. */
  149594. get scene(): Scene;
  149595. /**
  149596. * Gets the ratio used by the buffer during its creation.
  149597. * How big is the buffer related to the main canvas.
  149598. */
  149599. get ratio(): number;
  149600. /** @hidden */
  149601. static _SceneComponentInitialization: (scene: Scene) => void;
  149602. /**
  149603. * Creates a new G Buffer for the scene
  149604. * @param scene The scene the buffer belongs to
  149605. * @param ratio How big is the buffer related to the main canvas.
  149606. */
  149607. constructor(scene: Scene, ratio?: number);
  149608. /**
  149609. * Checks wether everything is ready to render a submesh to the G buffer.
  149610. * @param subMesh the submesh to check readiness for
  149611. * @param useInstances is the mesh drawn using instance or not
  149612. * @returns true if ready otherwise false
  149613. */
  149614. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149615. /**
  149616. * Gets the current underlying G Buffer.
  149617. * @returns the buffer
  149618. */
  149619. getGBuffer(): MultiRenderTarget;
  149620. /**
  149621. * Gets the number of samples used to render the buffer (anti aliasing).
  149622. */
  149623. get samples(): number;
  149624. /**
  149625. * Sets the number of samples used to render the buffer (anti aliasing).
  149626. */
  149627. set samples(value: number);
  149628. /**
  149629. * Disposes the renderer and frees up associated resources.
  149630. */
  149631. dispose(): void;
  149632. protected _createRenderTargets(): void;
  149633. private _copyBonesTransformationMatrices;
  149634. }
  149635. }
  149636. declare module BABYLON {
  149637. interface Scene {
  149638. /** @hidden (Backing field) */
  149639. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149640. /**
  149641. * Gets or Sets the current geometry buffer associated to the scene.
  149642. */
  149643. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149644. /**
  149645. * Enables a GeometryBufferRender and associates it with the scene
  149646. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149647. * @returns the GeometryBufferRenderer
  149648. */
  149649. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149650. /**
  149651. * Disables the GeometryBufferRender associated with the scene
  149652. */
  149653. disableGeometryBufferRenderer(): void;
  149654. }
  149655. /**
  149656. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149657. * in several rendering techniques.
  149658. */
  149659. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149660. /**
  149661. * The component name helpful to identify the component in the list of scene components.
  149662. */
  149663. readonly name: string;
  149664. /**
  149665. * The scene the component belongs to.
  149666. */
  149667. scene: Scene;
  149668. /**
  149669. * Creates a new instance of the component for the given scene
  149670. * @param scene Defines the scene to register the component in
  149671. */
  149672. constructor(scene: Scene);
  149673. /**
  149674. * Registers the component in a given scene
  149675. */
  149676. register(): void;
  149677. /**
  149678. * Rebuilds the elements related to this component in case of
  149679. * context lost for instance.
  149680. */
  149681. rebuild(): void;
  149682. /**
  149683. * Disposes the component and the associated ressources
  149684. */
  149685. dispose(): void;
  149686. private _gatherRenderTargets;
  149687. }
  149688. }
  149689. declare module BABYLON {
  149690. /** @hidden */
  149691. export var motionBlurPixelShader: {
  149692. name: string;
  149693. shader: string;
  149694. };
  149695. }
  149696. declare module BABYLON {
  149697. /**
  149698. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149699. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149700. * As an example, all you have to do is to create the post-process:
  149701. * var mb = new BABYLON.MotionBlurPostProcess(
  149702. * 'mb', // The name of the effect.
  149703. * scene, // The scene containing the objects to blur according to their velocity.
  149704. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149705. * camera // The camera to apply the render pass to.
  149706. * );
  149707. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149708. */
  149709. export class MotionBlurPostProcess extends PostProcess {
  149710. /**
  149711. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149712. */
  149713. motionStrength: number;
  149714. /**
  149715. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149716. */
  149717. get motionBlurSamples(): number;
  149718. /**
  149719. * Sets the number of iterations to be used for motion blur quality
  149720. */
  149721. set motionBlurSamples(samples: number);
  149722. private _motionBlurSamples;
  149723. private _geometryBufferRenderer;
  149724. /**
  149725. * Gets a string identifying the name of the class
  149726. * @returns "MotionBlurPostProcess" string
  149727. */
  149728. getClassName(): string;
  149729. /**
  149730. * Creates a new instance MotionBlurPostProcess
  149731. * @param name The name of the effect.
  149732. * @param scene The scene containing the objects to blur according to their velocity.
  149733. * @param options The required width/height ratio to downsize to before computing the render pass.
  149734. * @param camera The camera to apply the render pass to.
  149735. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149736. * @param engine The engine which the post process will be applied. (default: current engine)
  149737. * @param reusable If the post process can be reused on the same frame. (default: false)
  149738. * @param textureType Type of textures used when performing the post process. (default: 0)
  149739. * @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)
  149740. */
  149741. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149742. /**
  149743. * Excludes the given skinned mesh from computing bones velocities.
  149744. * 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.
  149745. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149746. */
  149747. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149748. /**
  149749. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149750. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149751. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149752. */
  149753. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149754. /**
  149755. * Disposes the post process.
  149756. * @param camera The camera to dispose the post process on.
  149757. */
  149758. dispose(camera?: Camera): void;
  149759. /** @hidden */
  149760. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149761. }
  149762. }
  149763. declare module BABYLON {
  149764. /** @hidden */
  149765. export var refractionPixelShader: {
  149766. name: string;
  149767. shader: string;
  149768. };
  149769. }
  149770. declare module BABYLON {
  149771. /**
  149772. * Post process which applies a refractin texture
  149773. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149774. */
  149775. export class RefractionPostProcess extends PostProcess {
  149776. private _refTexture;
  149777. private _ownRefractionTexture;
  149778. /** the base color of the refraction (used to taint the rendering) */
  149779. color: Color3;
  149780. /** simulated refraction depth */
  149781. depth: number;
  149782. /** the coefficient of the base color (0 to remove base color tainting) */
  149783. colorLevel: number;
  149784. /** Gets the url used to load the refraction texture */
  149785. refractionTextureUrl: string;
  149786. /**
  149787. * Gets or sets the refraction texture
  149788. * Please note that you are responsible for disposing the texture if you set it manually
  149789. */
  149790. get refractionTexture(): Texture;
  149791. set refractionTexture(value: Texture);
  149792. /**
  149793. * Gets a string identifying the name of the class
  149794. * @returns "RefractionPostProcess" string
  149795. */
  149796. getClassName(): string;
  149797. /**
  149798. * Initializes the RefractionPostProcess
  149799. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149800. * @param name The name of the effect.
  149801. * @param refractionTextureUrl Url of the refraction texture to use
  149802. * @param color the base color of the refraction (used to taint the rendering)
  149803. * @param depth simulated refraction depth
  149804. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149805. * @param camera The camera to apply the render pass to.
  149806. * @param options The required width/height ratio to downsize to before computing the render pass.
  149807. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149808. * @param engine The engine which the post process will be applied. (default: current engine)
  149809. * @param reusable If the post process can be reused on the same frame. (default: false)
  149810. */
  149811. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149812. /**
  149813. * Disposes of the post process
  149814. * @param camera Camera to dispose post process on
  149815. */
  149816. dispose(camera: Camera): void;
  149817. /** @hidden */
  149818. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149819. }
  149820. }
  149821. declare module BABYLON {
  149822. /** @hidden */
  149823. export var sharpenPixelShader: {
  149824. name: string;
  149825. shader: string;
  149826. };
  149827. }
  149828. declare module BABYLON {
  149829. /**
  149830. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149831. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149832. */
  149833. export class SharpenPostProcess extends PostProcess {
  149834. /**
  149835. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149836. */
  149837. colorAmount: number;
  149838. /**
  149839. * How much sharpness should be applied (default: 0.3)
  149840. */
  149841. edgeAmount: number;
  149842. /**
  149843. * Gets a string identifying the name of the class
  149844. * @returns "SharpenPostProcess" string
  149845. */
  149846. getClassName(): string;
  149847. /**
  149848. * Creates a new instance ConvolutionPostProcess
  149849. * @param name The name of the effect.
  149850. * @param options The required width/height ratio to downsize to before computing the render pass.
  149851. * @param camera The camera to apply the render pass to.
  149852. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149853. * @param engine The engine which the post process will be applied. (default: current engine)
  149854. * @param reusable If the post process can be reused on the same frame. (default: false)
  149855. * @param textureType Type of textures used when performing the post process. (default: 0)
  149856. * @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)
  149857. */
  149858. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149859. /** @hidden */
  149860. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149861. }
  149862. }
  149863. declare module BABYLON {
  149864. /**
  149865. * PostProcessRenderPipeline
  149866. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149867. */
  149868. export class PostProcessRenderPipeline {
  149869. private engine;
  149870. private _renderEffects;
  149871. private _renderEffectsForIsolatedPass;
  149872. /**
  149873. * List of inspectable custom properties (used by the Inspector)
  149874. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149875. */
  149876. inspectableCustomProperties: IInspectable[];
  149877. /**
  149878. * @hidden
  149879. */
  149880. protected _cameras: Camera[];
  149881. /** @hidden */
  149882. _name: string;
  149883. /**
  149884. * Gets pipeline name
  149885. */
  149886. get name(): string;
  149887. /** Gets the list of attached cameras */
  149888. get cameras(): Camera[];
  149889. /**
  149890. * Initializes a PostProcessRenderPipeline
  149891. * @param engine engine to add the pipeline to
  149892. * @param name name of the pipeline
  149893. */
  149894. constructor(engine: Engine, name: string);
  149895. /**
  149896. * Gets the class name
  149897. * @returns "PostProcessRenderPipeline"
  149898. */
  149899. getClassName(): string;
  149900. /**
  149901. * If all the render effects in the pipeline are supported
  149902. */
  149903. get isSupported(): boolean;
  149904. /**
  149905. * Adds an effect to the pipeline
  149906. * @param renderEffect the effect to add
  149907. */
  149908. addEffect(renderEffect: PostProcessRenderEffect): void;
  149909. /** @hidden */
  149910. _rebuild(): void;
  149911. /** @hidden */
  149912. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149913. /** @hidden */
  149914. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149915. /** @hidden */
  149916. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149917. /** @hidden */
  149918. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149919. /** @hidden */
  149920. _attachCameras(cameras: Camera, unique: boolean): void;
  149921. /** @hidden */
  149922. _attachCameras(cameras: Camera[], unique: boolean): void;
  149923. /** @hidden */
  149924. _detachCameras(cameras: Camera): void;
  149925. /** @hidden */
  149926. _detachCameras(cameras: Nullable<Camera[]>): void;
  149927. /** @hidden */
  149928. _update(): void;
  149929. /** @hidden */
  149930. _reset(): void;
  149931. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149932. /**
  149933. * Sets the required values to the prepass renderer.
  149934. * @param prePassRenderer defines the prepass renderer to setup.
  149935. * @returns true if the pre pass is needed.
  149936. */
  149937. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149938. /**
  149939. * Disposes of the pipeline
  149940. */
  149941. dispose(): void;
  149942. }
  149943. }
  149944. declare module BABYLON {
  149945. /**
  149946. * PostProcessRenderPipelineManager class
  149947. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149948. */
  149949. export class PostProcessRenderPipelineManager {
  149950. private _renderPipelines;
  149951. /**
  149952. * Initializes a PostProcessRenderPipelineManager
  149953. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149954. */
  149955. constructor();
  149956. /**
  149957. * Gets the list of supported render pipelines
  149958. */
  149959. get supportedPipelines(): PostProcessRenderPipeline[];
  149960. /**
  149961. * Adds a pipeline to the manager
  149962. * @param renderPipeline The pipeline to add
  149963. */
  149964. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149965. /**
  149966. * Attaches a camera to the pipeline
  149967. * @param renderPipelineName The name of the pipeline to attach to
  149968. * @param cameras the camera to attach
  149969. * @param unique if the camera can be attached multiple times to the pipeline
  149970. */
  149971. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149972. /**
  149973. * Detaches a camera from the pipeline
  149974. * @param renderPipelineName The name of the pipeline to detach from
  149975. * @param cameras the camera to detach
  149976. */
  149977. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149978. /**
  149979. * Enables an effect by name on a pipeline
  149980. * @param renderPipelineName the name of the pipeline to enable the effect in
  149981. * @param renderEffectName the name of the effect to enable
  149982. * @param cameras the cameras that the effect should be enabled on
  149983. */
  149984. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149985. /**
  149986. * Disables an effect by name on a pipeline
  149987. * @param renderPipelineName the name of the pipeline to disable the effect in
  149988. * @param renderEffectName the name of the effect to disable
  149989. * @param cameras the cameras that the effect should be disabled on
  149990. */
  149991. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149992. /**
  149993. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149994. */
  149995. update(): void;
  149996. /** @hidden */
  149997. _rebuild(): void;
  149998. /**
  149999. * Disposes of the manager and pipelines
  150000. */
  150001. dispose(): void;
  150002. }
  150003. }
  150004. declare module BABYLON {
  150005. interface Scene {
  150006. /** @hidden (Backing field) */
  150007. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150008. /**
  150009. * Gets the postprocess render pipeline manager
  150010. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150011. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150012. */
  150013. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150014. }
  150015. /**
  150016. * Defines the Render Pipeline scene component responsible to rendering pipelines
  150017. */
  150018. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  150019. /**
  150020. * The component name helpfull to identify the component in the list of scene components.
  150021. */
  150022. readonly name: string;
  150023. /**
  150024. * The scene the component belongs to.
  150025. */
  150026. scene: Scene;
  150027. /**
  150028. * Creates a new instance of the component for the given scene
  150029. * @param scene Defines the scene to register the component in
  150030. */
  150031. constructor(scene: Scene);
  150032. /**
  150033. * Registers the component in a given scene
  150034. */
  150035. register(): void;
  150036. /**
  150037. * Rebuilds the elements related to this component in case of
  150038. * context lost for instance.
  150039. */
  150040. rebuild(): void;
  150041. /**
  150042. * Disposes the component and the associated ressources
  150043. */
  150044. dispose(): void;
  150045. private _gatherRenderTargets;
  150046. }
  150047. }
  150048. declare module BABYLON {
  150049. /**
  150050. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  150051. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150052. */
  150053. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150054. private _scene;
  150055. private _camerasToBeAttached;
  150056. /**
  150057. * ID of the sharpen post process,
  150058. */
  150059. private readonly SharpenPostProcessId;
  150060. /**
  150061. * @ignore
  150062. * ID of the image processing post process;
  150063. */
  150064. readonly ImageProcessingPostProcessId: string;
  150065. /**
  150066. * @ignore
  150067. * ID of the Fast Approximate Anti-Aliasing post process;
  150068. */
  150069. readonly FxaaPostProcessId: string;
  150070. /**
  150071. * ID of the chromatic aberration post process,
  150072. */
  150073. private readonly ChromaticAberrationPostProcessId;
  150074. /**
  150075. * ID of the grain post process
  150076. */
  150077. private readonly GrainPostProcessId;
  150078. /**
  150079. * Sharpen post process which will apply a sharpen convolution to enhance edges
  150080. */
  150081. sharpen: SharpenPostProcess;
  150082. private _sharpenEffect;
  150083. private bloom;
  150084. /**
  150085. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  150086. */
  150087. depthOfField: DepthOfFieldEffect;
  150088. /**
  150089. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150090. */
  150091. fxaa: FxaaPostProcess;
  150092. /**
  150093. * Image post processing pass used to perform operations such as tone mapping or color grading.
  150094. */
  150095. imageProcessing: ImageProcessingPostProcess;
  150096. /**
  150097. * Chromatic aberration post process which will shift rgb colors in the image
  150098. */
  150099. chromaticAberration: ChromaticAberrationPostProcess;
  150100. private _chromaticAberrationEffect;
  150101. /**
  150102. * Grain post process which add noise to the image
  150103. */
  150104. grain: GrainPostProcess;
  150105. private _grainEffect;
  150106. /**
  150107. * Glow post process which adds a glow to emissive areas of the image
  150108. */
  150109. private _glowLayer;
  150110. /**
  150111. * Animations which can be used to tweak settings over a period of time
  150112. */
  150113. animations: Animation[];
  150114. private _imageProcessingConfigurationObserver;
  150115. private _sharpenEnabled;
  150116. private _bloomEnabled;
  150117. private _depthOfFieldEnabled;
  150118. private _depthOfFieldBlurLevel;
  150119. private _fxaaEnabled;
  150120. private _imageProcessingEnabled;
  150121. private _defaultPipelineTextureType;
  150122. private _bloomScale;
  150123. private _chromaticAberrationEnabled;
  150124. private _grainEnabled;
  150125. private _buildAllowed;
  150126. /**
  150127. * Gets active scene
  150128. */
  150129. get scene(): Scene;
  150130. /**
  150131. * Enable or disable the sharpen process from the pipeline
  150132. */
  150133. set sharpenEnabled(enabled: boolean);
  150134. get sharpenEnabled(): boolean;
  150135. private _resizeObserver;
  150136. private _hardwareScaleLevel;
  150137. private _bloomKernel;
  150138. /**
  150139. * Specifies the size of the bloom blur kernel, relative to the final output size
  150140. */
  150141. get bloomKernel(): number;
  150142. set bloomKernel(value: number);
  150143. /**
  150144. * Specifies the weight of the bloom in the final rendering
  150145. */
  150146. private _bloomWeight;
  150147. /**
  150148. * Specifies the luma threshold for the area that will be blurred by the bloom
  150149. */
  150150. private _bloomThreshold;
  150151. private _hdr;
  150152. /**
  150153. * The strength of the bloom.
  150154. */
  150155. set bloomWeight(value: number);
  150156. get bloomWeight(): number;
  150157. /**
  150158. * The strength of the bloom.
  150159. */
  150160. set bloomThreshold(value: number);
  150161. get bloomThreshold(): number;
  150162. /**
  150163. * The scale of the bloom, lower value will provide better performance.
  150164. */
  150165. set bloomScale(value: number);
  150166. get bloomScale(): number;
  150167. /**
  150168. * Enable or disable the bloom from the pipeline
  150169. */
  150170. set bloomEnabled(enabled: boolean);
  150171. get bloomEnabled(): boolean;
  150172. private _rebuildBloom;
  150173. /**
  150174. * If the depth of field is enabled.
  150175. */
  150176. get depthOfFieldEnabled(): boolean;
  150177. set depthOfFieldEnabled(enabled: boolean);
  150178. /**
  150179. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150180. */
  150181. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150182. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150183. /**
  150184. * If the anti aliasing is enabled.
  150185. */
  150186. set fxaaEnabled(enabled: boolean);
  150187. get fxaaEnabled(): boolean;
  150188. private _samples;
  150189. /**
  150190. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150191. */
  150192. set samples(sampleCount: number);
  150193. get samples(): number;
  150194. /**
  150195. * If image processing is enabled.
  150196. */
  150197. set imageProcessingEnabled(enabled: boolean);
  150198. get imageProcessingEnabled(): boolean;
  150199. /**
  150200. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150201. */
  150202. set glowLayerEnabled(enabled: boolean);
  150203. get glowLayerEnabled(): boolean;
  150204. /**
  150205. * Gets the glow layer (or null if not defined)
  150206. */
  150207. get glowLayer(): Nullable<GlowLayer>;
  150208. /**
  150209. * Enable or disable the chromaticAberration process from the pipeline
  150210. */
  150211. set chromaticAberrationEnabled(enabled: boolean);
  150212. get chromaticAberrationEnabled(): boolean;
  150213. /**
  150214. * Enable or disable the grain process from the pipeline
  150215. */
  150216. set grainEnabled(enabled: boolean);
  150217. get grainEnabled(): boolean;
  150218. /**
  150219. * @constructor
  150220. * @param name - The rendering pipeline name (default: "")
  150221. * @param hdr - If high dynamic range textures should be used (default: true)
  150222. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150223. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150224. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150225. */
  150226. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150227. /**
  150228. * Get the class name
  150229. * @returns "DefaultRenderingPipeline"
  150230. */
  150231. getClassName(): string;
  150232. /**
  150233. * Force the compilation of the entire pipeline.
  150234. */
  150235. prepare(): void;
  150236. private _hasCleared;
  150237. private _prevPostProcess;
  150238. private _prevPrevPostProcess;
  150239. private _setAutoClearAndTextureSharing;
  150240. private _depthOfFieldSceneObserver;
  150241. private _buildPipeline;
  150242. private _disposePostProcesses;
  150243. /**
  150244. * Adds a camera to the pipeline
  150245. * @param camera the camera to be added
  150246. */
  150247. addCamera(camera: Camera): void;
  150248. /**
  150249. * Removes a camera from the pipeline
  150250. * @param camera the camera to remove
  150251. */
  150252. removeCamera(camera: Camera): void;
  150253. /**
  150254. * Dispose of the pipeline and stop all post processes
  150255. */
  150256. dispose(): void;
  150257. /**
  150258. * Serialize the rendering pipeline (Used when exporting)
  150259. * @returns the serialized object
  150260. */
  150261. serialize(): any;
  150262. /**
  150263. * Parse the serialized pipeline
  150264. * @param source Source pipeline.
  150265. * @param scene The scene to load the pipeline to.
  150266. * @param rootUrl The URL of the serialized pipeline.
  150267. * @returns An instantiated pipeline from the serialized object.
  150268. */
  150269. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150270. }
  150271. }
  150272. declare module BABYLON {
  150273. /** @hidden */
  150274. export var lensHighlightsPixelShader: {
  150275. name: string;
  150276. shader: string;
  150277. };
  150278. }
  150279. declare module BABYLON {
  150280. /** @hidden */
  150281. export var depthOfFieldPixelShader: {
  150282. name: string;
  150283. shader: string;
  150284. };
  150285. }
  150286. declare module BABYLON {
  150287. /**
  150288. * BABYLON.JS Chromatic Aberration GLSL Shader
  150289. * Author: Olivier Guyot
  150290. * Separates very slightly R, G and B colors on the edges of the screen
  150291. * Inspired by Francois Tarlier & Martins Upitis
  150292. */
  150293. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150294. /**
  150295. * @ignore
  150296. * The chromatic aberration PostProcess id in the pipeline
  150297. */
  150298. LensChromaticAberrationEffect: string;
  150299. /**
  150300. * @ignore
  150301. * The highlights enhancing PostProcess id in the pipeline
  150302. */
  150303. HighlightsEnhancingEffect: string;
  150304. /**
  150305. * @ignore
  150306. * The depth-of-field PostProcess id in the pipeline
  150307. */
  150308. LensDepthOfFieldEffect: string;
  150309. private _scene;
  150310. private _depthTexture;
  150311. private _grainTexture;
  150312. private _chromaticAberrationPostProcess;
  150313. private _highlightsPostProcess;
  150314. private _depthOfFieldPostProcess;
  150315. private _edgeBlur;
  150316. private _grainAmount;
  150317. private _chromaticAberration;
  150318. private _distortion;
  150319. private _highlightsGain;
  150320. private _highlightsThreshold;
  150321. private _dofDistance;
  150322. private _dofAperture;
  150323. private _dofDarken;
  150324. private _dofPentagon;
  150325. private _blurNoise;
  150326. /**
  150327. * @constructor
  150328. *
  150329. * Effect parameters are as follow:
  150330. * {
  150331. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150332. * edge_blur: number; // from 0 to x (1 for realism)
  150333. * distortion: number; // from 0 to x (1 for realism)
  150334. * grain_amount: number; // from 0 to 1
  150335. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150336. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150337. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150338. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150339. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150340. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150341. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150342. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150343. * }
  150344. * Note: if an effect parameter is unset, effect is disabled
  150345. *
  150346. * @param name The rendering pipeline name
  150347. * @param parameters - An object containing all parameters (see above)
  150348. * @param scene The scene linked to this pipeline
  150349. * @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)
  150350. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150351. */
  150352. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150353. /**
  150354. * Get the class name
  150355. * @returns "LensRenderingPipeline"
  150356. */
  150357. getClassName(): string;
  150358. /**
  150359. * Gets associated scene
  150360. */
  150361. get scene(): Scene;
  150362. /**
  150363. * Gets or sets the edge blur
  150364. */
  150365. get edgeBlur(): number;
  150366. set edgeBlur(value: number);
  150367. /**
  150368. * Gets or sets the grain amount
  150369. */
  150370. get grainAmount(): number;
  150371. set grainAmount(value: number);
  150372. /**
  150373. * Gets or sets the chromatic aberration amount
  150374. */
  150375. get chromaticAberration(): number;
  150376. set chromaticAberration(value: number);
  150377. /**
  150378. * Gets or sets the depth of field aperture
  150379. */
  150380. get dofAperture(): number;
  150381. set dofAperture(value: number);
  150382. /**
  150383. * Gets or sets the edge distortion
  150384. */
  150385. get edgeDistortion(): number;
  150386. set edgeDistortion(value: number);
  150387. /**
  150388. * Gets or sets the depth of field distortion
  150389. */
  150390. get dofDistortion(): number;
  150391. set dofDistortion(value: number);
  150392. /**
  150393. * Gets or sets the darken out of focus amount
  150394. */
  150395. get darkenOutOfFocus(): number;
  150396. set darkenOutOfFocus(value: number);
  150397. /**
  150398. * Gets or sets a boolean indicating if blur noise is enabled
  150399. */
  150400. get blurNoise(): boolean;
  150401. set blurNoise(value: boolean);
  150402. /**
  150403. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150404. */
  150405. get pentagonBokeh(): boolean;
  150406. set pentagonBokeh(value: boolean);
  150407. /**
  150408. * Gets or sets the highlight grain amount
  150409. */
  150410. get highlightsGain(): number;
  150411. set highlightsGain(value: number);
  150412. /**
  150413. * Gets or sets the highlight threshold
  150414. */
  150415. get highlightsThreshold(): number;
  150416. set highlightsThreshold(value: number);
  150417. /**
  150418. * Sets the amount of blur at the edges
  150419. * @param amount blur amount
  150420. */
  150421. setEdgeBlur(amount: number): void;
  150422. /**
  150423. * Sets edge blur to 0
  150424. */
  150425. disableEdgeBlur(): void;
  150426. /**
  150427. * Sets the amout of grain
  150428. * @param amount Amount of grain
  150429. */
  150430. setGrainAmount(amount: number): void;
  150431. /**
  150432. * Set grain amount to 0
  150433. */
  150434. disableGrain(): void;
  150435. /**
  150436. * Sets the chromatic aberration amount
  150437. * @param amount amount of chromatic aberration
  150438. */
  150439. setChromaticAberration(amount: number): void;
  150440. /**
  150441. * Sets chromatic aberration amount to 0
  150442. */
  150443. disableChromaticAberration(): void;
  150444. /**
  150445. * Sets the EdgeDistortion amount
  150446. * @param amount amount of EdgeDistortion
  150447. */
  150448. setEdgeDistortion(amount: number): void;
  150449. /**
  150450. * Sets edge distortion to 0
  150451. */
  150452. disableEdgeDistortion(): void;
  150453. /**
  150454. * Sets the FocusDistance amount
  150455. * @param amount amount of FocusDistance
  150456. */
  150457. setFocusDistance(amount: number): void;
  150458. /**
  150459. * Disables depth of field
  150460. */
  150461. disableDepthOfField(): void;
  150462. /**
  150463. * Sets the Aperture amount
  150464. * @param amount amount of Aperture
  150465. */
  150466. setAperture(amount: number): void;
  150467. /**
  150468. * Sets the DarkenOutOfFocus amount
  150469. * @param amount amount of DarkenOutOfFocus
  150470. */
  150471. setDarkenOutOfFocus(amount: number): void;
  150472. private _pentagonBokehIsEnabled;
  150473. /**
  150474. * Creates a pentagon bokeh effect
  150475. */
  150476. enablePentagonBokeh(): void;
  150477. /**
  150478. * Disables the pentagon bokeh effect
  150479. */
  150480. disablePentagonBokeh(): void;
  150481. /**
  150482. * Enables noise blur
  150483. */
  150484. enableNoiseBlur(): void;
  150485. /**
  150486. * Disables noise blur
  150487. */
  150488. disableNoiseBlur(): void;
  150489. /**
  150490. * Sets the HighlightsGain amount
  150491. * @param amount amount of HighlightsGain
  150492. */
  150493. setHighlightsGain(amount: number): void;
  150494. /**
  150495. * Sets the HighlightsThreshold amount
  150496. * @param amount amount of HighlightsThreshold
  150497. */
  150498. setHighlightsThreshold(amount: number): void;
  150499. /**
  150500. * Disables highlights
  150501. */
  150502. disableHighlights(): void;
  150503. /**
  150504. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150505. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150506. */
  150507. dispose(disableDepthRender?: boolean): void;
  150508. private _createChromaticAberrationPostProcess;
  150509. private _createHighlightsPostProcess;
  150510. private _createDepthOfFieldPostProcess;
  150511. private _createGrainTexture;
  150512. }
  150513. }
  150514. declare module BABYLON {
  150515. /** @hidden */
  150516. export var ssao2PixelShader: {
  150517. name: string;
  150518. shader: string;
  150519. };
  150520. }
  150521. declare module BABYLON {
  150522. /** @hidden */
  150523. export var ssaoCombinePixelShader: {
  150524. name: string;
  150525. shader: string;
  150526. };
  150527. }
  150528. declare module BABYLON {
  150529. /**
  150530. * Render pipeline to produce ssao effect
  150531. */
  150532. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150533. /**
  150534. * @ignore
  150535. * The PassPostProcess id in the pipeline that contains the original scene color
  150536. */
  150537. SSAOOriginalSceneColorEffect: string;
  150538. /**
  150539. * @ignore
  150540. * The SSAO PostProcess id in the pipeline
  150541. */
  150542. SSAORenderEffect: string;
  150543. /**
  150544. * @ignore
  150545. * The horizontal blur PostProcess id in the pipeline
  150546. */
  150547. SSAOBlurHRenderEffect: string;
  150548. /**
  150549. * @ignore
  150550. * The vertical blur PostProcess id in the pipeline
  150551. */
  150552. SSAOBlurVRenderEffect: string;
  150553. /**
  150554. * @ignore
  150555. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150556. */
  150557. SSAOCombineRenderEffect: string;
  150558. /**
  150559. * The output strength of the SSAO post-process. Default value is 1.0.
  150560. */
  150561. totalStrength: number;
  150562. /**
  150563. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150564. */
  150565. maxZ: number;
  150566. /**
  150567. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150568. */
  150569. minZAspect: number;
  150570. private _samples;
  150571. /**
  150572. * Number of samples used for the SSAO calculations. Default value is 8
  150573. */
  150574. set samples(n: number);
  150575. get samples(): number;
  150576. private _textureSamples;
  150577. /**
  150578. * Number of samples to use for antialiasing
  150579. */
  150580. set textureSamples(n: number);
  150581. get textureSamples(): number;
  150582. /**
  150583. * Force rendering the geometry through geometry buffer
  150584. */
  150585. private _forceGeometryBuffer;
  150586. /**
  150587. * Ratio object used for SSAO ratio and blur ratio
  150588. */
  150589. private _ratio;
  150590. /**
  150591. * Dynamically generated sphere sampler.
  150592. */
  150593. private _sampleSphere;
  150594. /**
  150595. * Blur filter offsets
  150596. */
  150597. private _samplerOffsets;
  150598. private _expensiveBlur;
  150599. /**
  150600. * If bilateral blur should be used
  150601. */
  150602. set expensiveBlur(b: boolean);
  150603. get expensiveBlur(): boolean;
  150604. /**
  150605. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150606. */
  150607. radius: number;
  150608. /**
  150609. * The base color of the SSAO post-process
  150610. * The final result is "base + ssao" between [0, 1]
  150611. */
  150612. base: number;
  150613. /**
  150614. * Support test.
  150615. */
  150616. static get IsSupported(): boolean;
  150617. private _scene;
  150618. private _randomTexture;
  150619. private _originalColorPostProcess;
  150620. private _ssaoPostProcess;
  150621. private _blurHPostProcess;
  150622. private _blurVPostProcess;
  150623. private _ssaoCombinePostProcess;
  150624. private _prePassRenderer;
  150625. /**
  150626. * Gets active scene
  150627. */
  150628. get scene(): Scene;
  150629. /**
  150630. * @constructor
  150631. * @param name The rendering pipeline name
  150632. * @param scene The scene linked to this pipeline
  150633. * @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 }
  150634. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150635. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150636. */
  150637. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150638. /**
  150639. * Get the class name
  150640. * @returns "SSAO2RenderingPipeline"
  150641. */
  150642. getClassName(): string;
  150643. /**
  150644. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150645. */
  150646. dispose(disableGeometryBufferRenderer?: boolean): void;
  150647. private _createBlurPostProcess;
  150648. /** @hidden */
  150649. _rebuild(): void;
  150650. private _bits;
  150651. private _radicalInverse_VdC;
  150652. private _hammersley;
  150653. private _hemisphereSample_uniform;
  150654. private _generateHemisphere;
  150655. private _getDefinesForSSAO;
  150656. private _createSSAOPostProcess;
  150657. private _createSSAOCombinePostProcess;
  150658. private _createRandomTexture;
  150659. /**
  150660. * Serialize the rendering pipeline (Used when exporting)
  150661. * @returns the serialized object
  150662. */
  150663. serialize(): any;
  150664. /**
  150665. * Parse the serialized pipeline
  150666. * @param source Source pipeline.
  150667. * @param scene The scene to load the pipeline to.
  150668. * @param rootUrl The URL of the serialized pipeline.
  150669. * @returns An instantiated pipeline from the serialized object.
  150670. */
  150671. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150672. /**
  150673. * Sets the required values to the prepass renderer.
  150674. * @param prePassRenderer defines the prepass renderer to setup
  150675. * @returns true if the pre pass is needed.
  150676. */
  150677. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150678. }
  150679. }
  150680. declare module BABYLON {
  150681. /** @hidden */
  150682. export var ssaoPixelShader: {
  150683. name: string;
  150684. shader: string;
  150685. };
  150686. }
  150687. declare module BABYLON {
  150688. /**
  150689. * Render pipeline to produce ssao effect
  150690. */
  150691. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150692. /**
  150693. * @ignore
  150694. * The PassPostProcess id in the pipeline that contains the original scene color
  150695. */
  150696. SSAOOriginalSceneColorEffect: string;
  150697. /**
  150698. * @ignore
  150699. * The SSAO PostProcess id in the pipeline
  150700. */
  150701. SSAORenderEffect: string;
  150702. /**
  150703. * @ignore
  150704. * The horizontal blur PostProcess id in the pipeline
  150705. */
  150706. SSAOBlurHRenderEffect: string;
  150707. /**
  150708. * @ignore
  150709. * The vertical blur PostProcess id in the pipeline
  150710. */
  150711. SSAOBlurVRenderEffect: string;
  150712. /**
  150713. * @ignore
  150714. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150715. */
  150716. SSAOCombineRenderEffect: string;
  150717. /**
  150718. * The output strength of the SSAO post-process. Default value is 1.0.
  150719. */
  150720. totalStrength: number;
  150721. /**
  150722. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150723. */
  150724. radius: number;
  150725. /**
  150726. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150727. * Must not be equal to fallOff and superior to fallOff.
  150728. * Default value is 0.0075
  150729. */
  150730. area: number;
  150731. /**
  150732. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150733. * Must not be equal to area and inferior to area.
  150734. * Default value is 0.000001
  150735. */
  150736. fallOff: number;
  150737. /**
  150738. * The base color of the SSAO post-process
  150739. * The final result is "base + ssao" between [0, 1]
  150740. */
  150741. base: number;
  150742. private _scene;
  150743. private _depthTexture;
  150744. private _randomTexture;
  150745. private _originalColorPostProcess;
  150746. private _ssaoPostProcess;
  150747. private _blurHPostProcess;
  150748. private _blurVPostProcess;
  150749. private _ssaoCombinePostProcess;
  150750. private _firstUpdate;
  150751. /**
  150752. * Gets active scene
  150753. */
  150754. get scene(): Scene;
  150755. /**
  150756. * @constructor
  150757. * @param name - The rendering pipeline name
  150758. * @param scene - The scene linked to this pipeline
  150759. * @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 }
  150760. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150761. */
  150762. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150763. /**
  150764. * Get the class name
  150765. * @returns "SSAORenderingPipeline"
  150766. */
  150767. getClassName(): string;
  150768. /**
  150769. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150770. */
  150771. dispose(disableDepthRender?: boolean): void;
  150772. private _createBlurPostProcess;
  150773. /** @hidden */
  150774. _rebuild(): void;
  150775. private _createSSAOPostProcess;
  150776. private _createSSAOCombinePostProcess;
  150777. private _createRandomTexture;
  150778. }
  150779. }
  150780. declare module BABYLON {
  150781. /** @hidden */
  150782. export var screenSpaceReflectionPixelShader: {
  150783. name: string;
  150784. shader: string;
  150785. };
  150786. }
  150787. declare module BABYLON {
  150788. /**
  150789. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150790. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150791. */
  150792. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150793. /**
  150794. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150795. */
  150796. threshold: number;
  150797. /**
  150798. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150799. */
  150800. strength: number;
  150801. /**
  150802. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150803. */
  150804. reflectionSpecularFalloffExponent: number;
  150805. /**
  150806. * Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Typically in interval [0.1, 1.0]
  150807. */
  150808. step: number;
  150809. /**
  150810. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150811. */
  150812. roughnessFactor: number;
  150813. private _geometryBufferRenderer;
  150814. private _enableSmoothReflections;
  150815. private _reflectionSamples;
  150816. private _smoothSteps;
  150817. /**
  150818. * Gets a string identifying the name of the class
  150819. * @returns "ScreenSpaceReflectionPostProcess" string
  150820. */
  150821. getClassName(): string;
  150822. /**
  150823. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150824. * @param name The name of the effect.
  150825. * @param scene The scene containing the objects to calculate reflections.
  150826. * @param options The required width/height ratio to downsize to before computing the render pass.
  150827. * @param camera The camera to apply the render pass to.
  150828. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150829. * @param engine The engine which the post process will be applied. (default: current engine)
  150830. * @param reusable If the post process can be reused on the same frame. (default: false)
  150831. * @param textureType Type of textures used when performing the post process. (default: 0)
  150832. * @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)
  150833. */
  150834. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150835. /**
  150836. * Gets wether or not smoothing reflections is enabled.
  150837. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150838. */
  150839. get enableSmoothReflections(): boolean;
  150840. /**
  150841. * Sets wether or not smoothing reflections is enabled.
  150842. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150843. */
  150844. set enableSmoothReflections(enabled: boolean);
  150845. /**
  150846. * Gets the number of samples taken while computing reflections. More samples count is high,
  150847. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150848. */
  150849. get reflectionSamples(): number;
  150850. /**
  150851. * Sets the number of samples taken while computing reflections. More samples count is high,
  150852. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150853. */
  150854. set reflectionSamples(samples: number);
  150855. /**
  150856. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150857. * more the post-process will require GPU power and can generate a drop in FPS.
  150858. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150859. */
  150860. get smoothSteps(): number;
  150861. set smoothSteps(steps: number);
  150862. private _updateEffectDefines;
  150863. /** @hidden */
  150864. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150865. }
  150866. }
  150867. declare module BABYLON {
  150868. /** @hidden */
  150869. export var standardPixelShader: {
  150870. name: string;
  150871. shader: string;
  150872. };
  150873. }
  150874. declare module BABYLON {
  150875. /**
  150876. * Standard rendering pipeline
  150877. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150878. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150879. */
  150880. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150881. /**
  150882. * Public members
  150883. */
  150884. /**
  150885. * Post-process which contains the original scene color before the pipeline applies all the effects
  150886. */
  150887. originalPostProcess: Nullable<PostProcess>;
  150888. /**
  150889. * Post-process used to down scale an image x4
  150890. */
  150891. downSampleX4PostProcess: Nullable<PostProcess>;
  150892. /**
  150893. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150894. */
  150895. brightPassPostProcess: Nullable<PostProcess>;
  150896. /**
  150897. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150898. */
  150899. blurHPostProcesses: PostProcess[];
  150900. /**
  150901. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150902. */
  150903. blurVPostProcesses: PostProcess[];
  150904. /**
  150905. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150906. */
  150907. textureAdderPostProcess: Nullable<PostProcess>;
  150908. /**
  150909. * Post-process used to create volumetric lighting effect
  150910. */
  150911. volumetricLightPostProcess: Nullable<PostProcess>;
  150912. /**
  150913. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150914. */
  150915. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150916. /**
  150917. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150918. */
  150919. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150920. /**
  150921. * Post-process used to merge the volumetric light effect and the real scene color
  150922. */
  150923. volumetricLightMergePostProces: Nullable<PostProcess>;
  150924. /**
  150925. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150926. */
  150927. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150928. /**
  150929. * Base post-process used to calculate the average luminance of the final image for HDR
  150930. */
  150931. luminancePostProcess: Nullable<PostProcess>;
  150932. /**
  150933. * Post-processes used to create down sample post-processes in order to get
  150934. * the average luminance of the final image for HDR
  150935. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150936. */
  150937. luminanceDownSamplePostProcesses: PostProcess[];
  150938. /**
  150939. * Post-process used to create a HDR effect (light adaptation)
  150940. */
  150941. hdrPostProcess: Nullable<PostProcess>;
  150942. /**
  150943. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150944. */
  150945. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150946. /**
  150947. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150948. */
  150949. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150950. /**
  150951. * Post-process used to merge the final HDR post-process and the real scene color
  150952. */
  150953. hdrFinalPostProcess: Nullable<PostProcess>;
  150954. /**
  150955. * Post-process used to create a lens flare effect
  150956. */
  150957. lensFlarePostProcess: Nullable<PostProcess>;
  150958. /**
  150959. * Post-process that merges the result of the lens flare post-process and the real scene color
  150960. */
  150961. lensFlareComposePostProcess: Nullable<PostProcess>;
  150962. /**
  150963. * Post-process used to create a motion blur effect
  150964. */
  150965. motionBlurPostProcess: Nullable<PostProcess>;
  150966. /**
  150967. * Post-process used to create a depth of field effect
  150968. */
  150969. depthOfFieldPostProcess: Nullable<PostProcess>;
  150970. /**
  150971. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150972. */
  150973. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150974. /**
  150975. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150976. */
  150977. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150978. /**
  150979. * Represents the brightness threshold in order to configure the illuminated surfaces
  150980. */
  150981. brightThreshold: number;
  150982. /**
  150983. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150984. */
  150985. blurWidth: number;
  150986. /**
  150987. * Sets if the blur for highlighted surfaces must be only horizontal
  150988. */
  150989. horizontalBlur: boolean;
  150990. /**
  150991. * Gets the overall exposure used by the pipeline
  150992. */
  150993. get exposure(): number;
  150994. /**
  150995. * Sets the overall exposure used by the pipeline
  150996. */
  150997. set exposure(value: number);
  150998. /**
  150999. * Texture used typically to simulate "dirty" on camera lens
  151000. */
  151001. lensTexture: Nullable<Texture>;
  151002. /**
  151003. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  151004. */
  151005. volumetricLightCoefficient: number;
  151006. /**
  151007. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  151008. */
  151009. volumetricLightPower: number;
  151010. /**
  151011. * Used the set the blur intensity to smooth the volumetric lights
  151012. */
  151013. volumetricLightBlurScale: number;
  151014. /**
  151015. * Light (spot or directional) used to generate the volumetric lights rays
  151016. * The source light must have a shadow generate so the pipeline can get its
  151017. * depth map
  151018. */
  151019. sourceLight: Nullable<SpotLight | DirectionalLight>;
  151020. /**
  151021. * For eye adaptation, represents the minimum luminance the eye can see
  151022. */
  151023. hdrMinimumLuminance: number;
  151024. /**
  151025. * For eye adaptation, represents the decrease luminance speed
  151026. */
  151027. hdrDecreaseRate: number;
  151028. /**
  151029. * For eye adaptation, represents the increase luminance speed
  151030. */
  151031. hdrIncreaseRate: number;
  151032. /**
  151033. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151034. */
  151035. get hdrAutoExposure(): boolean;
  151036. /**
  151037. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151038. */
  151039. set hdrAutoExposure(value: boolean);
  151040. /**
  151041. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  151042. */
  151043. lensColorTexture: Nullable<Texture>;
  151044. /**
  151045. * The overall strengh for the lens flare effect
  151046. */
  151047. lensFlareStrength: number;
  151048. /**
  151049. * Dispersion coefficient for lens flare ghosts
  151050. */
  151051. lensFlareGhostDispersal: number;
  151052. /**
  151053. * Main lens flare halo width
  151054. */
  151055. lensFlareHaloWidth: number;
  151056. /**
  151057. * Based on the lens distortion effect, defines how much the lens flare result
  151058. * is distorted
  151059. */
  151060. lensFlareDistortionStrength: number;
  151061. /**
  151062. * Configures the blur intensity used for for lens flare (halo)
  151063. */
  151064. lensFlareBlurWidth: number;
  151065. /**
  151066. * Lens star texture must be used to simulate rays on the flares and is available
  151067. * in the documentation
  151068. */
  151069. lensStarTexture: Nullable<Texture>;
  151070. /**
  151071. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  151072. * flare effect by taking account of the dirt texture
  151073. */
  151074. lensFlareDirtTexture: Nullable<Texture>;
  151075. /**
  151076. * Represents the focal length for the depth of field effect
  151077. */
  151078. depthOfFieldDistance: number;
  151079. /**
  151080. * Represents the blur intensity for the blurred part of the depth of field effect
  151081. */
  151082. depthOfFieldBlurWidth: number;
  151083. /**
  151084. * Gets how much the image is blurred by the movement while using the motion blur post-process
  151085. */
  151086. get motionStrength(): number;
  151087. /**
  151088. * Sets how much the image is blurred by the movement while using the motion blur post-process
  151089. */
  151090. set motionStrength(strength: number);
  151091. /**
  151092. * Gets wether or not the motion blur post-process is object based or screen based.
  151093. */
  151094. get objectBasedMotionBlur(): boolean;
  151095. /**
  151096. * Sets wether or not the motion blur post-process should be object based or screen based
  151097. */
  151098. set objectBasedMotionBlur(value: boolean);
  151099. /**
  151100. * List of animations for the pipeline (IAnimatable implementation)
  151101. */
  151102. animations: Animation[];
  151103. /**
  151104. * Private members
  151105. */
  151106. private _scene;
  151107. private _currentDepthOfFieldSource;
  151108. private _basePostProcess;
  151109. private _fixedExposure;
  151110. private _currentExposure;
  151111. private _hdrAutoExposure;
  151112. private _hdrCurrentLuminance;
  151113. private _motionStrength;
  151114. private _isObjectBasedMotionBlur;
  151115. private _floatTextureType;
  151116. private _camerasToBeAttached;
  151117. private _ratio;
  151118. private _bloomEnabled;
  151119. private _depthOfFieldEnabled;
  151120. private _vlsEnabled;
  151121. private _lensFlareEnabled;
  151122. private _hdrEnabled;
  151123. private _motionBlurEnabled;
  151124. private _fxaaEnabled;
  151125. private _screenSpaceReflectionsEnabled;
  151126. private _motionBlurSamples;
  151127. private _volumetricLightStepsCount;
  151128. private _samples;
  151129. /**
  151130. * @ignore
  151131. * Specifies if the bloom pipeline is enabled
  151132. */
  151133. get BloomEnabled(): boolean;
  151134. set BloomEnabled(enabled: boolean);
  151135. /**
  151136. * @ignore
  151137. * Specifies if the depth of field pipeline is enabed
  151138. */
  151139. get DepthOfFieldEnabled(): boolean;
  151140. set DepthOfFieldEnabled(enabled: boolean);
  151141. /**
  151142. * @ignore
  151143. * Specifies if the lens flare pipeline is enabed
  151144. */
  151145. get LensFlareEnabled(): boolean;
  151146. set LensFlareEnabled(enabled: boolean);
  151147. /**
  151148. * @ignore
  151149. * Specifies if the HDR pipeline is enabled
  151150. */
  151151. get HDREnabled(): boolean;
  151152. set HDREnabled(enabled: boolean);
  151153. /**
  151154. * @ignore
  151155. * Specifies if the volumetric lights scattering effect is enabled
  151156. */
  151157. get VLSEnabled(): boolean;
  151158. set VLSEnabled(enabled: boolean);
  151159. /**
  151160. * @ignore
  151161. * Specifies if the motion blur effect is enabled
  151162. */
  151163. get MotionBlurEnabled(): boolean;
  151164. set MotionBlurEnabled(enabled: boolean);
  151165. /**
  151166. * Specifies if anti-aliasing is enabled
  151167. */
  151168. get fxaaEnabled(): boolean;
  151169. set fxaaEnabled(enabled: boolean);
  151170. /**
  151171. * Specifies if screen space reflections are enabled.
  151172. */
  151173. get screenSpaceReflectionsEnabled(): boolean;
  151174. set screenSpaceReflectionsEnabled(enabled: boolean);
  151175. /**
  151176. * Specifies the number of steps used to calculate the volumetric lights
  151177. * Typically in interval [50, 200]
  151178. */
  151179. get volumetricLightStepsCount(): number;
  151180. set volumetricLightStepsCount(count: number);
  151181. /**
  151182. * Specifies the number of samples used for the motion blur effect
  151183. * Typically in interval [16, 64]
  151184. */
  151185. get motionBlurSamples(): number;
  151186. set motionBlurSamples(samples: number);
  151187. /**
  151188. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151189. */
  151190. get samples(): number;
  151191. set samples(sampleCount: number);
  151192. /**
  151193. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151194. * @constructor
  151195. * @param name The rendering pipeline name
  151196. * @param scene The scene linked to this pipeline
  151197. * @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)
  151198. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151199. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151200. */
  151201. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151202. private _buildPipeline;
  151203. private _createDownSampleX4PostProcess;
  151204. private _createBrightPassPostProcess;
  151205. private _createBlurPostProcesses;
  151206. private _createTextureAdderPostProcess;
  151207. private _createVolumetricLightPostProcess;
  151208. private _createLuminancePostProcesses;
  151209. private _createHdrPostProcess;
  151210. private _createLensFlarePostProcess;
  151211. private _createDepthOfFieldPostProcess;
  151212. private _createMotionBlurPostProcess;
  151213. private _getDepthTexture;
  151214. private _disposePostProcesses;
  151215. /**
  151216. * Dispose of the pipeline and stop all post processes
  151217. */
  151218. dispose(): void;
  151219. /**
  151220. * Serialize the rendering pipeline (Used when exporting)
  151221. * @returns the serialized object
  151222. */
  151223. serialize(): any;
  151224. /**
  151225. * Parse the serialized pipeline
  151226. * @param source Source pipeline.
  151227. * @param scene The scene to load the pipeline to.
  151228. * @param rootUrl The URL of the serialized pipeline.
  151229. * @returns An instantiated pipeline from the serialized object.
  151230. */
  151231. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151232. /**
  151233. * Luminance steps
  151234. */
  151235. static LuminanceSteps: number;
  151236. }
  151237. }
  151238. declare module BABYLON {
  151239. /** @hidden */
  151240. export var stereoscopicInterlacePixelShader: {
  151241. name: string;
  151242. shader: string;
  151243. };
  151244. }
  151245. declare module BABYLON {
  151246. /**
  151247. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151248. */
  151249. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151250. private _stepSize;
  151251. private _passedProcess;
  151252. /**
  151253. * Gets a string identifying the name of the class
  151254. * @returns "StereoscopicInterlacePostProcessI" string
  151255. */
  151256. getClassName(): string;
  151257. /**
  151258. * Initializes a StereoscopicInterlacePostProcessI
  151259. * @param name The name of the effect.
  151260. * @param rigCameras The rig cameras to be appled to the post process
  151261. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151262. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151263. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151264. * @param engine The engine which the post process will be applied. (default: current engine)
  151265. * @param reusable If the post process can be reused on the same frame. (default: false)
  151266. */
  151267. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151268. }
  151269. /**
  151270. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151271. */
  151272. export class StereoscopicInterlacePostProcess extends PostProcess {
  151273. private _stepSize;
  151274. private _passedProcess;
  151275. /**
  151276. * Gets a string identifying the name of the class
  151277. * @returns "StereoscopicInterlacePostProcess" string
  151278. */
  151279. getClassName(): string;
  151280. /**
  151281. * Initializes a StereoscopicInterlacePostProcess
  151282. * @param name The name of the effect.
  151283. * @param rigCameras The rig cameras to be appled to the post process
  151284. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151285. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151286. * @param engine The engine which the post process will be applied. (default: current engine)
  151287. * @param reusable If the post process can be reused on the same frame. (default: false)
  151288. */
  151289. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151290. }
  151291. }
  151292. declare module BABYLON {
  151293. /** @hidden */
  151294. export var tonemapPixelShader: {
  151295. name: string;
  151296. shader: string;
  151297. };
  151298. }
  151299. declare module BABYLON {
  151300. /** Defines operator used for tonemapping */
  151301. export enum TonemappingOperator {
  151302. /** Hable */
  151303. Hable = 0,
  151304. /** Reinhard */
  151305. Reinhard = 1,
  151306. /** HejiDawson */
  151307. HejiDawson = 2,
  151308. /** Photographic */
  151309. Photographic = 3
  151310. }
  151311. /**
  151312. * Defines a post process to apply tone mapping
  151313. */
  151314. export class TonemapPostProcess extends PostProcess {
  151315. private _operator;
  151316. /** Defines the required exposure adjustement */
  151317. exposureAdjustment: number;
  151318. /**
  151319. * Gets a string identifying the name of the class
  151320. * @returns "TonemapPostProcess" string
  151321. */
  151322. getClassName(): string;
  151323. /**
  151324. * Creates a new TonemapPostProcess
  151325. * @param name defines the name of the postprocess
  151326. * @param _operator defines the operator to use
  151327. * @param exposureAdjustment defines the required exposure adjustement
  151328. * @param camera defines the camera to use (can be null)
  151329. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151330. * @param engine defines the hosting engine (can be ignore if camera is set)
  151331. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151332. */
  151333. constructor(name: string, _operator: TonemappingOperator,
  151334. /** Defines the required exposure adjustement */
  151335. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151336. }
  151337. }
  151338. declare module BABYLON {
  151339. /** @hidden */
  151340. export var volumetricLightScatteringPixelShader: {
  151341. name: string;
  151342. shader: string;
  151343. };
  151344. }
  151345. declare module BABYLON {
  151346. /** @hidden */
  151347. export var volumetricLightScatteringPassVertexShader: {
  151348. name: string;
  151349. shader: string;
  151350. };
  151351. }
  151352. declare module BABYLON {
  151353. /** @hidden */
  151354. export var volumetricLightScatteringPassPixelShader: {
  151355. name: string;
  151356. shader: string;
  151357. };
  151358. }
  151359. declare module BABYLON {
  151360. /**
  151361. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151362. */
  151363. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151364. private _volumetricLightScatteringPass;
  151365. private _volumetricLightScatteringRTT;
  151366. private _viewPort;
  151367. private _screenCoordinates;
  151368. private _cachedDefines;
  151369. /**
  151370. * If not undefined, the mesh position is computed from the attached node position
  151371. */
  151372. attachedNode: {
  151373. position: Vector3;
  151374. };
  151375. /**
  151376. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151377. */
  151378. customMeshPosition: Vector3;
  151379. /**
  151380. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151381. */
  151382. useCustomMeshPosition: boolean;
  151383. /**
  151384. * If the post-process should inverse the light scattering direction
  151385. */
  151386. invert: boolean;
  151387. /**
  151388. * The internal mesh used by the post-process
  151389. */
  151390. mesh: Mesh;
  151391. /**
  151392. * @hidden
  151393. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151394. */
  151395. get useDiffuseColor(): boolean;
  151396. set useDiffuseColor(useDiffuseColor: boolean);
  151397. /**
  151398. * Array containing the excluded meshes not rendered in the internal pass
  151399. */
  151400. excludedMeshes: AbstractMesh[];
  151401. /**
  151402. * Controls the overall intensity of the post-process
  151403. */
  151404. exposure: number;
  151405. /**
  151406. * Dissipates each sample's contribution in range [0, 1]
  151407. */
  151408. decay: number;
  151409. /**
  151410. * Controls the overall intensity of each sample
  151411. */
  151412. weight: number;
  151413. /**
  151414. * Controls the density of each sample
  151415. */
  151416. density: number;
  151417. /**
  151418. * @constructor
  151419. * @param name The post-process name
  151420. * @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)
  151421. * @param camera The camera that the post-process will be attached to
  151422. * @param mesh The mesh used to create the light scattering
  151423. * @param samples The post-process quality, default 100
  151424. * @param samplingModeThe post-process filtering mode
  151425. * @param engine The babylon engine
  151426. * @param reusable If the post-process is reusable
  151427. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151428. */
  151429. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151430. /**
  151431. * Returns the string "VolumetricLightScatteringPostProcess"
  151432. * @returns "VolumetricLightScatteringPostProcess"
  151433. */
  151434. getClassName(): string;
  151435. private _isReady;
  151436. /**
  151437. * Sets the new light position for light scattering effect
  151438. * @param position The new custom light position
  151439. */
  151440. setCustomMeshPosition(position: Vector3): void;
  151441. /**
  151442. * Returns the light position for light scattering effect
  151443. * @return Vector3 The custom light position
  151444. */
  151445. getCustomMeshPosition(): Vector3;
  151446. /**
  151447. * Disposes the internal assets and detaches the post-process from the camera
  151448. */
  151449. dispose(camera: Camera): void;
  151450. /**
  151451. * Returns the render target texture used by the post-process
  151452. * @return the render target texture used by the post-process
  151453. */
  151454. getPass(): RenderTargetTexture;
  151455. private _meshExcluded;
  151456. private _createPass;
  151457. private _updateMeshScreenCoordinates;
  151458. /**
  151459. * Creates a default mesh for the Volumeric Light Scattering post-process
  151460. * @param name The mesh name
  151461. * @param scene The scene where to create the mesh
  151462. * @return the default mesh
  151463. */
  151464. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151465. }
  151466. }
  151467. declare module BABYLON {
  151468. /** @hidden */
  151469. export var screenSpaceCurvaturePixelShader: {
  151470. name: string;
  151471. shader: string;
  151472. };
  151473. }
  151474. declare module BABYLON {
  151475. /**
  151476. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151477. */
  151478. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151479. /**
  151480. * Defines how much ridge the curvature effect displays.
  151481. */
  151482. ridge: number;
  151483. /**
  151484. * Defines how much valley the curvature effect displays.
  151485. */
  151486. valley: number;
  151487. private _geometryBufferRenderer;
  151488. /**
  151489. * Gets a string identifying the name of the class
  151490. * @returns "ScreenSpaceCurvaturePostProcess" string
  151491. */
  151492. getClassName(): string;
  151493. /**
  151494. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151495. * @param name The name of the effect.
  151496. * @param scene The scene containing the objects to blur according to their velocity.
  151497. * @param options The required width/height ratio to downsize to before computing the render pass.
  151498. * @param camera The camera to apply the render pass to.
  151499. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151500. * @param engine The engine which the post process will be applied. (default: current engine)
  151501. * @param reusable If the post process can be reused on the same frame. (default: false)
  151502. * @param textureType Type of textures used when performing the post process. (default: 0)
  151503. * @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)
  151504. */
  151505. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151506. /**
  151507. * Support test.
  151508. */
  151509. static get IsSupported(): boolean;
  151510. /** @hidden */
  151511. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151512. }
  151513. }
  151514. declare module BABYLON {
  151515. interface Scene {
  151516. /** @hidden (Backing field) */
  151517. _boundingBoxRenderer: BoundingBoxRenderer;
  151518. /** @hidden (Backing field) */
  151519. _forceShowBoundingBoxes: boolean;
  151520. /**
  151521. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151522. */
  151523. forceShowBoundingBoxes: boolean;
  151524. /**
  151525. * Gets the bounding box renderer associated with the scene
  151526. * @returns a BoundingBoxRenderer
  151527. */
  151528. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151529. }
  151530. interface AbstractMesh {
  151531. /** @hidden (Backing field) */
  151532. _showBoundingBox: boolean;
  151533. /**
  151534. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151535. */
  151536. showBoundingBox: boolean;
  151537. }
  151538. /**
  151539. * Component responsible of rendering the bounding box of the meshes in a scene.
  151540. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151541. */
  151542. export class BoundingBoxRenderer implements ISceneComponent {
  151543. /**
  151544. * The component name helpfull to identify the component in the list of scene components.
  151545. */
  151546. readonly name: string;
  151547. /**
  151548. * The scene the component belongs to.
  151549. */
  151550. scene: Scene;
  151551. /**
  151552. * Color of the bounding box lines placed in front of an object
  151553. */
  151554. frontColor: Color3;
  151555. /**
  151556. * Color of the bounding box lines placed behind an object
  151557. */
  151558. backColor: Color3;
  151559. /**
  151560. * Defines if the renderer should show the back lines or not
  151561. */
  151562. showBackLines: boolean;
  151563. /**
  151564. * Observable raised before rendering a bounding box
  151565. */
  151566. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151567. /**
  151568. * Observable raised after rendering a bounding box
  151569. */
  151570. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151571. /**
  151572. * @hidden
  151573. */
  151574. renderList: SmartArray<BoundingBox>;
  151575. private _colorShader;
  151576. private _vertexBuffers;
  151577. private _indexBuffer;
  151578. private _fillIndexBuffer;
  151579. private _fillIndexData;
  151580. /**
  151581. * Instantiates a new bounding box renderer in a scene.
  151582. * @param scene the scene the renderer renders in
  151583. */
  151584. constructor(scene: Scene);
  151585. /**
  151586. * Registers the component in a given scene
  151587. */
  151588. register(): void;
  151589. private _evaluateSubMesh;
  151590. private _activeMesh;
  151591. private _prepareRessources;
  151592. private _createIndexBuffer;
  151593. /**
  151594. * Rebuilds the elements related to this component in case of
  151595. * context lost for instance.
  151596. */
  151597. rebuild(): void;
  151598. /**
  151599. * @hidden
  151600. */
  151601. reset(): void;
  151602. /**
  151603. * Render the bounding boxes of a specific rendering group
  151604. * @param renderingGroupId defines the rendering group to render
  151605. */
  151606. render(renderingGroupId: number): void;
  151607. /**
  151608. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151609. * @param mesh Define the mesh to render the occlusion bounding box for
  151610. */
  151611. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151612. /**
  151613. * Dispose and release the resources attached to this renderer.
  151614. */
  151615. dispose(): void;
  151616. }
  151617. }
  151618. declare module BABYLON {
  151619. interface Scene {
  151620. /** @hidden (Backing field) */
  151621. _depthRenderer: {
  151622. [id: string]: DepthRenderer;
  151623. };
  151624. /**
  151625. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151626. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151627. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151628. * @returns the created depth renderer
  151629. */
  151630. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151631. /**
  151632. * Disables a depth renderer for a given camera
  151633. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151634. */
  151635. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151636. }
  151637. /**
  151638. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151639. * in several rendering techniques.
  151640. */
  151641. export class DepthRendererSceneComponent implements ISceneComponent {
  151642. /**
  151643. * The component name helpfull to identify the component in the list of scene components.
  151644. */
  151645. readonly name: string;
  151646. /**
  151647. * The scene the component belongs to.
  151648. */
  151649. scene: Scene;
  151650. /**
  151651. * Creates a new instance of the component for the given scene
  151652. * @param scene Defines the scene to register the component in
  151653. */
  151654. constructor(scene: Scene);
  151655. /**
  151656. * Registers the component in a given scene
  151657. */
  151658. register(): void;
  151659. /**
  151660. * Rebuilds the elements related to this component in case of
  151661. * context lost for instance.
  151662. */
  151663. rebuild(): void;
  151664. /**
  151665. * Disposes the component and the associated ressources
  151666. */
  151667. dispose(): void;
  151668. private _gatherRenderTargets;
  151669. private _gatherActiveCameraRenderTargets;
  151670. }
  151671. }
  151672. declare module BABYLON {
  151673. interface AbstractScene {
  151674. /** @hidden (Backing field) */
  151675. _prePassRenderer: Nullable<PrePassRenderer>;
  151676. /**
  151677. * Gets or Sets the current prepass renderer associated to the scene.
  151678. */
  151679. prePassRenderer: Nullable<PrePassRenderer>;
  151680. /**
  151681. * Enables the prepass and associates it with the scene
  151682. * @returns the PrePassRenderer
  151683. */
  151684. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151685. /**
  151686. * Disables the prepass associated with the scene
  151687. */
  151688. disablePrePassRenderer(): void;
  151689. }
  151690. /**
  151691. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151692. * in several rendering techniques.
  151693. */
  151694. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151695. /**
  151696. * The component name helpful to identify the component in the list of scene components.
  151697. */
  151698. readonly name: string;
  151699. /**
  151700. * The scene the component belongs to.
  151701. */
  151702. scene: Scene;
  151703. /**
  151704. * Creates a new instance of the component for the given scene
  151705. * @param scene Defines the scene to register the component in
  151706. */
  151707. constructor(scene: Scene);
  151708. /**
  151709. * Registers the component in a given scene
  151710. */
  151711. register(): void;
  151712. private _beforeCameraDraw;
  151713. private _afterCameraDraw;
  151714. private _beforeClearStage;
  151715. /**
  151716. * Serializes the component data to the specified json object
  151717. * @param serializationObject The object to serialize to
  151718. */
  151719. serialize(serializationObject: any): void;
  151720. /**
  151721. * Adds all the elements from the container to the scene
  151722. * @param container the container holding the elements
  151723. */
  151724. addFromContainer(container: AbstractScene): void;
  151725. /**
  151726. * Removes all the elements in the container from the scene
  151727. * @param container contains the elements to remove
  151728. * @param dispose if the removed element should be disposed (default: false)
  151729. */
  151730. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151731. /**
  151732. * Rebuilds the elements related to this component in case of
  151733. * context lost for instance.
  151734. */
  151735. rebuild(): void;
  151736. /**
  151737. * Disposes the component and the associated ressources
  151738. */
  151739. dispose(): void;
  151740. }
  151741. }
  151742. declare module BABYLON {
  151743. /** @hidden */
  151744. export var outlinePixelShader: {
  151745. name: string;
  151746. shader: string;
  151747. };
  151748. }
  151749. declare module BABYLON {
  151750. /** @hidden */
  151751. export var outlineVertexShader: {
  151752. name: string;
  151753. shader: string;
  151754. };
  151755. }
  151756. declare module BABYLON {
  151757. interface Scene {
  151758. /** @hidden */
  151759. _outlineRenderer: OutlineRenderer;
  151760. /**
  151761. * Gets the outline renderer associated with the scene
  151762. * @returns a OutlineRenderer
  151763. */
  151764. getOutlineRenderer(): OutlineRenderer;
  151765. }
  151766. interface AbstractMesh {
  151767. /** @hidden (Backing field) */
  151768. _renderOutline: boolean;
  151769. /**
  151770. * Gets or sets a boolean indicating if the outline must be rendered as well
  151771. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151772. */
  151773. renderOutline: boolean;
  151774. /** @hidden (Backing field) */
  151775. _renderOverlay: boolean;
  151776. /**
  151777. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151778. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151779. */
  151780. renderOverlay: boolean;
  151781. }
  151782. /**
  151783. * This class is responsible to draw bothe outline/overlay of meshes.
  151784. * It should not be used directly but through the available method on mesh.
  151785. */
  151786. export class OutlineRenderer implements ISceneComponent {
  151787. /**
  151788. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151789. */
  151790. private static _StencilReference;
  151791. /**
  151792. * The name of the component. Each component must have a unique name.
  151793. */
  151794. name: string;
  151795. /**
  151796. * The scene the component belongs to.
  151797. */
  151798. scene: Scene;
  151799. /**
  151800. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151801. */
  151802. zOffset: number;
  151803. private _engine;
  151804. private _effect;
  151805. private _cachedDefines;
  151806. private _savedDepthWrite;
  151807. /**
  151808. * Instantiates a new outline renderer. (There could be only one per scene).
  151809. * @param scene Defines the scene it belongs to
  151810. */
  151811. constructor(scene: Scene);
  151812. /**
  151813. * Register the component to one instance of a scene.
  151814. */
  151815. register(): void;
  151816. /**
  151817. * Rebuilds the elements related to this component in case of
  151818. * context lost for instance.
  151819. */
  151820. rebuild(): void;
  151821. /**
  151822. * Disposes the component and the associated ressources.
  151823. */
  151824. dispose(): void;
  151825. /**
  151826. * Renders the outline in the canvas.
  151827. * @param subMesh Defines the sumesh to render
  151828. * @param batch Defines the batch of meshes in case of instances
  151829. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151830. */
  151831. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151832. /**
  151833. * Returns whether or not the outline renderer is ready for a given submesh.
  151834. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151835. * @param subMesh Defines the submesh to check readyness for
  151836. * @param useInstances Defines wheter wee are trying to render instances or not
  151837. * @returns true if ready otherwise false
  151838. */
  151839. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151840. private _beforeRenderingMesh;
  151841. private _afterRenderingMesh;
  151842. }
  151843. }
  151844. declare module BABYLON {
  151845. /**
  151846. * Defines the basic options interface of a Sprite Frame Source Size.
  151847. */
  151848. export interface ISpriteJSONSpriteSourceSize {
  151849. /**
  151850. * number of the original width of the Frame
  151851. */
  151852. w: number;
  151853. /**
  151854. * number of the original height of the Frame
  151855. */
  151856. h: number;
  151857. }
  151858. /**
  151859. * Defines the basic options interface of a Sprite Frame Data.
  151860. */
  151861. export interface ISpriteJSONSpriteFrameData {
  151862. /**
  151863. * number of the x offset of the Frame
  151864. */
  151865. x: number;
  151866. /**
  151867. * number of the y offset of the Frame
  151868. */
  151869. y: number;
  151870. /**
  151871. * number of the width of the Frame
  151872. */
  151873. w: number;
  151874. /**
  151875. * number of the height of the Frame
  151876. */
  151877. h: number;
  151878. }
  151879. /**
  151880. * Defines the basic options interface of a JSON Sprite.
  151881. */
  151882. export interface ISpriteJSONSprite {
  151883. /**
  151884. * string name of the Frame
  151885. */
  151886. filename: string;
  151887. /**
  151888. * ISpriteJSONSpriteFrame basic object of the frame data
  151889. */
  151890. frame: ISpriteJSONSpriteFrameData;
  151891. /**
  151892. * boolean to flag is the frame was rotated.
  151893. */
  151894. rotated: boolean;
  151895. /**
  151896. * boolean to flag is the frame was trimmed.
  151897. */
  151898. trimmed: boolean;
  151899. /**
  151900. * ISpriteJSONSpriteFrame basic object of the source data
  151901. */
  151902. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151903. /**
  151904. * ISpriteJSONSpriteFrame basic object of the source data
  151905. */
  151906. sourceSize: ISpriteJSONSpriteSourceSize;
  151907. }
  151908. /**
  151909. * Defines the basic options interface of a JSON atlas.
  151910. */
  151911. export interface ISpriteJSONAtlas {
  151912. /**
  151913. * Array of objects that contain the frame data.
  151914. */
  151915. frames: Array<ISpriteJSONSprite>;
  151916. /**
  151917. * object basic object containing the sprite meta data.
  151918. */
  151919. meta?: object;
  151920. }
  151921. }
  151922. declare module BABYLON {
  151923. /** @hidden */
  151924. export var spriteMapPixelShader: {
  151925. name: string;
  151926. shader: string;
  151927. };
  151928. }
  151929. declare module BABYLON {
  151930. /** @hidden */
  151931. export var spriteMapVertexShader: {
  151932. name: string;
  151933. shader: string;
  151934. };
  151935. }
  151936. declare module BABYLON {
  151937. /**
  151938. * Defines the basic options interface of a SpriteMap
  151939. */
  151940. export interface ISpriteMapOptions {
  151941. /**
  151942. * Vector2 of the number of cells in the grid.
  151943. */
  151944. stageSize?: Vector2;
  151945. /**
  151946. * Vector2 of the size of the output plane in World Units.
  151947. */
  151948. outputSize?: Vector2;
  151949. /**
  151950. * Vector3 of the position of the output plane in World Units.
  151951. */
  151952. outputPosition?: Vector3;
  151953. /**
  151954. * Vector3 of the rotation of the output plane.
  151955. */
  151956. outputRotation?: Vector3;
  151957. /**
  151958. * number of layers that the system will reserve in resources.
  151959. */
  151960. layerCount?: number;
  151961. /**
  151962. * number of max animation frames a single cell will reserve in resources.
  151963. */
  151964. maxAnimationFrames?: number;
  151965. /**
  151966. * number cell index of the base tile when the system compiles.
  151967. */
  151968. baseTile?: number;
  151969. /**
  151970. * boolean flip the sprite after its been repositioned by the framing data.
  151971. */
  151972. flipU?: boolean;
  151973. /**
  151974. * Vector3 scalar of the global RGB values of the SpriteMap.
  151975. */
  151976. colorMultiply?: Vector3;
  151977. }
  151978. /**
  151979. * Defines the IDisposable interface in order to be cleanable from resources.
  151980. */
  151981. export interface ISpriteMap extends IDisposable {
  151982. /**
  151983. * String name of the SpriteMap.
  151984. */
  151985. name: string;
  151986. /**
  151987. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151988. */
  151989. atlasJSON: ISpriteJSONAtlas;
  151990. /**
  151991. * Texture of the SpriteMap.
  151992. */
  151993. spriteSheet: Texture;
  151994. /**
  151995. * The parameters to initialize the SpriteMap with.
  151996. */
  151997. options: ISpriteMapOptions;
  151998. }
  151999. /**
  152000. * Class used to manage a grid restricted sprite deployment on an Output plane.
  152001. */
  152002. export class SpriteMap implements ISpriteMap {
  152003. /** The Name of the spriteMap */
  152004. name: string;
  152005. /** The JSON file with the frame and meta data */
  152006. atlasJSON: ISpriteJSONAtlas;
  152007. /** The systems Sprite Sheet Texture */
  152008. spriteSheet: Texture;
  152009. /** Arguments passed with the Constructor */
  152010. options: ISpriteMapOptions;
  152011. /** Public Sprite Storage array, parsed from atlasJSON */
  152012. sprites: Array<ISpriteJSONSprite>;
  152013. /** Returns the Number of Sprites in the System */
  152014. get spriteCount(): number;
  152015. /** Returns the Position of Output Plane*/
  152016. get position(): Vector3;
  152017. /** Returns the Position of Output Plane*/
  152018. set position(v: Vector3);
  152019. /** Returns the Rotation of Output Plane*/
  152020. get rotation(): Vector3;
  152021. /** Returns the Rotation of Output Plane*/
  152022. set rotation(v: Vector3);
  152023. /** Sets the AnimationMap*/
  152024. get animationMap(): RawTexture;
  152025. /** Sets the AnimationMap*/
  152026. set animationMap(v: RawTexture);
  152027. /** Scene that the SpriteMap was created in */
  152028. private _scene;
  152029. /** Texture Buffer of Float32 that holds tile frame data*/
  152030. private _frameMap;
  152031. /** Texture Buffers of Float32 that holds tileMap data*/
  152032. private _tileMaps;
  152033. /** Texture Buffer of Float32 that holds Animation Data*/
  152034. private _animationMap;
  152035. /** Custom ShaderMaterial Central to the System*/
  152036. private _material;
  152037. /** Custom ShaderMaterial Central to the System*/
  152038. private _output;
  152039. /** Systems Time Ticker*/
  152040. private _time;
  152041. /**
  152042. * Creates a new SpriteMap
  152043. * @param name defines the SpriteMaps Name
  152044. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  152045. * @param spriteSheet is the Texture that the Sprites are on.
  152046. * @param options a basic deployment configuration
  152047. * @param scene The Scene that the map is deployed on
  152048. */
  152049. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  152050. /**
  152051. * Returns tileID location
  152052. * @returns Vector2 the cell position ID
  152053. */
  152054. getTileID(): Vector2;
  152055. /**
  152056. * Gets the UV location of the mouse over the SpriteMap.
  152057. * @returns Vector2 the UV position of the mouse interaction
  152058. */
  152059. getMousePosition(): Vector2;
  152060. /**
  152061. * Creates the "frame" texture Buffer
  152062. * -------------------------------------
  152063. * Structure of frames
  152064. * "filename": "Falling-Water-2.png",
  152065. * "frame": {"x":69,"y":103,"w":24,"h":32},
  152066. * "rotated": true,
  152067. * "trimmed": true,
  152068. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  152069. * "sourceSize": {"w":32,"h":32}
  152070. * @returns RawTexture of the frameMap
  152071. */
  152072. private _createFrameBuffer;
  152073. /**
  152074. * Creates the tileMap texture Buffer
  152075. * @param buffer normally and array of numbers, or a false to generate from scratch
  152076. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  152077. * @returns RawTexture of the tileMap
  152078. */
  152079. private _createTileBuffer;
  152080. /**
  152081. * Modifies the data of the tileMaps
  152082. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  152083. * @param pos is the iVector2 Coordinates of the Tile
  152084. * @param tile The SpriteIndex of the new Tile
  152085. */
  152086. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  152087. /**
  152088. * Creates the animationMap texture Buffer
  152089. * @param buffer normally and array of numbers, or a false to generate from scratch
  152090. * @returns RawTexture of the animationMap
  152091. */
  152092. private _createTileAnimationBuffer;
  152093. /**
  152094. * Modifies the data of the animationMap
  152095. * @param cellID is the Index of the Sprite
  152096. * @param _frame is the target Animation frame
  152097. * @param toCell is the Target Index of the next frame of the animation
  152098. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  152099. * @param speed is a global scalar of the time variable on the map.
  152100. */
  152101. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  152102. /**
  152103. * Exports the .tilemaps file
  152104. */
  152105. saveTileMaps(): void;
  152106. /**
  152107. * Imports the .tilemaps file
  152108. * @param url of the .tilemaps file
  152109. */
  152110. loadTileMaps(url: string): void;
  152111. /**
  152112. * Release associated resources
  152113. */
  152114. dispose(): void;
  152115. }
  152116. }
  152117. declare module BABYLON {
  152118. /**
  152119. * Class used to manage multiple sprites of different sizes on the same spritesheet
  152120. * @see https://doc.babylonjs.com/babylon101/sprites
  152121. */
  152122. export class SpritePackedManager extends SpriteManager {
  152123. /** defines the packed manager's name */
  152124. name: string;
  152125. /**
  152126. * Creates a new sprite manager from a packed sprite sheet
  152127. * @param name defines the manager's name
  152128. * @param imgUrl defines the sprite sheet url
  152129. * @param capacity defines the maximum allowed number of sprites
  152130. * @param scene defines the hosting scene
  152131. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  152132. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  152133. * @param samplingMode defines the smapling mode to use with spritesheet
  152134. * @param fromPacked set to true; do not alter
  152135. */
  152136. constructor(
  152137. /** defines the packed manager's name */
  152138. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  152139. }
  152140. }
  152141. declare module BABYLON {
  152142. /**
  152143. * Defines the list of states available for a task inside a AssetsManager
  152144. */
  152145. export enum AssetTaskState {
  152146. /**
  152147. * Initialization
  152148. */
  152149. INIT = 0,
  152150. /**
  152151. * Running
  152152. */
  152153. RUNNING = 1,
  152154. /**
  152155. * Done
  152156. */
  152157. DONE = 2,
  152158. /**
  152159. * Error
  152160. */
  152161. ERROR = 3
  152162. }
  152163. /**
  152164. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  152165. */
  152166. export abstract class AbstractAssetTask {
  152167. /**
  152168. * Task name
  152169. */ name: string;
  152170. /**
  152171. * Callback called when the task is successful
  152172. */
  152173. onSuccess: (task: any) => void;
  152174. /**
  152175. * Callback called when the task is not successful
  152176. */
  152177. onError: (task: any, message?: string, exception?: any) => void;
  152178. /**
  152179. * Creates a new AssetsManager
  152180. * @param name defines the name of the task
  152181. */
  152182. constructor(
  152183. /**
  152184. * Task name
  152185. */ name: string);
  152186. private _isCompleted;
  152187. private _taskState;
  152188. private _errorObject;
  152189. /**
  152190. * Get if the task is completed
  152191. */
  152192. get isCompleted(): boolean;
  152193. /**
  152194. * Gets the current state of the task
  152195. */
  152196. get taskState(): AssetTaskState;
  152197. /**
  152198. * Gets the current error object (if task is in error)
  152199. */
  152200. get errorObject(): {
  152201. message?: string;
  152202. exception?: any;
  152203. };
  152204. /**
  152205. * Internal only
  152206. * @hidden
  152207. */
  152208. _setErrorObject(message?: string, exception?: any): void;
  152209. /**
  152210. * Execute the current task
  152211. * @param scene defines the scene where you want your assets to be loaded
  152212. * @param onSuccess is a callback called when the task is successfully executed
  152213. * @param onError is a callback called if an error occurs
  152214. */
  152215. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152216. /**
  152217. * Execute the current task
  152218. * @param scene defines the scene where you want your assets to be loaded
  152219. * @param onSuccess is a callback called when the task is successfully executed
  152220. * @param onError is a callback called if an error occurs
  152221. */
  152222. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152223. /**
  152224. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152225. * This can be used with failed tasks that have the reason for failure fixed.
  152226. */
  152227. reset(): void;
  152228. private onErrorCallback;
  152229. private onDoneCallback;
  152230. }
  152231. /**
  152232. * Define the interface used by progress events raised during assets loading
  152233. */
  152234. export interface IAssetsProgressEvent {
  152235. /**
  152236. * Defines the number of remaining tasks to process
  152237. */
  152238. remainingCount: number;
  152239. /**
  152240. * Defines the total number of tasks
  152241. */
  152242. totalCount: number;
  152243. /**
  152244. * Defines the task that was just processed
  152245. */
  152246. task: AbstractAssetTask;
  152247. }
  152248. /**
  152249. * Class used to share progress information about assets loading
  152250. */
  152251. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152252. /**
  152253. * Defines the number of remaining tasks to process
  152254. */
  152255. remainingCount: number;
  152256. /**
  152257. * Defines the total number of tasks
  152258. */
  152259. totalCount: number;
  152260. /**
  152261. * Defines the task that was just processed
  152262. */
  152263. task: AbstractAssetTask;
  152264. /**
  152265. * Creates a AssetsProgressEvent
  152266. * @param remainingCount defines the number of remaining tasks to process
  152267. * @param totalCount defines the total number of tasks
  152268. * @param task defines the task that was just processed
  152269. */
  152270. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152271. }
  152272. /**
  152273. * Define a task used by AssetsManager to load assets into a container
  152274. */
  152275. export class ContainerAssetTask extends AbstractAssetTask {
  152276. /**
  152277. * Defines the name of the task
  152278. */
  152279. name: string;
  152280. /**
  152281. * Defines the list of mesh's names you want to load
  152282. */
  152283. meshesNames: any;
  152284. /**
  152285. * Defines the root url to use as a base to load your meshes and associated resources
  152286. */
  152287. rootUrl: string;
  152288. /**
  152289. * Defines the filename or File of the scene to load from
  152290. */
  152291. sceneFilename: string | File;
  152292. /**
  152293. * Get the loaded asset container
  152294. */
  152295. loadedContainer: AssetContainer;
  152296. /**
  152297. * Gets the list of loaded meshes
  152298. */
  152299. loadedMeshes: Array<AbstractMesh>;
  152300. /**
  152301. * Gets the list of loaded particle systems
  152302. */
  152303. loadedParticleSystems: Array<IParticleSystem>;
  152304. /**
  152305. * Gets the list of loaded skeletons
  152306. */
  152307. loadedSkeletons: Array<Skeleton>;
  152308. /**
  152309. * Gets the list of loaded animation groups
  152310. */
  152311. loadedAnimationGroups: Array<AnimationGroup>;
  152312. /**
  152313. * Callback called when the task is successful
  152314. */
  152315. onSuccess: (task: ContainerAssetTask) => void;
  152316. /**
  152317. * Callback called when the task is successful
  152318. */
  152319. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152320. /**
  152321. * Creates a new ContainerAssetTask
  152322. * @param name defines the name of the task
  152323. * @param meshesNames defines the list of mesh's names you want to load
  152324. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152325. * @param sceneFilename defines the filename or File of the scene to load from
  152326. */
  152327. constructor(
  152328. /**
  152329. * Defines the name of the task
  152330. */
  152331. name: string,
  152332. /**
  152333. * Defines the list of mesh's names you want to load
  152334. */
  152335. meshesNames: any,
  152336. /**
  152337. * Defines the root url to use as a base to load your meshes and associated resources
  152338. */
  152339. rootUrl: string,
  152340. /**
  152341. * Defines the filename or File of the scene to load from
  152342. */
  152343. sceneFilename: string | File);
  152344. /**
  152345. * Execute the current task
  152346. * @param scene defines the scene where you want your assets to be loaded
  152347. * @param onSuccess is a callback called when the task is successfully executed
  152348. * @param onError is a callback called if an error occurs
  152349. */
  152350. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152351. }
  152352. /**
  152353. * Define a task used by AssetsManager to load meshes
  152354. */
  152355. export class MeshAssetTask extends AbstractAssetTask {
  152356. /**
  152357. * Defines the name of the task
  152358. */
  152359. name: string;
  152360. /**
  152361. * Defines the list of mesh's names you want to load
  152362. */
  152363. meshesNames: any;
  152364. /**
  152365. * Defines the root url to use as a base to load your meshes and associated resources
  152366. */
  152367. rootUrl: string;
  152368. /**
  152369. * Defines the filename or File of the scene to load from
  152370. */
  152371. sceneFilename: string | File;
  152372. /**
  152373. * Gets the list of loaded meshes
  152374. */
  152375. loadedMeshes: Array<AbstractMesh>;
  152376. /**
  152377. * Gets the list of loaded particle systems
  152378. */
  152379. loadedParticleSystems: Array<IParticleSystem>;
  152380. /**
  152381. * Gets the list of loaded skeletons
  152382. */
  152383. loadedSkeletons: Array<Skeleton>;
  152384. /**
  152385. * Gets the list of loaded animation groups
  152386. */
  152387. loadedAnimationGroups: Array<AnimationGroup>;
  152388. /**
  152389. * Callback called when the task is successful
  152390. */
  152391. onSuccess: (task: MeshAssetTask) => void;
  152392. /**
  152393. * Callback called when the task is successful
  152394. */
  152395. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152396. /**
  152397. * Creates a new MeshAssetTask
  152398. * @param name defines the name of the task
  152399. * @param meshesNames defines the list of mesh's names you want to load
  152400. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152401. * @param sceneFilename defines the filename or File of the scene to load from
  152402. */
  152403. constructor(
  152404. /**
  152405. * Defines the name of the task
  152406. */
  152407. name: string,
  152408. /**
  152409. * Defines the list of mesh's names you want to load
  152410. */
  152411. meshesNames: any,
  152412. /**
  152413. * Defines the root url to use as a base to load your meshes and associated resources
  152414. */
  152415. rootUrl: string,
  152416. /**
  152417. * Defines the filename or File of the scene to load from
  152418. */
  152419. sceneFilename: string | File);
  152420. /**
  152421. * Execute the current task
  152422. * @param scene defines the scene where you want your assets to be loaded
  152423. * @param onSuccess is a callback called when the task is successfully executed
  152424. * @param onError is a callback called if an error occurs
  152425. */
  152426. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152427. }
  152428. /**
  152429. * Define a task used by AssetsManager to load text content
  152430. */
  152431. export class TextFileAssetTask extends AbstractAssetTask {
  152432. /**
  152433. * Defines the name of the task
  152434. */
  152435. name: string;
  152436. /**
  152437. * Defines the location of the file to load
  152438. */
  152439. url: string;
  152440. /**
  152441. * Gets the loaded text string
  152442. */
  152443. text: string;
  152444. /**
  152445. * Callback called when the task is successful
  152446. */
  152447. onSuccess: (task: TextFileAssetTask) => void;
  152448. /**
  152449. * Callback called when the task is successful
  152450. */
  152451. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152452. /**
  152453. * Creates a new TextFileAssetTask object
  152454. * @param name defines the name of the task
  152455. * @param url defines the location of the file to load
  152456. */
  152457. constructor(
  152458. /**
  152459. * Defines the name of the task
  152460. */
  152461. name: string,
  152462. /**
  152463. * Defines the location of the file to load
  152464. */
  152465. url: string);
  152466. /**
  152467. * Execute the current task
  152468. * @param scene defines the scene where you want your assets to be loaded
  152469. * @param onSuccess is a callback called when the task is successfully executed
  152470. * @param onError is a callback called if an error occurs
  152471. */
  152472. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152473. }
  152474. /**
  152475. * Define a task used by AssetsManager to load binary data
  152476. */
  152477. export class BinaryFileAssetTask extends AbstractAssetTask {
  152478. /**
  152479. * Defines the name of the task
  152480. */
  152481. name: string;
  152482. /**
  152483. * Defines the location of the file to load
  152484. */
  152485. url: string;
  152486. /**
  152487. * Gets the lodaded data (as an array buffer)
  152488. */
  152489. data: ArrayBuffer;
  152490. /**
  152491. * Callback called when the task is successful
  152492. */
  152493. onSuccess: (task: BinaryFileAssetTask) => void;
  152494. /**
  152495. * Callback called when the task is successful
  152496. */
  152497. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152498. /**
  152499. * Creates a new BinaryFileAssetTask object
  152500. * @param name defines the name of the new task
  152501. * @param url defines the location of the file to load
  152502. */
  152503. constructor(
  152504. /**
  152505. * Defines the name of the task
  152506. */
  152507. name: string,
  152508. /**
  152509. * Defines the location of the file to load
  152510. */
  152511. url: string);
  152512. /**
  152513. * Execute the current task
  152514. * @param scene defines the scene where you want your assets to be loaded
  152515. * @param onSuccess is a callback called when the task is successfully executed
  152516. * @param onError is a callback called if an error occurs
  152517. */
  152518. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152519. }
  152520. /**
  152521. * Define a task used by AssetsManager to load images
  152522. */
  152523. export class ImageAssetTask extends AbstractAssetTask {
  152524. /**
  152525. * Defines the name of the task
  152526. */
  152527. name: string;
  152528. /**
  152529. * Defines the location of the image to load
  152530. */
  152531. url: string;
  152532. /**
  152533. * Gets the loaded images
  152534. */
  152535. image: HTMLImageElement;
  152536. /**
  152537. * Callback called when the task is successful
  152538. */
  152539. onSuccess: (task: ImageAssetTask) => void;
  152540. /**
  152541. * Callback called when the task is successful
  152542. */
  152543. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152544. /**
  152545. * Creates a new ImageAssetTask
  152546. * @param name defines the name of the task
  152547. * @param url defines the location of the image to load
  152548. */
  152549. constructor(
  152550. /**
  152551. * Defines the name of the task
  152552. */
  152553. name: string,
  152554. /**
  152555. * Defines the location of the image to load
  152556. */
  152557. url: string);
  152558. /**
  152559. * Execute the current task
  152560. * @param scene defines the scene where you want your assets to be loaded
  152561. * @param onSuccess is a callback called when the task is successfully executed
  152562. * @param onError is a callback called if an error occurs
  152563. */
  152564. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152565. }
  152566. /**
  152567. * Defines the interface used by texture loading tasks
  152568. */
  152569. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152570. /**
  152571. * Gets the loaded texture
  152572. */
  152573. texture: TEX;
  152574. }
  152575. /**
  152576. * Define a task used by AssetsManager to load 2D textures
  152577. */
  152578. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152579. /**
  152580. * Defines the name of the task
  152581. */
  152582. name: string;
  152583. /**
  152584. * Defines the location of the file to load
  152585. */
  152586. url: string;
  152587. /**
  152588. * Defines if mipmap should not be generated (default is false)
  152589. */
  152590. noMipmap?: boolean | undefined;
  152591. /**
  152592. * Defines if texture must be inverted on Y axis (default is true)
  152593. */
  152594. invertY: boolean;
  152595. /**
  152596. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152597. */
  152598. samplingMode: number;
  152599. /**
  152600. * Gets the loaded texture
  152601. */
  152602. texture: Texture;
  152603. /**
  152604. * Callback called when the task is successful
  152605. */
  152606. onSuccess: (task: TextureAssetTask) => void;
  152607. /**
  152608. * Callback called when the task is successful
  152609. */
  152610. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152611. /**
  152612. * Creates a new TextureAssetTask object
  152613. * @param name defines the name of the task
  152614. * @param url defines the location of the file to load
  152615. * @param noMipmap defines if mipmap should not be generated (default is false)
  152616. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152617. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152618. */
  152619. constructor(
  152620. /**
  152621. * Defines the name of the task
  152622. */
  152623. name: string,
  152624. /**
  152625. * Defines the location of the file to load
  152626. */
  152627. url: string,
  152628. /**
  152629. * Defines if mipmap should not be generated (default is false)
  152630. */
  152631. noMipmap?: boolean | undefined,
  152632. /**
  152633. * Defines if texture must be inverted on Y axis (default is true)
  152634. */
  152635. invertY?: boolean,
  152636. /**
  152637. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152638. */
  152639. samplingMode?: number);
  152640. /**
  152641. * Execute the current task
  152642. * @param scene defines the scene where you want your assets to be loaded
  152643. * @param onSuccess is a callback called when the task is successfully executed
  152644. * @param onError is a callback called if an error occurs
  152645. */
  152646. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152647. }
  152648. /**
  152649. * Define a task used by AssetsManager to load cube textures
  152650. */
  152651. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152652. /**
  152653. * Defines the name of the task
  152654. */
  152655. name: string;
  152656. /**
  152657. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152658. */
  152659. url: string;
  152660. /**
  152661. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152662. */
  152663. extensions?: string[] | undefined;
  152664. /**
  152665. * Defines if mipmaps should not be generated (default is false)
  152666. */
  152667. noMipmap?: boolean | undefined;
  152668. /**
  152669. * Defines the explicit list of files (undefined by default)
  152670. */
  152671. files?: string[] | undefined;
  152672. /**
  152673. * Gets the loaded texture
  152674. */
  152675. texture: CubeTexture;
  152676. /**
  152677. * Callback called when the task is successful
  152678. */
  152679. onSuccess: (task: CubeTextureAssetTask) => void;
  152680. /**
  152681. * Callback called when the task is successful
  152682. */
  152683. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152684. /**
  152685. * Creates a new CubeTextureAssetTask
  152686. * @param name defines the name of the task
  152687. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152688. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152689. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152690. * @param files defines the explicit list of files (undefined by default)
  152691. */
  152692. constructor(
  152693. /**
  152694. * Defines the name of the task
  152695. */
  152696. name: string,
  152697. /**
  152698. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152699. */
  152700. url: string,
  152701. /**
  152702. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152703. */
  152704. extensions?: string[] | undefined,
  152705. /**
  152706. * Defines if mipmaps should not be generated (default is false)
  152707. */
  152708. noMipmap?: boolean | undefined,
  152709. /**
  152710. * Defines the explicit list of files (undefined by default)
  152711. */
  152712. files?: string[] | undefined);
  152713. /**
  152714. * Execute the current task
  152715. * @param scene defines the scene where you want your assets to be loaded
  152716. * @param onSuccess is a callback called when the task is successfully executed
  152717. * @param onError is a callback called if an error occurs
  152718. */
  152719. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152720. }
  152721. /**
  152722. * Define a task used by AssetsManager to load HDR cube textures
  152723. */
  152724. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152725. /**
  152726. * Defines the name of the task
  152727. */
  152728. name: string;
  152729. /**
  152730. * Defines the location of the file to load
  152731. */
  152732. url: string;
  152733. /**
  152734. * Defines the desired size (the more it increases the longer the generation will be)
  152735. */
  152736. size: number;
  152737. /**
  152738. * Defines if mipmaps should not be generated (default is false)
  152739. */
  152740. noMipmap: boolean;
  152741. /**
  152742. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152743. */
  152744. generateHarmonics: boolean;
  152745. /**
  152746. * 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)
  152747. */
  152748. gammaSpace: boolean;
  152749. /**
  152750. * Internal Use Only
  152751. */
  152752. reserved: boolean;
  152753. /**
  152754. * Gets the loaded texture
  152755. */
  152756. texture: HDRCubeTexture;
  152757. /**
  152758. * Callback called when the task is successful
  152759. */
  152760. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152761. /**
  152762. * Callback called when the task is successful
  152763. */
  152764. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152765. /**
  152766. * Creates a new HDRCubeTextureAssetTask object
  152767. * @param name defines the name of the task
  152768. * @param url defines the location of the file to load
  152769. * @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.
  152770. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152771. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152772. * @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)
  152773. * @param reserved Internal use only
  152774. */
  152775. constructor(
  152776. /**
  152777. * Defines the name of the task
  152778. */
  152779. name: string,
  152780. /**
  152781. * Defines the location of the file to load
  152782. */
  152783. url: string,
  152784. /**
  152785. * Defines the desired size (the more it increases the longer the generation will be)
  152786. */
  152787. size: number,
  152788. /**
  152789. * Defines if mipmaps should not be generated (default is false)
  152790. */
  152791. noMipmap?: boolean,
  152792. /**
  152793. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152794. */
  152795. generateHarmonics?: boolean,
  152796. /**
  152797. * 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)
  152798. */
  152799. gammaSpace?: boolean,
  152800. /**
  152801. * Internal Use Only
  152802. */
  152803. reserved?: boolean);
  152804. /**
  152805. * Execute the current task
  152806. * @param scene defines the scene where you want your assets to be loaded
  152807. * @param onSuccess is a callback called when the task is successfully executed
  152808. * @param onError is a callback called if an error occurs
  152809. */
  152810. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152811. }
  152812. /**
  152813. * Define a task used by AssetsManager to load Equirectangular cube textures
  152814. */
  152815. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152816. /**
  152817. * Defines the name of the task
  152818. */
  152819. name: string;
  152820. /**
  152821. * Defines the location of the file to load
  152822. */
  152823. url: string;
  152824. /**
  152825. * Defines the desired size (the more it increases the longer the generation will be)
  152826. */
  152827. size: number;
  152828. /**
  152829. * Defines if mipmaps should not be generated (default is false)
  152830. */
  152831. noMipmap: boolean;
  152832. /**
  152833. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152834. * but the standard material would require them in Gamma space) (default is true)
  152835. */
  152836. gammaSpace: boolean;
  152837. /**
  152838. * Gets the loaded texture
  152839. */
  152840. texture: EquiRectangularCubeTexture;
  152841. /**
  152842. * Callback called when the task is successful
  152843. */
  152844. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152845. /**
  152846. * Callback called when the task is successful
  152847. */
  152848. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152849. /**
  152850. * Creates a new EquiRectangularCubeTextureAssetTask object
  152851. * @param name defines the name of the task
  152852. * @param url defines the location of the file to load
  152853. * @param size defines the desired size (the more it increases the longer the generation will be)
  152854. * If the size is omitted this implies you are using a preprocessed cubemap.
  152855. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152856. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152857. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152858. * (default is true)
  152859. */
  152860. constructor(
  152861. /**
  152862. * Defines the name of the task
  152863. */
  152864. name: string,
  152865. /**
  152866. * Defines the location of the file to load
  152867. */
  152868. url: string,
  152869. /**
  152870. * Defines the desired size (the more it increases the longer the generation will be)
  152871. */
  152872. size: number,
  152873. /**
  152874. * Defines if mipmaps should not be generated (default is false)
  152875. */
  152876. noMipmap?: boolean,
  152877. /**
  152878. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152879. * but the standard material would require them in Gamma space) (default is true)
  152880. */
  152881. gammaSpace?: boolean);
  152882. /**
  152883. * Execute the current task
  152884. * @param scene defines the scene where you want your assets to be loaded
  152885. * @param onSuccess is a callback called when the task is successfully executed
  152886. * @param onError is a callback called if an error occurs
  152887. */
  152888. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152889. }
  152890. /**
  152891. * This class can be used to easily import assets into a scene
  152892. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152893. */
  152894. export class AssetsManager {
  152895. private _scene;
  152896. private _isLoading;
  152897. protected _tasks: AbstractAssetTask[];
  152898. protected _waitingTasksCount: number;
  152899. protected _totalTasksCount: number;
  152900. /**
  152901. * Callback called when all tasks are processed
  152902. */
  152903. onFinish: (tasks: AbstractAssetTask[]) => void;
  152904. /**
  152905. * Callback called when a task is successful
  152906. */
  152907. onTaskSuccess: (task: AbstractAssetTask) => void;
  152908. /**
  152909. * Callback called when a task had an error
  152910. */
  152911. onTaskError: (task: AbstractAssetTask) => void;
  152912. /**
  152913. * Callback called when a task is done (whatever the result is)
  152914. */
  152915. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152916. /**
  152917. * Observable called when all tasks are processed
  152918. */
  152919. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152920. /**
  152921. * Observable called when a task had an error
  152922. */
  152923. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152924. /**
  152925. * Observable called when all tasks were executed
  152926. */
  152927. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152928. /**
  152929. * Observable called when a task is done (whatever the result is)
  152930. */
  152931. onProgressObservable: Observable<IAssetsProgressEvent>;
  152932. /**
  152933. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152934. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152935. */
  152936. useDefaultLoadingScreen: boolean;
  152937. /**
  152938. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152939. * when all assets have been downloaded.
  152940. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152941. */
  152942. autoHideLoadingUI: boolean;
  152943. /**
  152944. * Creates a new AssetsManager
  152945. * @param scene defines the scene to work on
  152946. */
  152947. constructor(scene: Scene);
  152948. /**
  152949. * Add a ContainerAssetTask to the list of active tasks
  152950. * @param taskName defines the name of the new task
  152951. * @param meshesNames defines the name of meshes to load
  152952. * @param rootUrl defines the root url to use to locate files
  152953. * @param sceneFilename defines the filename of the scene file
  152954. * @returns a new ContainerAssetTask object
  152955. */
  152956. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152957. /**
  152958. * Add a MeshAssetTask to the list of active tasks
  152959. * @param taskName defines the name of the new task
  152960. * @param meshesNames defines the name of meshes to load
  152961. * @param rootUrl defines the root url to use to locate files
  152962. * @param sceneFilename defines the filename of the scene file
  152963. * @returns a new MeshAssetTask object
  152964. */
  152965. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152966. /**
  152967. * Add a TextFileAssetTask to the list of active tasks
  152968. * @param taskName defines the name of the new task
  152969. * @param url defines the url of the file to load
  152970. * @returns a new TextFileAssetTask object
  152971. */
  152972. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152973. /**
  152974. * Add a BinaryFileAssetTask to the list of active tasks
  152975. * @param taskName defines the name of the new task
  152976. * @param url defines the url of the file to load
  152977. * @returns a new BinaryFileAssetTask object
  152978. */
  152979. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152980. /**
  152981. * Add a ImageAssetTask to the list of active tasks
  152982. * @param taskName defines the name of the new task
  152983. * @param url defines the url of the file to load
  152984. * @returns a new ImageAssetTask object
  152985. */
  152986. addImageTask(taskName: string, url: string): ImageAssetTask;
  152987. /**
  152988. * Add a TextureAssetTask to the list of active tasks
  152989. * @param taskName defines the name of the new task
  152990. * @param url defines the url of the file to load
  152991. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152992. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152993. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152994. * @returns a new TextureAssetTask object
  152995. */
  152996. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152997. /**
  152998. * Add a CubeTextureAssetTask to the list of active tasks
  152999. * @param taskName defines the name of the new task
  153000. * @param url defines the url of the file to load
  153001. * @param extensions defines the extension to use to load the cube map (can be null)
  153002. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153003. * @param files defines the list of files to load (can be null)
  153004. * @returns a new CubeTextureAssetTask object
  153005. */
  153006. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  153007. /**
  153008. *
  153009. * Add a HDRCubeTextureAssetTask to the list of active tasks
  153010. * @param taskName defines the name of the new task
  153011. * @param url defines the url of the file to load
  153012. * @param size defines the size you want for the cubemap (can be null)
  153013. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153014. * @param generateHarmonics defines if you want to automatically generate (true by default)
  153015. * @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)
  153016. * @param reserved Internal use only
  153017. * @returns a new HDRCubeTextureAssetTask object
  153018. */
  153019. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  153020. /**
  153021. *
  153022. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  153023. * @param taskName defines the name of the new task
  153024. * @param url defines the url of the file to load
  153025. * @param size defines the size you want for the cubemap (can be null)
  153026. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153027. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  153028. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  153029. * @returns a new EquiRectangularCubeTextureAssetTask object
  153030. */
  153031. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  153032. /**
  153033. * Remove a task from the assets manager.
  153034. * @param task the task to remove
  153035. */
  153036. removeTask(task: AbstractAssetTask): void;
  153037. private _decreaseWaitingTasksCount;
  153038. private _runTask;
  153039. /**
  153040. * Reset the AssetsManager and remove all tasks
  153041. * @return the current instance of the AssetsManager
  153042. */
  153043. reset(): AssetsManager;
  153044. /**
  153045. * Start the loading process
  153046. * @return the current instance of the AssetsManager
  153047. */
  153048. load(): AssetsManager;
  153049. /**
  153050. * Start the loading process as an async operation
  153051. * @return a promise returning the list of failed tasks
  153052. */
  153053. loadAsync(): Promise<void>;
  153054. }
  153055. }
  153056. declare module BABYLON {
  153057. /**
  153058. * Wrapper class for promise with external resolve and reject.
  153059. */
  153060. export class Deferred<T> {
  153061. /**
  153062. * The promise associated with this deferred object.
  153063. */
  153064. readonly promise: Promise<T>;
  153065. private _resolve;
  153066. private _reject;
  153067. /**
  153068. * The resolve method of the promise associated with this deferred object.
  153069. */
  153070. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  153071. /**
  153072. * The reject method of the promise associated with this deferred object.
  153073. */
  153074. get reject(): (reason?: any) => void;
  153075. /**
  153076. * Constructor for this deferred object.
  153077. */
  153078. constructor();
  153079. }
  153080. }
  153081. declare module BABYLON {
  153082. /**
  153083. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  153084. */
  153085. export class MeshExploder {
  153086. private _centerMesh;
  153087. private _meshes;
  153088. private _meshesOrigins;
  153089. private _toCenterVectors;
  153090. private _scaledDirection;
  153091. private _newPosition;
  153092. private _centerPosition;
  153093. /**
  153094. * Explodes meshes from a center mesh.
  153095. * @param meshes The meshes to explode.
  153096. * @param centerMesh The mesh to be center of explosion.
  153097. */
  153098. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  153099. private _setCenterMesh;
  153100. /**
  153101. * Get class name
  153102. * @returns "MeshExploder"
  153103. */
  153104. getClassName(): string;
  153105. /**
  153106. * "Exploded meshes"
  153107. * @returns Array of meshes with the centerMesh at index 0.
  153108. */
  153109. getMeshes(): Array<Mesh>;
  153110. /**
  153111. * Explodes meshes giving a specific direction
  153112. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  153113. */
  153114. explode(direction?: number): void;
  153115. }
  153116. }
  153117. declare module BABYLON {
  153118. /**
  153119. * Class used to help managing file picking and drag'n'drop
  153120. */
  153121. export class FilesInput {
  153122. /**
  153123. * List of files ready to be loaded
  153124. */
  153125. static get FilesToLoad(): {
  153126. [key: string]: File;
  153127. };
  153128. /**
  153129. * Callback called when a file is processed
  153130. */
  153131. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  153132. private _engine;
  153133. private _currentScene;
  153134. private _sceneLoadedCallback;
  153135. private _progressCallback;
  153136. private _additionalRenderLoopLogicCallback;
  153137. private _textureLoadingCallback;
  153138. private _startingProcessingFilesCallback;
  153139. private _onReloadCallback;
  153140. private _errorCallback;
  153141. private _elementToMonitor;
  153142. private _sceneFileToLoad;
  153143. private _filesToLoad;
  153144. /**
  153145. * Creates a new FilesInput
  153146. * @param engine defines the rendering engine
  153147. * @param scene defines the hosting scene
  153148. * @param sceneLoadedCallback callback called when scene is loaded
  153149. * @param progressCallback callback called to track progress
  153150. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  153151. * @param textureLoadingCallback callback called when a texture is loading
  153152. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  153153. * @param onReloadCallback callback called when a reload is requested
  153154. * @param errorCallback callback call if an error occurs
  153155. */
  153156. constructor(engine: Engine, scene: Nullable<Scene>, sceneLoadedCallback: Nullable<(sceneFile: File, scene: Scene) => void>, progressCallback: Nullable<(progress: ISceneLoaderProgressEvent) => void>, additionalRenderLoopLogicCallback: Nullable<() => void>, textureLoadingCallback: Nullable<(remaining: number) => void>, startingProcessingFilesCallback: Nullable<(files?: File[]) => void>, onReloadCallback: Nullable<(sceneFile: File) => void>, errorCallback: Nullable<(sceneFile: File, scene: Nullable<Scene>, message: string) => void>);
  153157. private _dragEnterHandler;
  153158. private _dragOverHandler;
  153159. private _dropHandler;
  153160. /**
  153161. * Calls this function to listen to drag'n'drop events on a specific DOM element
  153162. * @param elementToMonitor defines the DOM element to track
  153163. */
  153164. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  153165. /** Gets the current list of files to load */
  153166. get filesToLoad(): File[];
  153167. /**
  153168. * Release all associated resources
  153169. */
  153170. dispose(): void;
  153171. private renderFunction;
  153172. private drag;
  153173. private drop;
  153174. private _traverseFolder;
  153175. private _processFiles;
  153176. /**
  153177. * Load files from a drop event
  153178. * @param event defines the drop event to use as source
  153179. */
  153180. loadFiles(event: any): void;
  153181. private _processReload;
  153182. /**
  153183. * Reload the current scene from the loaded files
  153184. */
  153185. reload(): void;
  153186. }
  153187. }
  153188. declare module BABYLON {
  153189. /**
  153190. * Defines the root class used to create scene optimization to use with SceneOptimizer
  153191. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153192. */
  153193. export class SceneOptimization {
  153194. /**
  153195. * Defines the priority of this optimization (0 by default which means first in the list)
  153196. */
  153197. priority: number;
  153198. /**
  153199. * Gets a string describing the action executed by the current optimization
  153200. * @returns description string
  153201. */
  153202. getDescription(): string;
  153203. /**
  153204. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153205. * @param scene defines the current scene where to apply this optimization
  153206. * @param optimizer defines the current optimizer
  153207. * @returns true if everything that can be done was applied
  153208. */
  153209. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153210. /**
  153211. * Creates the SceneOptimization object
  153212. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153213. * @param desc defines the description associated with the optimization
  153214. */
  153215. constructor(
  153216. /**
  153217. * Defines the priority of this optimization (0 by default which means first in the list)
  153218. */
  153219. priority?: number);
  153220. }
  153221. /**
  153222. * Defines an optimization used to reduce the size of render target textures
  153223. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153224. */
  153225. export class TextureOptimization extends SceneOptimization {
  153226. /**
  153227. * Defines the priority of this optimization (0 by default which means first in the list)
  153228. */
  153229. priority: number;
  153230. /**
  153231. * 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
  153232. */
  153233. maximumSize: number;
  153234. /**
  153235. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153236. */
  153237. step: number;
  153238. /**
  153239. * Gets a string describing the action executed by the current optimization
  153240. * @returns description string
  153241. */
  153242. getDescription(): string;
  153243. /**
  153244. * Creates the TextureOptimization object
  153245. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153246. * @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
  153247. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153248. */
  153249. constructor(
  153250. /**
  153251. * Defines the priority of this optimization (0 by default which means first in the list)
  153252. */
  153253. priority?: number,
  153254. /**
  153255. * 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
  153256. */
  153257. maximumSize?: number,
  153258. /**
  153259. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153260. */
  153261. step?: number);
  153262. /**
  153263. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153264. * @param scene defines the current scene where to apply this optimization
  153265. * @param optimizer defines the current optimizer
  153266. * @returns true if everything that can be done was applied
  153267. */
  153268. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153269. }
  153270. /**
  153271. * Defines an optimization used to increase or decrease the rendering resolution
  153272. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153273. */
  153274. export class HardwareScalingOptimization extends SceneOptimization {
  153275. /**
  153276. * Defines the priority of this optimization (0 by default which means first in the list)
  153277. */
  153278. priority: number;
  153279. /**
  153280. * Defines the maximum scale to use (2 by default)
  153281. */
  153282. maximumScale: number;
  153283. /**
  153284. * Defines the step to use between two passes (0.5 by default)
  153285. */
  153286. step: number;
  153287. private _currentScale;
  153288. private _directionOffset;
  153289. /**
  153290. * Gets a string describing the action executed by the current optimization
  153291. * @return description string
  153292. */
  153293. getDescription(): string;
  153294. /**
  153295. * Creates the HardwareScalingOptimization object
  153296. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153297. * @param maximumScale defines the maximum scale to use (2 by default)
  153298. * @param step defines the step to use between two passes (0.5 by default)
  153299. */
  153300. constructor(
  153301. /**
  153302. * Defines the priority of this optimization (0 by default which means first in the list)
  153303. */
  153304. priority?: number,
  153305. /**
  153306. * Defines the maximum scale to use (2 by default)
  153307. */
  153308. maximumScale?: number,
  153309. /**
  153310. * Defines the step to use between two passes (0.5 by default)
  153311. */
  153312. step?: number);
  153313. /**
  153314. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153315. * @param scene defines the current scene where to apply this optimization
  153316. * @param optimizer defines the current optimizer
  153317. * @returns true if everything that can be done was applied
  153318. */
  153319. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153320. }
  153321. /**
  153322. * Defines an optimization used to remove shadows
  153323. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153324. */
  153325. export class ShadowsOptimization extends SceneOptimization {
  153326. /**
  153327. * Gets a string describing the action executed by the current optimization
  153328. * @return description string
  153329. */
  153330. getDescription(): string;
  153331. /**
  153332. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153333. * @param scene defines the current scene where to apply this optimization
  153334. * @param optimizer defines the current optimizer
  153335. * @returns true if everything that can be done was applied
  153336. */
  153337. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153338. }
  153339. /**
  153340. * Defines an optimization used to turn post-processes off
  153341. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153342. */
  153343. export class PostProcessesOptimization extends SceneOptimization {
  153344. /**
  153345. * Gets a string describing the action executed by the current optimization
  153346. * @return description string
  153347. */
  153348. getDescription(): string;
  153349. /**
  153350. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153351. * @param scene defines the current scene where to apply this optimization
  153352. * @param optimizer defines the current optimizer
  153353. * @returns true if everything that can be done was applied
  153354. */
  153355. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153356. }
  153357. /**
  153358. * Defines an optimization used to turn lens flares off
  153359. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153360. */
  153361. export class LensFlaresOptimization extends SceneOptimization {
  153362. /**
  153363. * Gets a string describing the action executed by the current optimization
  153364. * @return description string
  153365. */
  153366. getDescription(): string;
  153367. /**
  153368. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153369. * @param scene defines the current scene where to apply this optimization
  153370. * @param optimizer defines the current optimizer
  153371. * @returns true if everything that can be done was applied
  153372. */
  153373. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153374. }
  153375. /**
  153376. * Defines an optimization based on user defined callback.
  153377. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153378. */
  153379. export class CustomOptimization extends SceneOptimization {
  153380. /**
  153381. * Callback called to apply the custom optimization.
  153382. */
  153383. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153384. /**
  153385. * Callback called to get custom description
  153386. */
  153387. onGetDescription: () => string;
  153388. /**
  153389. * Gets a string describing the action executed by the current optimization
  153390. * @returns description string
  153391. */
  153392. getDescription(): string;
  153393. /**
  153394. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153395. * @param scene defines the current scene where to apply this optimization
  153396. * @param optimizer defines the current optimizer
  153397. * @returns true if everything that can be done was applied
  153398. */
  153399. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153400. }
  153401. /**
  153402. * Defines an optimization used to turn particles off
  153403. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153404. */
  153405. export class ParticlesOptimization extends SceneOptimization {
  153406. /**
  153407. * Gets a string describing the action executed by the current optimization
  153408. * @return description string
  153409. */
  153410. getDescription(): string;
  153411. /**
  153412. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153413. * @param scene defines the current scene where to apply this optimization
  153414. * @param optimizer defines the current optimizer
  153415. * @returns true if everything that can be done was applied
  153416. */
  153417. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153418. }
  153419. /**
  153420. * Defines an optimization used to turn render targets off
  153421. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153422. */
  153423. export class RenderTargetsOptimization extends SceneOptimization {
  153424. /**
  153425. * Gets a string describing the action executed by the current optimization
  153426. * @return description string
  153427. */
  153428. getDescription(): string;
  153429. /**
  153430. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153431. * @param scene defines the current scene where to apply this optimization
  153432. * @param optimizer defines the current optimizer
  153433. * @returns true if everything that can be done was applied
  153434. */
  153435. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153436. }
  153437. /**
  153438. * Defines an optimization used to merge meshes with compatible materials
  153439. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153440. */
  153441. export class MergeMeshesOptimization extends SceneOptimization {
  153442. private static _UpdateSelectionTree;
  153443. /**
  153444. * Gets or sets a boolean which defines if optimization octree has to be updated
  153445. */
  153446. static get UpdateSelectionTree(): boolean;
  153447. /**
  153448. * Gets or sets a boolean which defines if optimization octree has to be updated
  153449. */
  153450. static set UpdateSelectionTree(value: boolean);
  153451. /**
  153452. * Gets a string describing the action executed by the current optimization
  153453. * @return description string
  153454. */
  153455. getDescription(): string;
  153456. private _canBeMerged;
  153457. /**
  153458. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153459. * @param scene defines the current scene where to apply this optimization
  153460. * @param optimizer defines the current optimizer
  153461. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153462. * @returns true if everything that can be done was applied
  153463. */
  153464. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153465. }
  153466. /**
  153467. * Defines a list of options used by SceneOptimizer
  153468. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153469. */
  153470. export class SceneOptimizerOptions {
  153471. /**
  153472. * Defines the target frame rate to reach (60 by default)
  153473. */
  153474. targetFrameRate: number;
  153475. /**
  153476. * Defines the interval between two checkes (2000ms by default)
  153477. */
  153478. trackerDuration: number;
  153479. /**
  153480. * Gets the list of optimizations to apply
  153481. */
  153482. optimizations: SceneOptimization[];
  153483. /**
  153484. * Creates a new list of options used by SceneOptimizer
  153485. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153486. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153487. */
  153488. constructor(
  153489. /**
  153490. * Defines the target frame rate to reach (60 by default)
  153491. */
  153492. targetFrameRate?: number,
  153493. /**
  153494. * Defines the interval between two checkes (2000ms by default)
  153495. */
  153496. trackerDuration?: number);
  153497. /**
  153498. * Add a new optimization
  153499. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153500. * @returns the current SceneOptimizerOptions
  153501. */
  153502. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153503. /**
  153504. * Add a new custom optimization
  153505. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153506. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153507. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153508. * @returns the current SceneOptimizerOptions
  153509. */
  153510. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153511. /**
  153512. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153513. * @param targetFrameRate defines the target frame rate (60 by default)
  153514. * @returns a SceneOptimizerOptions object
  153515. */
  153516. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153517. /**
  153518. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153519. * @param targetFrameRate defines the target frame rate (60 by default)
  153520. * @returns a SceneOptimizerOptions object
  153521. */
  153522. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153523. /**
  153524. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153525. * @param targetFrameRate defines the target frame rate (60 by default)
  153526. * @returns a SceneOptimizerOptions object
  153527. */
  153528. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153529. }
  153530. /**
  153531. * Class used to run optimizations in order to reach a target frame rate
  153532. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153533. */
  153534. export class SceneOptimizer implements IDisposable {
  153535. private _isRunning;
  153536. private _options;
  153537. private _scene;
  153538. private _currentPriorityLevel;
  153539. private _targetFrameRate;
  153540. private _trackerDuration;
  153541. private _currentFrameRate;
  153542. private _sceneDisposeObserver;
  153543. private _improvementMode;
  153544. /**
  153545. * Defines an observable called when the optimizer reaches the target frame rate
  153546. */
  153547. onSuccessObservable: Observable<SceneOptimizer>;
  153548. /**
  153549. * Defines an observable called when the optimizer enables an optimization
  153550. */
  153551. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153552. /**
  153553. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153554. */
  153555. onFailureObservable: Observable<SceneOptimizer>;
  153556. /**
  153557. * Gets a boolean indicating if the optimizer is in improvement mode
  153558. */
  153559. get isInImprovementMode(): boolean;
  153560. /**
  153561. * Gets the current priority level (0 at start)
  153562. */
  153563. get currentPriorityLevel(): number;
  153564. /**
  153565. * Gets the current frame rate checked by the SceneOptimizer
  153566. */
  153567. get currentFrameRate(): number;
  153568. /**
  153569. * Gets or sets the current target frame rate (60 by default)
  153570. */
  153571. get targetFrameRate(): number;
  153572. /**
  153573. * Gets or sets the current target frame rate (60 by default)
  153574. */
  153575. set targetFrameRate(value: number);
  153576. /**
  153577. * Gets or sets the current interval between two checks (every 2000ms by default)
  153578. */
  153579. get trackerDuration(): number;
  153580. /**
  153581. * Gets or sets the current interval between two checks (every 2000ms by default)
  153582. */
  153583. set trackerDuration(value: number);
  153584. /**
  153585. * Gets the list of active optimizations
  153586. */
  153587. get optimizations(): SceneOptimization[];
  153588. /**
  153589. * Creates a new SceneOptimizer
  153590. * @param scene defines the scene to work on
  153591. * @param options defines the options to use with the SceneOptimizer
  153592. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153593. * @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)
  153594. */
  153595. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153596. /**
  153597. * Stops the current optimizer
  153598. */
  153599. stop(): void;
  153600. /**
  153601. * Reset the optimizer to initial step (current priority level = 0)
  153602. */
  153603. reset(): void;
  153604. /**
  153605. * Start the optimizer. By default it will try to reach a specific framerate
  153606. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153607. */
  153608. start(): void;
  153609. private _checkCurrentState;
  153610. /**
  153611. * Release all resources
  153612. */
  153613. dispose(): void;
  153614. /**
  153615. * Helper function to create a SceneOptimizer with one single line of code
  153616. * @param scene defines the scene to work on
  153617. * @param options defines the options to use with the SceneOptimizer
  153618. * @param onSuccess defines a callback to call on success
  153619. * @param onFailure defines a callback to call on failure
  153620. * @returns the new SceneOptimizer object
  153621. */
  153622. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153623. }
  153624. }
  153625. declare module BABYLON {
  153626. /**
  153627. * Class used to serialize a scene into a string
  153628. */
  153629. export class SceneSerializer {
  153630. /**
  153631. * Clear cache used by a previous serialization
  153632. */
  153633. static ClearCache(): void;
  153634. /**
  153635. * Serialize a scene into a JSON compatible object
  153636. * @param scene defines the scene to serialize
  153637. * @returns a JSON compatible object
  153638. */
  153639. static Serialize(scene: Scene): any;
  153640. /**
  153641. * Serialize a mesh into a JSON compatible object
  153642. * @param toSerialize defines the mesh to serialize
  153643. * @param withParents defines if parents must be serialized as well
  153644. * @param withChildren defines if children must be serialized as well
  153645. * @returns a JSON compatible object
  153646. */
  153647. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153648. }
  153649. }
  153650. declare module BABYLON {
  153651. /**
  153652. * Class used to host texture specific utilities
  153653. */
  153654. export class TextureTools {
  153655. /**
  153656. * Uses the GPU to create a copy texture rescaled at a given size
  153657. * @param texture Texture to copy from
  153658. * @param width defines the desired width
  153659. * @param height defines the desired height
  153660. * @param useBilinearMode defines if bilinear mode has to be used
  153661. * @return the generated texture
  153662. */
  153663. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153664. }
  153665. }
  153666. declare module BABYLON {
  153667. /**
  153668. * This represents the different options available for the video capture.
  153669. */
  153670. export interface VideoRecorderOptions {
  153671. /** Defines the mime type of the video. */
  153672. mimeType: string;
  153673. /** Defines the FPS the video should be recorded at. */
  153674. fps: number;
  153675. /** Defines the chunk size for the recording data. */
  153676. recordChunckSize: number;
  153677. /** The audio tracks to attach to the recording. */
  153678. audioTracks?: MediaStreamTrack[];
  153679. }
  153680. /**
  153681. * This can help with recording videos from BabylonJS.
  153682. * This is based on the available WebRTC functionalities of the browser.
  153683. *
  153684. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153685. */
  153686. export class VideoRecorder {
  153687. private static readonly _defaultOptions;
  153688. /**
  153689. * Returns whether or not the VideoRecorder is available in your browser.
  153690. * @param engine Defines the Babylon Engine.
  153691. * @returns true if supported otherwise false.
  153692. */
  153693. static IsSupported(engine: Engine): boolean;
  153694. private readonly _options;
  153695. private _canvas;
  153696. private _mediaRecorder;
  153697. private _recordedChunks;
  153698. private _fileName;
  153699. private _resolve;
  153700. private _reject;
  153701. /**
  153702. * True when a recording is already in progress.
  153703. */
  153704. get isRecording(): boolean;
  153705. /**
  153706. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153707. * @param engine Defines the BabylonJS Engine you wish to record.
  153708. * @param options Defines options that can be used to customize the capture.
  153709. */
  153710. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153711. /**
  153712. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153713. */
  153714. stopRecording(): void;
  153715. /**
  153716. * Starts recording the canvas for a max duration specified in parameters.
  153717. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153718. * If null no automatic download will start and you can rely on the promise to get the data back.
  153719. * @param maxDuration Defines the maximum recording time in seconds.
  153720. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153721. * @return A promise callback at the end of the recording with the video data in Blob.
  153722. */
  153723. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153724. /**
  153725. * Releases internal resources used during the recording.
  153726. */
  153727. dispose(): void;
  153728. private _handleDataAvailable;
  153729. private _handleError;
  153730. private _handleStop;
  153731. }
  153732. }
  153733. declare module BABYLON {
  153734. /**
  153735. * Class containing a set of static utilities functions for screenshots
  153736. */
  153737. export class ScreenshotTools {
  153738. /**
  153739. * Captures a screenshot of the current rendering
  153740. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153741. * @param engine defines the rendering engine
  153742. * @param camera defines the source camera
  153743. * @param size This parameter can be set to a single number or to an object with the
  153744. * following (optional) properties: precision, width, height. If a single number is passed,
  153745. * it will be used for both width and height. If an object is passed, the screenshot size
  153746. * will be derived from the parameters. The precision property is a multiplier allowing
  153747. * rendering at a higher or lower resolution
  153748. * @param successCallback defines the callback receives a single parameter which contains the
  153749. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153750. * src parameter of an <img> to display it
  153751. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153752. * Check your browser for supported MIME types
  153753. */
  153754. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153755. /**
  153756. * Captures a screenshot of the current rendering
  153757. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153758. * @param engine defines the rendering engine
  153759. * @param camera defines the source camera
  153760. * @param size This parameter can be set to a single number or to an object with the
  153761. * following (optional) properties: precision, width, height. If a single number is passed,
  153762. * it will be used for both width and height. If an object is passed, the screenshot size
  153763. * will be derived from the parameters. The precision property is a multiplier allowing
  153764. * rendering at a higher or lower resolution
  153765. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153766. * Check your browser for supported MIME types
  153767. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153768. * to the src parameter of an <img> to display it
  153769. */
  153770. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153771. /**
  153772. * Generates an image screenshot from the specified camera.
  153773. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153774. * @param engine The engine to use for rendering
  153775. * @param camera The camera to use for rendering
  153776. * @param size This parameter can be set to a single number or to an object with the
  153777. * following (optional) properties: precision, width, height. If a single number is passed,
  153778. * it will be used for both width and height. If an object is passed, the screenshot size
  153779. * will be derived from the parameters. The precision property is a multiplier allowing
  153780. * rendering at a higher or lower resolution
  153781. * @param successCallback The callback receives a single parameter which contains the
  153782. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153783. * src parameter of an <img> to display it
  153784. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153785. * Check your browser for supported MIME types
  153786. * @param samples Texture samples (default: 1)
  153787. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153788. * @param fileName A name for for the downloaded file.
  153789. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153790. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153791. */
  153792. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  153793. /**
  153794. * Generates an image screenshot from the specified camera.
  153795. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153796. * @param engine The engine to use for rendering
  153797. * @param camera The camera to use for rendering
  153798. * @param size This parameter can be set to a single number or to an object with the
  153799. * following (optional) properties: precision, width, height. If a single number is passed,
  153800. * it will be used for both width and height. If an object is passed, the screenshot size
  153801. * will be derived from the parameters. The precision property is a multiplier allowing
  153802. * rendering at a higher or lower resolution
  153803. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153804. * Check your browser for supported MIME types
  153805. * @param samples Texture samples (default: 1)
  153806. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153807. * @param fileName A name for for the downloaded file.
  153808. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153809. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153810. * to the src parameter of an <img> to display it
  153811. */
  153812. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153813. /**
  153814. * Gets height and width for screenshot size
  153815. * @private
  153816. */
  153817. private static _getScreenshotSize;
  153818. }
  153819. }
  153820. declare module BABYLON {
  153821. /**
  153822. * Interface for a data buffer
  153823. */
  153824. export interface IDataBuffer {
  153825. /**
  153826. * Reads bytes from the data buffer.
  153827. * @param byteOffset The byte offset to read
  153828. * @param byteLength The byte length to read
  153829. * @returns A promise that resolves when the bytes are read
  153830. */
  153831. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153832. /**
  153833. * The byte length of the buffer.
  153834. */
  153835. readonly byteLength: number;
  153836. }
  153837. /**
  153838. * Utility class for reading from a data buffer
  153839. */
  153840. export class DataReader {
  153841. /**
  153842. * The data buffer associated with this data reader.
  153843. */
  153844. readonly buffer: IDataBuffer;
  153845. /**
  153846. * The current byte offset from the beginning of the data buffer.
  153847. */
  153848. byteOffset: number;
  153849. private _dataView;
  153850. private _dataByteOffset;
  153851. /**
  153852. * Constructor
  153853. * @param buffer The buffer to read
  153854. */
  153855. constructor(buffer: IDataBuffer);
  153856. /**
  153857. * Loads the given byte length.
  153858. * @param byteLength The byte length to load
  153859. * @returns A promise that resolves when the load is complete
  153860. */
  153861. loadAsync(byteLength: number): Promise<void>;
  153862. /**
  153863. * Read a unsigned 32-bit integer from the currently loaded data range.
  153864. * @returns The 32-bit integer read
  153865. */
  153866. readUint32(): number;
  153867. /**
  153868. * Read a byte array from the currently loaded data range.
  153869. * @param byteLength The byte length to read
  153870. * @returns The byte array read
  153871. */
  153872. readUint8Array(byteLength: number): Uint8Array;
  153873. /**
  153874. * Read a string from the currently loaded data range.
  153875. * @param byteLength The byte length to read
  153876. * @returns The string read
  153877. */
  153878. readString(byteLength: number): string;
  153879. /**
  153880. * Skips the given byte length the currently loaded data range.
  153881. * @param byteLength The byte length to skip
  153882. */
  153883. skipBytes(byteLength: number): void;
  153884. }
  153885. }
  153886. declare module BABYLON {
  153887. /**
  153888. * Class for storing data to local storage if available or in-memory storage otherwise
  153889. */
  153890. export class DataStorage {
  153891. private static _Storage;
  153892. private static _GetStorage;
  153893. /**
  153894. * Reads a string from the data storage
  153895. * @param key The key to read
  153896. * @param defaultValue The value if the key doesn't exist
  153897. * @returns The string value
  153898. */
  153899. static ReadString(key: string, defaultValue: string): string;
  153900. /**
  153901. * Writes a string to the data storage
  153902. * @param key The key to write
  153903. * @param value The value to write
  153904. */
  153905. static WriteString(key: string, value: string): void;
  153906. /**
  153907. * Reads a boolean from the data storage
  153908. * @param key The key to read
  153909. * @param defaultValue The value if the key doesn't exist
  153910. * @returns The boolean value
  153911. */
  153912. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153913. /**
  153914. * Writes a boolean to the data storage
  153915. * @param key The key to write
  153916. * @param value The value to write
  153917. */
  153918. static WriteBoolean(key: string, value: boolean): void;
  153919. /**
  153920. * Reads a number from the data storage
  153921. * @param key The key to read
  153922. * @param defaultValue The value if the key doesn't exist
  153923. * @returns The number value
  153924. */
  153925. static ReadNumber(key: string, defaultValue: number): number;
  153926. /**
  153927. * Writes a number to the data storage
  153928. * @param key The key to write
  153929. * @param value The value to write
  153930. */
  153931. static WriteNumber(key: string, value: number): void;
  153932. }
  153933. }
  153934. declare module BABYLON {
  153935. /**
  153936. * Class used to record delta files between 2 scene states
  153937. */
  153938. export class SceneRecorder {
  153939. private _trackedScene;
  153940. private _savedJSON;
  153941. /**
  153942. * Track a given scene. This means the current scene state will be considered the original state
  153943. * @param scene defines the scene to track
  153944. */
  153945. track(scene: Scene): void;
  153946. /**
  153947. * Get the delta between current state and original state
  153948. * @returns a string containing the delta
  153949. */
  153950. getDelta(): any;
  153951. private _compareArray;
  153952. private _compareObjects;
  153953. private _compareCollections;
  153954. private static GetShadowGeneratorById;
  153955. /**
  153956. * Apply a given delta to a given scene
  153957. * @param deltaJSON defines the JSON containing the delta
  153958. * @param scene defines the scene to apply the delta to
  153959. */
  153960. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153961. private static _ApplyPropertiesToEntity;
  153962. private static _ApplyDeltaForEntity;
  153963. }
  153964. }
  153965. declare module BABYLON {
  153966. /**
  153967. * An interface for all Hit test features
  153968. */
  153969. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153970. /**
  153971. * Triggered when new babylon (transformed) hit test results are available
  153972. */
  153973. onHitTestResultObservable: Observable<T[]>;
  153974. }
  153975. /**
  153976. * Options used for hit testing
  153977. */
  153978. export interface IWebXRLegacyHitTestOptions {
  153979. /**
  153980. * Only test when user interacted with the scene. Default - hit test every frame
  153981. */
  153982. testOnPointerDownOnly?: boolean;
  153983. /**
  153984. * The node to use to transform the local results to world coordinates
  153985. */
  153986. worldParentNode?: TransformNode;
  153987. }
  153988. /**
  153989. * Interface defining the babylon result of raycasting/hit-test
  153990. */
  153991. export interface IWebXRLegacyHitResult {
  153992. /**
  153993. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153994. */
  153995. transformationMatrix: Matrix;
  153996. /**
  153997. * The native hit test result
  153998. */
  153999. xrHitResult: XRHitResult | XRHitTestResult;
  154000. }
  154001. /**
  154002. * The currently-working hit-test module.
  154003. * Hit test (or Ray-casting) is used to interact with the real world.
  154004. * For further information read here - https://github.com/immersive-web/hit-test
  154005. */
  154006. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  154007. /**
  154008. * options to use when constructing this feature
  154009. */
  154010. readonly options: IWebXRLegacyHitTestOptions;
  154011. private _direction;
  154012. private _mat;
  154013. private _onSelectEnabled;
  154014. private _origin;
  154015. /**
  154016. * The module's name
  154017. */
  154018. static readonly Name: string;
  154019. /**
  154020. * The (Babylon) version of this module.
  154021. * This is an integer representing the implementation version.
  154022. * This number does not correspond to the WebXR specs version
  154023. */
  154024. static readonly Version: number;
  154025. /**
  154026. * Populated with the last native XR Hit Results
  154027. */
  154028. lastNativeXRHitResults: XRHitResult[];
  154029. /**
  154030. * Triggered when new babylon (transformed) hit test results are available
  154031. */
  154032. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  154033. /**
  154034. * Creates a new instance of the (legacy version) hit test feature
  154035. * @param _xrSessionManager an instance of WebXRSessionManager
  154036. * @param options options to use when constructing this feature
  154037. */
  154038. constructor(_xrSessionManager: WebXRSessionManager,
  154039. /**
  154040. * options to use when constructing this feature
  154041. */
  154042. options?: IWebXRLegacyHitTestOptions);
  154043. /**
  154044. * execute a hit test with an XR Ray
  154045. *
  154046. * @param xrSession a native xrSession that will execute this hit test
  154047. * @param xrRay the ray (position and direction) to use for ray-casting
  154048. * @param referenceSpace native XR reference space to use for the hit-test
  154049. * @param filter filter function that will filter the results
  154050. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  154051. */
  154052. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  154053. /**
  154054. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  154055. * @param event the (select) event to use to select with
  154056. * @param referenceSpace the reference space to use for this hit test
  154057. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  154058. */
  154059. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  154060. /**
  154061. * attach this feature
  154062. * Will usually be called by the features manager
  154063. *
  154064. * @returns true if successful.
  154065. */
  154066. attach(): boolean;
  154067. /**
  154068. * detach this feature.
  154069. * Will usually be called by the features manager
  154070. *
  154071. * @returns true if successful.
  154072. */
  154073. detach(): boolean;
  154074. /**
  154075. * Dispose this feature and all of the resources attached
  154076. */
  154077. dispose(): void;
  154078. protected _onXRFrame(frame: XRFrame): void;
  154079. private _onHitTestResults;
  154080. private _onSelect;
  154081. }
  154082. }
  154083. declare module BABYLON {
  154084. /**
  154085. * Options used for hit testing (version 2)
  154086. */
  154087. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  154088. /**
  154089. * Do not create a permanent hit test. Will usually be used when only
  154090. * transient inputs are needed.
  154091. */
  154092. disablePermanentHitTest?: boolean;
  154093. /**
  154094. * Enable transient (for example touch-based) hit test inspections
  154095. */
  154096. enableTransientHitTest?: boolean;
  154097. /**
  154098. * Offset ray for the permanent hit test
  154099. */
  154100. offsetRay?: Vector3;
  154101. /**
  154102. * Offset ray for the transient hit test
  154103. */
  154104. transientOffsetRay?: Vector3;
  154105. /**
  154106. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  154107. */
  154108. useReferenceSpace?: boolean;
  154109. /**
  154110. * Override the default entity type(s) of the hit-test result
  154111. */
  154112. entityTypes?: XRHitTestTrackableType[];
  154113. }
  154114. /**
  154115. * Interface defining the babylon result of hit-test
  154116. */
  154117. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  154118. /**
  154119. * The input source that generated this hit test (if transient)
  154120. */
  154121. inputSource?: XRInputSource;
  154122. /**
  154123. * Is this a transient hit test
  154124. */
  154125. isTransient?: boolean;
  154126. /**
  154127. * Position of the hit test result
  154128. */
  154129. position: Vector3;
  154130. /**
  154131. * Rotation of the hit test result
  154132. */
  154133. rotationQuaternion: Quaternion;
  154134. /**
  154135. * The native hit test result
  154136. */
  154137. xrHitResult: XRHitTestResult;
  154138. }
  154139. /**
  154140. * The currently-working hit-test module.
  154141. * Hit test (or Ray-casting) is used to interact with the real world.
  154142. * For further information read here - https://github.com/immersive-web/hit-test
  154143. *
  154144. * Tested on chrome (mobile) 80.
  154145. */
  154146. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  154147. /**
  154148. * options to use when constructing this feature
  154149. */
  154150. readonly options: IWebXRHitTestOptions;
  154151. private _tmpMat;
  154152. private _tmpPos;
  154153. private _tmpQuat;
  154154. private _transientXrHitTestSource;
  154155. private _xrHitTestSource;
  154156. private initHitTestSource;
  154157. /**
  154158. * The module's name
  154159. */
  154160. static readonly Name: string;
  154161. /**
  154162. * The (Babylon) version of this module.
  154163. * This is an integer representing the implementation version.
  154164. * This number does not correspond to the WebXR specs version
  154165. */
  154166. static readonly Version: number;
  154167. /**
  154168. * When set to true, each hit test will have its own position/rotation objects
  154169. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  154170. * the developers will clone them or copy them as they see fit.
  154171. */
  154172. autoCloneTransformation: boolean;
  154173. /**
  154174. * Triggered when new babylon (transformed) hit test results are available
  154175. */
  154176. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  154177. /**
  154178. * Use this to temporarily pause hit test checks.
  154179. */
  154180. paused: boolean;
  154181. /**
  154182. * Creates a new instance of the hit test feature
  154183. * @param _xrSessionManager an instance of WebXRSessionManager
  154184. * @param options options to use when constructing this feature
  154185. */
  154186. constructor(_xrSessionManager: WebXRSessionManager,
  154187. /**
  154188. * options to use when constructing this feature
  154189. */
  154190. options?: IWebXRHitTestOptions);
  154191. /**
  154192. * attach this feature
  154193. * Will usually be called by the features manager
  154194. *
  154195. * @returns true if successful.
  154196. */
  154197. attach(): boolean;
  154198. /**
  154199. * detach this feature.
  154200. * Will usually be called by the features manager
  154201. *
  154202. * @returns true if successful.
  154203. */
  154204. detach(): boolean;
  154205. /**
  154206. * Dispose this feature and all of the resources attached
  154207. */
  154208. dispose(): void;
  154209. protected _onXRFrame(frame: XRFrame): void;
  154210. private _processWebXRHitTestResult;
  154211. }
  154212. }
  154213. declare module BABYLON {
  154214. /**
  154215. * Configuration options of the anchor system
  154216. */
  154217. export interface IWebXRAnchorSystemOptions {
  154218. /**
  154219. * a node that will be used to convert local to world coordinates
  154220. */
  154221. worldParentNode?: TransformNode;
  154222. /**
  154223. * If set to true a reference of the created anchors will be kept until the next session starts
  154224. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154225. */
  154226. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154227. }
  154228. /**
  154229. * A babylon container for an XR Anchor
  154230. */
  154231. export interface IWebXRAnchor {
  154232. /**
  154233. * A babylon-assigned ID for this anchor
  154234. */
  154235. id: number;
  154236. /**
  154237. * Transformation matrix to apply to an object attached to this anchor
  154238. */
  154239. transformationMatrix: Matrix;
  154240. /**
  154241. * The native anchor object
  154242. */
  154243. xrAnchor: XRAnchor;
  154244. /**
  154245. * if defined, this object will be constantly updated by the anchor's position and rotation
  154246. */
  154247. attachedNode?: TransformNode;
  154248. }
  154249. /**
  154250. * An implementation of the anchor system for WebXR.
  154251. * For further information see https://github.com/immersive-web/anchors/
  154252. */
  154253. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154254. private _options;
  154255. private _lastFrameDetected;
  154256. private _trackedAnchors;
  154257. private _referenceSpaceForFrameAnchors;
  154258. private _futureAnchors;
  154259. /**
  154260. * The module's name
  154261. */
  154262. static readonly Name: string;
  154263. /**
  154264. * The (Babylon) version of this module.
  154265. * This is an integer representing the implementation version.
  154266. * This number does not correspond to the WebXR specs version
  154267. */
  154268. static readonly Version: number;
  154269. /**
  154270. * Observers registered here will be executed when a new anchor was added to the session
  154271. */
  154272. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154273. /**
  154274. * Observers registered here will be executed when an anchor was removed from the session
  154275. */
  154276. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154277. /**
  154278. * Observers registered here will be executed when an existing anchor updates
  154279. * This can execute N times every frame
  154280. */
  154281. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154282. /**
  154283. * Set the reference space to use for anchor creation, when not using a hit test.
  154284. * Will default to the session's reference space if not defined
  154285. */
  154286. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154287. /**
  154288. * constructs a new anchor system
  154289. * @param _xrSessionManager an instance of WebXRSessionManager
  154290. * @param _options configuration object for this feature
  154291. */
  154292. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154293. private _tmpVector;
  154294. private _tmpQuaternion;
  154295. private _populateTmpTransformation;
  154296. /**
  154297. * Create a new anchor point using a hit test result at a specific point in the scene
  154298. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154299. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154300. *
  154301. * @param hitTestResult The hit test result to use for this anchor creation
  154302. * @param position an optional position offset for this anchor
  154303. * @param rotationQuaternion an optional rotation offset for this anchor
  154304. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154305. */
  154306. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154307. /**
  154308. * Add a new anchor at a specific position and rotation
  154309. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154310. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154311. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154312. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154313. *
  154314. * @param position the position in which to add an anchor
  154315. * @param rotationQuaternion an optional rotation for the anchor transformation
  154316. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154317. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154318. */
  154319. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154320. /**
  154321. * detach this feature.
  154322. * Will usually be called by the features manager
  154323. *
  154324. * @returns true if successful.
  154325. */
  154326. detach(): boolean;
  154327. /**
  154328. * Dispose this feature and all of the resources attached
  154329. */
  154330. dispose(): void;
  154331. protected _onXRFrame(frame: XRFrame): void;
  154332. /**
  154333. * avoiding using Array.find for global support.
  154334. * @param xrAnchor the plane to find in the array
  154335. */
  154336. private _findIndexInAnchorArray;
  154337. private _updateAnchorWithXRFrame;
  154338. private _createAnchorAtTransformation;
  154339. }
  154340. }
  154341. declare module BABYLON {
  154342. /**
  154343. * Options used in the plane detector module
  154344. */
  154345. export interface IWebXRPlaneDetectorOptions {
  154346. /**
  154347. * The node to use to transform the local results to world coordinates
  154348. */
  154349. worldParentNode?: TransformNode;
  154350. /**
  154351. * If set to true a reference of the created planes will be kept until the next session starts
  154352. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154353. */
  154354. doNotRemovePlanesOnSessionEnded?: boolean;
  154355. }
  154356. /**
  154357. * A babylon interface for a WebXR plane.
  154358. * A Plane is actually a polygon, built from N points in space
  154359. *
  154360. * Supported in chrome 79, not supported in canary 81 ATM
  154361. */
  154362. export interface IWebXRPlane {
  154363. /**
  154364. * a babylon-assigned ID for this polygon
  154365. */
  154366. id: number;
  154367. /**
  154368. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154369. */
  154370. polygonDefinition: Array<Vector3>;
  154371. /**
  154372. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154373. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154374. */
  154375. transformationMatrix: Matrix;
  154376. /**
  154377. * the native xr-plane object
  154378. */
  154379. xrPlane: XRPlane;
  154380. }
  154381. /**
  154382. * The plane detector is used to detect planes in the real world when in AR
  154383. * For more information see https://github.com/immersive-web/real-world-geometry/
  154384. */
  154385. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154386. private _options;
  154387. private _detectedPlanes;
  154388. private _enabled;
  154389. private _lastFrameDetected;
  154390. /**
  154391. * The module's name
  154392. */
  154393. static readonly Name: string;
  154394. /**
  154395. * The (Babylon) version of this module.
  154396. * This is an integer representing the implementation version.
  154397. * This number does not correspond to the WebXR specs version
  154398. */
  154399. static readonly Version: number;
  154400. /**
  154401. * Observers registered here will be executed when a new plane was added to the session
  154402. */
  154403. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154404. /**
  154405. * Observers registered here will be executed when a plane is no longer detected in the session
  154406. */
  154407. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154408. /**
  154409. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154410. * This can execute N times every frame
  154411. */
  154412. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154413. /**
  154414. * construct a new Plane Detector
  154415. * @param _xrSessionManager an instance of xr Session manager
  154416. * @param _options configuration to use when constructing this feature
  154417. */
  154418. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154419. /**
  154420. * detach this feature.
  154421. * Will usually be called by the features manager
  154422. *
  154423. * @returns true if successful.
  154424. */
  154425. detach(): boolean;
  154426. /**
  154427. * Dispose this feature and all of the resources attached
  154428. */
  154429. dispose(): void;
  154430. protected _onXRFrame(frame: XRFrame): void;
  154431. private _init;
  154432. private _updatePlaneWithXRPlane;
  154433. /**
  154434. * avoiding using Array.find for global support.
  154435. * @param xrPlane the plane to find in the array
  154436. */
  154437. private findIndexInPlaneArray;
  154438. }
  154439. }
  154440. declare module BABYLON {
  154441. /**
  154442. * Options interface for the background remover plugin
  154443. */
  154444. export interface IWebXRBackgroundRemoverOptions {
  154445. /**
  154446. * Further background meshes to disable when entering AR
  154447. */
  154448. backgroundMeshes?: AbstractMesh[];
  154449. /**
  154450. * flags to configure the removal of the environment helper.
  154451. * If not set, the entire background will be removed. If set, flags should be set as well.
  154452. */
  154453. environmentHelperRemovalFlags?: {
  154454. /**
  154455. * Should the skybox be removed (default false)
  154456. */
  154457. skyBox?: boolean;
  154458. /**
  154459. * Should the ground be removed (default false)
  154460. */
  154461. ground?: boolean;
  154462. };
  154463. /**
  154464. * don't disable the environment helper
  154465. */
  154466. ignoreEnvironmentHelper?: boolean;
  154467. }
  154468. /**
  154469. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154470. */
  154471. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154472. /**
  154473. * read-only options to be used in this module
  154474. */
  154475. readonly options: IWebXRBackgroundRemoverOptions;
  154476. /**
  154477. * The module's name
  154478. */
  154479. static readonly Name: string;
  154480. /**
  154481. * The (Babylon) version of this module.
  154482. * This is an integer representing the implementation version.
  154483. * This number does not correspond to the WebXR specs version
  154484. */
  154485. static readonly Version: number;
  154486. /**
  154487. * registered observers will be triggered when the background state changes
  154488. */
  154489. onBackgroundStateChangedObservable: Observable<boolean>;
  154490. /**
  154491. * constructs a new background remover module
  154492. * @param _xrSessionManager the session manager for this module
  154493. * @param options read-only options to be used in this module
  154494. */
  154495. constructor(_xrSessionManager: WebXRSessionManager,
  154496. /**
  154497. * read-only options to be used in this module
  154498. */
  154499. options?: IWebXRBackgroundRemoverOptions);
  154500. /**
  154501. * attach this feature
  154502. * Will usually be called by the features manager
  154503. *
  154504. * @returns true if successful.
  154505. */
  154506. attach(): boolean;
  154507. /**
  154508. * detach this feature.
  154509. * Will usually be called by the features manager
  154510. *
  154511. * @returns true if successful.
  154512. */
  154513. detach(): boolean;
  154514. /**
  154515. * Dispose this feature and all of the resources attached
  154516. */
  154517. dispose(): void;
  154518. protected _onXRFrame(_xrFrame: XRFrame): void;
  154519. private _setBackgroundState;
  154520. }
  154521. }
  154522. declare module BABYLON {
  154523. /**
  154524. * Options for the controller physics feature
  154525. */
  154526. export class IWebXRControllerPhysicsOptions {
  154527. /**
  154528. * Should the headset get its own impostor
  154529. */
  154530. enableHeadsetImpostor?: boolean;
  154531. /**
  154532. * Optional parameters for the headset impostor
  154533. */
  154534. headsetImpostorParams?: {
  154535. /**
  154536. * The type of impostor to create. Default is sphere
  154537. */
  154538. impostorType: number;
  154539. /**
  154540. * the size of the impostor. Defaults to 10cm
  154541. */
  154542. impostorSize?: number | {
  154543. width: number;
  154544. height: number;
  154545. depth: number;
  154546. };
  154547. /**
  154548. * Friction definitions
  154549. */
  154550. friction?: number;
  154551. /**
  154552. * Restitution
  154553. */
  154554. restitution?: number;
  154555. };
  154556. /**
  154557. * The physics properties of the future impostors
  154558. */
  154559. physicsProperties?: {
  154560. /**
  154561. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154562. * Note that this requires a physics engine that supports mesh impostors!
  154563. */
  154564. useControllerMesh?: boolean;
  154565. /**
  154566. * The type of impostor to create. Default is sphere
  154567. */
  154568. impostorType?: number;
  154569. /**
  154570. * the size of the impostor. Defaults to 10cm
  154571. */
  154572. impostorSize?: number | {
  154573. width: number;
  154574. height: number;
  154575. depth: number;
  154576. };
  154577. /**
  154578. * Friction definitions
  154579. */
  154580. friction?: number;
  154581. /**
  154582. * Restitution
  154583. */
  154584. restitution?: number;
  154585. };
  154586. /**
  154587. * the xr input to use with this pointer selection
  154588. */
  154589. xrInput: WebXRInput;
  154590. }
  154591. /**
  154592. * Add physics impostor to your webxr controllers,
  154593. * including naive calculation of their linear and angular velocity
  154594. */
  154595. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154596. private readonly _options;
  154597. private _attachController;
  154598. private _controllers;
  154599. private _debugMode;
  154600. private _delta;
  154601. private _headsetImpostor?;
  154602. private _headsetMesh?;
  154603. private _lastTimestamp;
  154604. private _tmpQuaternion;
  154605. private _tmpVector;
  154606. /**
  154607. * The module's name
  154608. */
  154609. static readonly Name: string;
  154610. /**
  154611. * The (Babylon) version of this module.
  154612. * This is an integer representing the implementation version.
  154613. * This number does not correspond to the webxr specs version
  154614. */
  154615. static readonly Version: number;
  154616. /**
  154617. * Construct a new Controller Physics Feature
  154618. * @param _xrSessionManager the corresponding xr session manager
  154619. * @param _options options to create this feature with
  154620. */
  154621. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154622. /**
  154623. * @hidden
  154624. * enable debugging - will show console outputs and the impostor mesh
  154625. */
  154626. _enablePhysicsDebug(): void;
  154627. /**
  154628. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154629. * @param xrController the controller to add
  154630. */
  154631. addController(xrController: WebXRInputSource): void;
  154632. /**
  154633. * attach this feature
  154634. * Will usually be called by the features manager
  154635. *
  154636. * @returns true if successful.
  154637. */
  154638. attach(): boolean;
  154639. /**
  154640. * detach this feature.
  154641. * Will usually be called by the features manager
  154642. *
  154643. * @returns true if successful.
  154644. */
  154645. detach(): boolean;
  154646. /**
  154647. * Get the headset impostor, if enabled
  154648. * @returns the impostor
  154649. */
  154650. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154651. /**
  154652. * Get the physics impostor of a specific controller.
  154653. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154654. * @param controller the controller or the controller id of which to get the impostor
  154655. * @returns the impostor or null
  154656. */
  154657. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154658. /**
  154659. * Update the physics properties provided in the constructor
  154660. * @param newProperties the new properties object
  154661. */
  154662. setPhysicsProperties(newProperties: {
  154663. impostorType?: number;
  154664. impostorSize?: number | {
  154665. width: number;
  154666. height: number;
  154667. depth: number;
  154668. };
  154669. friction?: number;
  154670. restitution?: number;
  154671. }): void;
  154672. protected _onXRFrame(_xrFrame: any): void;
  154673. private _detachController;
  154674. }
  154675. }
  154676. declare module BABYLON {
  154677. /**
  154678. * A babylon interface for a "WebXR" feature point.
  154679. * Represents the position and confidence value of a given feature point.
  154680. */
  154681. export interface IWebXRFeaturePoint {
  154682. /**
  154683. * Represents the position of the feature point in world space.
  154684. */
  154685. position: Vector3;
  154686. /**
  154687. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154688. */
  154689. confidenceValue: number;
  154690. }
  154691. /**
  154692. * The feature point system is used to detect feature points from real world geometry.
  154693. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154694. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154695. */
  154696. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154697. private _enabled;
  154698. private _featurePointCloud;
  154699. /**
  154700. * The module's name
  154701. */
  154702. static readonly Name: string;
  154703. /**
  154704. * The (Babylon) version of this module.
  154705. * This is an integer representing the implementation version.
  154706. * This number does not correspond to the WebXR specs version
  154707. */
  154708. static readonly Version: number;
  154709. /**
  154710. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154711. * Will notify the observers about which feature points have been added.
  154712. */
  154713. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154714. /**
  154715. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154716. * Will notify the observers about which feature points have been updated.
  154717. */
  154718. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154719. /**
  154720. * The current feature point cloud maintained across frames.
  154721. */
  154722. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154723. /**
  154724. * construct the feature point system
  154725. * @param _xrSessionManager an instance of xr Session manager
  154726. */
  154727. constructor(_xrSessionManager: WebXRSessionManager);
  154728. /**
  154729. * Detach this feature.
  154730. * Will usually be called by the features manager
  154731. *
  154732. * @returns true if successful.
  154733. */
  154734. detach(): boolean;
  154735. /**
  154736. * Dispose this feature and all of the resources attached
  154737. */
  154738. dispose(): void;
  154739. /**
  154740. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154741. */
  154742. protected _onXRFrame(frame: XRFrame): void;
  154743. /**
  154744. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154745. */
  154746. private _init;
  154747. }
  154748. }
  154749. declare module BABYLON {
  154750. /**
  154751. * Configuration interface for the hand tracking feature
  154752. */
  154753. export interface IWebXRHandTrackingOptions {
  154754. /**
  154755. * The xrInput that will be used as source for new hands
  154756. */
  154757. xrInput: WebXRInput;
  154758. /**
  154759. * Configuration object for the joint meshes
  154760. */
  154761. jointMeshes?: {
  154762. /**
  154763. * Should the meshes created be invisible (defaults to false)
  154764. */
  154765. invisible?: boolean;
  154766. /**
  154767. * A source mesh to be used to create instances. Defaults to a sphere.
  154768. * This mesh will be the source for all other (25) meshes.
  154769. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154770. */
  154771. sourceMesh?: Mesh;
  154772. /**
  154773. * Should the source mesh stay visible. Defaults to false
  154774. */
  154775. keepOriginalVisible?: boolean;
  154776. /**
  154777. * Scale factor for all instances (defaults to 2)
  154778. */
  154779. scaleFactor?: number;
  154780. /**
  154781. * Should each instance have its own physics impostor
  154782. */
  154783. enablePhysics?: boolean;
  154784. /**
  154785. * If enabled, override default physics properties
  154786. */
  154787. physicsProps?: {
  154788. friction?: number;
  154789. restitution?: number;
  154790. impostorType?: number;
  154791. };
  154792. /**
  154793. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154794. */
  154795. handMesh?: AbstractMesh;
  154796. };
  154797. }
  154798. /**
  154799. * Parts of the hands divided to writs and finger names
  154800. */
  154801. export const enum HandPart {
  154802. /**
  154803. * HandPart - Wrist
  154804. */
  154805. WRIST = "wrist",
  154806. /**
  154807. * HandPart - The THumb
  154808. */
  154809. THUMB = "thumb",
  154810. /**
  154811. * HandPart - Index finger
  154812. */
  154813. INDEX = "index",
  154814. /**
  154815. * HandPart - Middle finger
  154816. */
  154817. MIDDLE = "middle",
  154818. /**
  154819. * HandPart - Ring finger
  154820. */
  154821. RING = "ring",
  154822. /**
  154823. * HandPart - Little finger
  154824. */
  154825. LITTLE = "little"
  154826. }
  154827. /**
  154828. * Representing a single hand (with its corresponding native XRHand object)
  154829. */
  154830. export class WebXRHand implements IDisposable {
  154831. /** the controller to which the hand correlates */
  154832. readonly xrController: WebXRInputSource;
  154833. /** the meshes to be used to track the hand joints */
  154834. readonly trackedMeshes: AbstractMesh[];
  154835. /**
  154836. * Hand-parts definition (key is HandPart)
  154837. */
  154838. handPartsDefinition: {
  154839. [key: string]: number[];
  154840. };
  154841. /**
  154842. * Populate the HandPartsDefinition object.
  154843. * This is called as a side effect since certain browsers don't have XRHand defined.
  154844. */
  154845. private generateHandPartsDefinition;
  154846. /**
  154847. * Construct a new hand object
  154848. * @param xrController the controller to which the hand correlates
  154849. * @param trackedMeshes the meshes to be used to track the hand joints
  154850. */
  154851. constructor(
  154852. /** the controller to which the hand correlates */
  154853. xrController: WebXRInputSource,
  154854. /** the meshes to be used to track the hand joints */
  154855. trackedMeshes: AbstractMesh[]);
  154856. /**
  154857. * Update this hand from the latest xr frame
  154858. * @param xrFrame xrFrame to update from
  154859. * @param referenceSpace The current viewer reference space
  154860. * @param scaleFactor optional scale factor for the meshes
  154861. */
  154862. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154863. /**
  154864. * Get meshes of part of the hand
  154865. * @param part the part of hand to get
  154866. * @returns An array of meshes that correlate to the hand part requested
  154867. */
  154868. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154869. /**
  154870. * Dispose this Hand object
  154871. */
  154872. dispose(): void;
  154873. }
  154874. /**
  154875. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154876. */
  154877. export class WebXRHandTracking extends WebXRAbstractFeature {
  154878. /**
  154879. * options to use when constructing this feature
  154880. */
  154881. readonly options: IWebXRHandTrackingOptions;
  154882. private static _idCounter;
  154883. /**
  154884. * The module's name
  154885. */
  154886. static readonly Name: string;
  154887. /**
  154888. * The (Babylon) version of this module.
  154889. * This is an integer representing the implementation version.
  154890. * This number does not correspond to the WebXR specs version
  154891. */
  154892. static readonly Version: number;
  154893. /**
  154894. * This observable will notify registered observers when a new hand object was added and initialized
  154895. */
  154896. onHandAddedObservable: Observable<WebXRHand>;
  154897. /**
  154898. * This observable will notify its observers right before the hand object is disposed
  154899. */
  154900. onHandRemovedObservable: Observable<WebXRHand>;
  154901. private _hands;
  154902. /**
  154903. * Creates a new instance of the hit test feature
  154904. * @param _xrSessionManager an instance of WebXRSessionManager
  154905. * @param options options to use when constructing this feature
  154906. */
  154907. constructor(_xrSessionManager: WebXRSessionManager,
  154908. /**
  154909. * options to use when constructing this feature
  154910. */
  154911. options: IWebXRHandTrackingOptions);
  154912. /**
  154913. * Check if the needed objects are defined.
  154914. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154915. */
  154916. isCompatible(): boolean;
  154917. /**
  154918. * attach this feature
  154919. * Will usually be called by the features manager
  154920. *
  154921. * @returns true if successful.
  154922. */
  154923. attach(): boolean;
  154924. /**
  154925. * detach this feature.
  154926. * Will usually be called by the features manager
  154927. *
  154928. * @returns true if successful.
  154929. */
  154930. detach(): boolean;
  154931. /**
  154932. * Dispose this feature and all of the resources attached
  154933. */
  154934. dispose(): void;
  154935. /**
  154936. * Get the hand object according to the controller id
  154937. * @param controllerId the controller id to which we want to get the hand
  154938. * @returns null if not found or the WebXRHand object if found
  154939. */
  154940. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154941. /**
  154942. * Get a hand object according to the requested handedness
  154943. * @param handedness the handedness to request
  154944. * @returns null if not found or the WebXRHand object if found
  154945. */
  154946. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154947. protected _onXRFrame(_xrFrame: XRFrame): void;
  154948. private _attachHand;
  154949. private _detachHand;
  154950. }
  154951. }
  154952. declare module BABYLON {
  154953. /**
  154954. * The motion controller class for all microsoft mixed reality controllers
  154955. */
  154956. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154957. protected readonly _mapping: {
  154958. defaultButton: {
  154959. valueNodeName: string;
  154960. unpressedNodeName: string;
  154961. pressedNodeName: string;
  154962. };
  154963. defaultAxis: {
  154964. valueNodeName: string;
  154965. minNodeName: string;
  154966. maxNodeName: string;
  154967. };
  154968. buttons: {
  154969. "xr-standard-trigger": {
  154970. rootNodeName: string;
  154971. componentProperty: string;
  154972. states: string[];
  154973. };
  154974. "xr-standard-squeeze": {
  154975. rootNodeName: string;
  154976. componentProperty: string;
  154977. states: string[];
  154978. };
  154979. "xr-standard-touchpad": {
  154980. rootNodeName: string;
  154981. labelAnchorNodeName: string;
  154982. touchPointNodeName: string;
  154983. };
  154984. "xr-standard-thumbstick": {
  154985. rootNodeName: string;
  154986. componentProperty: string;
  154987. states: string[];
  154988. };
  154989. };
  154990. axes: {
  154991. "xr-standard-touchpad": {
  154992. "x-axis": {
  154993. rootNodeName: string;
  154994. };
  154995. "y-axis": {
  154996. rootNodeName: string;
  154997. };
  154998. };
  154999. "xr-standard-thumbstick": {
  155000. "x-axis": {
  155001. rootNodeName: string;
  155002. };
  155003. "y-axis": {
  155004. rootNodeName: string;
  155005. };
  155006. };
  155007. };
  155008. };
  155009. /**
  155010. * The base url used to load the left and right controller models
  155011. */
  155012. static MODEL_BASE_URL: string;
  155013. /**
  155014. * The name of the left controller model file
  155015. */
  155016. static MODEL_LEFT_FILENAME: string;
  155017. /**
  155018. * The name of the right controller model file
  155019. */
  155020. static MODEL_RIGHT_FILENAME: string;
  155021. profileId: string;
  155022. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  155023. protected _getFilenameAndPath(): {
  155024. filename: string;
  155025. path: string;
  155026. };
  155027. protected _getModelLoadingConstraints(): boolean;
  155028. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155029. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155030. protected _updateModel(): void;
  155031. }
  155032. }
  155033. declare module BABYLON {
  155034. /**
  155035. * The motion controller class for oculus touch (quest, rift).
  155036. * This class supports legacy mapping as well the standard xr mapping
  155037. */
  155038. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  155039. private _forceLegacyControllers;
  155040. private _modelRootNode;
  155041. /**
  155042. * The base url used to load the left and right controller models
  155043. */
  155044. static MODEL_BASE_URL: string;
  155045. /**
  155046. * The name of the left controller model file
  155047. */
  155048. static MODEL_LEFT_FILENAME: string;
  155049. /**
  155050. * The name of the right controller model file
  155051. */
  155052. static MODEL_RIGHT_FILENAME: string;
  155053. /**
  155054. * Base Url for the Quest controller model.
  155055. */
  155056. static QUEST_MODEL_BASE_URL: string;
  155057. profileId: string;
  155058. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  155059. protected _getFilenameAndPath(): {
  155060. filename: string;
  155061. path: string;
  155062. };
  155063. protected _getModelLoadingConstraints(): boolean;
  155064. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155065. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155066. protected _updateModel(): void;
  155067. /**
  155068. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  155069. * between the touch and touch 2.
  155070. */
  155071. private _isQuest;
  155072. }
  155073. }
  155074. declare module BABYLON {
  155075. /**
  155076. * The motion controller class for the standard HTC-Vive controllers
  155077. */
  155078. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  155079. private _modelRootNode;
  155080. /**
  155081. * The base url used to load the left and right controller models
  155082. */
  155083. static MODEL_BASE_URL: string;
  155084. /**
  155085. * File name for the controller model.
  155086. */
  155087. static MODEL_FILENAME: string;
  155088. profileId: string;
  155089. /**
  155090. * Create a new Vive motion controller object
  155091. * @param scene the scene to use to create this controller
  155092. * @param gamepadObject the corresponding gamepad object
  155093. * @param handedness the handedness of the controller
  155094. */
  155095. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  155096. protected _getFilenameAndPath(): {
  155097. filename: string;
  155098. path: string;
  155099. };
  155100. protected _getModelLoadingConstraints(): boolean;
  155101. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  155102. protected _setRootMesh(meshes: AbstractMesh[]): void;
  155103. protected _updateModel(): void;
  155104. }
  155105. }
  155106. declare module BABYLON {
  155107. /**
  155108. * A cursor which tracks a point on a path
  155109. */
  155110. export class PathCursor {
  155111. private path;
  155112. /**
  155113. * Stores path cursor callbacks for when an onchange event is triggered
  155114. */
  155115. private _onchange;
  155116. /**
  155117. * The value of the path cursor
  155118. */
  155119. value: number;
  155120. /**
  155121. * The animation array of the path cursor
  155122. */
  155123. animations: Animation[];
  155124. /**
  155125. * Initializes the path cursor
  155126. * @param path The path to track
  155127. */
  155128. constructor(path: Path2);
  155129. /**
  155130. * Gets the cursor point on the path
  155131. * @returns A point on the path cursor at the cursor location
  155132. */
  155133. getPoint(): Vector3;
  155134. /**
  155135. * Moves the cursor ahead by the step amount
  155136. * @param step The amount to move the cursor forward
  155137. * @returns This path cursor
  155138. */
  155139. moveAhead(step?: number): PathCursor;
  155140. /**
  155141. * Moves the cursor behind by the step amount
  155142. * @param step The amount to move the cursor back
  155143. * @returns This path cursor
  155144. */
  155145. moveBack(step?: number): PathCursor;
  155146. /**
  155147. * Moves the cursor by the step amount
  155148. * If the step amount is greater than one, an exception is thrown
  155149. * @param step The amount to move the cursor
  155150. * @returns This path cursor
  155151. */
  155152. move(step: number): PathCursor;
  155153. /**
  155154. * Ensures that the value is limited between zero and one
  155155. * @returns This path cursor
  155156. */
  155157. private ensureLimits;
  155158. /**
  155159. * Runs onchange callbacks on change (used by the animation engine)
  155160. * @returns This path cursor
  155161. */
  155162. private raiseOnChange;
  155163. /**
  155164. * Executes a function on change
  155165. * @param f A path cursor onchange callback
  155166. * @returns This path cursor
  155167. */
  155168. onchange(f: (cursor: PathCursor) => void): PathCursor;
  155169. }
  155170. }
  155171. declare module BABYLON {
  155172. /** @hidden */
  155173. export var blurPixelShader: {
  155174. name: string;
  155175. shader: string;
  155176. };
  155177. }
  155178. declare module BABYLON {
  155179. /** @hidden */
  155180. export var pointCloudVertexDeclaration: {
  155181. name: string;
  155182. shader: string;
  155183. };
  155184. }
  155185. // Mixins
  155186. interface Window {
  155187. mozIndexedDB: IDBFactory;
  155188. webkitIndexedDB: IDBFactory;
  155189. msIndexedDB: IDBFactory;
  155190. webkitURL: typeof URL;
  155191. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  155192. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  155193. WebGLRenderingContext: WebGLRenderingContext;
  155194. MSGesture: MSGesture;
  155195. CANNON: any;
  155196. AudioContext: AudioContext;
  155197. webkitAudioContext: AudioContext;
  155198. PointerEvent: any;
  155199. Math: Math;
  155200. Uint8Array: Uint8ArrayConstructor;
  155201. Float32Array: Float32ArrayConstructor;
  155202. mozURL: typeof URL;
  155203. msURL: typeof URL;
  155204. VRFrameData: any; // WebVR, from specs 1.1
  155205. DracoDecoderModule: any;
  155206. setImmediate(handler: (...args: any[]) => void): number;
  155207. }
  155208. interface HTMLCanvasElement {
  155209. requestPointerLock(): void;
  155210. msRequestPointerLock?(): void;
  155211. mozRequestPointerLock?(): void;
  155212. webkitRequestPointerLock?(): void;
  155213. /** Track wether a record is in progress */
  155214. isRecording: boolean;
  155215. /** Capture Stream method defined by some browsers */
  155216. captureStream(fps?: number): MediaStream;
  155217. }
  155218. interface CanvasRenderingContext2D {
  155219. msImageSmoothingEnabled: boolean;
  155220. }
  155221. interface MouseEvent {
  155222. mozMovementX: number;
  155223. mozMovementY: number;
  155224. webkitMovementX: number;
  155225. webkitMovementY: number;
  155226. msMovementX: number;
  155227. msMovementY: number;
  155228. }
  155229. interface Navigator {
  155230. mozGetVRDevices: (any: any) => any;
  155231. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155232. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155233. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155234. webkitGetGamepads(): Gamepad[];
  155235. msGetGamepads(): Gamepad[];
  155236. webkitGamepads(): Gamepad[];
  155237. }
  155238. interface HTMLVideoElement {
  155239. mozSrcObject: any;
  155240. }
  155241. interface Math {
  155242. fround(x: number): number;
  155243. imul(a: number, b: number): number;
  155244. }
  155245. interface WebGLRenderingContext {
  155246. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155247. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155248. vertexAttribDivisor(index: number, divisor: number): void;
  155249. createVertexArray(): any;
  155250. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155251. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155252. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155253. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155254. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155255. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155256. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155257. // Queries
  155258. createQuery(): WebGLQuery;
  155259. deleteQuery(query: WebGLQuery): void;
  155260. beginQuery(target: number, query: WebGLQuery): void;
  155261. endQuery(target: number): void;
  155262. getQueryParameter(query: WebGLQuery, pname: number): any;
  155263. getQuery(target: number, pname: number): any;
  155264. MAX_SAMPLES: number;
  155265. RGBA8: number;
  155266. READ_FRAMEBUFFER: number;
  155267. DRAW_FRAMEBUFFER: number;
  155268. UNIFORM_BUFFER: number;
  155269. HALF_FLOAT_OES: number;
  155270. RGBA16F: number;
  155271. RGBA32F: number;
  155272. R32F: number;
  155273. RG32F: number;
  155274. RGB32F: number;
  155275. R16F: number;
  155276. RG16F: number;
  155277. RGB16F: number;
  155278. RED: number;
  155279. RG: number;
  155280. R8: number;
  155281. RG8: number;
  155282. UNSIGNED_INT_24_8: number;
  155283. DEPTH24_STENCIL8: number;
  155284. MIN: number;
  155285. MAX: number;
  155286. /* Multiple Render Targets */
  155287. drawBuffers(buffers: number[]): void;
  155288. readBuffer(src: number): void;
  155289. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155290. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155291. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155292. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155293. // Occlusion Query
  155294. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155295. ANY_SAMPLES_PASSED: number;
  155296. QUERY_RESULT_AVAILABLE: number;
  155297. QUERY_RESULT: number;
  155298. }
  155299. interface WebGLProgram {
  155300. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155301. }
  155302. interface EXT_disjoint_timer_query {
  155303. QUERY_COUNTER_BITS_EXT: number;
  155304. TIME_ELAPSED_EXT: number;
  155305. TIMESTAMP_EXT: number;
  155306. GPU_DISJOINT_EXT: number;
  155307. QUERY_RESULT_EXT: number;
  155308. QUERY_RESULT_AVAILABLE_EXT: number;
  155309. queryCounterEXT(query: WebGLQuery, target: number): void;
  155310. createQueryEXT(): WebGLQuery;
  155311. beginQueryEXT(target: number, query: WebGLQuery): void;
  155312. endQueryEXT(target: number): void;
  155313. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155314. deleteQueryEXT(query: WebGLQuery): void;
  155315. }
  155316. interface WebGLUniformLocation {
  155317. _currentState: any;
  155318. }
  155319. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155320. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155321. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155322. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155323. interface WebGLRenderingContext {
  155324. readonly RASTERIZER_DISCARD: number;
  155325. readonly DEPTH_COMPONENT24: number;
  155326. readonly TEXTURE_3D: number;
  155327. readonly TEXTURE_2D_ARRAY: number;
  155328. readonly TEXTURE_COMPARE_FUNC: number;
  155329. readonly TEXTURE_COMPARE_MODE: number;
  155330. readonly COMPARE_REF_TO_TEXTURE: number;
  155331. readonly TEXTURE_WRAP_R: number;
  155332. readonly HALF_FLOAT: number;
  155333. readonly RGB8: number;
  155334. readonly RED_INTEGER: number;
  155335. readonly RG_INTEGER: number;
  155336. readonly RGB_INTEGER: number;
  155337. readonly RGBA_INTEGER: number;
  155338. readonly R8_SNORM: number;
  155339. readonly RG8_SNORM: number;
  155340. readonly RGB8_SNORM: number;
  155341. readonly RGBA8_SNORM: number;
  155342. readonly R8I: number;
  155343. readonly RG8I: number;
  155344. readonly RGB8I: number;
  155345. readonly RGBA8I: number;
  155346. readonly R8UI: number;
  155347. readonly RG8UI: number;
  155348. readonly RGB8UI: number;
  155349. readonly RGBA8UI: number;
  155350. readonly R16I: number;
  155351. readonly RG16I: number;
  155352. readonly RGB16I: number;
  155353. readonly RGBA16I: number;
  155354. readonly R16UI: number;
  155355. readonly RG16UI: number;
  155356. readonly RGB16UI: number;
  155357. readonly RGBA16UI: number;
  155358. readonly R32I: number;
  155359. readonly RG32I: number;
  155360. readonly RGB32I: number;
  155361. readonly RGBA32I: number;
  155362. readonly R32UI: number;
  155363. readonly RG32UI: number;
  155364. readonly RGB32UI: number;
  155365. readonly RGBA32UI: number;
  155366. readonly RGB10_A2UI: number;
  155367. readonly R11F_G11F_B10F: number;
  155368. readonly RGB9_E5: number;
  155369. readonly RGB10_A2: number;
  155370. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155371. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155372. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155373. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155374. readonly DEPTH_COMPONENT32F: number;
  155375. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155376. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155377. 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;
  155378. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155379. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155380. readonly TRANSFORM_FEEDBACK: number;
  155381. readonly INTERLEAVED_ATTRIBS: number;
  155382. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155383. createTransformFeedback(): WebGLTransformFeedback;
  155384. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155385. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155386. beginTransformFeedback(primitiveMode: number): void;
  155387. endTransformFeedback(): void;
  155388. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155389. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155390. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155391. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155392. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155393. }
  155394. interface ImageBitmap {
  155395. readonly width: number;
  155396. readonly height: number;
  155397. close(): void;
  155398. }
  155399. interface WebGLQuery extends WebGLObject {
  155400. }
  155401. declare var WebGLQuery: {
  155402. prototype: WebGLQuery;
  155403. new(): WebGLQuery;
  155404. };
  155405. interface WebGLSampler extends WebGLObject {
  155406. }
  155407. declare var WebGLSampler: {
  155408. prototype: WebGLSampler;
  155409. new(): WebGLSampler;
  155410. };
  155411. interface WebGLSync extends WebGLObject {
  155412. }
  155413. declare var WebGLSync: {
  155414. prototype: WebGLSync;
  155415. new(): WebGLSync;
  155416. };
  155417. interface WebGLTransformFeedback extends WebGLObject {
  155418. }
  155419. declare var WebGLTransformFeedback: {
  155420. prototype: WebGLTransformFeedback;
  155421. new(): WebGLTransformFeedback;
  155422. };
  155423. interface WebGLVertexArrayObject extends WebGLObject {
  155424. }
  155425. declare var WebGLVertexArrayObject: {
  155426. prototype: WebGLVertexArrayObject;
  155427. new(): WebGLVertexArrayObject;
  155428. };
  155429. // Type definitions for WebVR API
  155430. // Project: https://w3c.github.io/webvr/
  155431. // Definitions by: six a <https://github.com/lostfictions>
  155432. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155433. interface VRDisplay extends EventTarget {
  155434. /**
  155435. * Dictionary of capabilities describing the VRDisplay.
  155436. */
  155437. readonly capabilities: VRDisplayCapabilities;
  155438. /**
  155439. * z-depth defining the far plane of the eye view frustum
  155440. * enables mapping of values in the render target depth
  155441. * attachment to scene coordinates. Initially set to 10000.0.
  155442. */
  155443. depthFar: number;
  155444. /**
  155445. * z-depth defining the near plane of the eye view frustum
  155446. * enables mapping of values in the render target depth
  155447. * attachment to scene coordinates. Initially set to 0.01.
  155448. */
  155449. depthNear: number;
  155450. /**
  155451. * An identifier for this distinct VRDisplay. Used as an
  155452. * association point in the Gamepad API.
  155453. */
  155454. readonly displayId: number;
  155455. /**
  155456. * A display name, a user-readable name identifying it.
  155457. */
  155458. readonly displayName: string;
  155459. readonly isConnected: boolean;
  155460. readonly isPresenting: boolean;
  155461. /**
  155462. * If this VRDisplay supports room-scale experiences, the optional
  155463. * stage attribute contains details on the room-scale parameters.
  155464. */
  155465. readonly stageParameters: VRStageParameters | null;
  155466. /**
  155467. * Passing the value returned by `requestAnimationFrame` to
  155468. * `cancelAnimationFrame` will unregister the callback.
  155469. * @param handle Define the hanle of the request to cancel
  155470. */
  155471. cancelAnimationFrame(handle: number): void;
  155472. /**
  155473. * Stops presenting to the VRDisplay.
  155474. * @returns a promise to know when it stopped
  155475. */
  155476. exitPresent(): Promise<void>;
  155477. /**
  155478. * Return the current VREyeParameters for the given eye.
  155479. * @param whichEye Define the eye we want the parameter for
  155480. * @returns the eye parameters
  155481. */
  155482. getEyeParameters(whichEye: string): VREyeParameters;
  155483. /**
  155484. * Populates the passed VRFrameData with the information required to render
  155485. * the current frame.
  155486. * @param frameData Define the data structure to populate
  155487. * @returns true if ok otherwise false
  155488. */
  155489. getFrameData(frameData: VRFrameData): boolean;
  155490. /**
  155491. * Get the layers currently being presented.
  155492. * @returns the list of VR layers
  155493. */
  155494. getLayers(): VRLayer[];
  155495. /**
  155496. * Return a VRPose containing the future predicted pose of the VRDisplay
  155497. * when the current frame will be presented. The value returned will not
  155498. * change until JavaScript has returned control to the browser.
  155499. *
  155500. * The VRPose will contain the position, orientation, velocity,
  155501. * and acceleration of each of these properties.
  155502. * @returns the pose object
  155503. */
  155504. getPose(): VRPose;
  155505. /**
  155506. * Return the current instantaneous pose of the VRDisplay, with no
  155507. * prediction applied.
  155508. * @returns the current instantaneous pose
  155509. */
  155510. getImmediatePose(): VRPose;
  155511. /**
  155512. * The callback passed to `requestAnimationFrame` will be called
  155513. * any time a new frame should be rendered. When the VRDisplay is
  155514. * presenting the callback will be called at the native refresh
  155515. * rate of the HMD. When not presenting this function acts
  155516. * identically to how window.requestAnimationFrame acts. Content should
  155517. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155518. * asynchronously from other displays and at differing refresh rates.
  155519. * @param callback Define the eaction to run next frame
  155520. * @returns the request handle it
  155521. */
  155522. requestAnimationFrame(callback: FrameRequestCallback): number;
  155523. /**
  155524. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155525. * Repeat calls while already presenting will update the VRLayers being displayed.
  155526. * @param layers Define the list of layer to present
  155527. * @returns a promise to know when the request has been fulfilled
  155528. */
  155529. requestPresent(layers: VRLayer[]): Promise<void>;
  155530. /**
  155531. * Reset the pose for this display, treating its current position and
  155532. * orientation as the "origin/zero" values. VRPose.position,
  155533. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155534. * updated when calling resetPose(). This should be called in only
  155535. * sitting-space experiences.
  155536. */
  155537. resetPose(): void;
  155538. /**
  155539. * The VRLayer provided to the VRDisplay will be captured and presented
  155540. * in the HMD. Calling this function has the same effect on the source
  155541. * canvas as any other operation that uses its source image, and canvases
  155542. * created without preserveDrawingBuffer set to true will be cleared.
  155543. * @param pose Define the pose to submit
  155544. */
  155545. submitFrame(pose?: VRPose): void;
  155546. }
  155547. declare var VRDisplay: {
  155548. prototype: VRDisplay;
  155549. new(): VRDisplay;
  155550. };
  155551. interface VRLayer {
  155552. leftBounds?: number[] | Float32Array | null;
  155553. rightBounds?: number[] | Float32Array | null;
  155554. source?: HTMLCanvasElement | null;
  155555. }
  155556. interface VRDisplayCapabilities {
  155557. readonly canPresent: boolean;
  155558. readonly hasExternalDisplay: boolean;
  155559. readonly hasOrientation: boolean;
  155560. readonly hasPosition: boolean;
  155561. readonly maxLayers: number;
  155562. }
  155563. interface VREyeParameters {
  155564. /** @deprecated */
  155565. readonly fieldOfView: VRFieldOfView;
  155566. readonly offset: Float32Array;
  155567. readonly renderHeight: number;
  155568. readonly renderWidth: number;
  155569. }
  155570. interface VRFieldOfView {
  155571. readonly downDegrees: number;
  155572. readonly leftDegrees: number;
  155573. readonly rightDegrees: number;
  155574. readonly upDegrees: number;
  155575. }
  155576. interface VRFrameData {
  155577. readonly leftProjectionMatrix: Float32Array;
  155578. readonly leftViewMatrix: Float32Array;
  155579. readonly pose: VRPose;
  155580. readonly rightProjectionMatrix: Float32Array;
  155581. readonly rightViewMatrix: Float32Array;
  155582. readonly timestamp: number;
  155583. }
  155584. interface VRPose {
  155585. readonly angularAcceleration: Float32Array | null;
  155586. readonly angularVelocity: Float32Array | null;
  155587. readonly linearAcceleration: Float32Array | null;
  155588. readonly linearVelocity: Float32Array | null;
  155589. readonly orientation: Float32Array | null;
  155590. readonly position: Float32Array | null;
  155591. readonly timestamp: number;
  155592. }
  155593. interface VRStageParameters {
  155594. sittingToStandingTransform?: Float32Array;
  155595. sizeX?: number;
  155596. sizeY?: number;
  155597. }
  155598. interface Navigator {
  155599. getVRDisplays(): Promise<VRDisplay[]>;
  155600. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155601. }
  155602. interface Window {
  155603. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155604. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155605. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155606. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155607. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155608. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155609. }
  155610. interface Gamepad {
  155611. readonly displayId: number;
  155612. }
  155613. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155614. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155615. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155616. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155617. type XRHandedness = "none" | "left" | "right";
  155618. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155619. type XREye = "none" | "left" | "right";
  155620. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155621. interface XRSpace extends EventTarget {}
  155622. interface XRRenderState {
  155623. depthNear?: number;
  155624. depthFar?: number;
  155625. inlineVerticalFieldOfView?: number;
  155626. baseLayer?: XRWebGLLayer;
  155627. }
  155628. interface XRInputSource {
  155629. handedness: XRHandedness;
  155630. targetRayMode: XRTargetRayMode;
  155631. targetRaySpace: XRSpace;
  155632. gripSpace: XRSpace | undefined;
  155633. gamepad: Gamepad | undefined;
  155634. profiles: Array<string>;
  155635. hand: XRHand | undefined;
  155636. }
  155637. interface XRSessionInit {
  155638. optionalFeatures?: string[];
  155639. requiredFeatures?: string[];
  155640. }
  155641. interface XRSession {
  155642. addEventListener: Function;
  155643. removeEventListener: Function;
  155644. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155645. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155646. requestAnimationFrame: Function;
  155647. end(): Promise<void>;
  155648. renderState: XRRenderState;
  155649. inputSources: Array<XRInputSource>;
  155650. // hit test
  155651. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155652. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155653. // legacy AR hit test
  155654. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155655. // legacy plane detection
  155656. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155657. }
  155658. interface XRReferenceSpace extends XRSpace {
  155659. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155660. onreset: any;
  155661. }
  155662. type XRPlaneSet = Set<XRPlane>;
  155663. type XRAnchorSet = Set<XRAnchor>;
  155664. interface XRFrame {
  155665. session: XRSession;
  155666. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155667. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155668. // AR
  155669. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155670. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155671. // Anchors
  155672. trackedAnchors?: XRAnchorSet;
  155673. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155674. // Planes
  155675. worldInformation: {
  155676. detectedPlanes?: XRPlaneSet;
  155677. };
  155678. // Hand tracking
  155679. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155680. }
  155681. interface XRViewerPose extends XRPose {
  155682. views: Array<XRView>;
  155683. }
  155684. interface XRPose {
  155685. transform: XRRigidTransform;
  155686. emulatedPosition: boolean;
  155687. }
  155688. interface XRWebGLLayerOptions {
  155689. antialias?: boolean;
  155690. depth?: boolean;
  155691. stencil?: boolean;
  155692. alpha?: boolean;
  155693. multiview?: boolean;
  155694. framebufferScaleFactor?: number;
  155695. }
  155696. declare var XRWebGLLayer: {
  155697. prototype: XRWebGLLayer;
  155698. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155699. };
  155700. interface XRWebGLLayer {
  155701. framebuffer: WebGLFramebuffer;
  155702. framebufferWidth: number;
  155703. framebufferHeight: number;
  155704. getViewport: Function;
  155705. }
  155706. declare class XRRigidTransform {
  155707. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155708. position: DOMPointReadOnly;
  155709. orientation: DOMPointReadOnly;
  155710. matrix: Float32Array;
  155711. inverse: XRRigidTransform;
  155712. }
  155713. interface XRView {
  155714. eye: XREye;
  155715. projectionMatrix: Float32Array;
  155716. transform: XRRigidTransform;
  155717. }
  155718. interface XRInputSourceChangeEvent {
  155719. session: XRSession;
  155720. removed: Array<XRInputSource>;
  155721. added: Array<XRInputSource>;
  155722. }
  155723. interface XRInputSourceEvent extends Event {
  155724. readonly frame: XRFrame;
  155725. readonly inputSource: XRInputSource;
  155726. }
  155727. // Experimental(er) features
  155728. declare class XRRay {
  155729. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155730. origin: DOMPointReadOnly;
  155731. direction: DOMPointReadOnly;
  155732. matrix: Float32Array;
  155733. }
  155734. declare enum XRHitTestTrackableType {
  155735. "point",
  155736. "plane",
  155737. "mesh",
  155738. }
  155739. interface XRHitResult {
  155740. hitMatrix: Float32Array;
  155741. }
  155742. interface XRTransientInputHitTestResult {
  155743. readonly inputSource: XRInputSource;
  155744. readonly results: Array<XRHitTestResult>;
  155745. }
  155746. interface XRHitTestResult {
  155747. getPose(baseSpace: XRSpace): XRPose | undefined;
  155748. // When anchor system is enabled
  155749. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155750. }
  155751. interface XRHitTestSource {
  155752. cancel(): void;
  155753. }
  155754. interface XRTransientInputHitTestSource {
  155755. cancel(): void;
  155756. }
  155757. interface XRHitTestOptionsInit {
  155758. space: XRSpace;
  155759. entityTypes?: Array<XRHitTestTrackableType>;
  155760. offsetRay?: XRRay;
  155761. }
  155762. interface XRTransientInputHitTestOptionsInit {
  155763. profile: string;
  155764. entityTypes?: Array<XRHitTestTrackableType>;
  155765. offsetRay?: XRRay;
  155766. }
  155767. interface XRAnchor {
  155768. anchorSpace: XRSpace;
  155769. delete(): void;
  155770. }
  155771. interface XRPlane {
  155772. orientation: "Horizontal" | "Vertical";
  155773. planeSpace: XRSpace;
  155774. polygon: Array<DOMPointReadOnly>;
  155775. lastChangedTime: number;
  155776. }
  155777. interface XRJointSpace extends XRSpace {}
  155778. interface XRJointPose extends XRPose {
  155779. radius: number | undefined;
  155780. }
  155781. interface XRHand /*extends Iterablele<XRJointSpace>*/ {
  155782. readonly length: number;
  155783. [index: number]: XRJointSpace;
  155784. // Specs have the function 'joint(idx: number)', but chrome doesn't support it yet.
  155785. readonly WRIST: number;
  155786. readonly THUMB_METACARPAL: number;
  155787. readonly THUMB_PHALANX_PROXIMAL: number;
  155788. readonly THUMB_PHALANX_DISTAL: number;
  155789. readonly THUMB_PHALANX_TIP: number;
  155790. readonly INDEX_METACARPAL: number;
  155791. readonly INDEX_PHALANX_PROXIMAL: number;
  155792. readonly INDEX_PHALANX_INTERMEDIATE: number;
  155793. readonly INDEX_PHALANX_DISTAL: number;
  155794. readonly INDEX_PHALANX_TIP: number;
  155795. readonly MIDDLE_METACARPAL: number;
  155796. readonly MIDDLE_PHALANX_PROXIMAL: number;
  155797. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  155798. readonly MIDDLE_PHALANX_DISTAL: number;
  155799. readonly MIDDLE_PHALANX_TIP: number;
  155800. readonly RING_METACARPAL: number;
  155801. readonly RING_PHALANX_PROXIMAL: number;
  155802. readonly RING_PHALANX_INTERMEDIATE: number;
  155803. readonly RING_PHALANX_DISTAL: number;
  155804. readonly RING_PHALANX_TIP: number;
  155805. readonly LITTLE_METACARPAL: number;
  155806. readonly LITTLE_PHALANX_PROXIMAL: number;
  155807. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  155808. readonly LITTLE_PHALANX_DISTAL: number;
  155809. readonly LITTLE_PHALANX_TIP: number;
  155810. }
  155811. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155812. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155813. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155814. interface XRSession {
  155815. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155816. }
  155817. interface XRFrame {
  155818. featurePointCloud? : Array<number>;
  155819. }